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 -712698321 "Jürgen Spitzmüller"
130 \author 1119979965 "Joel A. Kulesza"
136 Additional \SpecialChar LyX
140 \begin_layout Subtitle
145 by the \SpecialChar LyX
150 \begin_layout Plain Layout
152 Principal maintainer of this file is
157 If you have comments or error corrections, please send them to the \SpecialChar LyX
160 \begin_inset Flex Code
163 \begin_layout Plain Layout
164 <lyx-docs@lists.lyx.org>
177 \begin_layout Standard
178 \begin_inset CommandInset toc
179 LatexCommand tableofcontents
186 \begin_layout Chapter
190 \begin_layout Standard
191 This manual is essentially Part II of the
193 User's Guide\SpecialChar endofsentence
196 The reason for separating the two documents is simple: the
200 is already quite lengthy, and it contains information on all of the basic
201 features one needs to know in order to prepare most documents.
202 However, the \SpecialChar LyX
203 Team has worked to make \SpecialChar LyX
204 extensible through various configuration
205 files and external packages.
206 That means that if you want to support the Fizzwizzle \SpecialChar LaTeX
208 create a layout file (or module) for it without having to alter \SpecialChar LyX
210 We've already had contributions of several new features this way, and some
211 of them are documented here.
212 There are also some more `advanced' features, such as how to control the
213 presentation of bibliographies and how to work with multi-part documents,
214 that are not covered in the
218 and are discussed here.
221 \begin_layout Standard
222 This manual also documents some special features, like fax support, version
223 control, and SGML support, which require additional software to work properly.
224 There is also a chapter on \SpecialChar LyX
226 And lastly, there's a chapter of \SpecialChar LaTeX
227 tools and tips, things you can use to
228 spruce up your documents by directly using the powerful features of \SpecialChar LaTeX
230 After all, \SpecialChar LyX
235 only WYSIWYM and will only ever interface to some, not all, \SpecialChar LaTeX
239 \begin_layout Standard
240 If you haven't read the
244 yet, you are definitely in the wrong manual.
249 is the first place to go, since it describes the notation and format of
251 You should also be thoroughly familiar with the
255 and all of the basic features of \SpecialChar LyX
256 before attempting to read this one.
259 \begin_layout Standard
260 Since many of the topics in this manual depend heavily on \SpecialChar LyX
262 with \SpecialChar LaTeX
263 , this first chapter covers the inner workings of \SpecialChar LyX
266 to generate exactly the \SpecialChar LaTeX
268 It is obviously for more seasoned \SpecialChar LyX
272 \begin_layout Chapter
274 and \SpecialChar LaTeX
278 \begin_layout Section
280 Uses \SpecialChar LaTeX
284 \begin_layout Standard
285 This chapter is for both \SpecialChar TeX
286 -nicians and the \SpecialChar LaTeX
288 In it, we'll explain how \SpecialChar LyX
289 and \SpecialChar LaTeX
290 work together to produce printable output.
291 This is the only place in any of the manuals where we assume you know something
292 about \SpecialChar LaTeX
296 \begin_layout Standard
297 At one time, \SpecialChar LyX
299 \begin_inset Quotes eld
302 WYSIWYM frontend to \SpecialChar LaTeX
304 \begin_inset Quotes erd
307 but that's no longer true.
308 There are frontends to \SpecialChar LaTeX
313 \begin_layout Plain Layout
314 Some familar ones are \SpecialChar TeX
315 maker and kile, on Linux, and \SpecialChar TeX
317 There are also the \SpecialChar LaTeX
318 modes for vi and emacs, of course.
323 These are basically text editors with the ability to run \SpecialChar LaTeX
325 errors in the file you're editing.
326 Although \SpecialChar LyX
335 run \SpecialChar LaTeX
336 , and it also indicates errors in the file, it also does much, much
338 For one thing, you don't need to know \SpecialChar LaTeX
339 to use \SpecialChar LyX
342 has added its own extensions to \SpecialChar LaTeX
344 Try the following sometime: select
345 \begin_inset Flex Noun
348 \begin_layout Plain Layout
349 Export\SpecialChar menuseparator
356 \begin_inset Flex Noun
359 \begin_layout Plain Layout
366 \begin_inset Flex Noun
369 \begin_layout Plain Layout
370 View\SpecialChar menuseparator
380 ), then look at the preamble of the resulting
381 \begin_inset Flex Code
384 \begin_layout Plain Layout
391 You'll notice a variety of new macros defined specifically by \SpecialChar LyX
393 These macros are defined automatically, according to the features you use
397 \begin_layout Standard
398 There are several commands that automatically invoke \SpecialChar LaTeX
403 \begin_layout Itemize
404 \begin_inset Flex Noun
407 \begin_layout Plain Layout
408 Document\SpecialChar menuseparator
417 \begin_layout Itemize
418 \begin_inset Flex Noun
421 \begin_layout Plain Layout
422 Document\SpecialChar menuseparator
431 \begin_layout Standard
432 They will only invoke \SpecialChar LaTeX
433 if the file has changed since the last time \SpecialChar LaTeX
439 \begin_layout Standard
440 When \SpecialChar LyX
441 runs \SpecialChar LaTeX
442 on the file you're editing, it performs these steps:
445 \begin_layout Enumerate
446 Convert the document to \SpecialChar LaTeX
447 and save to a file with the extension
448 \begin_inset Flex Code
451 \begin_layout Plain Layout
458 \begin_inset Flex Code
461 \begin_layout Plain Layout
470 \begin_layout Enumerate
471 Run \SpecialChar LaTeX
473 \begin_inset Flex Code
476 \begin_layout Plain Layout
482 file (maybe several times), and run any other commands (such as
483 \begin_inset Flex Code
486 \begin_layout Plain Layout
493 \begin_inset Flex Code
496 \begin_layout Plain Layout
502 ) needed to compile the \SpecialChar LaTeX
506 \begin_layout Enumerate
507 If there are any errors, show the error log.
510 \begin_layout Standard
511 If you have run \SpecialChar LaTeX
513 \begin_inset Flex Noun
516 \begin_layout Plain Layout
517 View\SpecialChar menuseparator
524 then runs a DVI viewer to display the DVI-file.
526 \begin_inset Flex Noun
529 \begin_layout Plain Layout
530 View\SpecialChar menuseparator
537 performs further steps:
540 \begin_layout Itemize
542 \begin_inset Flex Code
545 \begin_layout Plain Layout
551 to convert the DVI file to PostScript.
554 \begin_layout Itemize
555 Run a PostScript viewer, such as
556 \begin_inset Flex Code
559 \begin_layout Plain Layout
565 , to display the PostScript file.
568 \begin_layout Standard
570 does similar things when viewing, or exporting, other formats.
573 \begin_layout Section
574 Translating \SpecialChar LaTeX
575 files into \SpecialChar LyX
579 \begin_layout Standard
580 You can import a \SpecialChar LaTeX
581 file into \SpecialChar LyX
583 \begin_inset Flex Noun
586 \begin_layout Plain Layout
587 File\SpecialChar menuseparator
588 Import\SpecialChar menuseparator
594 command in \SpecialChar LyX
596 This will call a program named
597 \begin_inset Flex Code
600 \begin_layout Plain Layout
606 which will create a file
607 \begin_inset Flex Code
610 \begin_layout Plain Layout
617 \begin_inset Flex Code
620 \begin_layout Plain Layout
628 will then open that file.
632 \begin_layout Plain Layout
633 \begin_inset Flex Code
636 \begin_layout Plain Layout
642 can also be run from the command line, of course.
650 \begin_layout Standard
651 \begin_inset Flex Code
654 \begin_layout Plain Layout
660 will translate most legal \SpecialChar LaTeX
661 , but not everything.
662 It will put things it doesn't understand into \SpecialChar TeX
663 code, so after translating
665 \begin_inset Flex Code
668 \begin_layout Plain Layout
674 , you can look for \SpecialChar TeX
675 code and hand-edit it until it looks right.
678 \begin_layout Standard
679 If you don't know what \SpecialChar TeX
680 code is, read the next section.
683 \begin_layout Section
684 \begin_inset CommandInset label
686 name "sec:Inserting-TeX-Code"
690 Inserting \SpecialChar TeX
691 Code into \SpecialChar LyX
695 \begin_layout Standard
696 Anything you can do in \SpecialChar LaTeX
697 you can do in \SpecialChar LyX
698 , for a very simple reason: You can
699 always insert \SpecialChar TeX
700 code into any \SpecialChar LyX
703 cannot, and will never be able to, display every possible \SpecialChar LaTeX
705 If ever you need to insert \SpecialChar LaTeX
706 commands into your \SpecialChar LyX
707 document, you can use the
709 \begin_inset Flex Code
712 \begin_layout Plain Layout
719 box, which you can insert into your document with
720 \begin_inset Flex Noun
723 \begin_layout Plain Layout
724 Insert\SpecialChar menuseparator
734 or the keyboard shortcut
743 \begin_layout Standard
744 Here's an example of inserting \SpecialChar LaTeX
745 commands in a \SpecialChar LyX
747 The code looks like this:
750 \begin_layout LyX-Code
754 \begin_inset Newline newline
760 \begin_inset Newline newline
763 This is an example of a minipage environment.
765 \begin_inset Newline newline
768 can put nearly everything in it, even (non-floating)
769 \begin_inset Newline newline
774 \begin_inset Newline newline
780 \begin_inset Newline newline
784 \begin_inset Newline newline
790 \begin_inset Newline newline
796 \begin_inset Newline newline
802 \begin_inset Newline newline
807 \begin_inset Newline newline
813 \begin_inset Newline newline
819 \begin_inset Newline newline
825 \begin_inset Newline newline
833 \begin_layout LyX-Code
837 \begin_layout Standard
839 \begin_inset Flex Code
842 \begin_layout Plain Layout
849 box containing this text is directly after this paragraph.
850 Those of you reading the manual in \SpecialChar LyX
851 will only see the \SpecialChar TeX
853 Those reading a printed version of the manuals will see the actual results:
854 \begin_inset VSpace bigskip
860 \begin_layout Standard
864 \begin_layout Plain Layout
871 \begin_layout Plain Layout
878 \begin_layout Plain Layout
880 This is an example of a minipage environment.
881 You can put nearly everything in it, even (non-floating) figures and tables.
885 \begin_layout Plain Layout
892 \begin_layout Plain Layout
897 \begin_layout Plain Layout
904 \begin_layout Plain Layout
911 \begin_layout Plain Layout
918 \begin_layout Plain Layout
924 \begin_layout Plain Layout
931 \begin_layout Plain Layout
938 \begin_layout Plain Layout
945 \begin_layout Plain Layout
955 \begin_inset VSpace bigskip
961 \begin_layout Standard
962 In addition to using \SpecialChar TeX
963 code, you can also create a separate file containing
964 some complex \SpecialChar LaTeX
965 structure and then use
966 \begin_inset Flex Noun
969 \begin_layout Plain Layout
970 Insert\SpecialChar menuseparator
980 to include your file (you should select the type
981 \begin_inset Flex Code
984 \begin_layout Plain Layout
991 We recommend that you only do this if you have a
992 \begin_inset Flex Code
995 \begin_layout Plain Layout
1006 Otherwise, you'll have a big job tracking down \SpecialChar LaTeX
1010 \begin_layout Standard
1011 There are a few last points to emphasize:
1014 \begin_layout Itemize
1020 check if your \SpecialChar LaTeX
1024 \begin_layout Itemize
1025 Beware of reinventing the wheel.
1028 \begin_layout Standard
1029 On that last point, \SpecialChar LyX
1030 does have quite a few features tucked into it, and
1032 Be sure to check the manuals to make sure that \SpecialChar LyX
1033 doesn't have such-and-such
1034 feature before you decide you have to do it by hand.
1035 Moreover, there are numerous \SpecialChar LaTeX
1036 packages out there to do all sorts of things,
1037 from labels to envelopes to fancy multipage tables.
1039 \begin_inset CommandInset href
1042 target "http://www.ctan.org/"
1050 \begin_layout Standard
1051 If you do need to do some wild and fancy things within your document, be
1052 sure to check out a good \SpecialChar LaTeX
1053 book for assistance.
1054 There are a number of them listed in the bibliography of the
1061 \begin_layout Section
1063 and the \SpecialChar LaTeX
1067 \begin_layout Subsection
1068 About the \SpecialChar LaTeX
1072 \begin_layout Standard
1073 If you already know \SpecialChar LaTeX
1074 , there is no need to explain here what the preamble
1076 If you don't, the following will give you some ideas—we recommend again
1077 that you consult a \SpecialChar LaTeX
1078 book for further information.
1079 In any case, you should read the points below, because they explain what
1080 you can do and what you don't need to do in the \SpecialChar LaTeX
1081 preamble of a \SpecialChar LyX
1085 \begin_layout Standard
1086 The \SpecialChar LaTeX
1087 preamble comes at the very beginning of a document,
1095 \begin_layout Itemize
1096 Declare the document class.
1098 \begin_inset Newline newline
1102 already does this for you.
1103 If you're a seasoned \SpecialChar LaTeX
1104 -nician, and you have a custom document class you
1105 want to use, check out the
1107 Customization Manual
1109 for information on how to make \SpecialChar LyX
1113 \begin_layout Itemize
1114 Declare the usage of packages.
1116 \begin_inset Newline newline
1120 packages provide special commands, which are only available within a document
1121 when the package has been declared in the preamble.
1122 In addition to providing special commands, the inclusion of a package can
1123 change the document.
1124 For example, the package
1125 \begin_inset Flex Code
1128 \begin_layout Plain Layout
1134 forces all paragraphs to be indented.
1135 There are other packages for labels, envelopes, margins, etc.
1139 \begin_layout Itemize
1140 Set counters, variables, lengths and widths.
1142 \begin_inset Newline newline
1145 There are several \SpecialChar LaTeX
1146 counters and variables that
1150 be set globally from within the preamble in order to have the desired effect.
1151 (There are variables that you can set and reset inside the document, too.)
1152 Margins are a good example of something that must be set in the preamble.
1153 Another example is the label format for lists.
1154 You can actually set these just about anywhere, but it's best to do it
1155 just once, inside the preamble.
1158 \begin_layout Itemize
1159 Declare user defined commands (with
1160 \begin_inset Flex Code
1163 \begin_layout Plain Layout
1172 \begin_inset Flex Code
1175 \begin_layout Plain Layout
1184 \begin_inset Newline newline
1187 These are abbreviations for \SpecialChar LaTeX
1188 commands which appear very often inside a document.
1189 Although the preamble is a good place to declare such commands, they
1193 be declared anywhere (before they are used for the first time, of course).
1194 This can be useful if there is a lot of raw \SpecialChar LaTeX
1195 code in your document, which
1196 normally should not be the case.
1199 \begin_layout Standard
1201 adds its own set of definitions to the preamble of the
1202 \begin_inset Flex Code
1205 \begin_layout Plain Layout
1212 This makes \SpecialChar LaTeX
1213 files generated by \SpecialChar LyX
1217 \begin_layout Subsection
1218 Changing the Preamble
1221 \begin_layout Standard
1222 The commands which \SpecialChar LyX
1223 adds to the preamble of a \SpecialChar LaTeX
1224 file are fixed; you can't
1225 change them without patching \SpecialChar LyX
1227 You can, however, add your own stuff to the preamble by selecting
1228 \begin_inset Flex Noun
1231 \begin_layout Plain Layout
1234 \begin_inset space ~
1243 \begin_inset Flex Noun
1246 \begin_layout Plain Layout
1247 Document\SpecialChar menuseparator
1255 adds anything in the
1256 \begin_inset Flex Noun
1259 \begin_layout Plain Layout
1265 dialog to its own built-in preamble.
1266 Before adding your own declarations in the preamble, you should make sure
1267 that \SpecialChar LyX
1268 doesn't already support what you want to do.
1269 (Remember what we said about reinventing the wheel?) Also,
1271 make sure your preamble code is correct
1275 doesn't check it for you.
1276 If there is an error, you're likely to get an error like
1277 \begin_inset Quotes eld
1281 \begin_inset Flex Code
1284 \begin_layout Plain Layout
1293 \begin_inset Quotes erd
1297 If you see this error, check your preamble.
1300 \begin_layout Subsection
1304 \begin_layout Standard
1305 Here are some examples of what you can add to a preamble, and what they
1309 \begin_layout Subsubsection
1313 \begin_layout Standard
1314 There are two variables under \SpecialChar LaTeX
1315 that control page position:
1316 \begin_inset Flex Code
1319 \begin_layout Plain Layout
1328 \begin_inset Flex Code
1331 \begin_layout Plain Layout
1340 Their names should be self-explanatory.
1341 These variables are useful if you think for a moment about computer labels.
1342 Sometimes, the size of a print medium and the area of the medium that you
1343 can actually print on aren't the same.
1345 \begin_inset Flex Code
1348 \begin_layout Plain Layout
1357 \begin_inset Flex Code
1360 \begin_layout Plain Layout
1371 \begin_layout Standard
1372 The default values for
1373 \begin_inset Flex Code
1376 \begin_layout Plain Layout
1385 \begin_inset Flex Code
1388 \begin_layout Plain Layout
1397 \begin_inset space \thinspace{}
1401 \begin_inset space \thinspace{}
1405 \begin_inset space \space{}
1408 the page isn't shifted.
1409 Unfortunately, some DVI drivers always seem to shift the page.
1410 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1411 If you're using \SpecialChar LyX
1412 on a system that you don't personally maintain, and your
1413 sysadmin is a doofus,
1414 \begin_inset Flex Code
1417 \begin_layout Plain Layout
1426 \begin_inset Flex Code
1429 \begin_layout Plain Layout
1438 Suppose your left and top margins are always 0.5
1439 \begin_inset space \thinspace{}
1443 You can add this to the preamble:
1446 \begin_layout LyX-Code
1454 \begin_layout LyX-Code
1462 \begin_layout Standard
1463 and your margins should now be correct.
1466 \begin_layout Subsubsection
1470 \begin_layout Standard
1471 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1472 There's a rather nice package, available at your nearest CTAN archive,
1473 for printing sheets of labels:
1474 \begin_inset Flex Code
1477 \begin_layout Plain Layout
1484 Now, your system may not have this package installed by default.
1485 We leave that up to you to check.
1486 You'll also want to read the documentation for it; we're not going to do
1488 Since this is an example, however, we'll give you an example of how you
1492 \begin_layout Standard
1493 First, make sure you're using the
1494 \begin_inset Flex Code
1497 \begin_layout Plain Layout
1504 Next, you need to put the following in your preamble:
1507 \begin_layout LyX-Code
1513 \begin_layout LyX-Code
1519 \begin_layout LyX-Code
1525 \begin_layout LyX-Code
1531 \begin_layout LyX-Code
1537 \begin_layout LyX-Code
1543 \begin_layout LyX-Code
1549 \begin_layout Standard
1550 This sets things up for Avery label sheets, stock #5360.
1551 You're now ready to print labels, but you'll need to insert \SpecialChar LaTeX
1554 \begin_inset Flex Code
1557 \begin_layout Plain Layout
1566 \begin_inset Flex Code
1569 \begin_layout Plain Layout
1577 around each label text.
1578 This and other special features of
1579 \begin_inset Flex Code
1582 \begin_layout Plain Layout
1588 are explained in its documentation.
1591 \begin_layout Standard
1592 Someday, someone may write a \SpecialChar LyX
1593 layout file to support this package directly.
1594 Maybe that someone is you.
1597 \begin_layout Subsubsection
1598 Example #3: Paragraph Indentation
1601 \begin_layout Standard
1602 Americans are trained to indent the first line of
1607 As with all of their other weird quirks, most Americans will whine and
1608 moan until they can have their way and indent the first line of all paragraphs.
1617 \begin_layout Standard
1618 Of course, this behavior isn't standard typography.
1619 In books, you typically only indent the first line of a paragraph
1623 it follows another one.
1624 The idea behind indenting the first line of a paragraph is to distinguish
1625 neighboring paragraphs from one another.
1626 If there is no previous paragraph—for example, if it follows a figure or
1627 is the first paragraph in a section—then there is no need for indentation.
1631 \begin_layout Standard
1632 If you're a typical American (we're still joking!), though, you don't care
1633 about such esoteric things; you want your indentation! Add this to the
1637 \begin_layout LyX-Code
1640 usepackage{indentfirst}
1643 \begin_layout Standard
1644 If your \SpecialChar TeX
1645 distribution isn't braindead, you'll have this package, and all
1646 of your paragraphs will get the indentation the Founding Fathers intended
1650 \begin_layout Subsubsection
1651 Example #4: This Document
1654 \begin_layout Standard
1655 You can also check out the preamble of this document to get an idea of some
1656 of the advanced things you can do.
1659 \begin_layout Section
1661 and \SpecialChar LaTeX
1665 \begin_layout Standard
1666 When \SpecialChar LyX
1667 calls \SpecialChar LaTeX
1668 , it tells \SpecialChar LaTeX
1669 to blithely ignore any errors and keep going.
1670 It then uses the logfile from the \SpecialChar LaTeX
1671 run to do a post-mortem.
1672 After analyzing the logfile, \SpecialChar LyX
1673 displays a dialog listing the errors.
1674 Clicking on any one of them will take you to the position in your \SpecialChar LyX
1676 where the error occurred.
1680 \begin_layout Plain Layout
1682 Analyzing the logfile is a tough job, and \SpecialChar LyX
1683 doesn't always go to the right
1685 There are also cases where \SpecialChar LaTeX
1686 reports the error on one line, but the actual
1688 This is not unlike forgetting a closing brace in a program: You'll get
1689 an error, but only later.
1697 \begin_layout Standard
1698 Some folks also like to look at the log file directly: It is available from
1700 \begin_inset Flex Noun
1703 \begin_layout Plain Layout
1704 Document\SpecialChar menuseparator
1706 \begin_inset space ~
1715 There are some fairly common error messages and warnings.
1716 We'll cover those here.
1717 You should look at a good \SpecialChar LaTeX
1718 book for a complete listing.
1721 \begin_layout Itemize
1722 \begin_inset Flex Code
1725 \begin_layout Plain Layout
1732 \begin_inset Newline newline
1735 Anything beginning with these words is a warning message for the purpose
1737 \begin_inset Quotes eld
1741 \begin_inset Quotes erd
1744 the \SpecialChar LaTeX
1746 You'll get messages like this if you added or changed cross-references
1747 or bibliography entries, in which case, \SpecialChar LaTeX
1748 is trying to tell you that you
1749 need to make another run.
1750 You can by-and-large ignore these.
1753 \begin_layout Itemize
1754 \begin_inset Flex Code
1757 \begin_layout Plain Layout
1764 \begin_inset Newline newline
1767 Another warning message, this time about fonts which \SpecialChar LaTeX
1769 The rest of the message will often say something about a replacement font
1770 that \SpecialChar LaTeX
1772 You can safely ignore these, too.
1775 \begin_layout Itemize
1776 \begin_inset Flex Code
1779 \begin_layout Plain Layout
1788 \begin_inset Newline newline
1797 It seems to generate at least one of these messages for just about any
1799 They are warnings about lines that were too long and run past the right
1801 This happens if \SpecialChar LaTeX
1802 does not find a reasonable way to break the lines (notoriously
1803 often with typewriter font, since this does not allow for automatic break
1805 In many cases, this is unnoticeable in the final output.
1806 (It can be just a point or two.) Sometimes, however, the lines run rather
1807 visibly into the margin; something you will not want to have in your final
1810 \begin_inset Newline newline
1813 There are several global ways to try to minimize the overfull lines.
1816 Enable micro-typographic extensions
1820 Document\SpecialChar menuseparator
1821 Settings\SpecialChar menuseparator
1824 might already improve things a lot.
1825 Furthermore, \SpecialChar LaTeX
1826 code such as the following in
1828 Document\SpecialChar menuseparator
1829 Settings\SpecialChar menuseparator
1832 usually reduces the overfull lines drastically (we use this in the preamble
1837 \begin_layout LyX-Code
1841 \begin_inset Newline newline
1847 \begin_inset Newline newline
1852 emergencystretch 1.5em
1853 \begin_inset Newline newline
1861 \begin_layout Standard
1862 In some cases, however, you eventually have to rewrite the text to get the
1863 line breaking right.
1867 \begin_layout Plain Layout
1868 For more information, see
1869 \begin_inset Flex URL
1872 \begin_layout Plain Layout
1874 http://www.tex.ac.uk/FAQ-overfull.html
1887 \begin_layout Standard
1888 In any case, you should check the respective lines, at least for the final
1889 version of your document.
1890 Your eyes will tell you if there's a problem with something that's too
1895 \begin_layout Plain Layout
1896 You can also enable the `draft' option in
1897 \begin_inset Flex Noun
1900 \begin_layout Plain Layout
1901 Document\SpecialChar menuseparator
1907 , and then \SpecialChar LaTeX
1908 will draw a black box in the margin of lines that are overfull.
1917 \begin_layout Itemize
1918 \begin_inset Flex Code
1921 \begin_layout Plain Layout
1930 \begin_inset Newline newline
1933 Not quite as common as its cousin.
1934 This happens again if \SpecialChar LaTeX
1935 does not find a reasonable break point and consequently
1936 generates too loose lines.
1937 As with the overfull lines, you should check if this is a visible problem.
1940 \begin_layout Itemize
1941 \begin_inset Flex Code
1944 \begin_layout Plain Layout
1953 \begin_inset Flex Code
1956 \begin_layout Plain Layout
1965 \begin_inset Newline newline
1968 Warnings about troubles breaking the page.
1969 Once again, just look at the output.
1970 Your eyes will tell you where something has gone wrong.
1973 \begin_layout Itemize
1974 \begin_inset Flex Code
1977 \begin_layout Plain Layout
1979 \begin_inset Quotes els
1983 \begin_inset Quotes ers
1992 \begin_inset Newline newline
1996 \begin_inset Quotes eld
2000 \begin_inset Quotes erd
2003 isn't installed on this system.
2004 This usually appears because some package your document needs isn't installed.
2005 If you didn't touch the preamble or didn't use the
2006 \begin_inset Flex Code
2009 \begin_layout Plain Layout
2017 command, then one of the packages \SpecialChar LyX
2018 tried to load is missing.
2020 \begin_inset Flex Noun
2023 \begin_layout Plain Layout
2024 Help\SpecialChar menuseparator
2031 to get a list of packages that \SpecialChar LyX
2033 This file is updated whenever you reconfigure \SpecialChar LyX
2035 \begin_inset Flex Noun
2038 \begin_layout Plain Layout
2039 Tools\SpecialChar menuseparator
2045 ) and tells you which packages have been detected and what they do.
2046 \begin_inset Newline newline
2050 \begin_inset Flex Code
2053 \begin_layout Plain Layout
2061 command and the package in question isn't installed, then you'll need to
2062 install it yourself.
2065 \begin_layout Itemize
2066 \begin_inset Flex Code
2069 \begin_layout Plain Layout
2070 LaTeX Error: Unknown option
2076 \begin_inset Newline newline
2079 Error messages beginning with this are trying to tell you that you specified
2080 a bad or undefined option to a package.
2081 Check the package's documentation.
2084 \begin_layout Itemize
2085 \begin_inset Flex Code
2088 \begin_layout Plain Layout
2089 Undefined control sequence
2095 \begin_inset Newline newline
2098 If you've inserted \SpecialChar LaTeX
2099 code into your document, but made a typo, you'll get
2101 You may have forgotten to load a package.
2102 In any case, this error message usually means that you used an undefined
2107 \begin_layout Standard
2108 There are other error and warning messages.
2109 Some are self-explanatory.
2110 These are usually \SpecialChar LaTeX
2112 Others are downright cryptic.
2113 These are usually \SpecialChar TeX
2114 error messages, and we really have
2118 what they mean or how to decipher them.
2122 \begin_layout Standard
2123 There's a general sequence you should follow if you get error messages:
2126 \begin_layout Enumerate
2127 Look at the \SpecialChar LaTeX
2128 code you inserted for typos.
2131 \begin_layout Enumerate
2132 If there are no typos, check that you used the command(s) correctly.
2135 \begin_layout Enumerate
2136 If you get a bunch of error boxes piled up at the very top of the document—and
2137 especially if you see a
2138 \begin_inset Quotes eld
2142 \begin_inset Flex Code
2145 \begin_layout Plain Layout
2154 \begin_inset Quotes erd
2157 error—it means that there are errors in the preamble.
2158 Start debugging your preamble.
2161 \begin_layout Enumerate
2162 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2164 document, the first suspect is your \SpecialChar LaTeX
2165 distribution itself.
2166 Check for missing packages and install them.
2169 \begin_layout Enumerate
2170 Okay, so there are no missing packages.
2171 Did you use any of the fine-tuning options in \SpecialChar LyX
2172 ? Specifically, did you
2176 any of them, like trying to manually insert lots of
2177 \begin_inset Flex Code
2180 \begin_layout Plain Layout
2182 \begin_inset space ~
2191 \begin_inset Flex Code
2194 \begin_layout Plain Layout
2201 \begin_inset Flex Code
2204 \begin_layout Plain Layout
2210 ? Did you try to kludge something together with these instead of using the
2211 appropriate paragraph environment?
2214 \begin_layout Enumerate
2215 All right, you didn't use any of the fine-tuning options, you played by
2217 Did you try to pull a fancy maneuver? Did you do something funky inside
2218 a table or an equation, like inserting a graphic into a table cell?
2221 \begin_layout Enumerate
2222 Do you have long sections of text where \SpecialChar LaTeX
2223 cannot find a place to break a
2224 line? By default, \SpecialChar LaTeX
2225 is rather strict about how much extra inter-word spacing
2226 it will add in order to break a line.
2227 Preferably, you should rework the paragraph to avoid the problem.
2230 \begin_layout Enumerate
2231 Did you go overboard with the nesting? \SpecialChar LyX
2232 (currently) doesn't check to make
2233 sure you're in the limits for nesting environments.
2234 If you nested a bunch of environments to the
2235 \begin_inset Formula $17^{\mathrm{th}}$
2238 level, that's the problem.
2239 (The limit in \SpecialChar LaTeX
2243 \begin_layout Enumerate
2244 Okay, you didn't get any error messages, but your output looks awful.
2245 If you have a table or figure that's too wide or long for the page, you
2250 \begin_layout Enumerate
2251 rescale the figure so it fits.
2254 \begin_layout Enumerate
2255 trim down the table so it fits.
2259 \begin_layout Enumerate
2260 If something else is wrong with the output, and you didn't try to pull anything
2261 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2264 \begin_layout Standard
2265 If all this doesn't help—well, then
2269 you might have found a bug in \SpecialChar LyX
2274 \begin_layout Chapter
2278 \begin_layout Section
2279 Customizing Bibliographies with Bib\SpecialChar TeX
2283 \begin_layout Standard
2284 The most basic information about how to use Bib\SpecialChar TeX
2289 with \SpecialChar LyX
2290 is contained in the section
2292 Bibliography databases
2299 The following subsections explain special bibliography features supported
2304 \begin_layout Subsection
2305 Alternative Citation Styles
2308 \begin_layout Standard
2309 Standard Bib\SpecialChar TeX
2311 \begin_inset space \thinspace{}
2315 \begin_inset space \space{}
2319 \begin_inset Quotes eld
2323 \begin_inset Quotes erd
2326 ) to refer to a cited work.
2327 However, in many scientific disciplines, other citation styles are in use.
2328 The most common one is the author-year style (e.
2329 \begin_inset space \thinspace{}
2333 \begin_inset space \space{}
2337 \begin_inset Quotes eld
2341 \begin_inset Quotes erd
2346 supports three packages that provide this style,
2347 \begin_inset Flex Code
2350 \begin_layout Plain Layout
2357 \begin_inset Flex Code
2360 \begin_layout Plain Layout
2367 \begin_inset Flex Code
2370 \begin_layout Plain Layout
2377 Each of these packages has their pros and cons, which cannot be listed
2379 If you only want to have simple author-year (or author-numerical) style,
2380 or if you want to use one of the countless style files for
2381 \begin_inset Flex Code
2384 \begin_layout Plain Layout
2390 , then the established
2391 \begin_inset Flex Code
2394 \begin_layout Plain Layout
2400 package is probably your choice.
2401 If you look for specific citation styles common in law studies, you might
2403 \begin_inset Flex Code
2406 \begin_layout Plain Layout
2413 If you want to have full control over the formatting or look for advanced
2414 features such as ibidem, footnote citations, full title citations, advanced
2415 date formats (such as 400 BC) or full localization to other languages than
2416 English, you should definitely consider
2417 \begin_inset Flex Code
2420 \begin_layout Plain Layout
2426 , which exceeds all other packages in terms of features, but is also quite
2427 heavy and more resource-hungry.
2430 \begin_layout Standard
2431 The handling of these packages in \SpecialChar LyX
2432 is basically the same.
2434 \begin_inset Flex Noun
2437 \begin_layout Plain Layout
2438 Document\SpecialChar menuseparator
2445 \begin_inset Flex Noun
2448 \begin_layout Plain Layout
2455 \begin_inset Flex Noun
2458 \begin_layout Plain Layout
2465 \begin_inset Flex Noun
2468 \begin_layout Plain Layout
2475 \begin_inset Flex Noun
2478 \begin_layout Plain Layout
2485 \begin_inset Flex Noun
2488 \begin_layout Plain Layout
2489 Biblatex (Natbib mode)
2495 \begin_inset Flex Noun
2498 \begin_layout Plain Layout
2505 \begin_inset Flex Noun
2508 \begin_layout Plain Layout
2515 \begin_inset space ~
2518 6.5.3 in the User's Guide for more information on these choices).
2519 With all these packages, you will get some extra features in the citation
2520 dialog and you can select the style of the reference (
2521 \begin_inset Quotes eld
2525 \begin_inset Quotes erd
2529 \begin_inset Quotes eld
2533 \begin_inset Quotes erd
2537 \begin_inset Quotes eld
2541 \begin_inset Quotes erd
2545 \begin_inset Quotes eld
2549 \begin_inset Quotes erd
2553 Note that either package needs specifically designed style files.
2554 They all ship their own, but there are lots of additional style files,
2555 and there is even an interactive style file builder
2559 \begin_layout Plain Layout
2561 \begin_inset Flex URL
2564 \begin_layout Plain Layout
2566 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2577 \begin_inset Flex Code
2580 \begin_layout Plain Layout
2589 \begin_layout Subsection
2590 Subdivided Bibliographies
2593 \begin_layout Standard
2594 Sometimes you might need to divide your bibliography into several sections.
2595 If you are for instance a historian, the possibility to separate sources
2596 and scientific works is most likely a
2597 \begin_inset Quotes eld
2601 \begin_inset Quotes erd
2605 Unfortunately, Bib\SpecialChar TeX
2606 itself does not allow you to do this.
2607 But with the help of some \SpecialChar LaTeX
2608 packages, Bib\SpecialChar TeX
2609 can be extended to fit your needs.
2612 \begin_layout Standard
2614 provides native support for one of these packages,
2622 \begin_layout Plain Layout
2624 \begin_inset Flex URL
2627 \begin_layout Plain Layout
2629 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2639 The advantage of this package (compared to other packages such as
2643 ) is that you don't need to define new citation commands.
2644 Instead, you need to prepare different bibliographic databases which include
2645 the entries for the different sections of the bibliography.
2646 For example: If you want to divide your bibliography into the sections
2648 \begin_inset Quotes eld
2652 \begin_inset Quotes erd
2656 \begin_inset Quotes eld
2660 \begin_inset Quotes erd
2663 , you first need to create two bibliographic databases, e.
2664 \begin_inset space \thinspace{}
2668 \begin_inset space \space{}
2672 \begin_inset Flex Code
2675 \begin_layout Plain Layout
2682 \begin_inset Flex Code
2685 \begin_layout Plain Layout
2695 \begin_layout Standard
2697 \begin_inset Flex Noun
2700 \begin_layout Plain Layout
2701 Document\SpecialChar menuseparator
2708 \begin_inset Flex Noun
2711 \begin_layout Plain Layout
2718 \begin_inset Flex Noun
2721 \begin_layout Plain Layout
2722 Subdivided bibliography
2728 Now you can insert multiple Bib\SpecialChar TeX
2729 bibliographies, one for each section of
2731 Returning to our example: Insert the Bib\SpecialChar TeX
2733 \begin_inset Flex Code
2736 \begin_layout Plain Layout
2742 and a second one for the database
2743 \begin_inset Flex Code
2746 \begin_layout Plain Layout
2753 You are free to use the same or different styles for each section.
2754 Additionally, you can choose if the bibliography section should contain
2756 \begin_inset Quotes eld
2759 all cited references
2760 \begin_inset Quotes erd
2763 of the specified database(s) (which is the default),
2764 \begin_inset Quotes eld
2767 all uncited references
2768 \begin_inset Quotes erd
2772 \begin_inset Quotes eld
2776 \begin_inset Quotes erd
2780 This might be useful if you would like to separate your bibliography into
2782 \begin_inset Quotes eld
2786 \begin_inset Quotes erd
2790 \begin_inset Quotes eld
2794 \begin_inset Quotes erd
2798 \begin_inset Quotes eld
2802 \begin_inset Quotes erd
2806 The titles for the sections can be added as ordinary sections or subsections.
2808 \begin_inset Flex Code
2811 \begin_layout Plain Layout
2817 removes the bibliography title, you have to manually re-add that, too (as
2818 a chapter* or section*, for instance).
2821 \begin_layout Standard
2826 , the procedure is a bit different.
2835 , the aforementioned
2836 \begin_inset Flex Noun
2839 \begin_layout Plain Layout
2840 Subdivided bibliography
2845 option is disabled if you use
2854 provides its own means to generate subdivided bibliographies.
2855 You can either add keywords to bibliography entries via the
2856 \begin_inset Flex Code
2859 \begin_layout Plain Layout
2865 entry option and then filter bibliography sections by keyword (by adding
2867 \begin_inset Flex Code
2870 \begin_layout Plain Layout
2877 \begin_inset Flex Noun
2880 \begin_layout Plain Layout
2886 field of the dialog that opens if you left-click on the
2887 \begin_inset Flex Noun
2890 \begin_layout Plain Layout
2891 Biblatex Generated Bibliography
2896 button), or you can filter by entry types (such as
2905 \begin_inset space \thinspace{}
2910 \begin_inset Flex Code
2913 \begin_layout Plain Layout
2920 \begin_inset Flex Code
2923 \begin_layout Plain Layout
2930 \begin_inset Flex Noun
2933 \begin_layout Plain Layout
2939 field, or you can create so-called
2940 \begin_inset Quotes eld
2943 Bibliography Categories
2944 \begin_inset Quotes erd
2947 to which you can assign individual entries.
2948 Please refer to the Biblatex manual, section
2950 Subdivided Bibliographies
2955 \begin_layout Subsection
2956 Multiple Bibliographies
2957 \begin_inset CommandInset label
2959 name "subsec:Multiple-Bibliographies"
2966 \begin_layout Standard
2967 Multiple bibliographies, e.
2968 \begin_inset space \thinspace{}
2972 \begin_inset space \space{}
2975 a bibliography for each part, chapter, section, subsection or child (sub-documen
2976 t) of the document, are also supported by \SpecialChar LyX
2978 In order to enable it, go to
2979 \begin_inset Flex Noun
2982 \begin_layout Plain Layout
2983 Document\SpecialChar menuseparator
2984 Settings\SpecialChar menuseparator
2990 and select the relevant unit (e.
2991 \begin_inset space \thinspace{}
2995 \begin_inset Quotes eld
2999 \begin_inset Quotes erd
3003 \begin_inset Flex Noun
3006 \begin_layout Plain Layout
3007 Multiple Bibliographies
3013 Then add a Bib(la)\SpecialChar TeX
3014 bibliography to each unit (e.
3015 \begin_inset space \thinspace{}
3018 g., section) of your document.
3019 In the output, a separate bibliography, containing only the references
3020 done in the current unit is generated.
3023 \begin_layout Standard
3024 If you use Bib\SpecialChar TeX
3026 \begin_inset Flex Code
3029 \begin_layout Plain Layout
3036 \begin_inset Flex Code
3039 \begin_layout Plain Layout
3045 package is used to create multiple bibliographies.
3046 The former package is used if you select
3047 \begin_inset Quotes eld
3051 \begin_inset Quotes erd
3059 \begin_inset Flex Noun
3062 \begin_layout Plain Layout
3063 Sectioned Bibliography
3070 \begin_inset Flex Code
3073 \begin_layout Plain Layout
3083 \begin_layout Plain Layout
3084 An alternative approach, if you are willing to use some
3085 \begin_inset Flex Noun
3088 \begin_layout Plain Layout
3096 \begin_inset space ~
3100 \begin_inset CommandInset ref
3102 reference "sec:Inserting-TeX-Code"
3107 \begin_inset Flex Code
3110 \begin_layout Plain Layout
3122 \begin_inset Flex Code
3125 \begin_layout Plain Layout
3131 is used, \SpecialChar LyX
3132 encloses the specified units in
3133 \begin_inset Flex Code
3136 \begin_layout Plain Layout
3143 \begin_inset Flex Code
3146 \begin_layout Plain Layout
3155 \begin_inset Flex Code
3158 \begin_layout Plain Layout
3166 in order to create the units.
3167 Note that this approach has some limitations.
3168 First, every citation reference has to be inside some
3169 \begin_inset Flex Code
3172 \begin_layout Plain Layout
3179 So citations outside a defined unit (e.
3180 \begin_inset space \thinspace{}
3183 g., before the first section if you use
3184 \begin_inset Quotes eld
3188 \begin_inset Quotes erd
3192 \begin_inset Quotes eld
3196 \begin_inset Quotes erd
3200 You can also create your own units by entering
3201 \begin_inset Flex Code
3204 \begin_layout Plain Layout
3213 \begin_inset Flex Code
3216 \begin_layout Plain Layout
3225 code (for instance to work around the mentioned limitation).
3227 \begin_inset Flex Code
3230 \begin_layout Plain Layout
3237 A second limitation is that
3238 \begin_inset Flex Code
3241 \begin_layout Plain Layout
3247 always processes all references of a bibliography database, even if they
3249 This can result in odd labels (e.
3250 \begin_inset space \thinspace{}
3255 \begin_inset Quotes eld
3259 \begin_inset Quotes erd
3262 if two works of this author from 2014 are in the database, even if only
3266 \begin_layout Standard
3272 \begin_inset Flex Code
3275 \begin_layout Plain Layout
3281 option is used instead.
3282 If you need specific units, you can start them with the \SpecialChar TeX
3284 \begin_inset Flex Code
3287 \begin_layout Plain Layout
3296 \begin_inset Flex Code
3299 \begin_layout Plain Layout
3308 If you also want to control the end of the unit, use the environment
3309 \begin_inset Flex Code
3312 \begin_layout Plain Layout
3322 \begin_inset Flex Code
3325 \begin_layout Plain Layout
3335 \begin_inset Flex Code
3338 \begin_layout Plain Layout
3345 In addition to the individual bibliography of the current unit,
3349 also provides an easy way to output all bibliographies, subsequently, at
3351 \begin_inset space \thinspace{}
3354 g., at the end of the document).
3356 \begin_inset Quotes eld
3360 \begin_inset Quotes erd
3363 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve
3369 manual for more information on this topic.
3372 \begin_layout Section
3376 \begin_layout Subsection
3380 \begin_layout Standard
3381 When you are working on a large file with many sections, it is often convenient
3382 to break up the document into several files, or perhaps you have something
3383 where a table may change from time to time, but the preceding text does
3385 In these cases, you should seriously consider using multipart documents.
3386 For example, scientific papers often have five major sections: the introduction
3387 , observations, results, discussion, and conclusion.
3388 Each of these could be its own separate \SpecialChar LyX
3390 \begin_inset Quotes eld
3394 \begin_inset Quotes erd
3397 file which contains the title, authors, abstract, references, etc., plus
3398 the five included files.
3399 It is important to note that each of these files is a full \SpecialChar LyX
3401 can be formatted and printed on its own, as well as included in a master
3403 Each of these files must have the same document class, however—don't attempt
3404 to mix book classes with article classes.
3405 You may also include \SpecialChar LaTeX
3406 files; however, these files must not have their own
3408 \begin_inset space \thinspace{}
3412 \begin_inset space \space{}
3415 everything up to and including the
3416 \begin_inset Flex Code
3419 \begin_layout Plain Layout
3428 \begin_inset Flex Code
3431 \begin_layout Plain Layout
3439 line must be deleted) or else errors will be generated when you try to
3443 \begin_layout Standard
3445 allows you to include files quite easily with
3446 \begin_inset Flex Noun
3449 \begin_layout Plain Layout
3450 Insert\SpecialChar menuseparator
3452 \begin_inset space ~
3461 When you click on this selection a small box is inserted into the file
3462 at the current cursor location.
3463 Clicking on the box raises a dialog which allows you to select the file
3464 to be included, and the method of its inclusion.
3468 \begin_layout Standard
3469 The file selection box should by now be obvious.
3470 The three inclusion methods are
3471 \begin_inset Quotes eld
3475 \begin_inset Quotes erd
3479 \begin_inset Quotes eld
3483 \begin_inset Quotes erd
3487 \begin_inset Quotes eld
3491 \begin_inset Quotes erd
3496 \begin_inset Quotes eld
3500 \begin_inset Quotes erd
3504 \begin_inset Quotes eld
3508 \begin_inset Quotes erd
3511 are similar in many ways, but there are also some notable differences:
3514 \begin_layout Enumerate
3516 \begin_inset Quotes eld
3520 \begin_inset Quotes erd
3523 are typeset beginning on a new page, while files that are
3524 \begin_inset Quotes eld
3528 \begin_inset Quotes erd
3531 are typeset starting on the current page.
3534 \begin_layout Enumerate
3535 \begin_inset Quotes eld
3539 \begin_inset Quotes erd
3542 files cannot themselves
3543 \begin_inset Quotes eld
3547 \begin_inset Quotes erd
3551 \begin_inset Quotes eld
3555 \begin_inset Quotes erd
3560 \begin_inset Quotes eld
3564 \begin_inset Quotes erd
3567 , on the other hand, infinite sub-inputting is possible.
3570 \begin_layout Enumerate
3571 \begin_inset Quotes eld
3575 \begin_inset Quotes erd
3578 allow for the output of only selected
3579 \begin_inset Quotes eld
3583 \begin_inset Quotes erd
3586 files, while maintaining the actual counters (pagination etc.) and references
3587 (please refer to the section
3590 \begin_inset space ~
3598 \begin_inset space ~
3603 manual for details).
3606 \begin_layout Standard
3608 \begin_inset Quotes eld
3612 \begin_inset Quotes erd
3615 is the preferred method for chapters that are outsourced to child documents,
3617 \begin_inset Quotes eld
3621 \begin_inset Quotes erd
3624 is more suitable for arbitrary file inheritance.
3627 \begin_layout Standard
3629 \begin_inset Quotes eld
3633 \begin_inset Quotes erd
3636 included file allows you to include a file typeset exactly as it appears
3638 \begin_inset space \thinspace{}
3642 \begin_inset space \space{}
3646 \begin_inset Flex Code
3649 \begin_layout Plain Layout
3655 mode, with the characters set in a fixed-width typewriter font.
3656 Normally, spaces in this file are invisible, though two consecutive spaces
3657 are conserved, unlike \SpecialChar LyX
3658 's normal treatment of spaces.
3659 However, setting the
3660 \begin_inset Flex Noun
3663 \begin_layout Plain Layout
3665 \begin_inset space ~
3669 \begin_inset space ~
3673 \begin_inset space ~
3681 checkbox typesets a mark to unambiguously define the presence of a space.
3685 \begin_layout Standard
3686 Generally, the master file is converted into a full \SpecialChar LaTeX
3687 file before typesetting,
3688 while the included files are converted to \SpecialChar LaTeX
3689 files that do not have all the
3690 preamble information.
3693 \begin_layout Subsection
3694 Cross-References Between Files
3697 \begin_layout Standard
3698 \begin_inset Box Shadowbox
3708 height_special "totalheight"
3713 backgroundcolor "none"
3716 \begin_layout Plain Layout
3717 This section is somewhat out of date.
3718 Need to describe default master documents and how children are opened when
3728 \begin_layout Standard
3729 It is possible to set up cross-references between the different files.
3730 First, open all the files in question: let's call them A and B in a two
3731 file example, where B is included in A.
3732 Let's say you insert a label in A, then want to reference it in B.
3733 Open the cross-reference dialog whilst in document B, and you can select
3735 \begin_inset Quotes eld
3739 \begin_inset Quotes erd
3745 \begin_layout Subsection
3746 Bibliography Lists in all Subdocuments
3749 \begin_layout Standard
3750 If you work with child documents, you might want to have only one main bibliogra
3751 phy at the end, but still be able to have a selected bibliography for the
3752 child if you output it on its own.
3753 Here is how to achieve this.
3756 \begin_layout Standard
3757 For the main document, you just insert a bibliography inset at the place
3758 where the main bibliography has to appear (within the master file or within
3760 If the bibliography inset is in the master file, the references will be
3761 inherited by all children, so they are available in the citation dialog
3765 \begin_layout Standard
3766 For child-specific bibliographies, insert bibliography insets within the
3767 child documents, at the place where the bibliography should appear when
3768 the child is compiled separately.
3769 However, the trick is to insert them into a branch (
3771 Insert\SpecialChar menuseparator
3772 Branch\SpecialChar menuseparator
3773 Insert New Branch...
3776 \begin_inset space \thinspace{}
3781 \begin_inset Quotes eld
3785 \begin_inset Quotes erd
3789 Within the children, activate the branch (
3791 Document\SpecialChar menuseparator
3792 Settings...\SpecialChar menuseparator
3796 Within the master, deactivate the branch (
3798 Document\SpecialChar menuseparator
3799 Settings...\SpecialChar menuseparator
3803 Now the child's bibliography will be ignored by the master, but considered
3807 \begin_layout Standard
3808 If you need multiple bibliographies (e.
3809 \begin_inset space \thinspace{}
3812 g., one per child in the
3816 ), please refer to sec.
3817 \begin_inset space ~
3821 \begin_inset CommandInset ref
3823 reference "subsec:Multiple-Bibliographies"
3830 \begin_layout Section
3835 \begin_layout Standard
3836 Users sometimes need to be able to
3837 \begin_inset Quotes eld
3841 \begin_inset Quotes erd
3845 file together with all the images (and other files) on which it depends,
3846 either for sending to a publisher or for sharing with a co-author.
3848 includes a Python script (
3849 \begin_inset Flex Code
3852 \begin_layout Plain Layout
3858 ) that automates this process.
3859 To use it, you must have either the
3860 \begin_inset Flex Code
3863 \begin_layout Plain Layout
3870 \begin_inset Flex Code
3873 \begin_layout Plain Layout
3879 python modules installed on your system.
3880 By default, the script prefers the
3881 \begin_inset Flex Code
3884 \begin_layout Plain Layout
3891 \begin_inset Flex Code
3894 \begin_layout Plain Layout
3900 format on Unix-like systems and the
3901 \begin_inset Flex Code
3904 \begin_layout Plain Layout
3913 \begin_layout Standard
3915 's configuration process will set the script up to export a `\SpecialChar LyX
3917 and this format will then be available under
3918 \begin_inset Flex Code
3921 \begin_layout Plain Layout
3922 File\SpecialChar menuseparator
3931 \begin_layout Standard
3932 Independently of the platform, the generation of a particular archive format
3933 can be forced by adding either the
3934 \begin_inset Flex Code
3937 \begin_layout Plain Layout
3944 \begin_inset Flex Code
3947 \begin_layout Plain Layout
3954 \begin_inset Flex Code
3957 \begin_layout Plain Layout
3964 \begin_inset Flex Code
3967 \begin_layout Plain Layout
3973 format) switch to the
3974 \begin_inset Flex Code
3977 \begin_layout Plain Layout
3979 \SpecialChar menuseparator
3987 \begin_inset Flex Code
3990 \begin_layout Plain Layout
3991 Tools\SpecialChar menuseparator
3992 Preferences\SpecialChar menuseparator
3993 File Handling\SpecialChar menuseparator
4000 (Make sure you add the switch after the script name, not before it.)
4003 \begin_layout Section
4004 Fancy Headers and Footers
4007 \begin_layout Standard
4008 The default page layout is rather plain; for an
4009 \begin_inset Flex Code
4012 \begin_layout Plain Layout
4018 document class, all you get is a centered page number at the bottom of
4020 This document uses KOMA-script's book class, so it appears to be a bit
4022 But to really put on a show, you need to set the document page style to
4024 \begin_inset Quotes eld
4028 \begin_inset Quotes erd
4031 , as mentioned in the
4036 This section describes the \SpecialChar LaTeX
4037 code you need to insert in your \SpecialChar LaTeX
4039 order to get the desired effects.
4042 \begin_layout Standard
4043 For more information on fancy headers, see the
4044 \begin_inset Flex Code
4047 \begin_layout Plain Layout
4053 package documentation.
4055 \begin_inset Flex URL
4058 \begin_layout Plain Layout
4060 https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
4068 \begin_layout Standard
4069 The page header is divided into three fields, not surprisingly labeled
4070 \begin_inset Quotes eld
4074 \begin_inset Quotes erd
4078 \begin_inset Quotes eld
4082 \begin_inset Quotes erd
4086 \begin_inset Quotes eld
4090 \begin_inset Quotes erd
4094 The footer is also divided into these three fields.
4095 The \SpecialChar LaTeX
4096 commands to set these fields in the simplest manner are
4097 \begin_inset Flex Code
4100 \begin_layout Plain Layout
4109 \begin_inset Flex Code
4112 \begin_layout Plain Layout
4121 \begin_inset Flex Code
4124 \begin_layout Plain Layout
4133 \begin_inset Flex Code
4136 \begin_layout Plain Layout
4145 Suppose you wish to put your name in the upper left hand corner of each
4147 Simply insert the following command in the preamble:
4150 \begin_layout Standard
4159 \begin_layout Standard
4160 You will now see your name in the upper left.
4161 If a field has a default entry that you would like to get rid of (often
4162 the page number appears in the central footer) simply include a command
4163 with a blank argument, e.
4164 \begin_inset space \thinspace{}
4170 \begin_layout Standard
4178 \begin_layout Standard
4179 Let's get really fancy: lets put the section number with the word
4180 \begin_inset Quotes eld
4184 \begin_inset Quotes erd
4188 \begin_inset space \thinspace{}
4192 \begin_inset space \space{}
4195 Section 3) in the upper left, the page number (e.
4196 \begin_inset space \thinspace{}
4200 \begin_inset space \space{}
4203 Page 4) in the upper right, your name in the lower left, and the date in
4205 The following commands should now appear in the preamble:
4208 \begin_layout Standard
4218 \begin_layout Standard
4226 \begin_layout Standard
4236 \begin_layout Standard
4245 \begin_layout Standard
4253 \begin_layout Standard
4263 \begin_layout Standard
4265 \begin_inset Flex Code
4268 \begin_layout Plain Layout
4277 \begin_inset Flex Code
4280 \begin_layout Plain Layout
4288 access \SpecialChar LaTeX
4289 's section and page counters, and so print out the current section
4292 \begin_inset Flex Code
4295 \begin_layout Plain Layout
4303 simply prints out today's date.
4306 \begin_layout Standard
4307 The thicknesses of the horizontal rules drawn beneath the header and above
4308 the footer can also be modified.
4309 If you don't want one of the rules, set its thickness to 0.
4310 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
4316 \begin_inset Flex Code
4319 \begin_layout Plain Layout
4324 headrulewidth}{0.4pt}
4330 \begin_inset Flex Code
4333 \begin_layout Plain Layout
4338 footrulewidth}{0.4pt}
4343 to set the thicknesses.
4346 \begin_layout Standard
4347 You can switch the header/footer settings on and off for individual pages
4349 \begin_inset Flex Code
4352 \begin_layout Plain Layout
4355 thispagestyle{empty}
4361 \begin_inset Flex Code
4364 \begin_layout Plain Layout
4367 thispagestyle{plain}
4373 \begin_inset Flex Code
4376 \begin_layout Plain Layout
4379 thispagestyle{fancy}
4385 Simply insert them in the text on the page you want changed and mark them
4388 In fact, title pages are marked as plain by default, while following pages
4389 are marked fancy when using the global fancy setting.
4392 \begin_layout Standard
4393 As a final example, it is possible to include an image in the header or
4395 Suppose you want to put a company logo in the upper lefthand corner.
4396 You might try something like
4399 \begin_layout Standard
4408 includegraphics{logo.eps}}}
4411 \begin_layout Standard
4413 (you may need to preface this with
4414 \begin_inset Flex Code
4417 \begin_layout Plain Layout
4420 usepackage{graphics}
4425 if you don't include graphics elsewhere in your document).
4428 \begin_layout Section
4429 Itemize Bullet Selection
4430 \begin_inset CommandInset label
4439 \begin_layout Standard
4445 \begin_layout Subsection
4449 \begin_layout Standard
4451 provides 216 bullet shapes that can be accessed from a simple dialog.
4452 Using this dialog you can easily specify what bullet shape to use at each
4453 level of an itemized list.
4454 These settings are document-wide so you won't be able to specify different
4455 sets of bullets for different paragraphs.
4459 \begin_layout Plain Layout
4460 Well, actually you can but you'll have to do it by hand.
4468 \begin_layout Subsection
4472 \begin_layout Standard
4473 Open the dialog by selecting the
4474 \begin_inset Flex Noun
4477 \begin_layout Plain Layout
4478 Document\SpecialChar menuseparator
4484 menu item and then select the
4485 \begin_inset Flex Noun
4488 \begin_layout Plain Layout
4497 \begin_layout Standard
4498 The dialog provides you with a table of bullet shapes.
4499 A column of buttons on the left of the table provides access to the six
4500 different panels of bullet shapes.
4501 The row of buttons across the top is used to select which bullet depth
4503 A text entry under the table shows the currently selected bullet shape's
4505 equivalent and this can be edited if desired.
4506 If you do modify the text you will also need to specify any needed packages
4507 in the \SpecialChar LaTeX
4511 \begin_layout Standard
4512 The six panels are divided up by the packages they require.
4513 The following table shows the mappings from button name to \SpecialChar LaTeX
4517 \begin_layout Standard
4519 \begin_inset Tabular
4520 <lyxtabular version="3" rows="7" columns="2">
4521 <features tabularvalignment="middle">
4522 <column alignment="center" valignment="top" width="0pt">
4523 <column alignment="center" valignment="top" width="0pt">
4525 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4528 \begin_layout Plain Layout
4543 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4546 \begin_layout Plain Layout
4563 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4566 \begin_layout Plain Layout
4581 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4584 \begin_layout Plain Layout
4593 base \SpecialChar LaTeX
4601 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4604 \begin_layout Plain Layout
4619 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4622 \begin_layout Plain Layout
4639 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4642 \begin_layout Plain Layout
4657 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4660 \begin_layout Plain Layout
4677 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4680 \begin_layout Plain Layout
4695 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4698 \begin_layout Plain Layout
4715 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4718 \begin_layout Plain Layout
4733 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4736 \begin_layout Plain Layout
4753 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4756 \begin_layout Plain Layout
4771 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4774 \begin_layout Plain Layout
4797 \begin_layout Standard
4799 doesn't stop you using bullets from packages you don't have.
4800 If you get errors from \SpecialChar LaTeX
4801 when you try to view or print the file, then it
4802 is likely you are missing a package.
4806 \begin_layout Plain Layout
4808 doesn't restrict your use since you may be editing locally and exporting
4817 \begin_layout Subsection
4821 \begin_layout Standard
4822 Select which bullet depth you want to change then select the bullet shape
4824 Any changes will not be visible in \SpecialChar LyX
4825 , but are visible when viewing the document.
4828 \begin_layout Standard
4829 You can reset a bullet shape to the default simply by clicking your right
4830 mouse button on the appropriate bullet depth button.
4834 \begin_layout Plain Layout
4839 want to have multiple sets of paragraphs with different sets of bullets
4840 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
4842 The bullet selection dialog can help though because it provides you with
4843 the \SpecialChar LaTeX
4844 code for a wide range of bullet shapes.
4845 To make your own custom paragraphs you have the following options:
4848 \begin_layout Plain Layout
4852 \begin_layout Plain Layout
4868 \begin_layout Plain Layout
4872 \begin_layout Plain Layout
4894 \begin_layout Itemize
4895 Use the \SpecialChar LaTeX
4897 \begin_inset Flex Code
4900 \begin_layout Plain Layout
4908 to specify a new bullet shape for a given depth.
4909 You'll also need to save the current bullet shape so you can restore it
4911 In this itemized list the following \SpecialChar LaTeX
4912 code was used to change the bullet
4913 used for the first depth.
4917 \begin_layout LyX-Code
4927 \begin_layout LyX-Code
4944 \begin_layout Itemize
4945 Note that the itemize depth is specified in Roman numerals as part of the
4955 \begin_layout Itemize
4956 \begin_inset Argument item:1
4959 \begin_layout Plain Layout
4963 \begin_layout Plain Layout
4981 Specify each individual entry by starting each item with the bullet shape
4983 \begin_inset Quotes eld
4987 \begin_inset Quotes erd
4992 Insert\SpecialChar menuseparator
4996 \begin_inset Flex Noun
4999 \begin_layout Plain Layout
5007 For example, this item was started with
5008 \begin_inset Flex Code
5011 \begin_layout Plain Layout
5026 \begin_layout Plain Layout
5030 \begin_layout Plain Layout
5046 \begin_layout Plain Layout
5047 You'll also need to revert the labelitem back to its previous setting for
5048 the global bullet shape settings to remain in effect.
5049 The way used here was:
5052 \begin_layout LyX-Code
5067 \begin_layout Chapter
5069 and the World Wide Web
5072 \begin_layout Standard
5074 has long supported the export of documents to various web-friendly formats,
5076 Before version 2.0, however, HTML export was always accomplished by the
5077 use of external converters.
5081 \begin_layout Plain Layout
5082 For details on the use of external converters with \SpecialChar LyX
5087 section of the Customization manual.
5092 These fall into two large groups: there are converters that use \SpecialChar LaTeX
5094 intermediate format, such as
5095 \begin_inset Flex Code
5098 \begin_layout Plain Layout
5105 \begin_inset Flex Code
5108 \begin_layout Plain Layout
5115 \begin_inset Flex Code
5118 \begin_layout Plain Layout
5124 , relying upon \SpecialChar LyX
5125 to produce the \SpecialChar LaTeX
5126 ; and there is a converter that works directly
5129 \begin_inset Flex Code
5132 \begin_layout Plain Layout
5140 All of these have different advantages and disadvantages.
5144 \begin_layout Standard
5145 The \SpecialChar LaTeX
5146 -based converters have the advantage that, in principle, they know everythin
5147 g about the exported document that \SpecialChar LaTeX
5149 Such converters do not care, for example, if a certain block of code was
5150 produced by \SpecialChar LyX
5151 or was Evil Red Text.
5152 These converters know about
5153 \begin_inset Flex Code
5156 \begin_layout Plain Layout
5162 files, counters, and references, and can often make use of the
5163 \begin_inset Flex Code
5166 \begin_layout Plain Layout
5172 files generated by Bib\SpecialChar TeX
5174 On the other hand, \SpecialChar LaTeX
5175 is a very hard language to parse—it is sometimes said
5176 that only \SpecialChar TeX
5177 itself understands \SpecialChar TeX
5178 —and \SpecialChar LaTeX
5179 -based converters will often choke on
5180 what seem to be quite simple constructs; complex ones can throw them completely
5181 , and as of this writing, for example, the
5185 manual will not export with
5186 \begin_inset Flex Code
5189 \begin_layout Plain Layout
5195 , though the others will.
5196 The other issue concerns how math is handled.
5197 These converters typically convert the formulae into little pictures that
5198 are then linked from the HTML document.
5199 Since these are actually generated by \SpecialChar LaTeX
5200 , they are accurate.
5201 But they do not scale well, and just getting them to look as if they are
5202 actually meant to be in your document—so that the font sizes seem to be
5203 roughly the same—can be a challenge.
5206 \begin_layout Standard
5208 \begin_inset Flex Code
5211 \begin_layout Plain Layout
5219 \begin_inset CommandInset href
5221 name "http://pinchito.es/elyxer/"
5222 target "http://pinchito.es/elyxer/"
5227 ) solves some of these problems.
5228 In particular, the formulae it produces scale perfectly, since it renders
5229 math using a combination of HTML and CSS rather than converting the formulae
5231 But even moderately complex formula are rendered less well than with
5232 \begin_inset Flex Code
5235 \begin_layout Plain Layout
5241 ; this reflects the limitations of HTML.
5245 \begin_layout Plain Layout
5247 \begin_inset Flex Code
5250 \begin_layout Plain Layout
5257 can also use jsMath and MathJax for equations, but this setting is only
5258 available globally and requires one to have access to a server that runs
5264 More importantly (as of version 1.1.1, at least),
5265 \begin_inset Flex Code
5268 \begin_layout Plain Layout
5275 has limited support for math macros and no support for user-defined paragraph
5276 or character styles.
5277 These limitations make
5278 \begin_inset Flex Code
5281 \begin_layout Plain Layout
5288 unsuitable for many of the documents \SpecialChar LyX
5290 In principle, of course, these problems could be solved, but the \SpecialChar LyX
5292 have decided to follow a different path and have made \SpecialChar LyX
5294 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
5295 , DocBook, and plaintext.
5298 \begin_layout Standard
5299 As of this writing, XHTML output remains under development and should probably
5301 \begin_inset Quotes eld
5305 \begin_inset Quotes erd
5312 \begin_layout Plain Layout
5314 \begin_inset Flex Code
5317 \begin_layout Plain Layout
5318 development/HTML/HTML.notes
5323 , which can be found in the \SpecialChar LyX
5325 \begin_inset CommandInset href
5327 name "accessed online"
5328 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
5333 , usually contains up-to-date information about the state of XHTML output.
5334 See also the list of XHTML bugs on
5335 \begin_inset CommandInset href
5337 name "the bug tracker"
5338 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"
5348 Still, the developers have chosen this approach because it has several
5349 potential advantages over the other two.
5352 \begin_layout Standard
5353 These advantages are primarily due to the fact that the XHTML output routines,
5354 since they are part of \SpecialChar LyX
5355 , know everything \SpecialChar LyX
5356 knows about the document being
5361 \begin_layout Plain Layout
5362 Another advantage is that, since these routines are internal to \SpecialChar LyX
5364 immune to changes in \SpecialChar LyX
5365 's file format, or to changes in the semantics of
5371 So they know about the table of contents (as displayed in the outline),
5372 about the counters associated with different paragraph styles, and about
5373 user-defined styles.
5374 The XHTML output routines know what \SpecialChar LyX
5375 knows about internationalization,
5376 too, so they will output
5377 \begin_inset Quotes eld
5381 \begin_inset Quotes erd
5385 \begin_inset Quotes eld
5393 \begin_inset Quotes erd
5396 , depending upon the language in effect at the time.
5400 \begin_layout Standard
5401 Quite generally, the output routines know what \SpecialChar LyX
5402 knows about document layout,
5403 that is, about how the document is to be rendered on screen.
5404 We use this information when we output the document as XHTML.
5405 In particular, \SpecialChar LyX
5410 generates CSS style information corresponding to the layout information
5411 it uses to render the document on screen: if section headings are supposed
5412 to be sans-serif and bold as seen in \SpecialChar LyX
5413 , then (by default) they will be sans-seri
5414 f and bold when viewed in a web browser, too.
5415 And this is true not just for pre-defined styles, like Section, but for
5416 any style, including user-defined styles.
5417 Indeed, the XHTML output routines make no distinction between user-defined
5418 paragraph and character styles and \SpecialChar LyX
5419 's own pre-defined styles: in each case,
5420 everything \SpecialChar LyX
5421 knows about the styles is contained in the layout files.
5422 And much the same is true as regards pre-defined textual insets, such as
5423 footnotes, and various custom insets.
5427 \begin_layout Standard
5428 The result is that XHTML output can be customized and extended in exactly
5429 the same way \SpecialChar LaTeX
5430 output can be customized and extended: through layout files
5432 See chapter five of the
5436 manual for the details.
5439 \begin_layout Standard
5440 The remainder of this chapter contains more detailed information on XHTML
5441 output, its limitations, and ways to work around those limitations.
5444 \begin_layout Section
5445 Math Output in XHTML
5448 \begin_layout Standard
5450 offers four choices for how math is rendered.
5451 These have various advantages and disadvantages:
5454 \begin_layout Itemize
5456 \begin_inset Newline newline
5459 MathML is a dialect of XML designed specifically for mathematics on the
5460 web, and it typically renders very well in browsers that support it.
5461 The disadvantage is that not all browsers support MathML, and support is
5462 not complete even in the Gecko-based browsers, such as Firefox.
5463 \begin_inset Newline newline
5467 is unable to render a formula as MathML—for example, if the formula
5469 \begin_inset Flex Code
5472 \begin_layout Plain Layout
5478 package or ERT—then it will instead output the formula as an image.
5482 \begin_layout Itemize
5484 \begin_inset Newline newline
5488 \begin_inset Flex Code
5491 \begin_layout Plain Layout
5497 outputs math as HTML, styled by CSS.
5501 \begin_layout Plain Layout
5503 has borrowed some of the CSS for its HTML output from
5504 \begin_inset Flex Code
5507 \begin_layout Plain Layout
5518 For simple formulae, this can work quite well, though with more complicated
5519 formulae it tends to break down.
5520 Still, this method has the advantage that it is very widely supported and
5521 so it may be appropriate for documents that contain only a little, fairly
5523 \begin_inset Newline newline
5526 If Lyx is unable to render a formula as HTML—for example, if the formula
5528 \begin_inset Flex Code
5531 \begin_layout Plain Layout
5537 package or ERT—then it will instead output the formula as an image.
5541 \begin_layout Itemize
5543 \begin_inset Newline newline
5547 \begin_inset Flex Code
5550 \begin_layout Plain Layout
5557 will output formulae as images, the very same images, in fact, that are
5558 used for instant preview.
5562 \begin_layout Plain Layout
5563 Instant preview does
5567 have to be on for images to be output, however.
5572 The advantage to this method is that the images are simply generated by
5574 , so they are very accurate.
5575 The disadvantage, as mentioned earlier, is that these are bitmapped images,
5576 so they do not scale terribly well, and one cannot copy them, etc.
5577 \begin_inset Newline newline
5580 The size of the images can be controlled by setting the
5581 \begin_inset Quotes eld
5585 \begin_inset Quotes erd
5589 \begin_inset Flex Noun
5592 \begin_layout Plain Layout
5593 Document\SpecialChar menuseparator
5594 Settings\SpecialChar menuseparator
5604 \begin_layout Plain Layout
5605 For those who want to know, this controls the resolution of the image in
5606 dots per inch and is based upon a default of 75 dpi.
5612 \begin_inset Newline newline
5616 for some reason fails to create an image for a formula (e.g., if a required
5618 package is not installed), then it will fall back to outputing the raw
5623 \begin_layout Itemize
5626 \begin_inset Newline newline
5629 Finally, \SpecialChar LyX
5630 will happily output math as \SpecialChar LaTeX
5632 As well as being the output of last resort, this method can be used with
5634 \begin_inset CommandInset href
5637 target "http://www.math.union.edu/~dpvc/jsMath/"
5642 , which uses JavaScript to render \SpecialChar LaTeX
5643 embedded in HTML documents.
5645 wraps the \SpecialChar LaTeX
5647 \begin_inset Flex Code
5650 \begin_layout Plain Layout
5656 (for inline formulas) or
5657 \begin_inset Flex Code
5660 \begin_layout Plain Layout
5666 (for displayed formulas) with
5667 \begin_inset Flex Code
5670 \begin_layout Plain Layout
5676 , as is required for jsMath.
5679 \begin_layout Standard
5680 One of these output methods must be selected under
5681 \begin_inset Flex Noun
5684 \begin_layout Plain Layout
5685 Document\SpecialChar menuseparator
5686 Settings\SpecialChar menuseparator
5693 By default, \SpecialChar LyX
5695 This is a document-wide setting, therefore.
5698 \begin_layout Standard
5699 Eventually, \SpecialChar LyX
5700 will offer the user the option to select an alternate output
5701 method for a particular inset, say, one that isn't being rendered very
5706 \begin_layout Plain Layout
5707 That said, since \SpecialChar LyX
5708 falls back to images if the inset contains ERT, then one
5709 can force output as an image by putting some harmless ERT into the math,
5711 \begin_inset Formula $a=b\relax$
5722 \begin_layout Section
5723 Bibliography and Citations
5726 \begin_layout Standard
5727 XHTML output fully supports bibliographies and citations.
5731 \begin_layout Standard
5732 Citation labels are generated by the same machinery that generates \SpecialChar LyX
5734 labels, so the labels will look in the output much as they do in \SpecialChar LyX
5737 If you are using numerical citations, then \SpecialChar LyX
5738 will output numerical labels,
5739 such as [1] or [17], rather than simply showing the citation key in square
5740 brackets, as it does on-screen.
5741 If you are using author-year citations, then \SpecialChar LyX
5742 will add lowercase letters
5743 to the years, just as Bib\SpecialChar TeX
5744 does, if it finds more than one citation for
5745 a given author-year combination.
5746 The labels will be printed with the bibliography entries.
5747 Note that there is, at present, no way to customize the appearance of the
5748 labels, for example, to choose between square brackets and parentheses.
5751 \begin_layout Standard
5752 Bibliography output is handled by the same machinery that handles the presentati
5753 on of reference information in the citation dialog, so you will see in the
5754 XHTML output pretty much what you would see if you were to look at a given
5755 entry in the citation dialog.
5756 The formatting can be customized in your layout file or, preferably, in
5762 manual for the details.
5765 \begin_layout Standard
5766 The main defect at present is that cross-referenced information is printed
5767 with every entry with which it is associated.
5768 So you can see things like this:
5773 \begin_inset Quotes eld
5776 Context and Logical Form
5777 \begin_inset Quotes erd
5782 Language in Context: Selected Essays
5784 (Oxford: Oxford University Press, 2007), pp.
5790 \begin_inset Quotes eld
5793 Semantics in Context
5794 \begin_inset Quotes erd
5799 Language in Context: Selected Essays
5801 (Oxford: Oxford University Press, 2007), pp.
5805 \begin_layout Standard
5806 This should be fixed before long.
5809 \begin_layout Standard
5810 There is no support at present for sectioned bibliographies.
5811 If you have multiple bibliographies, then \SpecialChar LyX
5812 will print the same bibliography
5816 \begin_layout Section
5820 \begin_layout Standard
5822 will happily export indexes as XHTML, but with certain limitations at the
5826 \begin_layout Standard
5827 Index export will be most reliable when you do not attempt to use the fancy
5828 constructs that are described in the section on indexes in the
5836 \begin_layout Plain Layout
5837 The main issue here is that \SpecialChar LyX
5838 itself does not really handle these.
5839 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
5845 We'll describe how they are handled using the subsection headings from
5849 \begin_layout Itemize
5850 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
5851 makes an effort to support these,
5852 but the entries must be separated by
5853 \begin_inset Quotes eld
5857 \begin_inset Quotes erd
5860 , that is, there must be spaces around the exclamation point.
5861 This is because it is otherwise too difficult to check for escaped exclamation
5862 points, ones in math, and so forth.
5865 \begin_layout Itemize
5866 Page Ranges: There is no support at all for page ranges, since these make
5867 no sense with XHMTL.
5868 Instead, you will just get two index entries, one at either end.
5871 \begin_layout Itemize
5872 Cross-referencing: There is no support for cross-referencing.
5874 finds an entry containing the
5875 \begin_inset Quotes eld
5878 |see\SpecialChar ldots
5880 \begin_inset Quotes erd
5883 construct, it is just dropped, and the rest is treated as an ordinary index
5887 \begin_layout Itemize
5888 Index Entry Order: \SpecialChar LyX
5889 does support attempts to fix the sorting order.
5890 It will take what is before the first `@' it finds and use that for sorting,
5891 taking what follows the first `@' to be the actual entry.
5892 At present, \SpecialChar LyX
5893 does not check for escaped `@', so do not try to index email
5897 \begin_layout Itemize
5898 Index Entry Layout: You can format entries by using the text style dialog,
5899 or by using any other method available within \SpecialChar LyX
5901 There is no support for constructs like:
5902 \begin_inset Quotes eld
5906 \begin_inset Quotes erd
5910 Indeed, if \SpecialChar LyX
5911 finds a pipe symbol, `|', in an entry, it will delete it and
5912 everything that follows it.
5915 \begin_layout Itemize
5916 Multiple Indexes: There is no support for multiple indexes.
5917 Rather, all index entries will be printed as one large index.
5918 To avoid our printing several versions of the index, we print only the
5919 main index, so make sure you have one.
5922 \begin_layout Section
5923 Nomenclature and Glossary
5926 \begin_layout Standard
5927 There is at present no support for glossaries.
5928 Adding it would be fairly trivial, and welcome.
5931 \begin_layout Chapter
5932 The \SpecialChar LyX
5936 \begin_layout Section
5940 \begin_layout Standard
5941 The `\SpecialChar LyX
5942 server' allows other programs to talk to \SpecialChar LyX
5943 , invoke \SpecialChar LyX
5944 commands, and retrieve
5945 information about the \SpecialChar LyX
5947 This is only intended for advanced users, but they should find it useful.
5948 It is by writing to the \SpecialChar LyX
5949 server, for example, that bibliography managers,
5950 such as JabRef, are able to
5951 \begin_inset Quotes eld
5955 \begin_inset Quotes erd
5958 citations to \SpecialChar LyX
5962 \begin_layout Section
5963 Starting the \SpecialChar LyX
5965 \begin_inset CommandInset label
5967 name "sec:Starting-the-Server"
5974 \begin_layout Standard
5975 The \SpecialChar LyX
5976 server works through the use of a pair of named pipes.
5977 These are usually located in
5978 \begin_inset Flex Code
5981 \begin_layout Plain Layout
5987 , (except on Windows, where
5991 named pipes are special objects located in
5992 \begin_inset Flex Code
5995 \begin_layout Plain Layout
6007 ) and have the names
6008 \begin_inset Quotes eld
6012 \begin_inset Flex Code
6015 \begin_layout Plain Layout
6022 \begin_inset Quotes erd
6026 \begin_inset Quotes eld
6030 \begin_inset Flex Code
6033 \begin_layout Plain Layout
6040 \begin_inset Quotes erd
6044 External programs write into
6045 \begin_inset Flex Code
6048 \begin_layout Plain Layout
6054 and read back data from
6055 \begin_inset Flex Code
6058 \begin_layout Plain Layout
6065 The stem of the pipe names can be defined in the
6066 \begin_inset Flex Noun
6069 \begin_layout Plain Layout
6070 Tools\SpecialChar menuseparator
6077 \begin_inset Flex Code
6080 \begin_layout Plain Layout
6081 "/home/myhome/lyxpipe"
6087 \begin_inset Flex Code
6090 \begin_layout Plain Layout
6104 on Windows (where any working path instead of lyxpipe can be used, for
6106 \begin_inset Flex Code
6109 \begin_layout Plain Layout
6132 configure this manually in order for the server to start.
6135 \begin_layout Standard
6138 \begin_inset Flex Code
6141 \begin_layout Plain Layout
6148 \begin_inset Flex Code
6151 \begin_layout Plain Layout
6157 ' to create the pipes.
6158 If one of the pipes already exists, \SpecialChar LyX
6159 will assume that another \SpecialChar LyX
6161 is already running and will not start the server.
6162 On POSIX (Unix like) systems, if for some other reason, an unused
6163 \begin_inset Quotes eld
6167 \begin_inset Quotes erd
6170 pipe is left in existence when \SpecialChar LyX
6171 closes, then \SpecialChar LyX
6172 will try to delete it.
6173 If this fails for some reason, you will need to delete the pipes manually
6174 and then restart \SpecialChar LyX
6176 On Windows, pipes are deleted by the OS on program termination or crash,
6178 \begin_inset Quotes eld
6182 \begin_inset Quotes erd
6185 pipes should not be possible.
6188 \begin_layout Standard
6189 To have several \SpecialChar LyX
6190 processes with servers at the same time, you have to use
6191 different configurations, perhaps by using separate user directories, each
6193 \begin_inset Flex Code
6196 \begin_layout Plain Layout
6202 file, for each process.
6205 \begin_layout Standard
6206 If you are developing a client program, you might find it useful to enable
6207 debugging information from the \SpecialChar LyX
6209 Do this by starting \SpecialChar LyX
6211 \begin_inset Flex Code
6214 \begin_layout Plain Layout
6223 \begin_layout Standard
6224 You can find a complete example client written in C++ in the source distribution
6226 \begin_inset Flex Code
6229 \begin_layout Plain Layout
6230 development/lyxserver/server_monitor.cpp
6238 \begin_layout Standard
6239 Another useful tool is the command-line based client found in
6240 \begin_inset Flex Code
6243 \begin_layout Plain Layout
6244 src/client/lyxclient
6252 \begin_layout Section
6253 Normal communication
6256 \begin_layout Standard
6257 To issue a \SpecialChar LyX
6258 call, the client writes a line of ASCII text into the input
6260 This line has the following format:
6277 \begin_layout Description
6278 clientname is a name that the client can choose arbitrarily.
6279 Its only use is that \SpecialChar LyX
6280 will echo it if it sends an answer—so a client can
6281 dispatch results from different requesters.
6284 \begin_layout Description
6285 function is the function you want \SpecialChar LyX
6287 It is the same as the commands you'd use in the minibuffer.
6290 \begin_layout Description
6291 argument is an optional argument which is meaningful only to some functions
6293 \begin_inset Quotes eld
6297 \begin_inset Quotes erd
6300 LFUN will insert the argument as text at the cursor position).
6303 \begin_layout Standard
6304 The answer from \SpecialChar LyX
6305 will arrive in the output pipe and be of the form
6322 \begin_layout Standard
6331 are just echoed from the command request, while
6335 is more or less useful information filled according to how the command
6336 execution worked out.
6337 Some commands, such as
6338 \begin_inset Quotes eld
6342 \begin_inset Quotes erd
6345 , will return information about the internal state of \SpecialChar LyX
6347 return an empty data-response.
6348 This means that the command execution went fine.
6351 \begin_layout Standard
6352 In case of errors, the response from \SpecialChar LyX
6370 \begin_layout Standard
6375 should contain an explanation of why the command failed.
6378 \begin_layout Standard
6382 \begin_layout LyX-Code
6383 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
6384 \begin_inset Newline newline
6387 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
6388 \begin_inset Newline newline
6391 read a <~/.lyxpipe.out
6392 \begin_inset Newline newline
6398 \begin_layout Subsection
6399 AppleScript (Mac OS X)
6402 \begin_layout Standard
6403 Since \SpecialChar LyX
6404 2.1, \SpecialChar LyX
6405 supports basic interactions with AppleScript for normal communicatio
6406 n through the command run.
6407 This command takes a direct argument (the
6411 to perform) and an optional argument.
6412 It either returns the output of the function or triggers an error with
6413 the error message and code.
6416 \begin_layout Standard
6420 \begin_layout LyX-Code
6421 tell application "\SpecialChar LyX
6425 \begin_layout LyX-Code
6429 \begin_layout LyX-Code
6430 -- Stores the current file name into f
6433 \begin_layout LyX-Code
6434 set f to (run "server-get-filename" with argument "")
6437 \begin_layout LyX-Code
6438 on error the error_message number the error_number
6441 \begin_layout LyX-Code
6442 display dialog "Error: " & the error_number & ".
6446 \begin_layout LyX-Code
6447 & the error_message buttons {"OK"} default button 1
6450 \begin_layout LyX-Code
6454 \begin_layout LyX-Code
6458 \begin_layout Section
6462 \begin_layout Standard
6464 can notify clients of events going on asynchronously.
6465 Currently it will only do this if the user binds a key sequence with the
6467 \begin_inset Quotes eld
6471 \begin_inset Quotes erd
6475 The format of the string \SpecialChar LyX
6476 sends is as follows:
6480 \begin_inset Flex Code
6483 \begin_layout Plain Layout
6494 \begin_layout Standard
6499 is the printed representation of the key sequence that was actually typed
6503 \begin_layout Standard
6504 This mechanism can be used to extend \SpecialChar LyX
6505 's command set and implement macros.
6506 Bind some key sequence to
6507 \begin_inset Quotes eld
6511 \begin_inset Quotes erd
6515 Then start a client that listens on the output pipe, dispatches the command
6516 according to the sequence, and starts a function that may use \SpecialChar LyX
6519 requests to issue a command or a series of commands to \SpecialChar LyX
6523 \begin_layout Section
6524 The simple \SpecialChar LyX
6528 \begin_layout Standard
6530 implements a simple protocol that can be used for session management.
6531 All messages are of the form
6544 \begin_layout Standard
6550 \begin_inset Quotes eld
6554 \begin_inset Quotes erd
6558 \begin_inset Quotes eld
6562 \begin_inset Quotes erd
6567 \begin_inset Quotes eld
6571 \begin_inset Quotes erd
6574 is received from a client, \SpecialChar LyX
6575 will report back to inform the client that
6576 it's listening to it's messages, while
6577 \begin_inset Quotes eld
6581 \begin_inset Quotes erd
6584 sent from \SpecialChar LyX
6585 will inform clients that \SpecialChar LyX
6589 \begin_layout Section
6590 Reverse DVI/PDF search
6593 \begin_layout Standard
6594 Some DVI/PDF viewers
6598 \begin_layout Plain Layout
6599 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
6600 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
6609 facility (also called
6614 This means that you can tell \SpecialChar LyX
6615 to put the cursor to a specific line in the
6616 document by clicking at the respective position in the DVI/PDF output.
6617 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
6619 This is done via the \SpecialChar LyX
6620 server either by using the named pipe (
6624 ), or the UNIX domain socket (
6628 ) that \SpecialChar LyX
6629 creates in its temporary directory (this is the way the
6630 \begin_inset Flex Code
6633 \begin_layout Plain Layout
6639 program communicates with \SpecialChar LyX
6641 In some cases, you need a helper script that mediates between the viewer
6642 and \SpecialChar LyX
6643 , in others, the viewer can communicate with \SpecialChar LyX
6645 This depends on the selected viewer and on your operating system.
6646 The same applies to the way viewers need to be configured and the way the
6647 reverse search is actually performed.
6648 In what follows, we will thus describe how to setup reverse search for
6650 Before we turn to this, though, we will explain what needs to be done generally
6651 to enable reverse search in the DVI/PDF output.
6654 \begin_layout Subsection
6656 \begin_inset CommandInset label
6658 name "subsec:rev-search"
6665 \begin_layout Standard
6666 In most cases \SpecialChar LyX
6667 will do the work for you by pressing the following button
6671 arg "buffer-toggle-output-sync"
6675 Alternatively, you can also enable the feature by checking
6677 Synchronize with Output
6680 \begin_inset Flex Noun
6683 \begin_layout Plain Layout
6684 Document\SpecialChar menuseparator
6685 Settings\SpecialChar menuseparator
6692 In such a case \SpecialChar LyX
6693 will automatically insert the necessary Sync\SpecialChar TeX
6695 PDF) or load the srcltx package (for DVI) respectively.
6696 This option can be easily reached also on
6697 \begin_inset Flex Code
6700 \begin_layout Plain Layout
6709 \begin_layout Standard
6710 If you need a different setting, you can select or input a custom macro
6711 from the drop down box just below
6712 \begin_inset Flex Noun
6715 \begin_layout Plain Layout
6716 Document\SpecialChar menuseparator
6717 Settings\SpecialChar menuseparator
6718 Output\SpecialChar menuseparator
6719 Synchronize with Output
6727 \begin_layout Standard
6728 Note that the method
6729 \begin_inset Flex Code
6732 \begin_layout Plain Layout
6740 enables gzip compression.
6741 If your viewer does not support it, you should instead use
6742 \begin_inset Flex Code
6745 \begin_layout Plain Layout
6756 \begin_layout Standard
6757 Please also note that including the
6758 \begin_inset Flex Code
6761 \begin_layout Plain Layout
6768 \begin_inset Flex Code
6771 \begin_layout Plain Layout
6777 sometimes has an undesired impact on the typesetting.
6778 Thus, you should switch output synchronization off for the final typesetting
6780 \begin_inset Flex Code
6783 \begin_layout Plain Layout
6790 \begin_inset Flex Code
6793 \begin_layout Plain Layout
6803 \begin_layout Standard
6804 In case you need some more special settings that are not covered by the
6805 automatic settings, read the next section about how to set up output synchroniz
6807 If the automatic setup suits your needs, you can readily jump to section
6808 \begin_inset space ~
6812 \begin_inset CommandInset ref
6814 reference "subsec:configuring-viewers"
6818 , where the necessary configuration steps in your viewer – needed both with
6819 the automatic and the manual setup – are described.
6822 \begin_layout Subsection
6826 \begin_layout Standard
6828 provides several different methods for reverse search.
6829 Some are built-in in the
6830 \begin_inset Flex Code
6833 \begin_layout Plain Layout
6839 program, some are provided by external packages.
6840 Your choice depends on whether your \SpecialChar LaTeX
6841 distribution already provides a given
6842 method (the built-in methods are rather new) and whether your viewer can
6844 The available methods are described in the following.
6847 \begin_layout Subsubsection*
6848 Built-in DVI-search via src-specials (DVI only)
6851 \begin_layout Standard
6852 This method provides the DVI file with the necessary information for reverse
6854 It is available in \SpecialChar LaTeX
6855 since quite some time (any somewhat recent \SpecialChar LaTeX
6857 should include it), and it works reliably.
6858 To enable it, change the
6859 \begin_inset Flex Noun
6862 \begin_layout Plain Layout
6873 \begin_inset Flex Noun
6876 \begin_layout Plain Layout
6887 \begin_inset Flex Noun
6890 \begin_layout Plain Layout
6891 Preferences\SpecialChar menuseparator
6892 File Handling\SpecialChar menuseparator
6899 \begin_inset Flex Code
6902 \begin_layout Plain Layout
6903 latex -src-specials $$i
6909 If this doesn't work, check if your \SpecialChar TeX
6910 engine needs different options (the
6911 syntax might differ in some distributions).
6914 \begin_layout Subsubsection*
6915 External Packages (PDFSync and scrltx)
6918 \begin_layout Standard
6927 provide reverse search facility for PDF output (via pdflatex) and DVI output,
6929 In order to enable it, load the packages in the \SpecialChar LyX
6933 \begin_layout Itemize
6934 \begin_inset Flex Code
6937 \begin_layout Plain Layout
6945 for reverse PDF search,
6948 \begin_layout Itemize
6949 \begin_inset Flex Code
6952 \begin_layout Plain Layout
6955 usepackage[active]{srcltx}
6960 for reverse DVI search.
6963 \begin_layout Standard
6964 If you want to be able to perform both DVI and PDF reverse searches, you
6965 can also insert in the preamble the following lines
6968 \begin_layout LyX-Code
6972 \begin_inset Newline newline
6978 \begin_inset Newline newline
6984 \begin_inset Newline newline
6990 \begin_inset Newline newline
6995 usepackage[active]{srcltx}
6996 \begin_inset Newline newline
7004 \begin_layout Standard
7005 This way, you can preview the file as either DVI or PDF (pdflatex) and the
7006 right package will be used.
7009 \begin_layout Standard
7010 Note that PDFSync might affect the output layout of your document.
7011 It is therefore advised to disable PDFsync for final documents.
7014 \begin_layout Subsubsection*
7015 Built-in reverse search via Sync\SpecialChar TeX
7019 \begin_layout Standard
7021 \begin_inset Flex Code
7024 \begin_layout Plain Layout
7030 have built-in support for both PDF and DVI reverse search.
7033 Sync\SpecialChar TeX
7036 facility is basically the result of the integration of the PDFSync package
7037 to the pdftex program and its merge with the
7042 You need at least \SpecialChar TeX
7043 Live 2008 or a recent Mik\SpecialChar TeX
7044 distribution in order to use
7049 \begin_layout Plain Layout
7050 For some reason, Mik\SpecialChar TeX
7051 does not understand/obey the command \SpecialChar LyX
7053 the preamble when you check the "Enable Forward/Reverse Search" button
7054 in the toolbar and does not generate the necessary info.
7057 \begin_layout Plain Layout
7058 The generation of the required info can be forced by changing the converter
7060 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
7061 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
7062 the -synctex=1 switch).
7067 Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
7068 Skim on the Mac, SumatraPDF on Windows; see the next section for details)
7069 already provide Sync\SpecialChar TeX
7073 \begin_layout Standard
7074 To enable Sync\SpecialChar TeX
7075 for DVI output, change the
7076 \begin_inset Flex Noun
7079 \begin_layout Plain Layout
7090 \begin_inset Flex Noun
7093 \begin_layout Plain Layout
7104 \begin_inset Flex Noun
7107 \begin_layout Plain Layout
7108 Preferences\SpecialChar menuseparator
7109 File Handling\SpecialChar menuseparator
7116 \begin_inset Flex Code
7119 \begin_layout Plain Layout
7120 latex -synctex=1 $$i
7125 , and for PDF output, change the
7126 \begin_inset Flex Noun
7129 \begin_layout Plain Layout
7134 (pdflatex) -> PDF (pdflatex)
7140 \begin_inset Flex Code
7143 \begin_layout Plain Layout
7144 pdflatex -synctex=1 $$i
7150 Should your viewer not be considered in the following description, or in
7151 case of missing success, please check the documentation of your viewer
7152 whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
7157 \begin_layout Plain Layout
7158 Note that the option
7159 \begin_inset Flex Code
7162 \begin_layout Plain Layout
7168 option enables gzip compression.
7169 If your viewer does not support it, you should instead use
7170 \begin_inset Flex Code
7173 \begin_layout Plain Layout
7187 \begin_layout Subsection
7188 Configuring and using specific viewers
7189 \begin_inset CommandInset label
7191 name "subsec:configuring-viewers"
7198 \begin_layout Subsubsection*
7199 Xdvi (all platforms)
7202 \begin_layout Standard
7204 \begin_inset Flex Code
7207 \begin_layout Plain Layout
7213 , you don't need to do anything else for performing a reverse DVI search,
7215 already provides the necessary hooks for automatically using the
7216 \begin_inset Flex Code
7219 \begin_layout Plain Layout
7226 Just setup your document as described above (reverse search is triggered
7227 by Ctrl-click or Alt-click on Mac OSX, respectively).
7230 \begin_layout Standard
7231 However, if for whatever reason you want to use the named pipe instead of
7232 the socket for communicating with \SpecialChar LyX
7233 , simply change the DVI viewer in
7234 \begin_inset Flex Noun
7237 \begin_layout Plain Layout
7238 Preferences\SpecialChar menuseparator
7239 File Handling\SpecialChar menuseparator
7249 \begin_layout Plain Layout
7250 On Mac OSX you have to use
7251 \begin_inset Flex Code
7254 \begin_layout Plain Layout
7255 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
7266 \begin_inset Flex Code
7269 \begin_layout Plain Layout
7270 xdvi -editor "lyxeditor.sh %f %l"
7276 \begin_inset Flex Code
7279 \begin_layout Plain Layout
7285 is a suitable script.
7286 For example, a minimal shell script is the following one:
7289 \begin_layout LyX-Code
7291 \begin_inset Newline newline
7294 LYXPIPE="/path/to/lyxpipe"
7295 \begin_inset Newline newline
7298 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
7299 \begin_inset Newline newline
7302 echo "$COMMAND" > "${LYXPIPE}".in || exit
7303 \begin_inset Newline newline
7306 read TMP < "${LYXPIPE}".out || exit
7309 \begin_layout Standard
7311 \begin_inset Flex Code
7314 \begin_layout Plain Layout
7320 is the LyXServer pipe path specified in
7321 \begin_inset Flex Noun
7324 \begin_layout Plain Layout
7325 Preferences\SpecialChar menuseparator
7335 \begin_layout Plain Layout
7337 \begin_inset Flex Code
7340 \begin_layout Plain Layout
7346 folder of a source distribution you can find a
7347 \begin_inset Flex Code
7350 \begin_layout Plain Layout
7356 script which is able to locate the
7360 based on your preferences.
7368 \begin_layout Subsubsection*
7372 \begin_layout Standard
7374 \begin_inset Flex Code
7377 \begin_layout Plain Layout
7378 /Applications/MacDviX_Folder/calleditor.script
7383 , add the following lines:
7386 \begin_layout LyX-Code
7387 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
7388 \begin_inset Newline newline
7394 \begin_layout Standard
7395 Modify the lines accordingly if you install \SpecialChar LyX
7396 somewhere else than in the
7397 Applications folder.
7400 \begin_layout Standard
7401 Reverse search is triggered by Alt-click (OPTION-click).
7404 \begin_layout Subsubsection*
7408 \begin_layout Standard
7410 \begin_inset Flex Code
7413 \begin_layout Plain Layout
7414 open -a Skim.app $$i
7419 to the viewer setting in
7420 \begin_inset Flex Noun
7423 \begin_layout Plain Layout
7424 Preferences\SpecialChar menuseparator
7425 File Handling\SpecialChar menuseparator
7426 File formats\SpecialChar menuseparator
7433 \begin_inset Flex Noun
7436 \begin_layout Plain Layout
7437 Skim\SpecialChar menuseparator
7438 Preferences\SpecialChar menuseparator
7445 \begin_inset Flex Noun
7448 \begin_layout Plain Layout
7454 preset and enter command
7455 \begin_inset Flex Noun
7458 \begin_layout Plain Layout
7459 /Applications/\SpecialChar LyX
7460 .app/Contents/MacOS/lyxeditor
7468 \begin_layout Standard
7469 Reverse search is triggered by COMMAND-SHIFT-click
7472 \begin_layout Subsubsection*
7476 \begin_layout Standard
7477 Reverse search with evince does not work out of the box, but it can be achieved
7478 by means of some third party helper scripts.
7480 \begin_inset CommandInset href
7482 target "https://wiki.lyx.org/LyX/SyncTeX"
7490 \begin_layout Subsubsection*
7494 \begin_layout Standard
7496 \begin_inset Flex Noun
7499 \begin_layout Plain Layout
7500 Settings\SpecialChar menuseparator
7501 Configure Okular\SpecialChar menuseparator
7508 \begin_inset Quotes erd
7512 This inserts the appropriate command (
7513 \begin_inset Flex Code
7516 \begin_layout Plain Layout
7525 \begin_layout Standard
7526 Reverse search is triggered by SHIFT-click.
7528 \change_inserted -712698321 1578211026
7529 Note that this only works if Okular is in
7530 \begin_inset Quotes eld
7534 \begin_inset Quotes erd
7538 \begin_inset space \thinspace{}
7541 e., the hand symbol is clicked).
7546 \begin_layout Subsubsection*
7550 \begin_layout Standard
7551 Qpdfview supports Sync\SpecialChar TeX
7552 since version 0.3.5.
7554 \begin_inset Flex Noun
7557 \begin_layout Plain Layout
7558 Edit\SpecialChar menuseparator
7559 Settings\SpecialChar menuseparator
7565 , click on the input field of the
7566 \begin_inset Quotes eld
7570 \begin_inset Quotes erd
7573 item and add the command
7574 \begin_inset Flex Code
7577 \begin_layout Plain Layout
7586 \begin_layout Standard
7587 Reverse search is triggered by double-click or, in more recent versions,
7591 \begin_layout Subsubsection*
7595 \begin_layout Standard
7596 Launch yap, choose its
7597 \begin_inset Flex Noun
7600 \begin_layout Plain Layout
7601 View\SpecialChar menuseparator
7608 \begin_inset Quotes eld
7612 \begin_inset Quotes erd
7617 \begin_inset Quotes eld
7620 New\SpecialChar ldots
7622 \begin_inset Quotes erd
7625 button and, in the window that opens, enter
7626 \begin_inset Quotes eld
7631 \begin_inset Quotes erd
7634 (or any other name you like) in the
7635 \begin_inset Quotes eld
7639 \begin_inset Quotes erd
7643 Now click on the button labeled
7644 \begin_inset Quotes eld
7649 \begin_inset Quotes erd
7652 to open a file dialog and navigate to the directory containing the batch
7654 \begin_inset Flex Code
7657 \begin_layout Plain Layout
7665 \begin_inset Flex Code
7668 \begin_layout Plain Layout
7674 and then specify the program arguments as
7675 \begin_inset Flex Code
7678 \begin_layout Plain Layout
7686 \begin_inset Flex Code
7689 \begin_layout Plain Layout
7695 wrapper is used for communicating with \SpecialChar LyX
7703 \begin_layout LyX-Code
7705 \begin_inset Newline newline
7708 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
7717 \begin_inset Newline newline
7731 \begin_layout Standard
7732 Make sure that the \SpecialChar LyX
7733 Server pipe path you specified in \SpecialChar LyX
7735 \begin_inset Flex Code
7738 \begin_layout Plain Layout
7752 , otherwise change the
7753 \begin_inset Flex Code
7756 \begin_layout Plain Layout
7762 wrapper accordingly.
7765 \begin_layout Standard
7766 In yap, reverse search is triggered by double-click.
7769 \begin_layout Subsubsection*
7770 SumatraPDF (Windows)
7773 \begin_layout Standard
7774 In order to use SumatraPDF for inverse search, enter
7775 \begin_inset Flex Code
7778 \begin_layout Plain Layout
7779 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
7784 in the viewer setting in
7785 \begin_inset Flex Noun
7788 \begin_layout Plain Layout
7789 Preferences\SpecialChar menuseparator
7790 File Handling\SpecialChar menuseparator
7791 File formats\SpecialChar menuseparator
7798 \begin_inset Flex Code
7801 \begin_layout Plain Layout
7807 is the previous wrapper.
7808 If SumatraPDF.exe is not in your command PATH, use its full file name.
7811 \begin_layout Standard
7812 Reverse search is triggered by double-click.
7815 \begin_layout Subsubsection*
7819 \begin_layout Standard
7820 First of all, make sure that yap is your default DVI viewer in the Windows
7821 environment, then launch it, choose its
7822 \begin_inset Flex Noun
7825 \begin_layout Plain Layout
7826 View\SpecialChar menuseparator
7833 \begin_inset Quotes eld
7837 \begin_inset Quotes erd
7842 \begin_inset Quotes eld
7845 New\SpecialChar ldots
7847 \begin_inset Quotes erd
7850 button and, in the window that opens, enter
7851 \begin_inset Quotes eld
7856 \begin_inset Quotes erd
7859 (or any other name you like) in the
7860 \begin_inset Quotes eld
7864 \begin_inset Quotes erd
7868 Now click on the button labeled
7869 \begin_inset Quotes eld
7874 \begin_inset Quotes erd
7877 to open a file dialog and navigate to the directory containing the
7878 \begin_inset Flex Code
7881 \begin_layout Plain Layout
7887 program (which is installed by default on Cygwin along with the \SpecialChar LyX
7890 \begin_inset Flex Code
7893 \begin_layout Plain Layout
7899 and then specify the program arguments as
7900 \begin_inset Flex Code
7903 \begin_layout Plain Layout
7910 In this way, you will be using the
7914 for communicating with \SpecialChar LyX
7916 If, for whatever reason, you want to use the
7921 \begin_inset Flex Code
7924 \begin_layout Plain Layout
7930 option and be sure to specify the \SpecialChar LyX
7931 Server pipe path in the \SpecialChar LyX
7935 \begin_layout Standard
7936 In yap, reverse search is triggered by double-click.
7939 \begin_layout Subsubsection*
7943 \begin_layout Standard
7944 In order to use SumatraPDF for inverse search, enter
7945 \begin_inset Flex Code
7948 \begin_layout Plain Layout
7949 SumatraPDF -inverse-search "lyxeditor -g %f %l"
7954 in the viewer setting in
7955 \begin_inset Flex Noun
7958 \begin_layout Plain Layout
7959 Preferences\SpecialChar menuseparator
7960 File Handling\SpecialChar menuseparator
7961 File formats\SpecialChar menuseparator
7968 If SumatraPDF.exe is not in your command PATH, use its full posix path.
7970 \begin_inset Flex Code
7973 \begin_layout Plain Layout
7979 enables communication via the
7985 \begin_inset Flex Code
7988 \begin_layout Plain Layout
7994 option if you want to use the
7998 , and be sure to specify the \SpecialChar LyX
7999 Server pipe path in the \SpecialChar LyX
8003 \begin_layout Standard
8004 Reverse search is triggered by double-click.
8007 \begin_layout Section
8011 \begin_layout Standard
8012 Forward search is, as the name implies, in a sense the
8013 \begin_inset Quotes eld
8017 \begin_inset Quotes erd
8021 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
8023 If forward search is set up (as described in what follows), you can put
8024 the cursor anywhere in your \SpecialChar LyX
8026 \begin_inset Flex Noun
8029 \begin_layout Plain Layout
8030 Navigate\SpecialChar menuseparator
8037 \begin_inset Flex Noun
8040 \begin_layout Plain Layout
8046 in the context menu via right mouse click), and then the viewer will jump
8047 to that position as well.
8048 This implies, of course, that your viewer supports this function.
8051 \begin_layout Standard
8052 To make forward search possible, you first need to provide the generated
8053 output PDF/DVI file with additional information about the \SpecialChar TeX
8055 This can be done via the methods described in the section
8056 \begin_inset CommandInset ref
8058 reference "subsec:rev-search"
8065 \begin_layout Standard
8066 Additionally, you need to configure \SpecialChar LyX
8067 for using your viewers in
8068 \begin_inset Flex Noun
8071 \begin_layout Plain Layout
8072 Tools\SpecialChar menuseparator
8073 Preferences\SpecialChar menuseparator
8074 Output\SpecialChar menuseparator
8081 We provide a range of tested configurations for some viewers, which you
8082 can select from the drop down list.
8083 If none of these configurations suits you, you have to find out and enter
8084 a suitable configuration yourself.
8085 The definition syntax uses the following placeholders:
8088 \begin_layout Itemize
8090 \begin_inset Flex Code
8093 \begin_layout Plain Layout
8102 \begin_layout Itemize
8104 \begin_inset Flex Code
8107 \begin_layout Plain Layout
8113 : name of the (temporary) exported .tex file (without path)
8116 \begin_layout Itemize
8118 \begin_inset Flex Code
8121 \begin_layout Plain Layout
8127 : name of the (temporary) exported .tex file (including path)
8130 \begin_layout Itemize
8132 \begin_inset Flex Code
8135 \begin_layout Plain Layout
8141 : name of the exported output file (either dvi or pdf, depending on which
8142 one exists in the temporary directory)
8145 \begin_layout Standard
8146 Note that only some of the viewers provide full and usable forward search
8147 functionality out of the box, among them yap, xdvi, okular
8151 \begin_layout Plain Layout
8152 You might want to set
8153 \begin_inset Flex Code
8156 \begin_layout Plain Layout
8163 \begin_inset Flex Noun
8166 \begin_layout Plain Layout
8167 Tools\SpecialChar menuseparator
8168 Preferences\SpecialChar menuseparator
8169 File Handling\SpecialChar menuseparator
8171 \begin_inset space ~
8184 , qpdfview, and SumatraPDF
8188 \begin_layout Plain Layout
8189 SumatraPDF can also use DDE commands through the external program CMCDDE
8191 \begin_inset CommandInset href
8193 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
8204 Others, such as evince
8208 \begin_layout Plain Layout
8209 Forward search with evince can be achieved by means of third party helper
8212 \begin_inset CommandInset href
8214 target "https://wiki.lyx.org/LyX/SyncTeX"
8224 , require some extra tools in order to use forward search.
8225 While many of the widespread PDF viewers (most notably Adobe Reader) do
8226 not support forward search at all, some other viewers – e.
8227 \begin_inset space \thinspace{}
8231 xpdf – allow at least to reload the document and jump to a specific page
8232 of the file, so you can at least navigate
8233 \begin_inset Quotes eld
8237 \begin_inset Quotes erd
8241 This latter functionality is provided by an external call of synctex (see
8242 the predefined example configurations).
8246 \begin_layout Standard
8247 Forward search works both with DVI and PDF output.
8249 simply checks which preview format you have used before (i.
8250 \begin_inset space \thinspace{}
8253 e., which format is already there in the temporary directory) and chooses
8254 the appropriate configuration for the respective format.
8257 \begin_layout Chapter
8258 Special Document Classes
8261 \begin_layout Section
8265 \begin_layout Standard
8271 \begin_layout Subsection
8275 \begin_layout Standard
8276 This section describes how \SpecialChar LyX
8277 can be used to write articles for submission
8278 to the scientific journal
8280 Astronomy and Astrophysics
8283 \begin_inset Flex URL
8286 \begin_layout Plain Layout
8288 https://www.aanda.org/
8293 ) using Version 5.01 of the document class
8298 This package can be downloaded from the ftp site
8301 \begin_layout Standard
8302 \begin_inset VSpace medskip
8308 \begin_layout Standard
8310 \begin_inset Flex URL
8313 \begin_layout Plain Layout
8315 ftp://ftp.edpsciences.org/pub/aa/readme.html
8323 \begin_layout Standard
8324 \begin_inset VSpace medskip
8330 \begin_layout Standard
8331 A manual comes together with that package, and this text is not meant to
8332 replace the original manual but is merely a short guide in how to realize
8333 the correct form of your paper.
8337 \begin_layout Standard
8338 Please note that the publisher of the journal was changed from Springer
8339 to EDP Sciences starting January 1, 2001.
8340 That change involved also some slight changes to the style files, namely
8341 the removal of the thesaurus command.
8342 The \SpecialChar LyX
8343 class aa supports the newest version of these style files, V 5.01.
8344 If you have an older version installed, please upgrade.
8345 For compatibility, the old (version 4) layout has been kept as
8350 Please refer to the comments in
8353 Dir/layouts/aapaper.layout
8358 \begin_layout Subsection
8362 \begin_layout Standard
8363 It is recommended you start from the example template distributed with \SpecialChar LyX
8365 If you are not using a template, note the following settings:
8368 \begin_layout Itemize
8375 Document\SpecialChar menuseparator
8378 dialog (OK, that one was obvious).
8381 \begin_layout Itemize
8382 Don't change the option
8385 \begin_inset space ~
8395 The whole layout is done by the macros, you shouldn't change anything.
8398 \begin_layout Subsection
8402 \begin_layout Standard
8403 First thing to enter is the header information.
8404 It consists of seven entries, of which some are optional.
8408 \begin_layout Itemize
8416 \begin_layout Itemize
8424 \begin_layout Itemize
8432 \begin_layout Itemize
8440 \begin_layout Itemize
8445 : [optional] if more than one author: whom to contact for offprint requests.
8448 \begin_layout Itemize
8453 : [optional] mail address for contacts.
8456 \begin_layout Itemize
8464 Received: <date>; Accepted <date>
8467 \begin_layout Standard
8468 There is no need to issue the
8474 command, this is done automatically by \SpecialChar LyX
8475 when the header is finished.
8476 Although the order of the single header entries doesn't matter it is advised
8477 to keep the above sequence, just to get the best optics and meets the layout
8478 of the real document.
8481 \begin_layout Standard
8482 If you want to place footnotes in the header block, e.
8483 \begin_inset space \thinspace{}
8487 \begin_inset space \space{}
8490 to state your present address, just use the standard footnote via the menu
8493 Insert\SpecialChar menuseparator
8498 will automagically use the term
8507 \begin_layout Standard
8510 Edit\SpecialChar menuseparator
8513 , you'll find two insets which are relevant for the titling:
8516 \begin_layout Itemize
8523 to mark corresponding author\SpecialChar breakableslash
8525 The institutes are numbered sequentially as they appear in the
8529 field, so you have to put a marker to each author.
8532 \begin_layout Itemize
8537 to supply an email address for fast contact.
8540 \begin_layout Standard
8541 In addition to these topics, the macros use one additional \SpecialChar LaTeX
8543 has no counterpart in \SpecialChar LyX
8547 \begin_layout Itemize
8554 to separate different names for more than one author and institute, respectivel
8558 \begin_layout Standard
8559 The appropriate command has to be entered in \SpecialChar LyX
8560 and marked as \SpecialChar LaTeX
8566 \begin_layout Subsection
8570 \begin_layout Standard
8571 The abstract should immediately follow the header block.
8572 With version 5 the abstract environment was changed to a command, and there
8573 is now a restriction to only one paragraph.
8574 In addition, it should contain an entry with the keywords.
8575 This is done via the paragraph style
8580 Refer to the example paper.
8583 \begin_layout Subsection
8584 Supported environments
8587 \begin_layout Standard
8588 The A&A paper layout supports the following environments for structuring
8592 \begin_layout Itemize
8598 \begin_layout Itemize
8604 \begin_layout Itemize
8610 \begin_layout Itemize
8616 \begin_layout Itemize
8622 \begin_layout Itemize
8628 \begin_layout Itemize
8634 \begin_layout Itemize
8640 \begin_layout Itemize
8646 \begin_layout Itemize
8652 \begin_layout Itemize
8658 \begin_layout Itemize
8665 \begin_layout Subsection
8666 Commands not supported by \SpecialChar LyX
8670 \begin_layout Standard
8671 Some commands are not yet supported by the
8675 layout for \SpecialChar LyX
8677 Some have already been mentioned.
8678 For the sake of completeness, they are listed all together here:
8681 \begin_layout Itemize
8689 \begin_layout Itemize
8697 \begin_layout Itemize
8705 \begin_layout Itemize
8713 \begin_layout Standard
8714 If you want to use any of these commands, you have to enter them yourself.
8717 Do not forget to mark them as \SpecialChar LaTeX
8721 \begin_layout Subsection
8722 Figure and Table Floats
8725 \begin_layout Standard
8727 provides support for the necessary float environments
8729 figure, figure*, table
8735 , therefore we won't tell much about it here.
8739 \begin_inset space ~
8745 Just remember that tables should be left-aligned.
8746 For that, select the table and change the alignment in
8748 Edit\SpecialChar menuseparator
8750 \begin_inset space ~
8756 \begin_layout Standard
8757 There is only one special thing: the figures with caption besides the figure.
8758 To create such a figure, you have to do the following:
8761 \begin_layout Enumerate
8762 Create a wide figure float:
8764 Insert\SpecialChar menuseparator
8765 Float\SpecialChar menuseparator
8768 , then right click in the figure and select
8771 \begin_inset space ~
8779 \begin_layout Enumerate
8780 Enter your caption text.
8783 \begin_layout Enumerate
8788 to move the cursor above the caption.
8791 \begin_layout Enumerate
8795 \begin_layout Enumerate
8796 Position the cursor behind the figure and insert a horizontal fill:
8798 Insert\SpecialChar menuseparator
8800 \begin_inset space ~
8803 Character\SpecialChar menuseparator
8805 \begin_inset space ~
8813 \begin_layout Enumerate
8814 Switch to \SpecialChar LaTeX
8818 \begin_inset space ~
8826 \begin_layout Enumerate
8836 Do not close the brace!
8839 \begin_layout Enumerate
8840 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
8845 \begin_inset space ~
8857 \begin_layout Standard
8858 Also, refer to the figures in the example paper.
8861 \begin_layout Subsection
8865 \begin_layout Standard
8866 For submission, the paper has to be formated in a special double-spacing
8868 For this purpose, you have to give the option
8872 to the document class.
8873 This must be done using the custom class options field in the
8875 Document\SpecialChar menuseparator
8879 Just enter the string
8886 \begin_layout Subsection
8890 \begin_layout Standard
8895 directory contains an example paper written with \SpecialChar LyX
8897 It is the example paper from the original macro package, translated to
8900 Use it for inspiration, and compare the original \SpecialChar LaTeX
8901 code with \SpecialChar LyX
8905 \begin_layout Section
8910 \begin_layout Standard
8916 \begin_layout Subsection
8920 \begin_layout Standard
8922 is a set of macros produced by the American Astronomical Society to
8923 facilitate electronic manuscript submission to the three journals they
8924 publish: the Astrophysical Journal (including the Letters and Supplement),
8925 the Astronomical Journal, and the Publications of the Astronomical Society
8928 has proven to be an excellent tool for generating these documents, especially
8929 given its equation, citation, and figure handling capabilities.
8931 requires version 5.0 (or higher) of these macros; preferably 6.0, which
8932 is the version described here, or higher.
8933 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
8934 2.09 and are fundamentally
8935 incompatible with \SpecialChar LyX
8937 The AAS\SpecialChar TeX
8938 package may be downloaded from the AAS\SpecialChar TeX
8942 \begin_layout Standard
8943 \begin_inset VSpace medskip
8949 \begin_layout Standard
8951 \begin_inset Flex URL
8954 \begin_layout Plain Layout
8956 https://aas.org/aastex/aastex-downloads
8964 \begin_layout Standard
8965 \begin_inset VSpace medskip
8971 \begin_layout Standard
8972 A complete user guide is contained in that package and you should familiarize
8973 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
8976 will not reduce the need to figure out all the AAS\SpecialChar TeX
8977 commands, it will only
8978 reduce the drudgery of typing everything in.
8979 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
8981 completely to the requirements of the journal to which you are submitting
8985 \begin_layout Subsection
8986 Starting a New Paper
8989 \begin_layout Standard
8990 I strongly suggest that you start with the AAS\SpecialChar TeX
8994 File\SpecialChar menuseparator
9001 , enter the new file name, then choose the
9006 This will show the most common fields found in a manuscript.
9007 Simply overwrite the existing text (including the brackets,
9011 ) with the correct information.
9012 Many of the AAS\SpecialChar TeX
9013 commands and environments can be implemented directly in
9016 For commands such as these, the \SpecialChar LaTeX
9017 code must be entered directly and marked
9019 Such commands are referred to as \SpecialChar TeX
9020 code, or Evil Red Text.
9021 I tried to minimize the amount of \SpecialChar TeX
9022 code needed in an AAS\SpecialChar TeX
9026 \begin_layout Subsection
9027 Finishing Your Paper
9030 \begin_layout Standard
9031 When the paper is finished to your satisfaction and previews/prints correctly,
9033 \begin_inset Quotes eld
9037 \begin_inset Quotes erd
9040 actions which need to be done before you submit it to the journals.
9044 \begin_layout Enumerate
9045 Export your paper as a \SpecialChar LaTeX
9048 File\SpecialChar menuseparator
9049 Export\SpecialChar menuseparator
9057 \begin_layout Enumerate
9062 file with your favorite text editor
9066 \begin_layout Enumerate
9067 remove the comment lines before the
9076 \begin_layout Enumerate
9081 usepackage...{fontenc}
9083 line if it appears (usually just after
9098 \begin_layout Enumerate
9099 remove everything between (and including) the
9111 commands, except for any commands you specifically put into the \SpecialChar LaTeX
9113 (which should appear immediately after the
9114 \begin_inset Quotes eld
9117 User specified \SpecialChar LaTeX
9119 \begin_inset Quotes erd
9130 \begin_layout Enumerate
9131 Run the resulting file through \SpecialChar LaTeX
9132 to make sure it still processes correctly.
9135 \begin_layout Enumerate
9136 Reread the journal requirements to make sure your filenames and formats
9140 \begin_layout Enumerate
9144 \begin_layout Subsection
9145 Comments On Specific Commands
9148 \begin_layout Standard
9149 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
9156 ) gives a good description of each.
9157 Thus it's probably easiest for me to go down the list as found in the guide
9158 and offer comments where necessary.
9159 So let's begin \SpecialChar ldots
9163 \begin_layout Subsubsection
9164 Things that work as expected
9167 \begin_layout Standard
9168 Because they work as you might expect, I simply list them and the section
9269 begin{thebibliography}
9277 (2.13.2), all the cite commands and their variations (2.13.2), the generic
9278 graphicx figure commands (2.14.1),
9302 (2.15.4, amongst other places),
9329 \begin_layout Standard
9330 The following style options also work correctly:
9351 Simply put them in the
9357 Layout\SpecialChar menuseparator
9363 \begin_layout Subsubsection
9364 Things that work, but require more comment
9367 \begin_layout Standard
9368 The following items work, but require a little more discussion:
9371 \begin_layout Itemize
9372 These items are reserved for use by the journal editors, but you can put
9373 them into the \SpecialChar LaTeX
9374 preamble if you feel compelled to do so:
9407 \begin_layout Itemize
9408 These items may be placed in the \SpecialChar LaTeX
9409 preamble, and are included as blanks in
9431 \begin_layout Itemize
9438 (2.3) – can only be used
9439 \begin_inset Quotes eld
9443 \begin_inset Quotes erd
9446 , not in the middle of a paragraph.
9447 Use \SpecialChar TeX
9448 code if you need to embed it.
9451 \begin_layout Itemize
9458 (2.3) – will have extra {} after it.
9459 This should not cause an error.
9462 \begin_layout Itemize
9469 (2.6) – can only be used
9470 \begin_inset Quotes eld
9474 \begin_inset Quotes erd
9477 , not in the middle of a paragraph.
9478 Use \SpecialChar TeX
9479 code if you need to embed it.
9482 \begin_layout Itemize
9489 (2.8) – can't insert a cross-reference tag, you must type the tag name by
9493 \begin_layout Itemize
9507 \begin_layout Itemize
9514 (2.9) – will have extra {} after it.
9515 This should not cause an error.
9518 \begin_layout Itemize
9525 (2.11) – will have extra {} after it.
9526 This should not cause an error.
9529 \begin_layout Itemize
9536 (2.14.2) – you can insert an optional filename argument by placing the cursor
9537 at the beginning of the text and selecting
9539 Insert\SpecialChar menuseparator
9544 \begin_inset Quotes eld
9548 \begin_inset Quotes erd
9551 inserts an optional argument of the type needed by
9558 Hopefully it will be renamed someday.
9561 \begin_layout Itemize
9574 for the catalog ID optional parameter
9577 \begin_layout Itemize
9590 for the catalog ID optional parameter
9593 \begin_layout Subsubsection
9594 Things not implemented, use \SpecialChar TeX
9598 \begin_layout Standard
9609 setcounter{equation}
9611 (2.12), Journal name abbreviations (2.13.4),
9647 (2.15.4, insert it as the first element in the lefthand cell after where
9649 Don't use any of \SpecialChar LyX
9650 's rules in the table),
9662 (2.15.5), much of Misc (2.17, except
9713 \begin_layout Subsubsection
9714 Things that cannot be implemented
9717 \begin_layout Standard
9719 at least in any meaningful sort of way, so I suggest ignoring them.
9720 They are the references environment (2.13.3), and the deluxetable environment
9722 If you really, really need to use deluxetable, I suggest editing it in
9723 a separate file with a text editor, then using
9725 Insert\SpecialChar menuseparator
9727 \begin_inset space ~
9732 to include it in your \SpecialChar LyX
9738 file to see an example of this.
9741 \begin_layout Subsection
9742 FAQs, Tips, Tricks, and Other Ruminations
9745 \begin_layout Subsubsection
9746 Getting \SpecialChar LyX
9747 and AAS\SpecialChar TeX
9751 \begin_layout Standard
9752 It can be a bit tricky to get \SpecialChar LyX
9753 to recognize a new layout and document class.
9754 When all else fails, do this:
9757 \begin_layout Enumerate
9758 Make certain that \SpecialChar LaTeX
9759 can find AAS\SpecialChar TeX
9761 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
9763 directory completely unrelated to \SpecialChar LaTeX
9764 or AAS\SpecialChar TeX
9765 and run \SpecialChar LaTeX
9773 \begin_layout Enumerate
9778 appears in \SpecialChar LyX
9786 \begin_layout Enumerate
9789 Tools\SpecialChar menuseparator
9793 , then restart \SpecialChar LyX
9797 \begin_layout Enumerate
9798 Open a regular new file, not from a template.
9799 Does AAS\SpecialChar TeX
9800 appear in the class list in
9802 Document\SpecialChar menuseparator
9808 \begin_layout Standard
9809 If you get a warning from an existing AAS\SpecialChar TeX
9810 document about not being able
9811 to find the AAS\SpecialChar TeX
9812 layout or a message about
9813 \begin_inset Quotes eld
9816 You should not mix title layouts with normal ones
9817 \begin_inset Quotes erd
9820 , things haven't been installed correctly.
9823 \begin_layout Subsubsection
9825 error processing a table
9828 \begin_layout Standard
9830 , by default, attempts to center the table caption/title.
9831 This seems to produce a bad interaction in AAS\SpecialChar TeX
9832 so you should click somewhere
9833 in the caption/title, then select
9835 Edit\SpecialChar menuseparator
9837 \begin_inset space ~
9851 This took care of it for me.
9854 \begin_layout Subsubsection
9858 \begin_layout Standard
9859 A couple of things: 1) I have noticed some funny spacing in the reference
9860 entries in the text.
9861 When you enter the bibliography item data, make sure their is
9865 space between the last author and the parenthesis setting off the year;
9869 \begin_inset space \thinspace{}
9873 \begin_inset space \space{}
9887 2) Entering the references at all is not obvious.
9888 The easiest thing is to start typing your first reference at the end of
9889 the document, then mark it as type
9894 That will put a small gray box in front of what you just typed.
9895 Click on the box to fill in the rest of the information.
9896 For new references, go to the end of an existing reference and press return.
9897 That will create a new line with its own box, etc.
9900 \begin_layout Subsubsection
9904 \begin_layout Standard
9905 Even though AAS\SpecialChar TeX
9906 provides its own figure commands (
9912 , for example), I much prefer \SpecialChar LaTeX
9913 's standard figure commands (with the default
9922 \begin_inset space ~
9925 commands as \SpecialChar TeX
9926 code into a Figure Float box if you desire, but I never have
9927 much luck getting the layout right.
9928 With the standard graphics, \SpecialChar LyX
9933 usepackage{graphicx}
9935 command into the \SpecialChar LaTeX
9936 preamble and handle the figures in the standard \SpecialChar LaTeX2e
9938 interspersing the figures in the text.
9939 I believe ApJ accepts figures exactly this way now; AJ might still use
9941 \begin_inset Quotes eld
9944 stack everything at the end
9945 \begin_inset Quotes erd
9951 \begin_layout Subsubsection
9952 Things I could have done, but didn't
9955 \begin_layout Standard
9957 \begin_inset Quotes eld
9961 \begin_inset Quotes erd
9964 things I could have implemented, but chose not to.
9965 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
9967 even though it is double-spaced in the paper manuscript.
9968 Also, I chose not to make separate layouts for the preprint and preprint2
9970 Since I assume you will spend most of your time in the plain manuscript
9971 mode anyway, I decided not to chew up more disk space with this.
9975 \begin_layout Subsection
9979 \begin_layout Standard
9980 Your mileage may vary.
9981 I've now had papers published by both ApJ and AJ that have had 98% of the
9982 effort done in \SpecialChar LyX
9983 ; the last 2% was the \SpecialChar LaTeX
9984 post-processing and a few cleanups.
9985 I have had no trouble with the submission process, and I'm sure the journals
9986 were never aware that there might be a difference.
9987 So, go forth and publish!
9990 \begin_layout Section
9991 AMS \SpecialChar LaTeX
9995 \begin_layout Standard
10005 \begin_layout Standard
10006 \begin_inset VSpace bigskip
10012 \begin_layout Standard
10014 The AMS \SpecialChar LaTeX
10015 layouts are set up to conform to suggested styles for mathematical
10016 papers to be submitted to American Mathematical Society publications.
10017 The layouts are not tailored to a specific journal, but easily can be.
10018 You should refer to the AMS documentation for specific instructions for
10019 each journal (usually it will entail only changing a single line in the
10022 That documentation is available on the Web at
10023 \begin_inset Flex URL
10026 \begin_layout Plain Layout
10034 \begin_inset Flex URL
10037 \begin_layout Plain Layout
10039 ftp://ftp.ams.org/pub/tex/amslatex/
10045 These layouts are appropriate, and useful, for any mathematical writing.
10049 \begin_layout Standard
10050 There are two basic AMS \SpecialChar LaTeX
10054 \begin_layout Itemize
10055 amsart: The standard AMS article format.
10058 \begin_layout Itemize
10059 amsbook: the standard AMS book (really, monograph) format.
10063 \begin_layout Standard
10064 The layouts themselves contain only the minimum necessary to use the AMS
10066 They do not, in particular, contain any of the `theorem' environments used
10067 for setting theorems, lemmas, and the like.
10068 These are contained, instead, in the
10069 \begin_inset Flex Code
10072 \begin_layout Plain Layout
10078 module, which is loaded by default when you select one of the AMS classes.
10079 (It can also be used with other classes and can be removed, if you would
10080 rather use something else.) Less commonly used environments are in the
10081 \begin_inset Flex Code
10084 \begin_layout Plain Layout
10085 Theorems (AMS-Extended)
10090 module, which must be loaded manually.
10093 \begin_layout Standard
10094 By default, theorems and the like are numbered consecutively throughout
10095 the document, but this may be modified by loading the module
10096 \begin_inset Flex Code
10099 \begin_layout Plain Layout
10100 Theorems (Order by Section)
10105 or, if you are using
10106 \begin_inset Flex Code
10109 \begin_layout Plain Layout
10116 \begin_inset Flex Code
10119 \begin_layout Plain Layout
10120 Theorems (Order by Chapter)
10126 These will number the results as
10127 \begin_inset Formula $n.m$
10130 , where the first number refers to the section (or chapter) and the second
10131 refers to the total number of results so far in that section (or chapter).
10132 Many environments are also available unnumbered.
10133 These are indicated by an asterisk at the end.
10134 If you happen to want
10138 unnumbered results, the module
10139 \begin_inset Flex Code
10142 \begin_layout Plain Layout
10148 provides that option.
10151 \begin_layout Standard
10152 Note that these modules do not
10156 to be used with the AMS classes.
10157 It is perfectly possible to use the
10158 \begin_inset Flex Code
10161 \begin_layout Plain Layout
10167 module, and the others mentioned, with other classes, such as
10168 \begin_inset Flex Code
10171 \begin_layout Plain Layout
10178 \begin_inset Flex Code
10181 \begin_layout Plain Layout
10188 \begin_inset Flex Code
10191 \begin_layout Plain Layout
10200 \begin_layout Subsection
10201 What these layouts provide
10204 \begin_layout Standard
10205 There is a long list of included environments provided by these layouts.
10206 In AMS-\SpecialChar LaTeX
10207 , there is, in fact, an opportunity to define an unlimited variety
10208 of `theorem' environments.
10209 However, the AMS recommends the environments that are available in \SpecialChar LyX
10214 \begin_layout Standard
10215 The following environments—as well as the standard environments, such as
10217 \begin_inset Flex Noun
10220 \begin_layout Plain Layout
10227 \begin_inset Flex Noun
10230 \begin_layout Plain Layout
10237 \begin_inset Flex Noun
10240 \begin_layout Plain Layout
10247 \begin_inset Flex Noun
10250 \begin_layout Plain Layout
10257 \begin_inset Flex Noun
10260 \begin_layout Plain Layout
10267 \begin_inset Flex Code
10270 \begin_layout Plain Layout
10277 \begin_inset Flex Code
10280 \begin_layout Plain Layout
10289 \begin_layout Description
10290 Address This should be the author's permanent address.
10293 \begin_layout Description
10295 \begin_inset space ~
10298 Address This should be the author's temporary address at the time of submission,
10299 if different from the Address.
10302 \begin_layout Description
10303 Email Author's e-mail address
10306 \begin_layout Description
10307 URL Author's Web address, if desired.
10310 \begin_layout Description
10311 Keywords Key words or phrases used to identify specific topics discussed
10315 \begin_layout Description
10316 Subjectclass These refer to the AMS Subject Classifications, published and
10319 Mathematical Reviews
10322 These are also available online at the AMS cites listed above.
10325 \begin_layout Description
10329 \begin_layout Description
10333 \begin_layout Description
10337 \begin_layout Standard
10338 The following environments are provided by both the
10339 \begin_inset Flex Code
10342 \begin_layout Plain Layout
10349 \begin_inset Flex Code
10352 \begin_layout Plain Layout
10358 modules, in the latter case in both starred (unnumbered) and unstarred
10359 (numbered) versions.
10360 These same environments are provided only in the starred versions by the
10362 \begin_inset Flex Code
10365 \begin_layout Plain Layout
10374 \begin_layout Theorem
10375 This is typically used for the statements of major results.
10379 \begin_layout Corollary*
10380 This is used for statements which follow fairly directly from previous statement
10382 Again, these can be major results.
10386 \begin_layout Lemma
10387 These are smaller results needed to prove other statements.
10390 \begin_layout Proposition
10391 These are less major results which (hopefully) add to the general theory
10395 \begin_layout Conjecture
10396 These are statements provided without justification, which the author does
10397 not know how to prove, but which seem to be true (to the author, at least).
10400 \begin_layout Definition*
10401 Guess what this is for.
10402 The font is different for this environment than for the previous ones.
10406 \begin_layout Example*
10407 Used for examples illustrating proven results.
10410 \begin_layout Problem
10411 It's not really known what this is for.
10412 You should figure it out.
10415 \begin_layout Exercise*
10416 Write a description for this one.
10419 \begin_layout Remark
10420 This environment is also a type of theorem, usually a lesser sort of observation.
10423 \begin_layout Claim*
10424 Often used in the course of giving a proof of a larger result.
10428 Generally, these are used to break up long arguments, using specific instances
10434 The numbering scheme for cases is on its own, not together with other numbered
10439 \begin_layout Proof
10440 At the end of this environment, a QED symbol (usually a square, but it can
10441 vary with different styles) is placed.
10442 If you want to have other environments within this one—for example, Case
10443 environments—and have the QED symbol appear only after them, then the other
10444 environments need to be nested within the proof environment.
10447 Nesting Environments
10453 for information on nesting.
10456 \begin_layout Standard
10457 And these environments are provided by
10458 \begin_inset Flex Code
10461 \begin_layout Plain Layout
10462 Theorems (AMS-Extended)
10470 \begin_layout Criterion*
10471 A required condition.
10474 \begin_layout Algorithm*
10475 A general procedure to be used.
10478 \begin_layout Axiom*
10479 This is a property or statement taken as true within the system being discussed.
10482 \begin_layout Condition*
10483 Sometimes used to state a condition assumed within the present context of
10487 \begin_layout Note*
10488 Similar to a Remark.
10491 \begin_layout Notation*
10492 Used for the explanation of, yes, notation.
10495 \begin_layout Summary
10496 Do we really need to tell you?
10499 \begin_layout Acknowledgement*
10503 \begin_layout Conclusion*
10504 Sometimes used at the end of a long train of argument.
10508 Used in a way similar to Proposition, though perhaps lower on the scale.
10511 \begin_layout Standard
10512 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
10515 They need to be available on your system in order to use these environments.
10518 \begin_layout Section
10522 \begin_layout Standard
10528 \begin_layout Subsection
10532 \begin_layout Standard
10533 Broadway is for writing plays.
10534 The format is more decorative than Hollywood, and much less standardized.
10535 This format should be suitable for workshops.
10538 \begin_layout Subsection
10542 \begin_layout Standard
10543 The same as in Hollywood.
10546 \begin_layout Subsection
10550 \begin_layout Standard
10555 names as labels then cross-reference the label to insert the name.
10556 The cross-reference dialog will show the current cast of characters.
10559 \begin_layout Subsection
10560 Paper size and Margins
10563 \begin_layout Standard
10564 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
10567 \begin_layout Subsection
10571 \begin_layout Standard
10572 The following environments are available.
10573 You can use broadway.bind to get the bind keys shown at the right.
10576 \begin_layout Itemize
10580 \begin_inset Newline newline
10585 You should not have to use this, but it is here for anything that does not
10589 \begin_layout Itemize
10593 \begin_inset space \hfill{}
10597 \begin_inset Newline newline
10602 Used to describe stage setting and the action.
10603 First use of speaker names in all CAPs.
10606 \begin_layout Itemize
10610 \begin_inset space \hfill{}
10614 \begin_inset Newline newline
10619 Automatically numbered.
10620 On screen it will be arabic, but will print as Roman.
10623 \begin_layout Itemize
10627 \begin_inset space \hfill{}
10631 \begin_inset Newline newline
10641 It is just centered text.
10644 \begin_layout Itemize
10648 \begin_inset space \hfill{}
10652 \begin_inset Newline newline
10657 Not automatically numbered.
10658 You supply the number.
10659 This is because I couldn't figure out how.
10662 \begin_layout Itemize
10666 \begin_inset space \hfill{}
10670 \begin_inset Newline newline
10675 A special case of Narrative to describe the setting and action as the curtain
10679 \begin_layout Itemize
10683 \begin_inset space \hfill{}
10687 \begin_inset Newline newline
10692 The speaker's (actor's) title, centered in all CAPS.
10695 \begin_layout Itemize
10699 \begin_inset space \hfill{}
10703 \begin_inset Newline newline
10708 Instructions to the speaker.
10709 The parentheses are automatically inserted.
10710 The ( will appear on screen, but both will be in the printed play.
10711 This environment is only used within
10718 \begin_layout Itemize
10722 \begin_inset space \hfill{}
10726 \begin_inset Newline newline
10731 What the Speaker says.
10734 \begin_layout Itemize
10738 \begin_inset space \hfill{}
10742 \begin_inset Newline newline
10747 The curtain comes down.
10750 \begin_layout Itemize
10754 \begin_inset space \hfill{}
10760 \begin_layout Itemize
10764 \begin_inset space \hfill{}
10770 \begin_layout Itemize
10774 \begin_inset space \hfill{}
10780 \begin_layout Standard
10784 \begin_layout Section
10788 \begin_layout Standard
10793 can be used to type letters according to German conventions.
10794 A template file is included in
10796 .../lyx/share/templates
10798 for you to use as a starting point.
10801 \begin_layout Section
10805 \begin_layout Standard
10806 See the \SpecialChar LyX
10812 It contains all infos you need.
10815 \begin_layout Section
10818 Foil\SpecialChar TeX
10822 \begin_inset CommandInset label
10831 \begin_layout Standard
10837 \begin_layout Subsection
10841 \begin_layout Standard
10842 This section describes how to use \SpecialChar LyX
10843 to make slides for overhead projectors.
10844 There are two document classes that can do this: the default slides class
10847 Foil\SpecialChar TeX
10851 This section documents the latter.
10854 \begin_layout Standard
10855 I'm going to say this again, nice and clear, so that there's no misunderstanding
10859 \begin_layout Standard
10860 \begin_inset VSpace bigskip
10866 \begin_layout Standard
10870 This section documents the class
10871 \begin_inset Quotes eld
10879 \begin_inset Quotes erd
10887 \begin_layout Standard
10888 \begin_inset VSpace bigskip
10894 \begin_layout Standard
10895 If you're looking for the documentation for
10896 \begin_inset Quotes eld
10904 \begin_inset Quotes erd
10907 , check out section
10908 \begin_inset space ~
10912 \begin_inset CommandInset ref
10914 reference "sec:slitex"
10919 If your machine doesn't have the
10927 installed, you'll probably have to use the default
10931 class, which isn't quite as good as
10936 \begin_layout Standard
10941 class is designed for use with version
10942 \begin_inset space ~
10950 class file which is now an integral part of \SpecialChar LaTeX2e
10954 \begin_layout Subsection
10958 \begin_layout Standard
10959 Obviously, to use this document class, you need to select
10970 \begin_inset space ~
10976 There are some settings in the
10979 \begin_inset space ~
10984 dialog that you should know about that are specific to this class:
10987 \begin_layout Itemize
10988 Don't change the options
10999 \begin_inset space ~
11005 They're ignored by the
11012 \begin_layout Itemize
11013 The default font size is 20
11014 \begin_inset space \thinspace{}
11017 pt with the other options being 17
11018 \begin_inset space \thinspace{}
11022 \begin_inset space \thinspace{}
11026 \begin_inset space \thinspace{}
11032 \begin_layout Itemize
11033 The default font is
11041 but all math equations are still typeset in the usual roman font.
11044 \begin_layout Itemize
11047 Foil\SpecialChar TeX
11050 supports A4 and Letter paper sizes as well as a special size for working
11052 \begin_inset space \thinspace{}
11056 It doesn't support A5, B5, legal or executive paper sizes.
11059 \begin_layout Itemize
11060 Don't bother changing the
11064 settings because they are ignored anyway.
11065 All floats appear where they are defined in the text.
11068 \begin_layout Itemize
11073 setting behaves a bit differently for this class.
11076 Foil\SpecialChar TeX
11079 provides extensive footer and header capabilities including a user-defined
11082 \begin_inset space ~
11086 \begin_inset CommandInset ref
11088 reference "sec:foilfoot"
11093 The title page is treated differently to all other pages in the document
11102 has the logo centered at the bottom of the page (if one is defined).
11103 The possible page style choices and what they do are as follows:
11107 \begin_layout Labeling
11108 \labelwidthstring MMMMMMM
11115 The final output contains no page numbers, or other headers or footers
11116 (except footnotes of course).
11120 \begin_layout Labeling
11121 \labelwidthstring MMMMMMM
11128 The final output contains page numbers centered at the bottom of the page.
11129 No other headings or footers (other than footnotes).
11132 \begin_layout Labeling
11133 \labelwidthstring MMMMMMM
11138 Page numbers in lower right corner.
11139 Additional headers and footers are also shown.
11140 This is also the default.
11143 \begin_layout Labeling
11144 \labelwidthstring MMMMMMM
11149 Gives you access to the
11153 package although its use with
11155 Foil\SpecialChar TeX
11158 is discouraged by the writer of the
11160 Foil\SpecialChar TeX
11163 package because of some potential page layout clashes.
11167 \begin_layout Subsubsection
11171 \begin_layout Standard
11172 The following options may be used in the extra class options in the
11174 Document\SpecialChar menuseparator
11180 \begin_layout Labeling
11181 \labelwidthstring MMMMMMx
11186 This sets up the page layout for 7.33
11187 \begin_inset space \thinspace{}
11191 \begin_inset space \thinspace{}
11194 in paper, which is about the same aspect ratio as a 35
11195 \begin_inset space \thinspace{}
11198 mm slide, making it a bit easier to work with this medium.
11201 \begin_layout Labeling
11202 \labelwidthstring MMMMMMx
11207 Places a rule across the page below the header on every page except the
11211 \begin_layout Labeling
11212 \labelwidthstring MMMMMMx
11217 Places a rule across the page above the footer on every page except the
11221 \begin_layout Labeling
11222 \labelwidthstring MMMMMMx
11227 This is automatically set each time you create a new
11234 Foil\SpecialChar TeX
11237 to use the dvips driver to rotate those pages that are set as landscape
11241 \begin_layout Labeling
11242 \labelwidthstring MMMMMMx
11247 Simply changes the page dimensions to those of a landscape page but doesn't
11249 Thus if you use this option you need to use an external program to rotate
11250 each page or feed your paper through your printer as landscape.
11251 Note that this option effectively reverses the roles of the
11259 environments (don't worry these are described in the next section).
11262 \begin_layout Labeling
11263 \labelwidthstring MMMMMMx
11268 Equation numbers on the left.
11271 \begin_layout Labeling
11272 \labelwidthstring MMMMMMx
11277 Flush-left equations.
11280 \begin_layout Subsection
11281 Supported Environments
11284 \begin_layout Standard
11285 Most of the environments commonly supported in other classes are also supported
11291 There are several additional environments provided by
11293 Foil\SpecialChar TeX
11296 as well as a couple added by \SpecialChar LyX
11298 The following environments are shared with other classes:
11301 \begin_layout Standard
11302 \begin_inset Flex Multiple Columns
11305 \begin_layout Itemize
11311 \begin_layout Itemize
11317 \begin_layout Itemize
11323 \begin_layout Itemize
11329 \begin_layout Itemize
11335 \begin_layout Itemize
11342 \begin_layout Itemize
11348 \begin_layout Itemize
11354 \begin_layout Itemize
11360 \begin_layout Itemize
11366 \begin_layout Itemize
11372 \begin_layout Itemize
11378 \begin_layout Itemize
11384 \begin_layout Itemize
11390 \begin_layout Itemize
11401 \begin_layout Standard
11402 That is, all the major environments apart from the sectioning environments.
11403 Since foils are essentially self-contained sections, with a title and body,
11406 Foil\SpecialChar TeX
11409 provides specific commands for starting new foils and these are:
11412 \begin_layout Itemize
11418 \begin_layout Itemize
11424 \begin_layout Standard
11426 also provides slightly modified versions of these two environments called:
11429 \begin_layout Itemize
11435 \begin_layout Itemize
11438 ShortRotatefoilhead
11441 \begin_layout Standard
11442 and the differences will be explained in the next section.
11445 \begin_layout Standard
11446 Since foils are often used in presenting ideas or new theorems and such
11449 Foil\SpecialChar TeX
11452 also provides a comprehensive box of goodies for presenting them:
11455 \begin_layout Standard
11456 \begin_inset Flex Multiple Columns
11459 \begin_layout Itemize
11465 \begin_layout Itemize
11471 \begin_layout Itemize
11477 \begin_layout Itemize
11483 \begin_layout Itemize
11489 \begin_layout Itemize
11495 \begin_layout Itemize
11501 \begin_layout Itemize
11507 \begin_layout Itemize
11513 \begin_layout Itemize
11519 \begin_layout Itemize
11530 \begin_layout Standard
11531 The starred versions are unnumbered while the unstarred versions are numbered.
11532 There are also two list environments added by \SpecialChar LyX
11536 \begin_layout Itemize
11542 \begin_layout Itemize
11548 \begin_layout Standard
11551 Foil\SpecialChar TeX
11554 provides some powerful header and footer capabilities that are best set
11555 in the preamble although they may be set at any point in a document.
11556 If you want to change these settings in your document the best place to
11557 do so is at the very top of a foil, i.
11558 \begin_inset space \thinspace{}
11564 \begin_inset space \space{}
11569 straight after the foilhead.
11572 \begin_layout Standard
11573 For this purpose, the following command styles are provided [
11580 \begin_layout Standard
11581 \begin_inset Flex Multiple Columns
11584 \begin_layout Itemize
11588 \begin_inset space ~
11594 \begin_layout Itemize
11600 \begin_layout Itemize
11604 \begin_inset space ~
11610 \begin_layout Itemize
11614 \begin_inset space ~
11620 \begin_layout Itemize
11624 \begin_inset space ~
11631 \begin_layout Plain Layout
11632 \begin_inset space ~
11644 \begin_layout Standard
11645 There are also a few commands provided by
11647 Foil\SpecialChar TeX
11650 that aren't directly supported by \SpecialChar LyX
11651 but I'll tell you what they do and how
11652 to use them in section
11653 \begin_inset space ~
11657 \begin_inset CommandInset ref
11659 reference "sec:unsuppfoils"
11666 \begin_layout Subsection
11667 Building a Set of Foils
11670 \begin_layout Standard
11671 This section will give a simple introduction to using the different environments
11672 to build a set of foils.
11673 If you want to see an example set of foils, take a look at the
11677 file you find in \SpecialChar LyX
11685 \begin_layout Subsubsection
11686 Give It a Title Page
11689 \begin_layout Standard
11690 Unlike other classes that provide
11710 creates the title on a page of its own.
11711 If you leave out the
11715 environment \SpecialChar LaTeX
11716 will substitute the current date (every time you regenerate
11720 \begin_layout Subsubsection
11724 \begin_layout Standard
11725 As I mentioned earlier, there are four ways of starting a new foil.
11726 For portrait foils you should use
11735 The difference between these two environments is the amount of space between
11736 the title of the foil (the foilhead) and the body of the foil.
11739 \begin_layout Standard
11740 Landscape foils are generated using the
11746 ShortRotatefoilhead
11749 Again the only difference is the spacing between foilhead and body.
11750 Both of the short versions have 0.5
11751 \begin_inset space ~
11754 inches less separation between the foilhead and the body.
11758 \begin_layout Standard
11759 One problem with the support for landscape foils is the requirement that
11760 you have to use the
11764 driver to generate the PostScript output otherwise the foils won't be rotated.
11765 It is possible to get landscape foils even if you haven't got the
11769 driver provided you can feed your foils sideways through your printer ;-)
11772 \begin_layout Subsubsection
11773 Theorems, Lemmas, Proofs and more
11776 \begin_layout Standard
11777 You can't have two of the same type of these environments directly following
11779 If you use a normal paragraph break, , you will just be extending the previous
11780 environment as if you had merged the two environments together.
11781 Rather than that, you need to insert a so-called separator.
11782 Please refer to the section entitled
11793 \begin_layout Subsubsection
11797 \begin_layout Standard
11798 You get all the commonly supported list styles found in other classes as
11799 well as two new ones.
11800 I'll only describe the new ones here.
11801 If you want to find out more about the other list environments check out
11807 If you intend to use itemized lists you might also want to read about the
11811 \begin_inset space ~
11815 \begin_inset space ~
11820 dialog described above in section
11821 \begin_inset space ~
11825 \begin_inset CommandInset ref
11827 reference "sec:bullet"
11834 \begin_layout Standard
11835 The two new list styles,
11843 , are designed to make it easier for you to create lists of do's and don'ts
11844 or right and wrong by providing dedicated environments that use a tick
11845 or a cross as the label of the list.
11846 These lists are in fact dedicated variants of the
11851 They do however require that you have the
11855 packages installed.
11858 \begin_layout Subsubsection
11862 \begin_layout Standard
11865 Foil\SpecialChar TeX
11868 redefines the floating tables and figures so that they appear exactly where
11869 they are in the text rather than pushing them to the top of the page or
11870 to some user specified location.
11871 In fact if you change the float placement settings they are simply ignored.
11874 \begin_layout Subsubsection
11875 Page Headers and Footers
11876 \begin_inset CommandInset label
11878 name "sec:foilfoot"
11885 \begin_layout Standard
11889 \begin_inset space ~
11898 are two commands used to control the left-footer text string.
11899 The first is meant to allow you to include a graphic logo on your foils
11901 \begin_inset Quotes eld
11906 Foil\SpecialChar TeX
11910 \begin_inset Quotes erd
11914 While the second is meant to provide a classification for the audience,
11918 \begin_inset space \thinspace{}
11924 \begin_inset space \space{}
11928 It is empty by default.
11931 \begin_layout Standard
11932 The remaining page corners can be filled by
11935 \begin_inset space ~
11940 (which defaults to page numbers),
11943 \begin_inset space ~
11951 \begin_inset space ~
11959 \begin_layout Subsection
11962 Foil\SpecialChar TeX
11966 \begin_inset CommandInset label
11968 name "sec:unsuppfoils"
11975 \begin_layout Standard
11976 All the commands mentioned below need to be set in a
11986 within another environment.
11989 \begin_layout Subsubsection
11993 \begin_layout Standard
11994 All lengths are adjusted using the
12017 should be replaced by the name given to the length you want to change and
12022 is the length value.
12023 All lengths should be specified in units of length such as inches (
12035 ) or relative to some document or font-based length such as
12045 \begin_layout Standard
12046 It's possible to change the spacing between a foilhead and the body of the
12047 foil by adjusting the length specified by
12054 For example, to make
12059 \begin_inset space \space{}
12062 in closer to their bodies put the following in the preamble:
12068 foilheadskip}{-0.5in}
12071 \begin_layout Standard
12072 The spacings around floats can be adjusted by setting these lengths:
12075 \begin_layout Labeling
12076 \labelwidthstring MMMMMMMMMMM
12083 Separation between the text and the top of the float
12086 \begin_layout Labeling
12087 \labelwidthstring MMMMMMMMMMM
12094 Separation between the float and the caption
12097 \begin_layout Labeling
12098 \labelwidthstring MMMMMMMMMMM
12105 Separation between the caption and the following text
12108 \begin_layout Labeling
12109 \labelwidthstring MMMMMMMMMMM
12116 You can make the captions narrower than the surrounding text by adjusting
12118 Best done relative to
12127 \begin_layout Standard
12128 There are also several title page related lengths that you may find useful
12129 if you have a long title or several authors:
12132 \begin_layout Labeling
12133 \labelwidthstring MMMMMMMMMMM
12140 Separation from headers to
12145 \begin_layout Labeling
12146 \labelwidthstring MMMMMMMMMMM
12164 \begin_layout Labeling
12165 \labelwidthstring MMMMMMMMMMM
12179 \begin_layout Labeling
12180 \labelwidthstring MMMMMMMMMMM
12196 \begin_layout Labeling
12197 \labelwidthstring MMMMMMMMMMM
12213 \begin_layout Standard
12214 The last length related command affects all the list environments.
12225 a list environment then all the vertical spacing between the list items
12227 Note that this is a command not a length so it doesn't require
12233 like the stuff mentioned above.
12236 \begin_layout Subsubsection
12237 Headers and Footers
12240 \begin_layout Standard
12253 commands control whether the logo in the
12257 definition appear on a given page.
12264 in the preamble then none of the foils will have the logo on them.
12265 If you don't want the logo on a particular page place the
12271 directly after the foilhead of that page and the
12277 directly after the next foilhead.
12280 \begin_layout Standard
12281 If you decide to use the
12285 page style setting in the
12288 \begin_inset space ~
12293 dialog you should probably add
12303 to your preamble so headers and footers on landscape pages are correctly
12304 placed when rotated.
12305 This is due to some clashes between the page layouts provided by the
12316 \begin_layout Section
12317 Hollywood (Hollywood spec scripts)
12320 \begin_layout Standard
12326 \begin_layout Subsection
12330 \begin_layout Standard
12331 Getting the format of a Hollywood script right is a
12332 \begin_inset Quotes eld
12336 \begin_inset Quotes erd
12339 It is designed to make the readers focus on content and to be easy and
12340 familiar for the actors to read.
12341 Each page of a script should be one minute of film.
12342 Nothing goes in a script that you cannot see or hear on screen.
12343 The courier 12 pt font should be used throughout.
12347 \begin_layout Subsection
12351 \begin_layout Standard
12352 Speakers' lines should NEVER break in mid-sentence.
12353 If a speaker's lines continue over a page break, repeat the
12357 title followed by (Cont'd).
12360 \begin_layout Subsection
12364 \begin_layout Standard
12369 names as labels then cross-reference the label to insert the name.
12370 The cross-reference dialog will show the current cast of characters.
12371 You can use this to insert the speaker name in narratives also.
12374 \begin_layout Subsection
12375 Paper size and Margins
12378 \begin_layout Standard
12379 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12382 \begin_layout Subsection
12386 \begin_layout Standard
12387 The following environments are available.
12388 You can use hollywood.bind to get the bind keys shown at the right.
12391 \begin_layout Itemize
12395 \begin_inset Newline newline
12400 Used where nothing else works.
12404 \begin_layout Itemize
12410 \begin_inset space \hfill{}
12418 \begin_inset Newline newline
12421 Usually followed by something like
12422 \begin_inset Quotes eld
12425 on Sally waking up.
12426 \begin_inset Quotes erd
12432 \begin_layout Itemize
12436 \begin_inset space \hfill{}
12440 \begin_inset Newline newline
12445 Introduces a new INTERIOR camera set-up.
12446 Always followed by DAY or NIGHT, or something similar to define the lighting
12448 Everthing on this line in CAPS.
12451 \begin_layout Itemize
12455 \begin_inset space \hfill{}
12459 \begin_inset Newline newline
12464 Introduces a new EXTERIOR camera set-up.
12465 Everthing on this line in CAPS.
12468 \begin_layout Itemize
12472 \begin_inset space \hfill{}
12476 \begin_inset Newline newline
12481 The character speaking.
12484 \begin_layout Itemize
12488 \begin_inset space \hfill{}
12492 \begin_inset Newline newline
12497 Instructions to the speaker.
12498 The () are automatically inserted.
12501 \begin_layout Itemize
12505 \begin_inset space \hfill{}
12509 \begin_inset Newline newline
12521 \begin_layout Itemize
12525 \begin_inset space \hfill{}
12529 \begin_inset Newline newline
12534 Camera movement instruction.
12536 \begin_inset space \thinspace{}
12540 \begin_inset space \space{}
12546 \begin_layout Itemize
12550 \begin_inset space \hfill{}
12556 \begin_layout Itemize
12560 \begin_inset space \hfill{}
12566 \begin_layout Itemize
12570 \begin_inset space \hfill{}
12576 \begin_layout Itemize
12580 \begin_inset space \hfill{}
12586 \begin_layout Subsection
12590 \begin_layout Itemize
12594 \begin_layout Itemize
12598 \begin_layout Itemize
12600 \begin_inset space \thinspace{}
12607 \begin_layout Itemize
12612 \begin_layout Itemize
12613 PAN — camera movement
12616 \begin_layout Itemize
12617 INSERT — cut to close-up of
12620 \begin_layout Section
12624 \begin_layout Standard
12627 Panayotis Papasotiriou
12630 \begin_layout Subsection
12634 \begin_layout Standard
12635 The ijmpc package is a set of macros that facilitates electronic manuscript
12638 International Journal of Modern Physics C
12641 Similarly, the ijmpd package is for creating manuscripts to be submitted
12644 International Journal of Modern Physics D
12647 Both journals are published by World Scientific.
12648 The corresponding document classes are named
12657 These files, together with instructions for the authors, can be downloaded
12659 \begin_inset Flex URL
12662 \begin_layout Plain Layout
12664 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
12670 \begin_inset Flex URL
12673 \begin_layout Plain Layout
12675 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
12681 Both packages are modified versions of the standard
12682 \begin_inset Quotes eld
12686 \begin_inset Quotes erd
12689 package, and they are almost (but not exactly) identical.
12690 Most of their features are supported by \SpecialChar LyX
12692 I have used \SpecialChar LyX
12693 successfully to write articles submitted to both journals
12694 without any problem.
12697 \begin_layout Subsection
12701 \begin_layout Standard
12702 As usual, the easiest way to write a paper is to start with a template.
12705 File\SpecialChar menuseparator
12721 This will give an (almost) empty document that includes the most common
12722 fields found in a manuscript.
12723 Simply overwrite the existing text (including the brackets,
12728 You should keep in mind the following remarks.
12731 \begin_layout Enumerate
12733 won't let you change the font size and the page style of the document,
12734 because such modifications are not allowed by both packages.
12737 \begin_layout Enumerate
12738 The language of the document should not be changed.
12739 Before previewing your paper, be sure that the babel package is not used.
12740 To do this, click on
12743 arg "dialog-show document"
12748 \SpecialChar menuseparator
12752 \begin_inset Quotes eld
12756 \begin_inset Quotes erd
12766 \begin_layout Enumerate
12768 \begin_inset Quotes eld
12772 \begin_inset Quotes erd
12775 style must be used to define keywords.
12778 \begin_layout Enumerate
12779 The ijmpc package provides a style named
12780 \begin_inset Quotes eld
12783 Classification Codes
12784 \begin_inset Quotes erd
12787 , which can be used to define classification codes, such as PACS numbers.
12788 Note that this facility is not supported by the ijmpd package.
12791 \begin_layout Enumerate
12792 Several new environments are available:
12793 \begin_inset Quotes eld
12797 \begin_inset Quotes erd
12801 \begin_inset Quotes eld
12805 \begin_inset Quotes erd
12809 \begin_inset Quotes eld
12813 \begin_inset Quotes erd
12817 \begin_inset Quotes eld
12821 \begin_inset Quotes erd
12825 \begin_inset Quotes eld
12829 \begin_inset Quotes erd
12833 \begin_inset Quotes eld
12837 \begin_inset Quotes erd
12841 \begin_inset Quotes eld
12845 \begin_inset Quotes erd
12849 \begin_inset Quotes eld
12853 \begin_inset Quotes erd
12857 \begin_inset Quotes eld
12861 \begin_inset Quotes erd
12865 \begin_inset Quotes eld
12869 \begin_inset Quotes erd
12873 \begin_inset Quotes eld
12877 \begin_inset Quotes erd
12881 \begin_inset Quotes eld
12885 \begin_inset Quotes erd
12889 \begin_inset Quotes eld
12893 \begin_inset Quotes erd
12897 \begin_inset Quotes eld
12901 \begin_inset Quotes erd
12905 Their use is more or less obvious.
12907 supports all these environments; it will use the proper label, text style,
12908 and numbering scheme for each of them.
12911 \begin_layout Enumerate
12912 Both packages use basic citations; the natbib package should not be used.
12913 In \SpecialChar LyX
12914 , citation references are shown as usual; in the output, citations are
12915 shown as superscripts.
12916 If you want to use a citation as normal text, you should use the
12921 \begin_inset space \thinspace{}
12925 \begin_inset space \space{}
12929 \begin_inset Quotes eld
12933 \begin_inset space \space{}
12943 \begin_inset Quotes erd
12949 \begin_layout Enumerate
12951 \begin_inset Quotes eld
12955 \begin_inset Quotes erd
12958 section in both packages.
12959 To put acknowledgments, just use the
12960 \begin_inset Quotes eld
12964 \begin_inset Quotes erd
12970 \begin_layout Enumerate
12971 Appendices may be added to the paper,
12975 the Acknowledgments and
12981 provides a special environment, called
12982 \begin_inset Quotes eld
12986 \begin_inset Quotes erd
12989 which marks the beginning of the appendices.
12990 This environment should be left blank; it just sends a \SpecialChar LaTeX
12991 command, but nothing
12993 In \SpecialChar LyX
12995 \begin_inset Quotes eld
12999 \begin_inset Quotes erd
13002 is printed with blue letters, as a signal that all sections after that
13003 point are appendices.
13004 To write an appendix, use the
13005 \begin_inset Quotes eld
13009 \begin_inset Quotes erd
13014 will number each appendix with capital letters, as required by both journals.
13016 \begin_inset Quotes eld
13020 \begin_inset Quotes erd
13027 be present before the first appendix; if not, all appendices will be numbered
13028 as normal sections in the output.
13031 \begin_layout Enumerate
13032 The ijmpc and the ijmpd packages use the
13036 command to implement table captions.
13037 As a result, a table created by \SpecialChar LyX
13038 is printed correctly, but its caption
13040 However, you can use some \SpecialChar TeX
13041 code to overcome this problem, so that captions
13042 are printed as expected.
13043 To do so, create a float table as usual, remove the caption, and replace
13044 it with the \SpecialChar TeX
13055 (sic); you must also the \SpecialChar TeX
13060 immediately after the tabular material.
13061 Study the example table included in the template files to see how this
13062 trick is implemented.
13063 Alternatively, If you need table captions, you should implement the whole
13068 file, then include this file to the \SpecialChar LyX
13071 Insert\SpecialChar menuseparator
13072 File\SpecialChar menuseparator
13074 \begin_inset space ~
13080 Details on how to create a table float can be found in the files
13088 , included in the corresponding packages.
13091 \begin_layout Subsection
13092 Preparing a paper for submission
13095 \begin_layout Standard
13096 Before you submit your paper you must export the \SpecialChar LyX
13097 document as a \SpecialChar LaTeX
13100 File\SpecialChar menuseparator
13101 Export\SpecialChar menuseparator
13109 \begin_layout Plain Layout
13110 Actually you have the choice between \SpecialChar LaTeX
13111 (plain) and pdflatex.
13112 If you intend to use pdflatex to prepare the paper, you should use the
13113 pdflatex option so that included graphics are converted to PDF format,
13114 ready for use by pdflatex.
13119 , then make the following changes to the resulting
13126 \begin_layout Enumerate
13127 Remove the comment lines before the
13136 \begin_layout Enumerate
13137 Remove everything between (and including) the
13149 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13153 \begin_layout Standard
13158 file should be saved and processed through \SpecialChar LaTeX
13159 as many times as necessary.
13160 You may also want to check the resulting
13167 \begin_layout Section
13171 \begin_layout Standard
13177 \begin_layout Subsection
13181 \begin_layout Standard
13182 The iopart package provides a document class to create electronic manuscript
13183 submission to the journals published by the Institute of Physics.
13184 Instructions for the authors how to create a paper using the iopart class
13185 can be downloaded together with the iopart package from the site
13186 \begin_inset Flex URL
13189 \begin_layout Plain Layout
13191 ftp://ftp.iop.org/pub/journals/latex2e
13199 \begin_layout Subsection
13203 \begin_layout Standard
13204 The easiest way to write a paper is to start with the template
13208 that is available via
13210 File\SpecialChar menuseparator
13213 The template explains how to use the special text environments.
13214 Here are the most important advices:
13217 \begin_layout Itemize
13218 To be able to compile your document to a PDF, PS, or DVI, ensure that the
13219 no AMS packages are loaded in
13221 Document\SpecialChar menuseparator
13222 Settings\SpecialChar menuseparator
13228 \begin_layout Itemize
13231 The title environment defines the kind of your paper.
13232 So use one of the following environments for the title:
13236 \begin_layout Itemize
13245 \begin_layout Itemize
13254 \begin_layout Itemize
13260 for a Topical review
13263 \begin_layout Itemize
13272 \begin_layout Itemize
13281 \begin_layout Itemize
13287 for a Paper (same as Title)
13290 \begin_layout Itemize
13296 for a Preliminary communication
13299 \begin_layout Itemize
13305 for a Rapid communication
13308 \begin_layout Itemize
13314 for a Letter to the editor
13318 \begin_layout Itemize
13321 All title environments except of
13325 can have an optional short title.
13328 \begin_layout Itemize
13329 There is a general title environment
13333 which is not directly supported by \SpecialChar LyX
13335 This can be used as \SpecialChar TeX
13336 code when your document doesn't fit into one of the
13340 \begin_layout Standard
13341 For more informations like hints for special table and formula formatting,
13342 look at the IOP author guidelines.
13345 \begin_layout Section
13349 \begin_layout Standard
13352 Panayotis Papasotiriou
13355 \begin_layout Subsection
13359 \begin_layout Standard
13360 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
13361 that facilitates electronic manuscript submission to the journals they
13363 Most known of them (at least in my domain of interest) are
13365 Astrophysics and Space Science
13371 , but there are many others (see a complete list at
13372 \begin_inset Flex URL
13375 \begin_layout Plain Layout
13377 http://www.wkap.nl/jrnllist.htm/JRNLHOME
13383 The Kluwer package may be downloaded from the site
13384 \begin_inset Flex URL
13387 \begin_layout Plain Layout
13389 http://www.wkap.nl/kaphtml.htm/STYLEFILES
13395 A complete user guide is contained in that package (but it can also be
13396 downloaded separately).
13399 \begin_layout Standard
13401 supports many features of the package but not everything.
13402 However, the \SpecialChar TeX
13403 code needed is reduced to some
13404 \begin_inset Quotes eld
13408 \begin_inset Quotes erd
13411 commands of the package (see
13412 \begin_inset space ~
13416 \begin_inset CommandInset ref
13418 reference "subsec:kluwer_peculiarities"
13423 I have recently used \SpecialChar LyX
13424 to write an article submitted to the
13426 Astrophysics and Space Science
13428 without any problem.
13431 \begin_layout Subsection
13435 \begin_layout Standard
13436 The easiest way to write a paper is to start with the Kluwer template file.
13439 File\SpecialChar menuseparator
13451 This will give an (almost) empty document that includes the most common
13452 fields found in a manuscript and a short description of their use.
13453 As in most templates, simply overwrite the existing text (including the
13458 ) with the correct information.
13461 \begin_layout Subsection
13462 Preparing a paper for submission
13465 \begin_layout Standard
13466 As in the AAS\SpecialChar TeX
13467 package, before you submit your paper to a journal you must
13469 \begin_inset Quotes eld
13473 \begin_inset Quotes erd
13479 \begin_layout Enumerate
13480 Export your paper as a \SpecialChar LaTeX
13482 To do this, click on
13484 File\SpecialChar menuseparator
13485 Export\SpecialChar menuseparator
13493 \begin_layout Enumerate
13498 file with a text editor and make the following changes
13502 \begin_layout Enumerate
13503 remove the comment lines before the
13512 \begin_layout Enumerate
13513 remove everything between (and including) the
13525 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13529 \begin_layout Standard
13538 \begin_layout Enumerate
13543 file through \SpecialChar LaTeX
13544 as many times as necessary (usually up to three).
13547 \begin_layout Enumerate
13553 \begin_inset space \thinspace{}
13557 \begin_inset space \space{}
13564 , and check if everything is OK (it should, if you didn't make any mistake).
13567 \begin_layout Subsection
13568 \begin_inset Quotes eld
13572 \begin_inset Quotes erd
13575 of the Kluwer package
13576 \begin_inset CommandInset label
13578 name "subsec:kluwer_peculiarities"
13585 \begin_layout Standard
13586 The Kluwer package has the following
13587 \begin_inset Quotes eld
13591 \begin_inset Quotes erd
13597 \begin_layout Enumerate
13598 It is possible to write multiple articles in the same \SpecialChar LaTeX
13603 \begin_layout Plain Layout
13604 I can't imagine any good reason to do this.
13610 Each article must be included in the environment
13611 \begin_inset Quotes eld
13615 \begin_inset Quotes erd
13619 Unfortunately, this environment cannot be omitted, even if you write just
13621 Therefore, each article starts with the command
13627 and, obviously, ends with the command
13634 Although this can be implemented in \SpecialChar LyX
13635 , I didn't included it, since it looks
13636 ugly and can confuse the novice user.
13637 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
13640 \begin_inset Quotes eld
13645 \begin_inset Quotes erd
13651 \begin_layout Enumerate
13652 Information given at the beginning of the article (i.
13653 \begin_inset space \thinspace{}
13657 \begin_inset space \space{}
13660 title, subtitle, author, institution, running title, running author, abstract
13661 and keywords) must be included in an environment called
13662 \begin_inset Quotes eld
13666 \begin_inset Quotes erd
13670 This is not implemented in \SpecialChar LyX
13671 , so you must enter title, subtitle etc.
13672 \begin_inset space ~
13675 between two \SpecialChar TeX
13691 \begin_layout Enumerate
13692 According to the user manual, the label of each bibliography item must be
13716 \begin_layout Standard
13721 template takes care of all these
13722 \begin_inset Quotes eld
13726 \begin_inset Quotes erd
13730 If you start a new paper using this template you don't need to do anything
13735 \begin_layout Enumerate
13736 don't delete the \SpecialChar TeX
13737 code included in the template, and
13740 \begin_layout Enumerate
13741 copy the example bibliography item included in the template and modify it
13742 as necessary to enter new bibliography items.
13745 \begin_layout Section
13749 \begin_layout Standard
13755 \begin_layout Subsection
13759 \begin_layout Standard
13760 The \SpecialChar LyX
13763 article (koma-script)
13767 report (koma-script)
13785 correspond to the \SpecialChar LaTeX
13803 \begin_inset space ~
13806 of the Koma-Script family.
13807 They are replacements for the standard document classes
13823 , resp., and fit better to European typography conventions in a number of
13827 \begin_layout Itemize
13828 Standard character size is 11pt in
13830 article (koma-script)
13834 report (koma-script)
13842 letter (koma-script)
13847 \begin_layout Itemize
13848 Headings, labels of the description environment, and a number of elements
13851 letter (koma-script)
13853 document class are set in a bold sans serif font.
13857 \begin_layout Plain Layout
13858 There is a big difference between the bold sans serif old cm fonts and new
13859 ec fonts, especially in the appearance of headings.
13860 In comparison, the ec bold sans serif fonts look a bit thin.
13861 Here the \SpecialChar LaTeX
13870 helps to produce the
13871 \begin_inset Quotes eld
13875 \begin_inset Quotes erd
13878 appearance when using the ec fonts.
13883 The numbering of chapter headings is made in the same way as the numbering
13884 of section headings, that is without the extra line
13885 \begin_inset Quotes eld
13888 Chapter\SpecialChar ldots
13890 \begin_inset Quotes erd
13894 In addition, the appearance of the headings can be modified by using a
13895 number of options (in \SpecialChar LyX
13896 to be entered in the field
13899 \begin_inset space ~
13906 Layout\SpecialChar menuseparator
13913 \begin_layout Itemize
13914 The main means in the Koma-Script document classes to design the type area
13923 (in \SpecialChar LyX
13924 to be entered in the extra class options field in the dialog
13926 Document\SpecialChar menuseparator
13930 They make a clearer modification of page margins possible as do the options
13933 Document\SpecialChar menuseparator
13940 \begin_layout Itemize
13941 The \SpecialChar LaTeX
13942 document classes of the Koma-Script family define a number of additional
13944 Those part of it which makes sense in \SpecialChar LyX
13945 is implemented in corresponding
13949 \begin_layout Standard
13950 Detailed descriptions of the \SpecialChar LaTeX
13951 document classes of the Koma-Script family
13952 can be found in the Koma-Script documentation
13963 \begin_layout Subsection
13964 article (koma-script), report (koma-script), and book (koma-script)
13967 \begin_layout Standard
13968 The document classes
13970 article (koma-script)
13974 report (koma-script)
13984 are implemented in the layout files
13997 They contain all the paragraph types of the corresponding standard document
14010 , resp., partly modified, with the exception of the \SpecialChar LyX
14015 -type, which is replaced by the new
14019 -type having the same functionality.
14024 -Type there is a number of new paragraph types added.
14031 letter (koma-script)
14036 \begin_layout Itemize
14045 : are equivalents to
14053 , resp., additionally inserting an entry in the table of contents.
14062 are not contained in
14064 article (koma-script)
14069 \begin_layout Itemize
14078 : behave exactly as
14086 , resp., additionally clearing running heads.
14091 is not contained in
14093 article (koma-script)
14099 \begin_layout Plain Layout
14112 report (koma-script)
14114 , but since this is identical to
14118 , is has not been implemented in \SpecialChar LyX
14127 \begin_layout Itemize
14132 : generates a heading directly above the following paragraph in the standard
14133 character size without affecting the structure of the document.
14136 \begin_layout Itemize
14145 are special captions which respect the different space settings needed
14146 for captions placed above or below an element (if you follow strict typographic
14147 rules, you might want to place table captions always above the table).
14148 You can also use the class option
14152 , which will switch
14165 You need at least Koma-Script version 2.8q to use this.
14168 \begin_layout Itemize
14173 : can be used to set a bonmot, e.
14174 \begin_inset space \thinspace{}
14178 \begin_inset space \space{}
14181 at the beginning of a chapter.
14182 If you use the optional argument (
14184 Insert\SpecialChar menuseparator
14186 \begin_inset space ~
14191 ), you can insert the dictum's author there.
14192 Dictum and author are separated by a line.
14193 You need at least Koma-Script version 2.8q to use this.
14198 is not contained in
14200 article (koma-script)
14205 \begin_layout Standard
14206 The following types, together with the standard types
14218 , form the title area of the document.
14219 They must be entered ahead of the first
14220 \begin_inset Quotes eld
14224 \begin_inset Quotes erd
14231 \begin_layout Plain Layout
14232 The corresponding \SpecialChar LaTeX
14233 commands must appear before the
14244 When such a type is used more than once, the latter usage overwrites the
14245 former one, that means, for every type only the latest usage is valid.
14246 The order of the different types however has, like
14258 , no effect on the appearance of the produced document.
14261 \begin_layout Itemize
14266 : produces a centered paragraph above the ordinary title (
14278 ) for the subject of the document.
14281 \begin_layout Itemize
14286 : produces a centered paragraph below the ordinary title (
14298 ) for the publishers' name.
14301 \begin_layout Itemize
14308 report (koma-script)
14314 produces a centered paragraph on its own page behind the title page, or
14317 article (koma-script)
14319 produces a centered paragraph below the ordinary title (
14335 ) for a dedication.
14338 \begin_layout Itemize
14343 : produces a left aligned paragraph above the ordinary title (
14359 ) for a document`s head.
14362 \begin_layout Itemize
14367 : produces in a double-sided print in
14369 report (koma-script)
14375 a left-aligned paragraph at the top of the title page`s back or has no
14376 effect in a single-sided print or in
14378 article (koma-script)
14383 \begin_layout Itemize
14388 : produces in a double-sided print in
14390 report (koma-script)
14396 a left-aligned paragraph at the bottom of the title page`s back or has
14397 no effect in a single-sided print or in
14399 article (koma-script)
14404 \begin_layout Itemize
14409 : produces a special
14410 \begin_inset Quotes eld
14414 \begin_inset Quotes erd
14417 page ahead of the actual document containing a paragraph without special
14421 \begin_layout Standard
14422 The layout files for the document classes
14424 article (koma-script)
14428 report (koma-script)
14434 do include the file
14439 This is thought of as a place to define your own types.
14444 in your personal layout directory and edit the file!
14447 \begin_layout Subsection
14448 letter (koma-script)
14451 \begin_layout Description
14452 Note: This section discusses the obsolete
14454 KOMA-Script-Letter (v.
14455 \begin_inset space ~
14460 , which is not even included anymore in recent KOMA releases.
14461 Please refer to the next section for the current KOMA-Script-Letter class
14463 \begin_inset space ~
14469 \begin_layout Standard
14473 letter (koma-script)
14475 is implemented in the layout file
14480 It contains all the paragraph types of the corresponding standard document
14485 , partly modified, with the exception of the \SpecialChar LyX
14499 type, which is replaced by the new
14504 In addition, it contains, in contrast to the standard document class, the
14523 Furthermore, there are a number of new letter specific types.
14526 \begin_layout Standard
14527 The appearance of the letter produced by this document class can be controlled
14528 by a number of \SpecialChar LaTeX
14529 commands, which you can put in the \SpecialChar LaTeX
14534 \begin_layout Plain Layout
14535 For example, the standard appearance of the letter`s heading, consisting
14536 of name and address, is quite self-willed.
14538 \begin_inset Quotes eld
14542 \begin_inset Quotes erd
14545 heading is produced by the following \SpecialChar LaTeX
14546 commands in the preamble:
14549 \begin_layout LyX-Code
14559 \begin_layout LyX-Code
14575 \begin_layout LyX-Code
14585 \begin_layout LyX-Code
14605 A detailed German description of such \SpecialChar LaTeX
14606 commands can be found in the Koma-Script
14612 With it, the letter's author can produce his personal letter layout.
14615 \begin_layout Standard
14624 define the beginning of the letter and must be used in every letter.
14625 To emphasize them in the \SpecialChar LyX
14626 document class, they are marked with the letter
14636 \begin_inset space ~
14639 in the left margin.
14640 It is possible to write any number of letters in one file.
14645 type produces a new letter using the same addressee and a
14649 type produces a new addressee.
14666 are ordinary paragraph types and can also be used several times in one
14667 and the same letter.
14670 \begin_layout Itemize
14675 : produces a paragraph for the addressee and implicitly defines the beginning
14679 \begin_layout Itemize
14684 : produces a paragraph for the form of address and implicitly produces a
14688 \begin_layout Itemize
14693 : produces a paragraph for a close.
14696 \begin_layout Itemize
14701 : produces a paragraph for a postscript.
14704 \begin_layout Itemize
14709 : produces a paragraph for a distribution list.
14712 \begin_layout Itemize
14717 : produces a paragraph for enclosures.
14720 \begin_layout Standard
14761 are input types provided with a label to enter information, which will
14762 be processed by the document class.
14766 \begin_layout Plain Layout
14767 It could be seen as a matter of inconsequence, that the types
14775 described above are not such input types as well.
14776 Because of the special meaning of those types, however, I have implemented
14777 them as ordinary paragraph types with a one letter mark in the left margin.
14778 Moreover, it would affect my feeling of symmetry, if the
14786 type had such a serious different appearance.
14791 The types must be used ahead of the corresponding
14798 \begin_layout Standard
14799 An implementation of these types in a WYSIWYG fashion does not seem to make
14800 sense, because the real appearance of the produced letter does not only
14801 depend on the usage of the particular type, but also on other factors.
14802 For example, a signature entered in the
14806 type will in the standard behavior appear in the produced letter only,
14807 when in the same letter also a
14812 The entered value of the
14816 type will in the standard behavior not appear in the produced letter at
14818 The possibility to design the letter`s heading freely is already indicated
14819 in a footnote above.
14822 \begin_layout Standard
14823 The input types can also be used as empty paragraphs.
14824 This makes sense e.
14825 \begin_inset space \thinspace{}
14829 \begin_inset space \space{}
14841 type is not used at all, in the standard behavior the value of the
14845 type is used as signature, whereas if an empty
14849 type is used, no signature value is defined.
14852 \begin_layout Standard
14853 By using the input types it is possible to write a letter template, containing
14854 filled input types with your personal dates (name, address, etc.) and empty
14855 input types for other dates you want to enter.
14858 \begin_layout Itemize
14863 : sender's name, in the standard behavior appears as a centered paragraph
14864 in small caps in the letter`s heading.
14867 \begin_layout Itemize
14872 : sender's signature, in the standard behavior appears below the
14881 type is used, the value of the
14885 type appears instead.
14888 \begin_layout Itemize
14893 : sender's address, in the standard behavior appears in a centered paragraph
14894 in the letter`s heading below the sender's name.
14897 \begin_layout Itemize
14902 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
14913 \begin_layout Itemize
14918 : place of the letter`s making.
14921 \begin_layout Itemize
14926 : date of the letter`s making.
14935 , in the standard behavior, produce the place and the date in a right-aligned
14936 line below the addressee's field.
14941 type is used, neither place nor date appear, independent of the value of
14951 type is used, the date of the letter `s production is used.
14954 \begin_layout Itemize
14959 : sender`s back address, in the standard behavior appears above the addressee's
14960 field in a small sans serif font.
14963 \begin_layout Itemize
14968 : special mail information, in the standard behavior appears underlined
14969 above the addressee's field below the back address.
14972 \begin_layout Itemize
14977 : additional information, in the standard behavior appears on right side
14978 below the addressee`s field.
14981 \begin_layout Itemize
14986 : the letter's title, in the standard behavior appears in a big, bold, sans
14987 serif font above the subject.
14990 \begin_layout Itemize
14995 : the letter's subject, in the standard behavior appears in a bold font
15003 \begin_layout Standard
15024 produce a business letter like line above the
15028 line containing the fields
15029 \begin_inset Quotes eld
15033 \begin_inset Quotes erd
15037 \begin_inset Quotes eld
15041 \begin_inset Quotes erd
15045 \begin_inset Quotes eld
15049 \begin_inset Quotes erd
15053 \begin_inset Quotes eld
15057 \begin_inset Quotes erd
15061 \begin_inset Quotes eld
15065 \begin_inset Quotes erd
15069 \begin_inset Quotes eld
15073 \begin_inset Quotes erd
15077 For the date field, the value of the
15083 \begin_inset Quotes eld
15086 business letter types
15087 \begin_inset Quotes erd
15090 is used, the value of the
15094 type however does not appear, but only the \SpecialChar LaTeX
15102 The ordinary output of place and date in a right-aligned line below the
15103 addressee`s field is suppressed.
15104 The types are implemented as input types provided with a label and must
15105 be used ahead of the corresponding
15112 \begin_layout Itemize
15120 \begin_layout Itemize
15128 \begin_layout Itemize
15136 \begin_layout Itemize
15144 \begin_layout Itemize
15152 \begin_layout Subsection
15153 The new letter class: letter (koma-script v.2)
15156 \begin_layout Standard
15162 \begin_layout Standard
15163 \begin_inset VSpace medskip
15169 \begin_layout Standard
15171 Koma-Script version 2.8 has introduced a new letter class
15175 which supersedes the now unsupported
15180 It has — on the \SpecialChar LaTeX
15181 side — a completely new interface and is not compatible
15182 with the old class.
15183 Therefore, \SpecialChar LyX
15184 supports both, though it is recommended you use the new class.
15187 \begin_layout Standard
15188 This class covers the same functionality as
15190 letter (koma-script),
15193 The basic items are
15197 (receiver's address, same as
15201 in the old layout),
15214 will start a new letter (i.
15215 \begin_inset space \thinspace{}
15219 \begin_inset space \space{}
15222 you can write several letters per document).
15223 New elements are sender's
15239 and the possibility to use a
15245 Insert\SpecialChar menuseparator
15251 \begin_layout Standard
15252 The biggest improvement is, though, that the letter's layout is configurable
15253 to meet almost any needs.
15254 This can be done via the preamble or with a special style file (Letter
15255 Class Option, extension
15259 ), that will be read in as a class option.
15263 \begin_layout Plain Layout
15264 The KOMA package comes with some default
15269 There is, for instance, a
15273 file that follows german typesetting rules, or a
15277 that provides the default layout of the old
15282 The latter can be loaded with the class option
15288 Layout\SpecialChar menuseparator
15289 Document\SpecialChar menuseparator
15301 template that is included in \SpecialChar LyX
15303 A detailed description is to be found in the Koma-Script documentation
15311 \begin_layout Subsection
15315 \begin_layout Standard
15316 Visualizing the Koma-Script document classes in \SpecialChar LyX
15317 , the \SpecialChar LyX
15318 internals cause some
15322 \begin_layout Itemize
15323 The chapter number of a
15327 type appears on a line of its own above the chapter heading instead of
15328 appearing in the same line ahead of it.
15329 The cause for that is the \SpecialChar LyX
15330 internal behavior for the labeltype
15334 in the layout file.
15337 \begin_layout Itemize
15338 The headings of the types
15346 are only put in the
15347 \begin_inset Quotes eld
15351 \begin_inset Quotes erd
15355 table of contents, but not in the \SpecialChar LyX
15356 table of contents (
15358 Document\SpecialChar menuseparator
15360 \begin_inset space ~
15364 \begin_inset space ~
15372 \begin_layout Itemize
15373 The paragraphs in a
15377 document class appear in a skip separation mode, not indented.
15378 This is the standard behavior, no special \SpecialChar LaTeX
15379 commands are needed for that.
15382 Document\SpecialChar menuseparator
15385 dialog the corresponding radio button indicates
15394 value always has the effect that extra \SpecialChar LaTeX
15395 commands are inserted in the document
15396 to produce the gap, which is not what is wanted in this case.
15399 \begin_layout Section
15403 \begin_layout Standard
15409 \begin_layout Subsection
15413 \begin_layout Standard
15414 Memoir is a very powerful and constantly evolving class.
15415 It has been designed with regard to fictional and non-fictional literature.
15416 Its aim is to let the user have maximum control over the typesetting of
15418 Memoir is based on the standard book class, but it can also emulate the
15419 article class (see below).
15422 \begin_layout Standard
15423 Peter Wilson, the developer of Memoir, is known as the author of lots of
15424 useful packages in the \SpecialChar LaTeX
15426 Most of them have been merged with Memoir.
15427 Therefore, it is much easier to layout the table of contents, appendices,
15428 chapter designs and such.
15430 , though, does not support all of these goodies natively.
15431 Some of them might be added to forthcoming releases
15435 \begin_layout Plain Layout
15436 You are invited to send suggestions to
15437 \begin_inset Flex URL
15440 \begin_layout Plain Layout
15442 lyx-devel@lists.lyx.org
15452 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
15454 Of course you can still use all features with the help of some native \SpecialChar LaTeX
15456 commands (\SpecialChar TeX
15461 \begin_layout Plain Layout
15466 \begin_layout Plain Layout
15476 \begin_inset space ~
15480 \begin_inset CommandInset ref
15482 reference "sec:Inserting-TeX-Code"
15492 In this section, we can only list those features that are natively supported
15493 by \SpecialChar LyX
15495 For detailed descriptions (and for the rest of features) we recommend you
15496 have a look at the detailed manual of the Memoir class
15500 \begin_layout Plain Layout
15505 \begin_layout Plain Layout
15515 \begin_inset Flex URL
15518 \begin_layout Plain Layout
15520 CTAN:/macros/latex/memoir/memman.pdf
15530 , which is not only a user guide for the class, but also both a comprehensive
15531 description on good typesetting and a superb example for good typesetting
15535 \begin_layout Subsection
15536 Basic features and restrictions
15539 \begin_layout Standard
15540 Memoir supports basically all features of the standard book classes.
15541 There are, however, some differences, as follows:
15544 \begin_layout Description
15546 \begin_inset space ~
15549 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
15552 \begin_layout Description
15554 \begin_inset space ~
15557 style: The fancy page style is not supported, due to a command clash between
15558 Memoir and the fancyhdr package (they both define a command with the same
15559 name, which confuses \SpecialChar LaTeX
15561 Instead, Memoir comes with a number of its own page styles (see
15563 Document\SpecialChar menuseparator
15564 Settings\SpecialChar menuseparator
15566 \begin_inset space ~
15572 If you want to use these for the chapter pages, you have to use the command
15579 in the main text or in preamble (e.
15580 \begin_inset space \thinspace{}
15584 \begin_inset space \space{}
15591 chapterstyle{companion}
15596 \begin_layout Description
15597 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
15598 optional argument in the standard classes.
15599 With this, you can specify an alternative version of the title for the
15600 table of contents and the headers (for instance, if the title is too long).
15601 In \SpecialChar LyX
15602 , you can do this via
15604 Insert\SpecialChar menuseparator
15606 \begin_inset space ~
15611 at the beginning of a chapter/section.
15612 Memoir features a second optional argument and thus separates the table
15613 of contents from the header.
15614 You can define three variants of a title with this: one for the main text,
15615 one for the table of contents, and one for the headers.
15617 makes these available in form of specific
15628 \begin_layout Description
15629 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
15630 of contents, the list of figures and the list of table start a new page
15632 Memoir does not follow this route.
15633 You have to insert a page break yourself, if you want to have one.
15636 \begin_layout Description
15637 Titlepage: For some unknown reason, Memoir uses pagination on the title
15638 page (in the standard classes, title pages are
15639 \begin_inset Quotes eld
15643 \begin_inset Quotes erd
15647 If you want an empty title page, type
15651 aliaspagestyle{title}{empty}
15656 \begin_layout Description
15657 Article: With the class option
15663 Document\SpecialChar menuseparator
15664 Settings\SpecialChar menuseparator
15665 Class Settings\SpecialChar menuseparator
15667 \begin_inset space ~
15672 ), you can emulate article style.
15673 That is, counters (footnotes, figures, tables etc.) will not be reset on
15674 new chapters, chapters don't start a new page (but are—in contrary to
15675 \begin_inset Quotes eld
15679 \begin_inset Quotes erd
15682 article classes—still allowed), parts, though, use their own page, as in
15686 \begin_layout Description
15687 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
15688 font commands, which have been used in the old \SpecialChar LaTeX
15690 \begin_inset space \thinspace{}
15694 \begin_inset space \space{}
15710 It produces an error and stops \SpecialChar LaTeX
15711 whenever such a command appears.
15716 reallows the commands and spits out warnings instead (which does at least
15717 not stop \SpecialChar LaTeX
15719 Since a lot of packages and particularly Bib\SpecialChar TeX
15720 style files are still using
15721 those commands, we have decided to use this option by default.
15724 \begin_layout Subsection
15728 \begin_layout Standard
15729 We will only describe the features supported by \SpecialChar LyX
15730 (which is not much currently).
15731 Please consult the Memoir manual
15735 \begin_layout Plain Layout
15740 \begin_layout Plain Layout
15750 \begin_inset Flex URL
15753 \begin_layout Plain Layout
15755 CTAN:/macros/latex/memoir/memman.pdf
15768 \begin_layout Description
15769 Abstract: You may wonder why an abstract is an extra feature.
15770 Well, it is in book class.
15771 Usually books don't have abstracts.
15772 Memoir, however, has.
15773 You can use it wherever and how often you like.
15776 \begin_layout Description
15777 Chapterprecis: You may know this older typesetting style: The contents of
15778 a chapter are summarized below the title and also in the table of contents
15780 \begin_inset space \thinspace{}
15784 \begin_inset space \space{}
15789 Our hero arrives in Troia; he loses some friends; he finds others
15792 Chapterprecis does exactly this.
15793 It is therefore only sensible below a chapter.
15796 \begin_layout Description
15797 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
15798 The epigraph environment provides an elegant way of typesetting such a
15800 The motto itself (text) and its (optional) author (source) are divided
15802 The author (source) can be inserted via
15804 Insert\SpecialChar menuseparator
15811 \begin_layout Description
15812 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
15813 complex figurative poems).
15815 can only support a few of them.
15816 One is poemtitle, which is a centered title for poems, which will also
15817 be added to the table of contents (verse is the standard environment for
15819 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
15821 because they have to be nested inside regular verse environments, which
15822 is not possible with \SpecialChar LyX
15826 \begin_layout Description
15827 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
15830 \begin_layout Section
15831 Article (mwart), book (mwbk) and report (mwrep)
15832 \begin_inset Argument status
15835 \begin_layout Plain Layout
15848 \begin_layout Standard
15854 \begin_layout Standard
15855 The \SpecialChar LyX
15872 correspond to the \SpecialChar LaTeX
15886 They are replacements for the standard document classes
15898 , resp., and fit better to Polish typography conventions in a number of points.
15902 \begin_layout Standard
15906 \begin_layout Itemize
15907 Unnumbered titles (with star, e.
15908 \begin_inset space \thinspace{}
15912 \begin_inset space \space{}
15919 ) are added into table of contents,
15922 \begin_layout Itemize
15923 Additional page styles:
15927 \begin_layout Description
15928 uheadings header with separated lines,
15931 \begin_layout Description
15932 myheadings custom header, contents headers via commands:
15947 \begin_layout Description
15948 myuheadings custom header with separated lines,
15951 \begin_layout Description
15952 outer page number is placed on outer side of page
15956 \begin_layout Itemize
15961 \begin_layout Description
15962 rmheadings serif titles — default,
15965 \begin_layout Description
15966 sfheadings sansserif titles,
15969 \begin_layout Description
15970 authortitle on title page first placed is author next title — default,
15973 \begin_layout Description
15974 titleauthor on title page first placed is title next author,
15977 \begin_layout Description
15978 withmarginpar reserve place on page for margins.
15982 \begin_layout Section
15986 \begin_layout Standard
15991 provides an alternative to the standard
15996 It provides similar functionality, but you might prefer this layout with
15997 sans serif sections, headings, and more.
16000 \begin_layout Section
16001 Rev\SpecialChar TeX
16005 \begin_layout Standard
16011 \begin_layout Standard
16012 \begin_inset VSpace bigskip
16018 \begin_layout Standard
16023 \begin_inset space ~
16028 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
16030 \begin_inset Formula $\beta$
16033 release of May, 1999) class.
16036 \begin_layout Standard
16042 textclass, which works with Rev\SpecialChar TeX
16044 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
16046 That means that it doesn't interact very well with \SpecialChar LyX
16047 , which requires \SpecialChar LaTeX2e
16049 it has been kludged to work.
16050 Since Rev\SpecialChar TeX
16051 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
16056 Rev\SpecialChar TeX
16058 \begin_inset space ~
16063 textclass should also be pretty easy to use.
16066 \begin_layout Standard
16067 These documents are supposed to be used in
16071 to the Rev\SpecialChar TeX
16072 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
16074 and assume you'll know what to put in the preamble if necessary.
16077 \begin_layout Subsection
16081 \begin_layout Standard
16082 All you need to do is install Rev\SpecialChar TeX
16083 4, as described in the package's README
16085 The package can be found at The Rev\SpecialChar TeX
16087 \begin_inset Flex URL
16090 \begin_layout Plain Layout
16092 http://publish.aps.org/revtex4/
16098 Install it somewhere that \SpecialChar LaTeX
16100 Test it by trying to \SpecialChar LaTeX
16101 a short Rev\SpecialChar TeX
16102 4 document in some random directory (i.
16103 \begin_inset space \thinspace{}
16107 \begin_inset space \space{}
16110 not the directory where you installed the class file.) Then, if you reconfigure
16112 , it will find the class file and let you use the Rev\SpecialChar TeX
16116 \begin_layout Standard
16117 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
16126 \begin_inset space ~
16131 template, found in the templates directory.
16134 \begin_layout Subsection
16138 \begin_layout Standard
16139 Optional arguments to
16146 \begin_inset Quotes eld
16150 \begin_inset Quotes erd
16154 \begin_inset Quotes eld
16158 \begin_inset Quotes erd
16164 \begin_inset space ~
16172 \begin_inset space ~
16178 Remember that in Rev\SpecialChar TeX
16179 , at least one optional argument is required!
16182 \begin_layout Standard
16183 Other preamble matter, like
16190 \begin_inset space ~
16197 \begin_inset space ~
16202 dialog, also as usual.
16205 \begin_layout Subsection
16209 \begin_layout Standard
16210 The layouts basically correspond to the commands in Rev\SpecialChar TeX
16212 For example, the Email layout corresponds to
16219 Note that (at least as of Rev\SpecialChar TeX
16228 layouts are exactly equivalent, so you shouldn't need to use both.
16232 \begin_layout Plain Layout
16233 In case you're curious, both were included so that
16237 would be able to translate both
16257 \begin_layout Subsection
16261 \begin_layout Standard
16262 There are a couple of important unique aspects of Rev\SpecialChar TeX
16263 4 which might cause
16264 bugs that will be even more confusing in \SpecialChar LyX
16268 \begin_layout Standard
16269 In Rev\SpecialChar TeX
16287 The \SpecialChar LyX
16288 equivalent is that there is a separate Thanks layout.
16293 write footnotes in the
16297 layout, or weird things may happen.
16298 See the Rev\SpecialChar TeX
16299 4 documentation for more details.
16302 \begin_layout Standard
16306 \begin_inset space ~
16314 \begin_inset space ~
16323 layouts must be placed
16331 layout and the corresponding
16348 , the \SpecialChar LaTeX
16352 \begin_layout Section
16353 Springer Journals (
16360 \begin_layout Standard
16366 \begin_layout Subsection
16370 \begin_layout Standard
16371 These are the layout files for some of the journal formats used by Springer
16372 Verlag and listed on
16373 \begin_inset Flex URL
16376 \begin_layout Plain Layout
16378 http://www.springer.de/author/tex/help-journals.html
16383 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
16385 It is a modular system: the things common to all journals are implemented
16390 , which journal-specific layout files (such as, e.
16391 \begin_inset space \thinspace{}
16395 \begin_inset space \space{}
16402 for Journal of Geodesy) can include.
16405 \begin_layout Standard
16406 This means that implementing support for any other Springer journal on this
16407 list is as simple as writing your own
16415 file following the outline given in
16423 \begin_layout Standard
16424 It is reasonably well tested only for the Journal of Geodesy.
16433 come with the standard \SpecialChar LyX
16435 Install the relevant class file (downloaded from Springer) in a proper
16436 directory, reconfigure \SpecialChar LaTeX
16437 (in the te\SpecialChar TeX
16442 , as root if necessary — doesn't \SpecialChar LyX
16443 take care of this?), reconfigure \SpecialChar LyX
16448 \begin_layout Subsection
16452 \begin_layout Standard
16453 A large number of theorem-like styles —
16465 \begin_layout Standard
16468 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
16469 _Title, Author_Running, Institute,
16470 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
16473 See the Springer class file documentation for details.
16476 \begin_layout Subsection
16480 \begin_layout Itemize
16492 \begin_layout Itemize
16495 Probability Theory and Related Fields
16501 — Jean-Marc Lasgouttes
16504 \begin_layout Standard
16505 Add your own, it isn't so hard!
16508 \begin_layout Subsection
16512 \begin_layout Standard
16513 These files are partly based on the older
16517 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
16519 file from Springer.
16524 layout, are now defunct.
16525 Jean-Marc Lasgouttes helped out big in making me find my way around the
16527 layout file mechanism.
16530 \begin_layout Subsection
16534 \begin_layout Standard
16536 But probably less than in the old hacked-\SpecialChar LaTeX
16544 \begin_layout Section
16547 Sli\SpecialChar TeX
16551 \begin_inset CommandInset label
16560 \begin_layout Standard
16568 \begin_layout Subsection
16572 \begin_layout Standard
16573 This section describes how to use \SpecialChar LyX
16574 to make slides for overhead projectors.
16575 There are two document classes that can do this: the default slides class
16578 Foil\SpecialChar TeX
16582 This section documents the former.
16585 \begin_layout Standard
16586 I'm going to say this again, nice and clear, so that there's no misunderstanding
16590 \begin_layout Standard
16591 \begin_inset VSpace bigskip
16597 \begin_layout Standard
16601 This section documents the class
16602 \begin_inset Quotes eld
16610 \begin_inset Quotes erd
16618 \begin_layout Standard
16619 \begin_inset VSpace bigskip
16625 \begin_layout Standard
16626 If you're looking for the documentation for
16627 \begin_inset Quotes eld
16632 slides (Foil\SpecialChar TeX
16636 \begin_inset Quotes erd
16639 , check out section
16640 \begin_inset space ~
16644 \begin_inset CommandInset ref
16646 reference "sec:foiltex"
16656 \begin_inset Quotes eld
16661 slides (Foil\SpecialChar TeX
16665 \begin_inset Quotes erd
16668 ] is actually somewhat better than the default
16676 \begin_layout Plain Layout
16678 or so I've been told repeatedly by its advocates.
16679 Having never used it, I have no idea if this claim is true or not.
16684 which this section documents.
16687 \begin_layout Standard
16688 This class is the \SpecialChar LaTeX2e
16689 improvement of the old
16691 Sli\SpecialChar TeX
16695 Every \SpecialChar LaTeX2e
16696 distribution includes this class [which I'll just refer to as
16697 \begin_inset Quotes eld
16705 \begin_inset Quotes erd
16708 from now on], so you're bound to have it.
16709 As I noted earlier, there are other classes, such as
16713 , which also produce slides for overhead projectors and do a better job
16715 However, there are some things which
16719 can do which the others can't, such as generate overlays.
16720 Read on to learn more!
16723 \begin_layout Subsection
16725 \begin_inset CommandInset label
16727 name "sec:slidesetup"
16734 \begin_layout Standard
16735 Obviously, to use this document class, you need to select
16736 \begin_inset Quotes eld
16744 \begin_inset Quotes erd
16747 from the class list in the
16749 Document\SpecialChar menuseparator
16753 There are some other special things you should know about this class:
16756 \begin_layout Itemize
16757 Don't bother changing the options
16762 They're not supported by the
16769 \begin_layout Itemize
16773 \begin_inset space ~
16778 behaves a bit differently for this class.
16779 The possible choices and what they do are as follows:
16783 \begin_layout Description
16788 The final output contains page numbers in the lower right corner.
16791 \begin_layout Description
16800 , but also prints out any time markers you've put in.
16801 This is the default.
16804 \begin_layout Description
16809 The final output contains no page numbers, time markers, or alignment markers.
16813 \begin_layout Itemize
16818 class has an extra option:
16824 \begin_inset Quotes eld
16832 \begin_inset Quotes erd
16835 in the extra class options.
16839 \begin_layout Standard
16840 Using this options allows you to add time markers to
16846 \begin_inset space ~
16850 \begin_inset CommandInset ref
16852 reference "sec:slideNote"
16860 \begin_layout Standard
16861 You can also use the template file
16862 \begin_inset Quotes eld
16870 \begin_inset Quotes erd
16873 to automatically set up a document to use the
16879 File\SpecialChar menuseparator
16881 \begin_inset space ~
16885 \begin_inset space ~
16890 to open your new document].
16891 The template file also contains some examples of the special paragraph
16892 environments used by this class.
16893 I'll describe those next.
16896 \begin_layout Subsection
16897 Paragraph Environments
16900 \begin_layout Subsubsection
16901 Supported Environments
16904 \begin_layout Standard
16905 The first thing you'll notice when you start up a new
16909 document is the font size and type: it's the equivalent of the size
16910 \begin_inset Quotes eld
16918 \begin_inset Quotes erd
16924 \begin_inset space ~
16930 This is also what's used in the output.
16932 \begin_inset Quotes eld
16936 \begin_inset Quotes erd
16939 to remind you that this is a slide.
16940 Your final slides will use a larger font; ergo, you'll have less space.
16941 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
16944 \begin_layout Standard
16945 The next thing that becomes obvious is the changes to the paragraph environment
16946 pull-down box [at the far-left end of the toolbar].
16947 Most of the paragraph environments you're used to seeing are missing.
16948 There are also five new ones.
16953 class itself only supports certain paragraph environments:
16956 \begin_layout Itemize
16962 \begin_layout Itemize
16968 \begin_layout Itemize
16974 \begin_layout Itemize
16980 \begin_layout Itemize
16986 \begin_layout Itemize
16992 \begin_layout Itemize
16998 \begin_layout Itemize
17004 \begin_layout Itemize
17010 \begin_layout Itemize
17017 \begin_layout Standard
17018 All of the other standard environments, including the section-heading environmen
17019 ts, aren't used in the
17026 \begin_layout Standard
17027 On the other hand, you'll notice the following new environments:
17030 \begin_layout Itemize
17036 \begin_layout Itemize
17042 \begin_layout Itemize
17048 \begin_layout Itemize
17054 \begin_layout Itemize
17060 \begin_layout Standard
17061 These five are kind of quirky, due to a
17062 \begin_inset Quotes eld
17066 \begin_inset Quotes erd
17069 in \SpecialChar LyX
17071 You see, \SpecialChar LyX
17072 doesn't permit you to nest any other paragraph environment into
17073 an empty environment.
17074 Now, that's fine and dandy, but it means that you wouldn't be able to start
17075 a slide with anything except plain text.
17076 To deal with this, I've performed a little
17077 \begin_inset Quotes eld
17082 \begin_inset Quotes erd
17088 \begin_layout Subsubsection
17089 Quirks of the New Environments
17090 \begin_inset CommandInset label
17092 name "sec:slideQuirk"
17099 \begin_layout Standard
17100 All five of the new paragraph environments are somewhat quirky due to inherent
17101 limitiations in the current version of \SpecialChar LyX
17103 As I just mentioned, \SpecialChar LyX
17104 forbids environments that begin with another environment.
17105 To get around this, the
17109 environment isn't a paragraph environment as described in the
17117 \begin_layout Standard
17118 You should consider
17131 \begin_inset Quotes eld
17134 pseudo-environments.
17135 \begin_inset Quotes erd
17138 They look like a section heading or a
17139 \begin_inset Quotes eld
17147 \begin_inset Quotes erd
17150 but really begin a [and, if necessary, end the previous] paragraph environment.
17160 \begin_inset Quotes eld
17164 \begin_inset Quotes erd
17167 These two perform some action.
17170 \begin_layout Standard
17171 A common feature of all five environments,
17191 , is a rather long-ish label.
17192 The text following this label — ordinarily the contents of the paragraph
17193 environment — is utterly irrelevant for
17215 completely ignores it.
17216 In fact, you can leave these five environments completely empty.
17220 \begin_layout Standard
17225 to put any text after the rather long-ish label, you might want to.
17226 This could be a short description of the contents of the
17231 In that case, enter your descriptive comment and hit
17235 as you normally would.
17238 \begin_layout Standard
17239 If, on the other hand, you don't want to enter any descriptive text, you'll
17240 hit another \SpecialChar LyX
17243 , like nature, abhors a vacuum, and will not let you start a new paragraph
17244 environment until you put something in the old one.
17248 \begin_layout Itemize
17249 Start entering the text that will
17277 \begin_layout Itemize
17278 Now move to the beginning of that paragraph.
17282 \begin_layout Itemize
17291 \begin_layout Itemize
17292 Finally, change this new, empty paragraph to a
17316 \begin_layout Standard
17317 Some future version of \SpecialChar LyX
17318 will, hopefully, resolve this quirkiness\SpecialChar ldots
17322 \begin_layout Subsection
17323 Making a Presentation with
17336 \begin_layout Subsubsection
17344 \begin_layout Standard
17345 If you're expecting this section to teach you how to actually make a presentatio
17346 n, you'll be sorely disappointed.
17347 Naturally, I'll describe all of the ways the
17351 class can assist you in preparing the materials for a presentation.
17352 Filling in the contents, however, is up to you.
17357 the \SpecialChar LyX
17361 \begin_layout Standard
17366 environment [in the manner described in section
17367 \begin_inset space ~
17371 \begin_inset CommandInset ref
17373 reference "sec:slideQuirk"
17377 ] tells \SpecialChar LyX
17378 to begin a new slide [duh].
17379 The label for this environment/
17380 \begin_inset Quotes erd
17384 \begin_inset Quotes erd
17388 \begin_inset Quotes eld
17392 \begin_inset Quotes erd
17395 in cool blue, followed by the label,
17396 \begin_inset Quotes eld
17400 \begin_inset Quotes erd
17404 Any text or paragraph environments that follow this one go on the new slide.
17408 \begin_layout Standard
17409 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
17411 (this can be specified in the
17416 In fact, you'll want to, once you finish entering the contents of one slide.
17417 If you've entered more text than can physically fit on a slide, the extra
17418 overflows onto a new slide.
17419 I don't recommend doing this, however, since the overflow slide won't have
17420 any page number on it.
17421 Furthermore, it may interfere with any
17425 you've made to accompany the oversized
17432 \begin_layout Standard
17441 environments work the same way as the
17446 They both create an
17447 \begin_inset Quotes eld
17451 \begin_inset Quotes erd
17454 followed by a label [
17455 \begin_inset Quotes eld
17459 \begin_inset Quotes erd
17463 \begin_inset Quotes eld
17467 \begin_inset Quotes erd
17471 The color is a stunning magenta instead of blue, and the
17472 \begin_inset Quotes eld
17476 \begin_inset Quotes erd
17479 will look different, in style and in length.
17480 The label fonts of all three also differ from one another.
17483 \begin_layout Standard
17488 , if the contents of a
17496 exceed the physical size of a slide or sheet of paper, the extra will overflow
17498 Again, you should avoid this.
17499 It defeats the whole purpose of
17510 \begin_layout Subsubsection
17520 \begin_layout Standard
17525 is a slide that sits atop another slide.
17526 Perhaps you wish to discuss a figure on the main
17530 before displaying the text associated with it.
17531 One way to accomplish this is tape a flap of dark paper over the part of
17536 you want to display later.
17537 This method fails, however, if you wish to overlap one graph with another,
17539 You would then have to fumble while speaking to align the two separate,
17544 s to align the two graphs.
17549 environment in both cases makes life much easier.
17552 \begin_layout Standard
17557 receives the page number of its
17558 \begin_inset Quotes eld
17562 \begin_inset Quotes erd
17570 \begin_inset Quotes eld
17578 \begin_inset Quotes erd
17585 \begin_layout Plain Layout
17586 Presumably, mutliple
17591 \begin_inset Quotes eld
17599 \begin_inset Quotes erd
17603 \begin_inset Quotes eld
17611 \begin_inset Quotes erd
17615 \begin_inset Quotes eld
17623 \begin_inset Quotes erd
17627 \begin_inset space ~
17630 appended to the page number of the parent
17640 Clearly, you want the contents of both the
17648 to each fit on a single physical slide! You should probably consider an
17654 \begin_inset Quotes eld
17658 \begin_inset Quotes erd
17666 Indeed, the \SpecialChar LyX
17671 class provides a visual cue for this: the label at the start of an
17675 is shorter than that at the start of a
17680 Lastly, when you generate printable output, you'll find alignment markers
17681 in all four corners of both the
17685 page and its parent
17690 These will assist you in lining up the two physical slides.
17693 \begin_layout Standard
17694 The major problem in overlaying two slides is aligning the contents of the
17695 two transparencies.
17696 How much space should you leave for that graph on the second slide? Worse
17697 still, what if you want a graph and a sentence on second slide, but there
17698 is text on the main transparency that goes in between them? You could try
17699 and insert vertical space of the right size.
17700 The better way is to use
17711 \begin_layout Standard
17712 As their names imply,
17720 are two command-like paragraph environments that make all subsequent text
17721 invisible and visible, respectively.
17723 \begin_inset space ~
17727 \begin_inset CommandInset ref
17729 reference "sec:slideQuirk"
17733 that you don't place anything
17737 these two environments, however.
17742 , it inserts a centered, sky-blue label into the page reading
17743 \begin_inset Quotes eld
17746 <Invisible Text Follows>
17747 \begin_inset Quotes erd
17751 For paragraphs following this label, the parts of the
17759 ; it doesn't matter which] where they would be contain instead blank space.
17763 \begin_layout Standard
17768 , the corresponding centered label is
17769 \begin_inset Quotes eld
17772 <Visible Text Follows>
17773 \begin_inset Quotes erd
17777 Paragraphs following this label behave normally.
17778 Note that the beginning of a new
17790 automatically shuts off an
17795 It's therefore not necessary to use
17806 \begin_layout Standard
17807 By now, it should be obvious how to create overlay transparencies using
17808 the proper combination of
17827 \begin_layout Enumerate
17832 , including everything that will appear on it, whether on the main slide
17840 \begin_layout Enumerate
17841 Before each figure or paragraph that will appear only on the
17850 If necessary, insert a
17854 environment after the
17861 \begin_layout Enumerate
17866 immediately following the
17873 \begin_layout Enumerate
17874 Copy the contents of this
17885 \begin_layout Enumerate
17890 , change all of the
17901 \begin_layout Standard
17903 You've just made an
17910 \begin_layout Standard
17911 There's one problem with the way I've designed the \SpecialChar LyX
17916 class: you can't make text in the middle of a paragraph invisible, nor
17917 make text in the middle of an invisible paragraph visible again.
17918 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
17923 \begin_layout Plain Layout
17924 The commands of interest are:
17927 \begin_layout Itemize
17932 invisible \SpecialChar ldots
17936 \begin_layout Itemize
17941 visible \SpecialChar ldots
17945 \begin_layout Plain Layout
17947 and need to be marked as \SpecialChar TeX
17950 \begin_inset Quotes eld
17954 \begin_inset Quotes erd
17957 you wish to change goes in between the brackets [and after the
17970 If you don't know how to mark text as \SpecialChar TeX
17971 , see the appropriate section of
17984 \begin_layout Subsubsection
17994 \begin_inset CommandInset label
17996 name "sec:slideNote"
18003 \begin_layout Standard
18012 is associated with a
18013 \begin_inset Quotes eld
18017 \begin_inset Quotes erd
18025 Here, too, the \SpecialChar LyX
18030 class provides visual cues.
18035 is shorter than that of a
18039 [yet longer than that of an
18043 ] and, like the label of an
18047 is shockingly magenta.
18048 Additionally, the printed
18052 has the page number of its
18053 \begin_inset Quotes eld
18057 \begin_inset Quotes erd
18065 \begin_inset Quotes eld
18073 \begin_inset Quotes erd
18077 \begin_inset Quotes eld
18085 \begin_inset Quotes erd
18089 \begin_inset Quotes eld
18097 \begin_inset Quotes erd
18101 You can have multiple
18105 s associated with a single
18117 , you'll probably want to break up long
18121 s so that they fit on a single sheet of paper.
18124 \begin_layout Standard
18129 is obvious: it contains anything additional you might want to say about
18135 It could also be used as a sheet of reminders for a particular
18140 In the case of the latter, you might want to make use of time markers.
18141 Currently, the \SpecialChar LyX
18147 \begin_inset Quotes eld
18151 \begin_inset Quotes erd
18154 support for time markers, a
18156 Sli\SpecialChar TeX
18160 So, you'll have to resort to using the \SpecialChar LaTeX
18164 \begin_layout Standard
18165 To use time markers, you'll need to specify the extra class option
18166 \begin_inset Quotes eld
18174 \begin_inset Quotes erd
18178 \begin_inset space ~
18182 \begin_inset CommandInset ref
18184 reference "sec:slidesetup"
18189 This option turns on timing marks, which will appear in the lower-left-hand
18195 To set what appears in the time marker, you use the \SpecialChar LaTeX
18197 \begin_inset Quotes eld
18207 \begin_inset Quotes erd
18211 \begin_inset Quotes eld
18221 \begin_inset Quotes erd
18225 The arguments of both commands are time measured in seconds.
18227 \begin_inset Quotes eld
18237 \begin_inset Quotes erd
18240 sets the time marker to a given time.
18242 \begin_inset Quotes eld
18252 \begin_inset Quotes erd
18255 increments the time marker by the specified amount.
18256 Using time markers and
18260 s in this fashion, you can remind yourself how much time to spend on a particula
18268 \begin_layout Standard
18269 There's one last feature to describe.
18270 Clearly, you'd like to print out all of your
18278 s on transparencies while printing all of your
18295 with which it is associated.
18296 What's a person to do?
18299 \begin_layout Standard
18300 Luckily, there are two \SpecialChar LaTeX
18301 commands that allow you to select what to print
18303 Both must be placed into the preamble of your document.
18305 \begin_inset Quotes eld
18317 \begin_inset Quotes erd
18320 will cause the output to contain only the
18329 Correspondingly, the command
18330 \begin_inset Quotes eld
18342 \begin_inset Quotes erd
18345 prevents the output of anything but
18350 I'd advise placing both commands in the preamble and initially comment
18352 You can then preview your entire presentation as you write.
18353 When you're done writing, you can then uncomment one of the two to select
18354 what you want to print.
18355 I like to uncomment
18356 \begin_inset Quotes eld
18368 \begin_inset Quotes erd
18371 , print to a file with
18372 \begin_inset Quotes eld
18380 \begin_inset Quotes erd
18383 in its name, comment it back out, then uncomment
18384 \begin_inset Quotes eld
18396 \begin_inset Quotes erd
18400 \begin_inset Quotes eld
18408 \begin_inset Quotes erd
18412 I can then send either file to a printer, loading transparencies or plain
18413 paper as appropriate.
18416 \begin_layout Standard
18417 You can also provide other arguments to the
18418 \begin_inset Quotes eld
18428 \begin_inset Quotes erd
18432 \begin_inset Quotes eld
18442 \begin_inset Quotes erd
18446 See a good \SpecialChar LaTeX
18450 \begin_layout Subsection
18455 Class Template File
18458 \begin_layout Standard
18459 I have also provided a template file,
18460 \begin_inset Quotes eld
18468 \begin_inset Quotes erd
18476 To use it, begin your new presentation with
18478 File\SpecialChar menuseparator
18480 \begin_inset space ~
18484 \begin_inset space ~
18490 Your new \SpecialChar LyX
18491 presentation file will contain an example
18512 additionally contain an example of the use of
18521 Lastly, the preamble will contain:
18524 \begin_layout LyX-Code
18525 % Uncomment to print out only slides and overlays
18528 \begin_layout LyX-Code
18532 \begin_layout LyX-Code
18538 \begin_inset Newline newline
18544 \begin_layout LyX-Code
18545 % Uncomment to print out only notes
18548 \begin_layout LyX-Code
18552 \begin_layout LyX-Code
18560 \begin_layout Standard
18561 One final thing: I created this class to support the \SpecialChar LaTeX2e
18563 \begin_inset Quotes eld
18568 Sli\SpecialChar TeX
18572 \begin_inset Quotes erd
18575 class, one of the built-in \SpecialChar LaTeX2e
18577 Neither I nor the rest of the \SpecialChar LyX
18578 Team endorse or oppose the use of this built-in
18580 It's here if you want it or need it.
18581 There exist other \SpecialChar LaTeX2e
18582 classes for creating presentations, such as the
18587 \begin_inset space ~
18591 \begin_inset CommandInset ref
18593 reference "sec:foiltex"
18598 \begin_inset Quotes eld
18606 \begin_inset Quotes erd
18609 package [present on some \SpecialChar TeX
18611 The latter is not yet supported under \SpecialChar LyX
18616 \begin_layout Plain Layout
18617 Perhaps you can take on the task\SpecialChar ldots
18623 I know nothing about these other classes.
18624 Try them out to see what sort of alternative they provide.
18627 \begin_layout Chapter
18629 Features needing Extra Software
18632 \begin_layout Section
18633 Checking \SpecialChar TeX
18637 \begin_layout Standard
18643 \begin_layout Subsection
18647 \begin_layout Standard
18656 \begin_layout Plain Layout
18661 is not yet available when you are using the \SpecialChar LaTeX
18662 distribution MiK\SpecialChar TeX
18668 , you'll find in the
18675 \begin_inset space ~
18686 \begin_inset Newline newline
18690 \begin_inset CommandInset href
18692 target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
18700 \begin_layout Standard
18703 Chk\SpecialChar TeX
18706 package is a program that was written by
18707 \begin_inset Flex Noun
18710 \begin_layout Plain Layout
18712 \begin_inset space ~
18720 in frustration because some constructs in \SpecialChar LaTeX
18721 are sometimes non-intuitive,
18722 and easy to forget.
18723 The program runs over your \SpecialChar LaTeX
18724 file, checks the integrity of the file, and
18725 flags some common errors.
18726 In other technical words, it is
18730 for \SpecialChar LaTeX
18734 \begin_layout Standard
18735 Well, what is a syntax checker doing in \SpecialChar LyX
18736 which is supposed to produce correct
18738 anyways? The answer is simple: Just as
18742 not only checks the
18746 of C programs, but also does
18750 checks for type-errors,
18752 Chk\SpecialChar TeX
18755 catches some common
18759 errors, in addition to the syntactical ones.
18762 Chk\SpecialChar TeX
18765 is capable of detecting several common errors, such as
18768 \begin_layout Itemize
18769 Ellipsis detection:
18770 \begin_inset Newline newline
18773 Use \SpecialChar ldots
18777 \begin_layout Itemize
18778 No space in front of/after parenthesis:
18779 \begin_inset Newline newline
18785 \begin_layout Itemize
18786 Enforcement of normal space after common abbreviations:
18787 \begin_inset Newline newline
18791 \begin_inset space \thinspace{}
18795 \begin_inset space \space{}
18798 is too wide spacing.
18801 \begin_layout Itemize
18802 Enforcement of end-of-sentence space when the last sentence ends with a
18804 \begin_inset Newline newline
18808 And this is wrong spacing.
18811 \begin_layout Itemize
18812 Space in front of labels and similar commands:
18813 \begin_inset Newline newline
18816 The label should stick right up to the text to avoid falling to a wrong
18819 \begin_inset CommandInset label
18829 \begin_layout Plain Layout
18830 This footnote is in danger of falling off to a wrong page
18835 The label is separated too much.
18838 \begin_layout Itemize
18839 Space in front of references, instead of hard spaces:
18840 \begin_inset Newline newline
18843 If you have bad luck, the text will break right between the referenced text
18844 and reference number, and that's a pity.
18846 \begin_inset CommandInset ref
18848 reference "sec:chktex"
18855 \begin_layout Itemize
18857 \begin_inset Quotes eld
18861 \begin_inset Quotes erd
18865 \begin_inset Formula $\times$
18869 \begin_inset Newline newline
18872 2x2 looks cheap compared to
18873 \begin_inset Formula $2\times2$
18879 \begin_layout Standard
18880 and more \SpecialChar ldots
18881 It is an invaluable tool when you are
18882 \begin_inset Quotes eld
18886 \begin_inset Quotes erd
18889 your document before printing, and you should run it right after the obligatory
18890 spelling check, and before you go fine tuning the typesetting.
18893 \begin_layout Subsection
18897 \begin_layout Standard
18898 If you have the program installed, usage is as simple as choosing
18900 Tools\SpecialChar menuseparator
18902 \begin_inset space ~
18908 This will make \SpecialChar LyX
18909 generate a \SpecialChar LaTeX
18910 file of your document, start
18912 Chk\SpecialChar TeX
18915 to check it, and then make \SpecialChar LyX
18917 \begin_inset Quotes eld
18921 \begin_inset Quotes erd
18924 with the warnings from
18926 Chk\SpecialChar TeX
18929 , if there were any.
18930 The warnings will be placed close to the point of the mistake, and you
18931 can quickly find them by using the
18933 Navigate\SpecialChar menuseparator
18936 menu item, or the shortcut key
18945 Open the error boxes by clicking on them with the mouse, or use the shortcut
18954 bindings, or the corresponding
18963 Read the warning and correct the mistake, if it is a mistake.
18964 If you have trouble understanding what the warning is about, you can safely
18966 Remember that there is a hidden layer between the document on screen and
18967 the technical details in invoking
18969 Chk\SpecialChar TeX
18972 , and this gap can make some warnings seem arcane or just plain silly.
18975 \begin_layout Standard
18976 This document is an excellent testing bed for the feature, and it should
18977 provide quite a few warnings for you to fiddle with.
18978 Since computers are only so smart, expect most of the warnings to be false
18982 \begin_layout Subsection
18983 How to fine tune it
18986 \begin_layout Standard
18987 Sometimes, you'll find that
18989 Chk\SpecialChar TeX
18992 makes more noise than suits your mood.
18993 Then you can choose not to use it, wait until your mood changes, or try
18996 Chk\SpecialChar TeX
18999 to get better along with you.
19002 \begin_layout Standard
19005 Chk\SpecialChar TeX
19012 very configurable and extensible, you should not expect to solve all problems
19015 Chk\SpecialChar TeX
19018 in \SpecialChar LyX
19020 Since \SpecialChar LyX
19021 has to generate a somewhat special \SpecialChar LaTeX
19022 file to be able to match the
19023 line numbers from the
19025 Chk\SpecialChar TeX
19032 \begin_layout Plain Layout
19033 You can inspect the specific output from
19039 Document\SpecialChar menuseparator
19042 \begin_inset space ~
19056 to the internal document structure, some of the warnings will not appear
19058 There are two things you can do about this:
19061 \begin_layout Itemize
19064 Chk\SpecialChar TeX
19067 invocation command line in
19068 \begin_inset Flex Noun
19071 \begin_layout Plain Layout
19072 Tools\SpecialChar menuseparator
19073 Preferences\SpecialChar menuseparator
19074 Output\SpecialChar menuseparator
19075 LaTeX\SpecialChar menuseparator
19083 Chk\SpecialChar TeX
19086 installation configuration file (usually with the file
19091 See below to learn what warnings can be enabled and disabled on the command
19095 \begin_layout Itemize
19096 Export your document as a raw \SpecialChar LaTeX
19099 File\SpecialChar menuseparator
19100 Export\SpecialChar menuseparator
19109 Invoked in this way, it can be a hassle to find the corresponding place
19110 in the document inside \SpecialChar LyX
19111 , but with a little patience, you should be able
19115 \begin_layout Standard
19116 Here follows the warning messages that can be enabled and disabled in
19125 to disable a warning, and
19129 to enable a warning.
19130 The emphasized entries are disabled by default, because the default is
19133 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
19138 \begin_layout Standard
19139 Notice that you should only use the options that enable and disable warnings,
19140 because \SpecialChar LyX
19141 relies on some of the other command line parameters to be set
19142 in a specific way to have a chance to communicate with
19149 \begin_layout Enumerate
19153 Command terminated with space.
19156 \begin_layout Enumerate
19159 Non-breaking space (
19160 \begin_inset Quotes eld
19168 \begin_inset Quotes erd
19171 ) should have been used.
19174 \begin_layout Enumerate
19178 You should enclose the previous parenthesis with
19179 \begin_inset Quotes eld
19187 \begin_inset Quotes erd
19193 \begin_layout Enumerate
19196 Italic correction (
19197 \begin_inset Quotes eld
19207 \begin_inset Quotes erd
19210 ) found in non-italic buffer.
19213 \begin_layout Enumerate
19216 Italic correction (
19217 \begin_inset Quotes eld
19227 \begin_inset Quotes erd
19230 ) found more than once.
19233 \begin_layout Enumerate
19237 No italic correction (
19238 \begin_inset Quotes eld
19248 \begin_inset Quotes erd
19254 \begin_layout Enumerate
19258 \begin_inset Quotes eld
19266 \begin_inset Quotes erd
19270 \begin_inset Quotes eld
19278 \begin_inset Quotes erd
19284 \begin_layout Enumerate
19287 Wrong length of dash may have been used.
19290 \begin_layout Enumerate
19294 \begin_inset Quotes eld
19302 \begin_inset Quotes erd
19306 \begin_inset Quotes eld
19314 \begin_inset Quotes erd
19320 \begin_layout Enumerate
19324 \begin_inset Quotes eld
19332 \begin_inset Quotes erd
19338 \begin_layout Enumerate
19342 \begin_inset Quotes eld
19350 \begin_inset Quotes erd
19353 to achieve an ellipsis.
19356 \begin_layout Enumerate
19359 Inter-word spacing (
19360 \begin_inset Quotes eld
19370 \begin_inset Quotes eld
19373 ) should perhaps be used.
19376 \begin_layout Enumerate
19379 Inter-sentence spacing (
19380 \begin_inset Quotes eld
19390 \begin_inset Quotes erd
19393 ) should perhaps be used.
19396 \begin_layout Enumerate
19399 Could not find argument for command.
19402 \begin_layout Enumerate
19406 \begin_inset Quotes eld
19414 \begin_inset Quotes erd
19420 \begin_layout Enumerate
19423 Math mode still on at end of \SpecialChar LaTeX
19427 \begin_layout Enumerate
19431 \begin_inset Quotes eld
19439 \begin_inset Quotes erd
19442 doesn't match the number of
19443 \begin_inset Quotes eld
19451 \begin_inset Quotes erd
19457 \begin_layout Enumerate
19460 You should use either
19463 \begin_inset Quotes eld
19471 \begin_inset Quotes erd
19476 as an alternative to
19477 \begin_inset Quotes eld
19485 \begin_inset Quotes erd
19491 \begin_layout Enumerate
19498 " (ASCII 39) instead of "
19505 \begin_layout Enumerate
19508 User-specified pattern found.
19511 \begin_layout Enumerate
19514 This command might not be intended.
19517 \begin_layout Enumerate
19524 \begin_layout Enumerate
19542 \begin_layout Enumerate
19545 Delete this space to maintain correct page references.
19548 \begin_layout Enumerate
19552 You might wish to put this between a pair of
19553 \begin_inset Quotes eld
19561 \begin_inset Quotes erd
19567 \begin_layout Enumerate
19570 You ought to remove spaces in front of punctuation.
19573 \begin_layout Enumerate
19576 Could not execute \SpecialChar LaTeX
19580 \begin_layout Enumerate
19589 in front of small punctuation.
19592 \begin_layout Enumerate
19600 may look prettier here.
19603 \begin_layout Enumerate
19607 Multiple spaces detected in output.
19610 \begin_layout Enumerate
19613 This text may be ignored.
19616 \begin_layout Enumerate
19622 \begin_inset Quotes eld
19627 to begin quotation, not
19634 \begin_layout Enumerate
19641 to end quotation, not
19644 \begin_inset Quotes eld
19652 \begin_layout Enumerate
19658 \begin_layout Enumerate
19661 You should perhaps use
19662 \begin_inset Quotes eld
19670 \begin_inset Quotes erd
19676 \begin_layout Enumerate
19679 You should put a space in front of/after parenthesis.
19682 \begin_layout Enumerate
19685 You should avoid spaces in front of/after parenthesis.
19688 \begin_layout Enumerate
19692 You should not use punctuation in front of/after quotes.
19695 \begin_layout Enumerate
19698 Double space found.
19701 \begin_layout Enumerate
19704 You should put punctuation outside inner/inside display math mode.
19707 \begin_layout Enumerate
19710 You ought to not use primitive \SpecialChar TeX
19711 in \SpecialChar LaTeX
19715 \begin_layout Enumerate
19718 You should remove spaces in front of
19719 \begin_inset Quotes eld
19727 \begin_inset Quotes erd
19733 \begin_layout Enumerate
19736 \begin_inset Quotes eld
19744 \begin_inset Quotes erd
19747 is normally not followed by
19748 \begin_inset Quotes eld
19756 \begin_inset Quotes erd
19762 \begin_layout Standard
19763 In later versions of \SpecialChar LyX
19764 , we hope to provide a more complete interface to this
19765 tool (and it's smaller cousin
19769 ) to exploit the full power of it.
19770 But it's not exactly useless as it is now: go try it on one of your existing
19771 documents of a certain length and be surprised.
19774 \begin_layout Section
19775 Version Control in \SpecialChar LyX
19779 \begin_layout Standard
19782 Lars Gullik Bjønnes
19789 \begin_layout Subsection
19793 \begin_layout Standard
19795 supports some of the most basic RCS/CVS/SVN/GIT commands.
19796 If you need something a bit more sophisticated you will have to do that
19797 manually in a terminal.
19800 \begin_layout Standard
19801 Also note that CVS support is not as good as subversion support, so we advise
19803 A good place to start learning Subversion is the SVN Book
19807 \begin_layout Plain Layout
19808 \begin_inset CommandInset href
19810 target "http://svnbook.red-bean.com/"
19821 In the case of RCS you should read
19822 \begin_inset Quotes eld
19826 \begin_inset Quotes erd
19829 (a man file, read it with
19834 This file describes all the basic features of RCS.
19835 You should especially notice the comment about a RCS directory, and the
19836 notion of a master RCS file (the file ending in
19843 \begin_layout Standard
19844 Before you begin to use the version control features in \SpecialChar LyX
19846 familiar with RCS/CVS/SVN/GIT usage.
19847 The implementation in \SpecialChar LyX
19848 assumes a recent version of the GNU RCS or CVS/SVN
19849 package — no guarantees are made for older versions.
19850 Most of the log messages are not currently displayed after operations —
19851 you can check them in the Messages pane if you are unsure.
19852 Regular users of version control will appreciate the VC toolbar, which
19855 View\SpecialChar menuseparator
19856 Toolbars\SpecialChar menuseparator
19858 \begin_inset space ~
19866 \begin_layout Standard
19867 For introducing your own external commands consult
19868 \begin_inset Flex Code
19871 \begin_layout Plain Layout
19885 \begin_layout Standard
19886 It is strongly recommended to store documents in uncompressed format if
19887 using version control (uncheck
19889 Document\SpecialChar menuseparator
19892 if it is checked): Uncompressed LyX documents are text files and therefore
19893 for merging two different versions by version control systems.
19894 Compressed LyX documents are binary files, which cannot be merged by version
19898 \begin_layout Subsection
19899 RCS commands in \SpecialChar LyX
19903 \begin_layout Standard
19904 The following sections describe the RCS commands supported by \SpecialChar LyX
19906 You can find them in the
19908 File\SpecialChar menuseparator
19910 \begin_inset space ~
19917 was tested against RCS 5.7/5.8.
19920 \begin_layout Subsubsection
19926 \begin_layout Standard
19927 If your document is not under revision control, this is the only item shown
19929 And if it is under revision control, the
19933 item is not visible.
19937 \begin_layout Standard
19938 This command registers your document with RCS (unless you are under the
19939 directory managed by CVS)\SpecialChar endofsentence
19940 You are asked interactively to supply an initial
19941 description of the document.
19942 The document is now set in Read-Only mode and you have to
19945 \begin_inset space ~
19949 \begin_inset space ~
19953 \begin_inset space ~
19958 , before making any changes to it.
19959 A document under revision control has a
19960 \begin_inset Quotes eld
19963 [RCS:<version> <locker>]
19964 \begin_inset Quotes erd
19967 item tagged to the filename in the minibuffer.
19970 \begin_layout Standard
19971 RCS command that is run:
19974 \begin_layout LyX-Code
19977 ci -q -u -i -t-"<initial description>" <file-name>
19980 \begin_layout Standard
19985 to understand the switches.
19989 \begin_layout Subsubsection
19995 \begin_layout Standard
19996 When you are finished editing a file, you check in your changes.
19997 When you do this, you are asked for a description of the changes.
19998 This is stored in the history log.
19999 The version number is bumped, your changes are applied to the master RCS
20000 file, the document is unlocked and set to Read-Only mode.
20003 \begin_layout Itemize
20006 ci -q -u -m"<description>" <file-name>
20009 \begin_layout Subsubsection
20015 \begin_layout Standard
20016 By doing this you lock the document so that only you can edit it.
20017 This will also make the document Read-Write only for you.
20018 You will usually continue editing for a while and when you are finished
20019 you check in your changes.
20020 The status line is changed to reflect that you have locked the file.
20023 \begin_layout Itemize
20026 co -q -l <file-name>
20029 \begin_layout Subsubsection
20032 Revert To Repository Version
20035 \begin_layout Standard
20036 This will discard all changes made to the document since the last check
20038 You get a warning before changes are discarded.
20041 \begin_layout Itemize
20044 co -f -u<version> <file-name>
20047 \begin_layout Subsubsection
20053 \begin_layout Standard
20054 This will create a copy of the current document.
20055 Since RCS does not support copy operations natively, the version history
20056 is not preserved, and the copy is added as a new file.
20057 It requires a clean document without any changes since the last checkin.
20058 You are asked for a file name and a description of the copy operation.
20059 After that the copy is created, both locally and in the repository.
20060 If the parent directories of the copied and original document differ, all
20061 relative paths of included files of the copy are adjusted (like in
20063 File\SpecialChar menuseparator
20068 Finally, the copy is loaded instead of the original document.
20071 \begin_layout Labeling
20072 \labelwidthstring 00.00.0000
20074 \begin_inset space ~
20078 \begin_inset space ~
20082 \begin_inset Newline newline
20086 \begin_inset Flex Code
20089 \begin_layout Plain Layout
20092 \begin_inset Quotes qld
20096 \begin_inset Quotes qld
20105 \begin_inset Flex Code
20108 \begin_layout Plain Layout
20111 \begin_inset Quotes qld
20115 \begin_inset Quotes qld
20124 \begin_inset Newline newline
20128 \begin_inset Flex Code
20131 \begin_layout Plain Layout
20135 \begin_inset Quotes qld
20139 \begin_inset Quotes qld
20150 \begin_layout Subsubsection
20156 \begin_layout Standard
20157 This makes as if the last check in never happened.
20158 No changes are made to the document loaded into \SpecialChar LyX
20159 , but the last version
20160 is removed from the master RCS file.
20163 \begin_layout Itemize
20166 rcs -o<version> <file-name>
20169 \begin_layout Subsubsection
20175 \begin_layout Standard
20176 This shows the complete history of the RCS document.
20181 is shown in a browser.
20189 \begin_layout Subsubsection
20193 \begin_layout Standard
20195 supports RCS version number, author name, date and time of last commit.
20196 All those are extracted from
20198 rlog -r <file-name>
20202 \begin_inset CommandInset ref
20204 reference "subsec:VCS-Revision-Information"
20211 \begin_layout Subsection
20212 CVS commands in \SpecialChar LyX
20216 \begin_layout Standard
20217 A subset of CVS operations is supported by \SpecialChar LyX
20219 You can find the commands in the
20221 File\SpecialChar menuseparator
20223 \begin_inset space ~
20229 The version control system SVN is more powerful, so please use it instead
20230 of CVS if possible.
20233 \begin_layout Subsubsection
20239 \begin_layout Standard
20240 If you start from scratch with CVS you have to create your repository and
20241 checkout the working copy with external tools.
20242 If you're using a client-server setup you may need to login before doing
20243 the first repository checkout.
20246 \begin_layout Standard
20247 If your documents are under revision control and others are using the same
20248 repository problems arise when different changes to the same document at
20249 the same location happen.
20250 Standard CVS repositories don't operate with a file locking mechanism.
20251 This may be surprising, but conflicts only occur if people disagree on
20252 the proper content of the same part of a document.
20253 So, if co-workers are used to communicate regularly, these conflicts occur
20255 If they don't communicate they have a fundamental problem anyway.
20256 Nevertheless some people like to work with so called
20257 \begin_inset Quotes eld
20261 \begin_inset Quotes erd
20265 If they do so the working copy of all files is readonly when checked out
20266 first and the user starts editing after using a special command to make
20267 the working copy writable.
20268 When the changes are checked in the working copy returns to readonly state.
20269 With \SpecialChar LyX
20270 one has to edit the
20271 \begin_inset Flex Code
20274 \begin_layout Plain Layout
20280 file and add the line
20281 \begin_inset Flex Code
20284 \begin_layout Plain Layout
20290 to work with reserved checkouts.
20291 The benefit is the possibility to see who is using a writable copy of some
20293 It's not guaranteed only one user makes a copy writable.
20296 \begin_layout Standard
20298 tries to guess if you're using reserved or non-reserved checkouts.
20299 If your working copy is readonly or it is writable and an additional copy
20300 of your document exists in the CVS/Base sub-directory a reserved otherwise
20301 a non-reserved checkout is assumed.
20302 When a reserved checkout is detected you have to use
20303 \begin_inset Flex Noun
20306 \begin_layout Plain Layout
20312 to make your working copy writable if it's readonly.
20314 \begin_inset Flex Noun
20317 \begin_layout Plain Layout
20323 operation is possible and that makes your working copy readonly again after
20324 transferring your changes to the repository.
20327 \begin_layout Standard
20328 More information about CVS can be found here
20329 \begin_inset Flex URL
20332 \begin_layout Plain Layout
20334 http://www.nongnu.org/cvs
20340 \begin_inset Flex URL
20343 \begin_layout Plain Layout
20345 http://ximbiot.com/cvs
20353 \begin_layout Standard
20358 to understand the sub-commands and the switches mentioned below.
20361 \begin_layout Subsubsection
20367 \begin_layout Standard
20368 If your document is not under revision control, this is the only item shown
20370 And if it is under revision control, the
20374 item is not visible.
20378 \begin_layout Standard
20379 This command registers in CVS your document
20380 \begin_inset Flex Strong
20383 \begin_layout Plain Layout
20391 in the case you have already the documents directory under CVS control
20397 This means you have to create or checkout the archive by yourself using
20399 (In case you forget that step \SpecialChar LyX
20400 registers the document with RCS.)
20403 \begin_layout Standard
20404 Then you are asked interactively to supply an initial description of the
20406 Don't forget that registered file is not yet checked in.
20409 \begin_layout Standard
20410 CVS command that is run:
20412 cvs -q add -m"<entered message>" "<file-name>"
20415 \begin_layout Standard
20420 above and for all other CVS commands is an abbreviation for
20421 \begin_inset Quotes eld
20424 change the current working directory to file location and use the file name
20425 without path component as argument
20426 \begin_inset Quotes erd
20432 \begin_layout Subsubsection
20438 \begin_layout Standard
20439 When you are finished editing a file, you commit your changes.
20440 When you do this and you had changed the document, you are asked for a
20441 description of the changes.
20442 After that changes are written to the repository.
20443 In case you didn't change the document and a reserved checkout is detected
20444 the reservation made on
20445 \begin_inset Flex Noun
20448 \begin_layout Plain Layout
20457 \begin_layout Labeling
20458 \labelwidthstring 00.00.0000
20460 \begin_inset space ~
20464 \begin_inset space ~
20468 \begin_inset Newline newline
20472 \begin_inset Flex Code
20475 \begin_layout Plain Layout
20478 -q commit -m"<description>" "<file-name>"
20484 \begin_inset Newline newline
20488 \begin_inset Flex Code
20491 \begin_layout Plain Layout
20502 \begin_layout Subsubsection
20508 \begin_layout Standard
20509 When you are sharing a repository with others, you may have to incorporate
20510 their changes into your working copy.
20513 \begin_layout Standard
20516 cvs -q update "<file-name>"
20519 \begin_layout Standard
20520 If a readonly checkout is detected the working copy is made writable and
20524 \begin_layout Standard
20527 cvs -q edit "<file-name>"
20530 \begin_layout Subsubsection
20533 Revert To Repository Version
20536 \begin_layout Standard
20537 This will discard all changes made to the document since the last check
20539 You get a warning before changes are discarded.
20540 Firstly the file is deleted, secondly CVS update command is run.
20543 \begin_layout Standard
20546 cvs -q update "<file-name>"
20549 \begin_layout Standard
20550 If a reserved checkout is detected and the working copy has no changes only
20551 the reservation is undone.
20554 \begin_layout Standard
20557 cvs -q unedit "<file-name>"
20560 \begin_layout Subsubsection
20566 \begin_layout Standard
20567 This will create a copy of the current document.
20568 Since CVS does not support copy operations natively, the version history
20569 is not preserved, and the copy is added as a new file.
20570 It requires a clean document without any changes since the last checkin.
20571 You are asked for a file name and a description of the copy operation.
20572 After that the copy is created, both locally and in the repository.
20573 If the parent directories of the copied and original document differ, all
20574 relative paths of included files of the copy are adjusted (like in
20576 File\SpecialChar menuseparator
20581 Finally, the copy is loaded instead of the original document.
20584 \begin_layout Labeling
20585 \labelwidthstring 00.00.0000
20587 \begin_inset space ~
20591 \begin_inset space ~
20595 \begin_inset Newline newline
20599 \begin_inset Flex Code
20602 \begin_layout Plain Layout
20616 \begin_inset Flex Code
20619 \begin_layout Plain Layout
20633 \begin_inset Newline newline
20637 \begin_inset Flex Code
20640 \begin_layout Plain Layout
20656 \begin_layout Subsubsection
20662 \begin_layout Standard
20663 This will rename the current document.
20664 Since CVS does not support rename operations natively, the version history
20665 is not preserved, the renamed document is added as a new file, and the
20666 original document is deleted.
20667 It requires a clean document without any changes since the last checkin.
20668 You are asked for a file name and a description of the rename operation.
20669 After that the document is renamed, both locally and in the repository.
20670 If the parent directories of the new and old file names differ, all relative
20671 paths of included files are adjusted (like in
20673 File\SpecialChar menuseparator
20678 Finally, the document is reloaded using the new name.
20681 \begin_layout Labeling
20682 \labelwidthstring 00.00.0000
20684 \begin_inset space ~
20688 \begin_inset space ~
20692 \begin_inset Newline newline
20696 \begin_inset Flex Code
20699 \begin_layout Plain Layout
20713 \begin_inset Flex Code
20716 \begin_layout Plain Layout
20730 \begin_inset Newline newline
20734 \begin_inset Flex Code
20737 \begin_layout Plain Layout
20751 \begin_inset Newline newline
20755 \begin_inset Flex Code
20758 \begin_layout Plain Layout
20774 \begin_layout Subsubsection
20775 Update of the local directory checkout from repository
20778 \begin_layout Standard
20779 Once your documents gets more complex, containing sub-documents and pictures,
20781 \begin_inset Flex Code
20784 \begin_layout Plain Layout
20790 files and so on using version control becomes more complicated.
20792 supports updating the whole tree in which resides the document.
20793 This become especially useful once you cooperate with people which neither
20794 have detailed knowledge about CVS usage nor they have ambition to commit
20795 additional material to the repository.
20796 You have to organize the files structure so that all external files are
20797 in the same directory or subdirectories of the document.
20798 It's good practice anyway to store multipart documents in an extra directory.
20801 \begin_layout Standard
20803 \begin_inset Flex Code
20806 \begin_layout Plain Layout
20807 Update local directory from repository
20812 command updates the whole directory.
20813 If local changes are detected user is warned before update starts.
20814 In case of merge conflicts both versions of the conflicting document parts
20815 are placed in the final document.
20816 You have to review and correct the result of the merge.
20817 You'll find the conflicts enclosed in pairs of
20818 \begin_inset Flex Code
20821 \begin_layout Plain Layout
20828 \begin_inset Flex Code
20831 \begin_layout Plain Layout
20838 \begin_inset Flex Code
20841 \begin_layout Plain Layout
20848 The first part is your version as before the update operation with the
20849 document name prepended.
20850 The second one is the repository version with the version number after
20852 \begin_inset Flex Code
20855 \begin_layout Plain Layout
20864 \begin_layout Labeling
20865 \labelwidthstring 00.00.0000
20867 \begin_inset space ~
20871 \begin_inset space ~
20875 \begin_inset Newline newline
20879 \begin_inset Flex Code
20882 \begin_layout Plain Layout
20890 (Ask if changes are detected.)
20891 \begin_inset Newline newline
20895 \begin_inset Flex Code
20898 \begin_layout Plain Layout
20899 cd $path; cvs -q update
20909 \begin_layout Standard
20911 \begin_inset Flex Code
20914 \begin_layout Plain Layout
20920 stands for the path to the document.
20923 \begin_layout Subsubsection
20929 \begin_layout Standard
20930 This shows the complete history of the CVS document.
20933 cvs log "<file-name>"
20935 is shown in a browser.
20938 \begin_layout Subsubsection
20942 \begin_layout Standard
20944 supports CVS version number, author name, date and time of last commit.
20945 All those are extracted from
20947 cvs log -r <file-name>
20951 \begin_inset CommandInset ref
20953 reference "subsec:VCS-Revision-Information"
20960 \begin_layout Subsection
20961 SVN commands in \SpecialChar LyX
20965 \begin_layout Standard
20966 SVN is now partially supported by \SpecialChar LyX
20968 You can find the commands in the
20970 File\SpecialChar menuseparator
20972 \begin_inset space ~
20978 Please note that if you use password protected access to repository via
20979 ssh, you will be asked in terminal window.
20981 was tested against SVN 1.5, 1.6, 1.7 and 1.8
20985 \begin_layout Plain Layout
20986 Most of the commands will work with 1.4 too, see
20987 \begin_inset CommandInset ref
20989 reference "subsec:SVN-Repo-Update"
20994 There seems to be currently unresolved permissions problem under SVN 1.8
20995 with reverting changes when file is locked.
21003 \begin_layout Subsubsection
21009 \begin_layout Standard
21010 If your document is not under revision control, this is the only item shown
21012 And if it is under revision control, the
21016 item is not visible.
21019 \begin_layout Standard
21020 This command registers in SVN your document ONLY in case you have already
21021 the documents directory under SVN control (in particular
21026 This means you have to checkout the archive by yourself.
21029 \begin_layout Standard
21030 Then you are asked interactively to supply an initial description of the
21032 Don't forget that registered file is not yet commited.
21035 \begin_layout Standard
21036 SVN command that is run:
21039 \begin_inset Quotes qld
21043 \begin_inset Quotes qld
21049 \begin_layout Standard
21054 to understand the switches.
21057 \begin_layout Subsubsection
21063 \begin_layout Standard
21064 When you are finished editing a file, you commit your changes.
21065 When you do this, you are asked for a description of the changes.
21066 After that changes are commited.
21069 \begin_layout Standard
21074 \begin_layout Plain Layout
21075 In case locking is not enabled.
21077 \begin_inset CommandInset ref
21079 reference "subsec:SVN-File-Locking"
21090 svn commit -q -m"<description>" <file-name>
21093 \begin_layout Subsubsection
21099 \begin_layout Standard
21100 Updates the changes of this file from the repository.
21101 Be sure you understand SVN merging and conflicts resolving before using
21102 this function, because all conflicts has to be resolved manually by you!
21105 \begin_layout Standard
21110 \begin_layout Plain Layout
21118 svn update --non-interactive
21119 \begin_inset Quotes qld
21123 \begin_inset Quotes qld
21129 \begin_layout Subsubsection
21132 Revert To Repository Version
21135 \begin_layout Standard
21136 This will discard all changes made to the document since the last check
21138 You get a warning before changes are discarded.
21141 \begin_layout Standard
21145 \begin_inset Quotes qld
21149 \begin_inset Quotes qld
21155 \begin_layout Subsubsection
21161 \begin_layout Standard
21162 This will create a copy of the current document including the version history.
21163 It requires a clean document without any changes since the last checkin.
21164 You are asked for a file name and a description of the copy operation.
21165 After that the copy is created, both locally and in the repository.
21166 If the parent directories of the copied and original document differ, all
21167 relative paths of included files of the copy are adjusted (like in
21169 File\SpecialChar menuseparator
21174 Finally, the copy is loaded instead of the original document.
21177 \begin_layout Labeling
21178 \labelwidthstring 00.00.0000
21180 \begin_inset space ~
21184 \begin_inset space ~
21188 \begin_inset Newline newline
21192 \begin_inset Flex Code
21195 \begin_layout Plain Layout
21199 \begin_inset Quotes qld
21203 \begin_inset Quotes qld
21207 \begin_inset Quotes qld
21211 \begin_inset Quotes qld
21220 \begin_inset Newline newline
21224 \begin_inset Flex Code
21227 \begin_layout Plain Layout
21236 \begin_layout Subsubsection
21242 \begin_layout Standard
21243 This will rename the current document including the version history.
21244 It requires a clean document without any changes since the last checkin.
21245 You are asked for a file name and a description of the rename operation.
21246 After that the document is renamed, both locally and in the repository.
21247 If the parent directories of the new and old file names differ, all relative
21248 paths of included files are adjusted (like in
21250 File\SpecialChar menuseparator
21255 Finally, the document is reloaded using the new name.
21258 \begin_layout Labeling
21259 \labelwidthstring 00.00.0000
21261 \begin_inset space ~
21265 \begin_inset space ~
21269 \begin_inset Newline newline
21273 \begin_inset Flex Code
21276 \begin_layout Plain Layout
21280 \begin_inset Quotes qld
21284 \begin_inset Quotes qld
21288 \begin_inset Quotes qld
21292 \begin_inset Quotes qld
21301 \begin_inset Newline newline
21305 \begin_inset Flex Code
21308 \begin_layout Plain Layout
21317 \begin_layout Subsubsection
21318 \begin_inset CommandInset label
21320 name "subsec:SVN-Repo-Update"
21324 Update of the local directory checkout from repository
21328 \begin_layout Plain Layout
21329 Note that this command will work only with subversion
21330 \begin_inset Formula $\geqq1.5$
21341 \begin_layout Standard
21342 All the commands above have one shortcoming – they deal with the current
21344 Once your document contains pictures, includes external
21345 \begin_inset Flex Code
21348 \begin_layout Plain Layout
21354 files and so on administration becomes more complicated.
21356 now supports updating the whole tree in which resides the document
21360 \begin_layout Plain Layout
21361 One need to organize the files structure so that all external files are
21362 in the same directory or subdirectories of the document.
21369 This become especially useful once you cooperate with people which neither
21370 know about subversion management nor they have ambition to commit additional
21371 material to the repository.
21375 \begin_layout Standard
21376 \begin_inset Flex Code
21379 \begin_layout Plain Layout
21380 Update local directory from repository
21385 command updates the whole directory and in case of merge conflicts local
21386 version of the files are left, so no unintended data loss occurs.
21387 If local changes are detected user is warned before update starts.
21390 \begin_layout Labeling
21391 \labelwidthstring 00.00.0000
21393 \begin_inset space ~
21397 \begin_inset space ~
21401 \begin_inset Newline newline
21405 \begin_inset Flex Code
21408 \begin_layout Plain Layout
21414 (Ask if changes are detected.)
21415 \begin_inset Newline newline
21419 \begin_inset Flex Code
21422 \begin_layout Plain Layout
21423 svn update --accept mine-full $path
21431 \begin_layout Standard
21433 \begin_inset Flex Code
21436 \begin_layout Plain Layout
21442 stands for the path to the document.
21445 \begin_layout Subsubsection
21451 \begin_layout Standard
21452 This shows the complete history of the SVN document.
21456 \begin_inset Quotes qld
21460 \begin_inset Quotes qld
21465 is shown in a browser.
21468 \begin_layout Subsubsection
21470 \begin_inset CommandInset label
21472 name "subsec:SVN-File-Locking"
21479 \begin_layout Standard
21480 The file exchange through various revision control systems brings the problem
21481 of merge conflicts in case two different users try to edit the same (parts
21483 When such a conflict happens it needs manual resolving and one reasonable
21484 alternative is to provide some kind of locking mechanism, which guarantees
21485 that only one user is allowed to edit file at the given time.
21488 \begin_layout Standard
21489 SVN has two such mechanisms to provide mutual exclusivity for file access
21490 – locks and automatic setting of write permissions (see sec.
21492 \begin_inset CommandInset ref
21494 reference "subsec:Automatical-Locking-Property"
21499 \begin_inset Flex Code
21502 \begin_layout Plain Layout
21512 \begin_layout Plain Layout
21513 \begin_inset Flex URL
21516 \begin_layout Plain Layout
21518 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
21529 If this property is detected for a given document \SpecialChar LyX
21530 starts to use SVN locks
21531 for document editing automatically and the whole check-in/out mechanism
21532 switches to the same regimen as for RCS.
21533 This in particular means there are two different modes of file use in \SpecialChar LyX
21537 \begin_layout Itemize
21539 The loaded file is in the read-only mode.
21540 For editing on needs to check-out.
21545 consists of updating from the repository and gaining write lock.
21546 If the lock is not possible to obtain, we remain in unlocked state.
21549 \begin_layout Itemize
21551 The loaded file is in the
21552 \begin_inset Quotes els
21556 \begin_inset Quotes ers
21560 No other user is allowed to edit the file.
21565 consists of commiting changes and releasing write-lock.
21566 If no changes have been made to the document, no commit will be produced
21570 \begin_layout Plain Layout
21571 Don't be puzzled by the fact that you will be asked for commit message anyway.
21576 and only the write-lock will be released.
21579 \begin_layout Standard
21583 \begin_layout Labeling
21584 \labelwidthstring 00.00.0000
21587 svn commit -q -m"<description>" "<file-name>"
21588 \begin_inset Newline newline
21591 svn unlock "<file-name>"
21594 \begin_layout Labeling
21595 \labelwidthstring 00.00.0000
21598 svn update "<file-name>"
21599 \begin_inset Newline newline
21602 svn lock "<file-name>"
21605 \begin_layout Subsubsection
21608 \begin_inset CommandInset label
21610 name "subsec:Automatical-Locking-Property"
21616 Automatic Locking Property
21619 \begin_layout Standard
21620 The above mentioned automatic setting of write permissions of the .lyx file
21623 File\SpecialChar menuseparator
21625 \begin_inset space ~
21628 Control\SpecialChar menuseparator
21629 Use Locking Property
21632 This command is active only when the file is not locked on the svn server
21634 you need to check-out before proceeding).
21637 \begin_layout Labeling
21638 \labelwidthstring 00.00.0000
21640 \begin_inset space ~
21646 \begin_layout Labeling
21647 \labelwidthstring 00.00.0000
21650 svn propset svn:needs-lock ON "<file-name>"
21653 \begin_layout Labeling
21654 \labelwidthstring 00.00.0000
21657 svn propdel svn:needs-lock "<file-name>"
21660 \begin_layout Subsubsection
21661 \begin_inset CommandInset label
21663 name "subsec:VCS-Revision-Information"
21667 Revision Information in Documents
21670 \begin_layout Standard
21671 There are more possibilities how to activate revision information in our
21675 \begin_layout Itemize
21681 \begin_layout Itemize
21682 tree revision information (
21683 \begin_inset Flex Code
21686 \begin_layout Plain Layout
21693 The result is the output of the
21694 \begin_inset Flex Code
21697 \begin_layout Plain Layout
21703 command, the following table gives you an idea, how to read the results.
21706 \begin_layout Standard
21708 \begin_inset Tabular
21709 <lyxtabular version="3" rows="6" columns="2">
21710 <features tabularvalignment="middle">
21711 <column alignment="left" valignment="top">
21712 <column alignment="left" valignment="top">
21714 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21717 \begin_layout Plain Layout
21725 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21728 \begin_layout Plain Layout
21738 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
21741 \begin_layout Plain Layout
21747 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21750 \begin_layout Plain Layout
21751 mixed revision working copy
21758 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
21761 \begin_layout Plain Layout
21767 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21770 \begin_layout Plain Layout
21771 modified working copy
21778 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
21781 \begin_layout Plain Layout
21787 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21790 \begin_layout Plain Layout
21791 switched working copy
21798 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
21801 \begin_layout Plain Layout
21807 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21810 \begin_layout Plain Layout
21811 partial working copy, from a sparse checkout
21818 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21821 \begin_layout Plain Layout
21827 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21830 \begin_layout Plain Layout
21831 mixed revision, modified, switched working copy
21844 \begin_layout Itemize
21845 file revision information.
21846 The result comes from parsing the output of
21847 \begin_inset Flex Code
21850 \begin_layout Plain Layout
21852 \begin_inset space ~
21856 \begin_inset space ~
21860 \begin_inset space ~
21869 Supported flags are:
21873 \begin_layout Itemize
21874 version number of the last commit (
21875 \begin_inset Flex Code
21878 \begin_layout Plain Layout
21887 \begin_layout Itemize
21888 author of the last commit (
21889 \begin_inset Flex Code
21892 \begin_layout Plain Layout
21901 \begin_layout Itemize
21902 date of the last commit (
21903 \begin_inset Flex Code
21906 \begin_layout Plain Layout
21915 \begin_layout Itemize
21916 time of the last commit (
21917 \begin_inset Flex Code
21920 \begin_layout Plain Layout
21930 \begin_layout Standard
21931 You can obtain this info via InsetInfo (
21932 \change_inserted 5863208 1564400022
21935 Insert\SpecialChar menuseparator
21936 Field\SpecialChar menuseparator
21937 Version Control Revision
21938 \change_deleted 5863208 1564399852
21943 \begin_inset Flex Code
21946 \begin_layout Plain Layout
21947 info-insert buffer vcs-date
21955 The information will be available only when you have the file stored under
21956 svn managment (i.e.
21958 \begin_inset Flex Code
21961 \begin_layout Plain Layout
21967 directory is available with your document).
21971 \begin_layout Itemize
21972 Another—a hacking one—possibility is to use svn keywords
21976 \begin_layout Plain Layout
21977 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
21983 In short – you set file keywords property (e.g.
21986 svn propset svn:keywords 'Rev' file.lyx
21988 ) and then paste keyword \SpecialChar TeX
21993 \begin_layout Plain Layout
21994 This is an easy way how to ensure that \SpecialChar LyX
21995 won't break the line in the middle
22001 tag in your document (e.g.
22003 \begin_inset Flex Code
22006 \begin_layout Plain Layout
22013 This way svn client will automatically substitute revision number (e.g.
22015 \begin_inset Flex Code
22018 \begin_layout Plain Layout
22024 ) after each update and commit.
22025 There are more problems with this approach.
22026 Firstly, the '$' character is used in \SpecialChar TeX
22027 world for math equations, so any
22028 occurence of math formula
22029 \begin_inset Formula $Rev$
22033 \begin_inset Formula $Rev:59$
22036 in your \SpecialChar LyX
22038 Similarly for other keywords like Id, Date, Author, etc.
22039 Secondly svn output is dependent on your locales, so its very easy that
22040 svn would produce some problematic strings once Date is used.
22041 Thirdly you get the whole 'Rev: 59' string in your document instead of
22043 Until subversion implements user's custom keywords it will be hard to use
22044 this approach reliably or let \SpecialChar LyX
22045 to support it directly.
22048 \begin_layout Subsection
22049 SVN and Windows Environment
22052 \begin_layout Quote
22053 My inclination is to say that if the user cannot figure out the command
22054 line operations on their own fairly quickly, they would be well advised
22055 to use TortoiseSVN.
22061 \begin_layout Subsubsection
22065 \begin_layout Standard
22066 In addition to installing \SpecialChar LyX
22067 , and having access to a Subversion repository,
22068 the user will need to install the Subversion client program.
22069 A Windows installer for the client program is available from
22070 \begin_inset CommandInset href
22073 target "http://www.collab.net/nonav/downloads/subversion/"
22079 The user may also want to install
22080 \begin_inset CommandInset href
22083 target "http://tortoisesvn.tigris.org/"
22088 , which integrates Subversion operations into the context (rightclick) menu
22089 of Windows Explorer.
22090 Operations done outside \SpecialChar LyX
22091 will typically be more convenient using the Explorer
22093 Note that TortoiseSVN is not a replacement for the client program, which
22094 is what \SpecialChar LyX
22098 \begin_layout Subsubsection
22099 Bringing a document under Subversion control
22102 \begin_layout Standard
22103 Before a \SpecialChar LyX
22104 document can be brought under version control in Subversion, its
22105 parent directory needs to be under version control.
22106 If the document is being added to a project already in the repository,
22107 this is accomplished by checking the project out to the directory where
22108 the new document will be placed.
22109 If the project itself is not yet under version control (for instance, if
22110 this document starts a new project), the directory must be imported into
22112 This is done outside \SpecialChar LyX
22114 Both import and checkout are easily accomplished from the Explorer context
22115 menu using TortoiseSVN, or alternatively can be done using the command
22116 line client at a DOS prompt.
22117 The procedure for importing the project using TortoiseSVN is described
22118 below, assuming an existing repository and a new project being started
22126 For information on using the Subversion client program, run
22133 \begin_layout Enumerate
22140 in Windows Explorer, right click it, and select
22142 TortoiseSVN\SpecialChar menuseparator
22146 If necessary, adjust the URL for the repository, then click OK.
22149 \begin_layout Enumerate
22150 Right click the level of the repository under which you want to place the
22151 new project folder (typically the top level) and click
22155 Supply a name for the project folder and click OK.
22156 Add a message for the log file if desired, then click OK again.
22157 The new project folder should appear in the repository.
22158 Finally, click OK again to exit the repository browser.
22161 \begin_layout Enumerate
22162 Once again right click
22168 , this time selecting SVN Checkout\SpecialChar ldots
22169 Select the URL of the project folder
22170 you just created in the repository, and set the checkout directory to
22178 You will be warned about a non-empty folder; click OK to proceed.
22179 You should now have a
22190 \begin_layout Enumerate
22191 Create or open your document in \SpecialChar LyX
22194 File\SpecialChar menuseparator
22196 \begin_inset space ~
22199 Control\SpecialChar menuseparator
22203 Add a log message and click OK to commit the document to version control.
22206 \begin_layout Standard
22207 From this point onward, you should have full functionality in the
22209 File\SpecialChar menuseparator
22211 \begin_inset space ~
22217 You also have the option of checking the document in and out, viewing its
22219 using the TortoiseSVN context menu in Windows Explorer or the Subversion
22220 client program from a command prompt.
22223 \begin_layout Subsubsection
22224 SSH tunnel used with SVN under Windows
22227 \begin_layout Standard
22228 Compared with Linux setting up an svn client to communicate over ssh under
22229 Windows is a rather troublesome task.
22230 We will at least offer some hints how to setup the client side but prior
22231 knowledge about ssh and the Windows command line is needed, also be prepared
22232 for a great deal of frustration\SpecialChar ldots
22236 \begin_layout Enumerate
22237 Get an svn client for windows, as described in the previous sections.
22238 When it is a fresh install run some svn command (e.g.
22240 \begin_inset Flex Code
22243 \begin_layout Plain Layout
22249 ) to create config files, which you will need to change later on.
22252 \begin_layout Enumerate
22253 Choose an ssh client for Windows.
22254 There are several possibilities, we will use the one from Putty tools
22258 \begin_layout Plain Layout
22259 \begin_inset Flex URL
22262 \begin_layout Plain Layout
22264 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
22275 You will need to set the connection up so that the client doesn't ask for
22276 any password from you.
22277 To keep things easy we will use only keys without any additional password
22282 \begin_layout Enumerate
22284 \begin_inset Flex Code
22287 \begin_layout Plain Layout
22294 Save your private .ppk key file and put the public one on the server side.
22295 If the SVN server runs on Linux, note that the format of the public key
22296 is not compatible with Linux openssh and you will need to direcly copy-paste
22298 \begin_inset Quotes eld
22303 Public key for pasting into OpenSSH authorized_keys file
22306 \begin_inset Quotes erd
22309 edit field into the server's
22310 \begin_inset Flex Code
22313 \begin_layout Plain Layout
22314 ~/.ssh/authorized_keys
22320 \begin_inset Flex Code
22323 \begin_layout Plain Layout
22332 \begin_layout Enumerate
22334 \begin_inset Flex Code
22337 \begin_layout Plain Layout
22344 In the SVN config file
22348 \begin_layout Plain Layout
22349 Exact path depends on Windows version, usually somewhere around
22350 \begin_inset Flex Code
22353 \begin_layout Plain Layout
22356 Documents and Settings
22370 \begin_inset Flex Code
22373 \begin_layout Plain Layout
22388 , section [tunnels], setup ssh command, e.g.
22390 \begin_inset Flex Code
22393 \begin_layout Plain Layout
22394 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
22403 \begin_layout Plain Layout
22404 It will usually take a lot of time to get exact command right and it depends
22406 For example do not have some remote server saved as a default session in
22408 If things fail, try to connect via plink without SVN first.
22417 \begin_layout Enumerate
22418 Checkout the SVN archive, e.
22419 \begin_inset space \thinspace{}
22423 \begin_inset Newline newline
22427 \begin_inset Flex Code
22430 \begin_layout Plain Layout
22431 svn co svn+ssh://user@server/repository_path
22439 \begin_layout Subsubsection
22440 End-of-Line Conversions
22443 \begin_layout Standard
22444 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
22446 use different line endings inside the .lyx files.
22447 This is not a problem as far as \SpecialChar LyX
22448 functionality is concerned, but the commit
22449 diffs will be huge and merge-conflicts prone.
22450 Fortunately SVN itself knows
22454 \begin_layout Plain Layout
22455 \begin_inset Flex URL
22458 \begin_layout Plain Layout
22460 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
22470 how to deal with CR/LF problems when switching .lyx files to the
22471 \begin_inset Flex Code
22474 \begin_layout Plain Layout
22484 \begin_layout Plain Layout
22486 \begin_inset Flex Code
22489 \begin_layout Plain Layout
22490 svn propset svn:eol-style native FILE_NAME
22503 \begin_layout Subsection
22504 GIT commands in \SpecialChar LyX
22508 \begin_layout Standard
22509 A minimal subset of GIT commands is now supported by \SpecialChar LyX
22511 You can find the commands in the
22513 File\SpecialChar menuseparator
22515 \begin_inset space ~
22521 Please note that if you use password protected access to repository via
22522 ssh, you will be asked in terminal window.
22524 was tested against GIT 1.7.
22528 \begin_layout Plain Layout
22529 Windows users please note that you need to ensure that git is on the path.
22530 This can be set from within \SpecialChar LyX
22533 Tools\SpecialChar menuseparator
22534 Preferences\SpecialChar menuseparator
22535 Paths\SpecialChar menuseparator
22546 \begin_layout Standard
22547 One big difference of GIT and the other supported version control systems
22548 is the distributed nature of GIT: With traditional version control systems
22549 there is one central server which hosts the repository.
22550 Users commit their changes to the server, and get updates made by other
22552 With GIT, users commit to a local repository.
22553 The local repository can be synchronized with one or more remote repositories
22555 \begin_inset Flex Code
22558 \begin_layout Plain Layout
22565 \begin_inset Flex Code
22568 \begin_layout Plain Layout
22576 does not interact in any way with remote GIT repositories.
22577 It works exclusively with the local repository in a very similar way as
22578 with a central CVS or SVN repository.
22579 If you use remote GIT repositories you need to do the
22580 \begin_inset Flex Code
22583 \begin_layout Plain Layout
22590 \begin_inset Flex Code
22593 \begin_layout Plain Layout
22599 operations with your favourite GIT client.
22602 \begin_layout Subsubsection
22608 \begin_layout Standard
22609 If your document is not under revision control, this is the only item shown
22611 And if it is under revision control, the
22615 item is not visible.
22618 \begin_layout Standard
22619 This command registers in GIT your document ONLY in case you have already
22620 the documents directory under GIT control (in particular
22625 This means you have to checkout the archive by yourself.
22628 \begin_layout Standard
22629 Then you are asked interactively to supply an initial description of the
22631 Don't forget that registered file is not yet committed.
22634 \begin_layout Standard
22635 GIT command that is run:
22638 \begin_inset Quotes qld
22642 \begin_inset Quotes qld
22648 \begin_layout Standard
22653 to understand the switches.
22656 \begin_layout Subsubsection
22662 \begin_layout Standard
22663 When you are finished editing a file, you commit your changes.
22664 When you do this, you are asked for a description of the changes.
22665 After that changes are committed.
22668 \begin_layout Standard
22671 git commit -q -m"<description>" <file-name>
22674 \begin_layout Subsubsection
22677 Revert To Repository Version
22680 \begin_layout Standard
22681 This will discard all changes made to the document since the last check
22683 You get a warning before changes are discarded.
22686 \begin_layout Standard
22690 \begin_inset Quotes qld
22694 \begin_inset Quotes qld
22700 \begin_layout Subsubsection
22706 \begin_layout Standard
22707 This will rename the current document including the version history.
22708 It requires a clean document without any changes since the last checkin.
22709 You are asked for a file name and a description of the rename operation.
22710 After that the document is renamed, both locally and in the repository.
22711 If the parent directories of the new and old file names differ, all relative
22712 paths of included files are adjusted (like in
22714 File\SpecialChar menuseparator
22719 Finally, the document is reloaded using the new name.
22722 \begin_layout Labeling
22723 \labelwidthstring 00.00.0000
22725 \begin_inset space ~
22729 \begin_inset space ~
22733 \begin_inset Newline newline
22737 \begin_inset Flex Code
22740 \begin_layout Plain Layout
22744 \begin_inset Quotes qld
22748 \begin_inset Quotes qld
22752 \begin_inset Quotes qld
22756 \begin_inset Quotes qld
22765 \begin_inset Newline newline
22769 \begin_inset Flex Code
22772 \begin_layout Plain Layout
22781 \begin_layout Subsubsection
22787 \begin_layout Standard
22788 This shows the complete history of the GIT document.
22792 \begin_inset Quotes qld
22796 \begin_inset Quotes qld
22801 is shown in a browser.
22804 \begin_layout Subsubsection
22808 \begin_layout Standard
22810 supports GIT hash number of the last commit to the file,
22811 \change_inserted 1119979965 1564297456
22812 its abbreviated form,
22814 author name, date and time of last commit.
22815 All those are extracted from
22817 git log -n 1 --pretty=format:%H%n
22818 \change_inserted 1119979965 1564297427
22824 Tree version information is obtained via
22826 git describe --abbrev --dirty --long
22830 \begin_inset CommandInset ref
22832 reference "subsec:VCS-Revision-Information"
22839 \begin_layout Subsection
22843 \begin_layout Standard
22844 With the recent addition of the
22845 \begin_inset Flex Code
22848 \begin_layout Plain Layout
22854 function \SpecialChar LyX
22855 power users are allowed to create their own commands for revision
22859 \begin_layout Standard
22860 As an example you can see how two TortoiseSVN commands could be integrated
22864 \begin_layout Description
22866 \begin_inset Flex Code
22869 \begin_layout Plain Layout
22870 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
22878 \begin_layout Description
22880 \begin_inset Flex Code
22883 \begin_layout Plain Layout
22884 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
22892 \begin_layout Subsection
22893 Version control and Document comparison
22896 \begin_layout Standard
22897 One of the typical uses of version control is to inspect the changes between
22898 revisions, usually by creating
22899 \begin_inset Flex Code
22902 \begin_layout Plain Layout
22909 While this is useful for plain text files, it is much less useful in the
22910 case of \SpecialChar LyX
22911 files, which have more a complicated structure.
22912 Hence we provide binding to the Document comparison feature.
22913 There are two ways of calling this feature – either by direct call of
22914 \begin_inset Flex Code
22917 \begin_layout Plain Layout
22924 function (for details see \SpecialChar LyX
22925 functions manual) or by the toolbar icon
22938 One can either compare two chosen revisions of the document or he can simply
22939 compare the current version of edited text with older revisions (where
22941 \begin_inset Flex Noun
22944 \begin_layout Plain Layout
22950 ' revisions back means comparison of the edited file with last commited
22955 \begin_layout Standard
22956 This feature is supported for SVN and RCS though due to the more complicated
22957 versioning scheme of RCS there is a constraint – when addressing the revisions
22958 in dialog, numbers always point to the last number in RCS revision number,
22961 We don't currently support GIT addressing of revisions, one can just compare
22962 edited document with its revision X steps backs, where X is addressed as
22964 \begin_inset Flex Code
22967 \begin_layout Plain Layout
22976 \begin_layout Section
22977 Literate Programming
22980 \begin_layout Standard
22985 (kayvan@sylvan.com)
22989 original documentation written by
22991 Edmar Wienskoski Jr.
22994 (edmar-w-jr@technologist.com)
22997 \begin_layout Subsection
23001 \begin_layout Standard
23002 The main purpose of this documentation is to show you how to use \SpecialChar LyX
23004 programming, where it is assumed that you are familiar with this programming
23005 technique, and know what
23006 \begin_inset Quotes eld
23010 \begin_inset Quotes erd
23014 \begin_inset Quotes eld
23018 \begin_inset Quotes erd
23022 If that is not the case, please follow the web links provided in the following
23024 There is a lot of good documentation out there covering old development
23025 history to the latest tools tips.
23028 \begin_layout Standard
23029 It is also assumed that you are familiar with \SpecialChar LyX
23030 itself to a point that you
23031 are comfortable changing your \SpecialChar LyX
23032 preferences, and X resources file.
23033 If that is not the case please refer to other \SpecialChar LyX
23034 documentation to cover your
23038 \begin_layout Subsection
23039 Literate Programming
23042 \begin_layout Standard
23043 From the Literate Programming FAQ:
23046 \begin_layout Quotation
23047 Literate programming is the combination of documentation and source together
23048 in a fashion suited for reading by human beings.
23049 In fact, literate programs should be enjoyable reading, even inviting!
23050 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
23051 and documentation in a single file.
23052 Literate programming tools then parse the file to produce either readable
23053 documentation or compilable source.
23054 The WEB style of literate programming was created by D.
23055 \begin_inset space \thinspace{}
23059 Knuth during the development of his \SpecialChar TeX
23060 typesetting software.
23064 \begin_layout Standard
23065 Another excerpt says:
23068 \begin_layout Quotation
23071 How is literate programming different from verbose commenting?
23074 \begin_layout Quotation
23075 There are three distinguishing characteristics.
23076 In order of importance, they are:
23080 \begin_layout Itemize
23081 flexible order of elaboration
23084 \begin_layout Itemize
23085 automatic support for browsing
23088 \begin_layout Itemize
23089 typeset documentation, especially diagrams and mathematics
23093 \begin_layout Standard
23094 Now that I sparked your curiosity, take a look in the references.
23097 \begin_layout Subsubsection
23101 \begin_layout Standard
23102 The complete Literate Programming FAQ can be found at:
23105 \begin_layout Quote
23106 Literate Programming FAQ
23107 \begin_inset Flex URL
23110 \begin_layout Plain Layout
23112 http://www.literateprogramming.com/lpfaq.pdf
23120 \begin_layout Standard
23121 The FAQ lists 23 (twenty three!) different literate programming tools.
23122 Where some are specialized or
23123 \begin_inset Quotes eld
23127 \begin_inset Quotes erd
23130 for particular programming languages, while other have general scope.
23135 for my own use for several reasons:
23138 \begin_layout Itemize
23139 It can generate the documentation either in \SpecialChar LaTeX
23143 \begin_layout Itemize
23144 It has a open architecture, i.
23145 \begin_inset space \thinspace{}
23149 \begin_inset space \space{}
23152 it is easy to plug in new filters
23156 \begin_layout Plain Layout
23161 are programs that read a given data stream and output a manipulated data
23163 That way, a WEB file (consisting of literate code) can be turned into a
23164 file consisting only of C program code or \SpecialChar LaTeX
23170 and to perform special processing that you may need.
23174 \begin_layout Itemize
23175 There is a good selection of filters available already (the HTML is one
23179 \begin_layout Itemize
23183 \begin_layout Standard
23184 The Noweb web page can be found at:
23187 \begin_layout Quote
23189 \begin_inset Flex URL
23192 \begin_layout Plain Layout
23194 https://www.cs.tufts.edu/~nr/noweb/
23202 \begin_layout Standard
23203 Starting from there you can reach many other interesting links and even
23204 some literate program examples.
23207 \begin_layout Subsection
23209 and Literate Programming with Noweb
23212 \begin_layout Standard
23213 The \SpecialChar LyX
23214 support for Literate Programming is provided by using the generic \SpecialChar LyX
23216 converters mechanism.
23217 This support is provided in a
23218 \begin_inset Quotes eld
23222 \begin_inset Quotes erd
23226 \begin_inset space \thinspace{}
23230 \begin_inset space \space{}
23233 you will be able to use this new \SpecialChar LyX
23234 feature with some other literate programming
23235 tool of your choice by just changing your \SpecialChar LyX
23239 \begin_layout Subsubsection
23240 Generating documents and code (weaving and tangling)
23243 \begin_layout Paragraph
23244 Using the noweb module
23247 \begin_layout Standard
23248 If you have installed Noweb and \SpecialChar LyX
23249 successfully, whenever you open a new document,
23250 after you have chosen its document class, use the
23252 Document\SpecialChar menuseparator
23256 \begin_inset Quotes eld
23260 \begin_inset Quotes erd
23264 If Noweb is correctly installed, when you click on the
23265 \begin_inset Quotes eld
23269 \begin_inset Quotes erd
23272 link, you will see the
23273 \begin_inset Quotes eld
23277 \begin_inset Quotes erd
23280 module in the available list and you can add it to your document.
23283 \begin_layout Paragraph
23287 \begin_layout Standard
23289 enables you to write code with a custom inset named
23290 \begin_inset Flex Noun
23293 \begin_layout Plain Layout
23300 Noweb delimits chunks like this:
23303 \begin_layout LyX-Code
23307 \begin_layout LyX-Code
23311 \begin_layout LyX-Code
23315 \begin_layout LyX-Code
23319 \begin_layout LyX-Code
23323 \begin_layout Standard
23324 The problem is that whatever is written in between the << and the
23328 must be taken literally, i.
23329 \begin_inset space \thinspace{}
23333 \begin_inset space \space{}
23337 should be prevented from making any special interpretation of what has
23339 This is also handled by
23340 \begin_inset Flex Noun
23343 \begin_layout Plain Layout
23349 , that works like a normal text inset but has a free spacing capability.
23352 \begin_layout Standard
23353 As a special note, you can also use the
23354 \begin_inset Quotes eld
23358 \begin_inset Quotes erd
23361 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
23365 \begin_layout LyX-Code
23369 \begin_layout LyX-Code
23370 def some_function(args):
23373 \begin_layout LyX-Code
23374 "This is the doc string for this function."
23377 \begin_layout LyX-Code
23378 print "My args: ", args
23381 \begin_layout LyX-Code
23382 @ %def some_function
23385 \begin_layout Standard
23386 For an example of this usage and the resulting cross-reference output, look
23387 at the Literate python program in
23389 LIBDIR/examples/listerrors.lyx
23391 which should make this all clear.
23394 \begin_layout Paragraph
23395 Generating the documentation
23398 \begin_layout Standard
23399 At this point you already have a new document file with a proper document
23400 class, and with some code and text on it.
23401 How do I print it? The answer is simple, you select
23403 View\SpecialChar menuseparator
23407 Just like you would do for a plain document.
23408 No special procedure is required.
23411 \begin_layout Standard
23412 To help orientate you, I will now explain what happens inside \SpecialChar LyX
23416 \begin_layout Enumerate
23419 Update\SpecialChar menuseparator
23422 menu option is chosen, a \SpecialChar LaTeX
23428 \begin_layout Standard
23429 If the document is of any literate class the generated file will be named
23430 with an extension name defined by the
23431 \begin_inset Quotes eld
23435 \begin_inset Quotes erd
23438 format (defined in the Preferences panel), otherwise the file will have
23447 \begin_layout Enumerate
23448 Note that the only difference so far is in the name of the file, no special
23449 processing is required by \SpecialChar LyX
23451 Given that you formatted the code using the
23452 \begin_inset Flex Noun
23455 \begin_layout Plain Layout
23461 inset that, by itself, takes care of the business.
23464 \begin_layout Enumerate
23465 If the document is of any literate class \SpecialChar LyX
23466 will then use the internal \SpecialChar LyX
23468 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
23473 \begin_layout Plain Layout
23474 The converters are defined in the
23476 Tools\SpecialChar menuseparator
23480 \begin_inset Quotes eld
23484 \begin_inset Quotes erd
23496 manual for general information about converters.
23501 to generate the \SpecialChar LaTeX
23506 \begin_layout Standard
23507 Otherwise it will just skip this step.
23511 \begin_layout Enumerate
23512 Finally, \SpecialChar LaTeX
23513 is invoked and the regular post processing continues as in a plain
23517 \begin_layout Standard
23518 Independence from a particular
23519 \begin_inset Quotes eld
23523 \begin_inset Quotes erd
23526 is easily achieved by changing the commands that are run by the various
23530 \begin_layout Paragraph
23531 Generating the code
23534 \begin_layout Standard
23535 When the build menu option is chosen or the corresponding button in the
23536 toolbar is pressed, a \SpecialChar LaTeX
23537 file is generated just like step 1 above.
23538 Next, \SpecialChar LyX
23544 This converter needs to be defined by the user and is not installed by
23545 default, though the Program format is.
23546 This converter (like any other converter) will have two parts:
23549 \begin_layout Enumerate
23550 The converter program itself.
23551 This program performs the conversion from the one format to the other (in
23552 this case, from the Noweb format to the Program pseudo-format).
23555 \begin_layout Enumerate
23556 The error log parser.
23557 This is a program whose sole purpose is to rewrite error messages in a
23558 format that \SpecialChar LyX
23560 This makes it possible for \SpecialChar LyX
23561 to place error boxes in the right places in
23565 \begin_layout Standard
23566 The first part, the
23567 \begin_inset Quotes eld
23571 \begin_inset Quotes erd
23574 setting, should be set to
23577 \begin_layout LyX-Code
23585 \begin_layout Standard
23586 This basically means that \SpecialChar LyX
23588 \begin_inset Quotes eld
23592 \begin_inset Quotes erd
23595 (a program or script) with the name of the Noweb file (normally a file
23596 in the \SpecialChar LyX
23597 temp directory) and the directory path of the original \SpecialChar LyX
23602 \begin_layout Standard
23603 This is an implementation of
23604 \begin_inset Quotes eld
23608 \begin_inset Quotes erd
23611 that you can place in a directory on your path:
23614 \begin_layout LyX-Code
23620 \begin_layout LyX-Code
23626 \begin_layout LyX-Code
23629 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
23632 \begin_layout Standard
23633 The next part of the converter setting is the
23634 \begin_inset Quotes eld
23638 \begin_inset Quotes erd
23641 which is to be set to
23644 \begin_layout LyX-Code
23647 parselog=$$s/scripts/listerrors
23650 \begin_layout Standard
23651 This will run any errors that are generated by the
23652 \begin_inset Quotes eld
23656 \begin_inset Quotes erd
23659 process through the
23660 \begin_inset Quotes eld
23664 \begin_inset Quotes erd
23670 \begin_layout Standard
23671 The build will normally take place in \SpecialChar LyX
23672 's temporary directory, so the files
23673 produced by the conversion will be in that directory.
23675 will copy out what it regards as the `main' file, but the
23679 conversion may produce several files, and so most of these would then be
23680 deleted when \SpecialChar LyX
23682 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
23683 the build-script chunk can place the generated files in that location.
23686 \begin_layout Paragraph
23687 Build instructions in the document
23690 \begin_layout Standard
23691 The last piece of the integration between \SpecialChar LyX
23693 \begin_inset Quotes eld
23697 \begin_inset Quotes erd
23701 Generally, the instructions for building your program should be embedded
23702 in a chunk of its own.
23704 \begin_inset Quotes eld
23708 \begin_inset Quotes erd
23711 above uses the notangle command to look for this chunk (called
23712 \begin_inset Quotes eld
23716 \begin_inset Quotes erd
23719 ) and runs its contents through
23720 \begin_inset Quotes eld
23724 \begin_inset Quotes erd
23730 \begin_layout Standard
23731 Typically, such a chunk would look something like this:
23734 \begin_layout LyX-Code
23738 \begin_layout LyX-Code
23740 \begin_inset Newline newline
23743 if [ -z "${NOWEB_SOURCE}" ]
23744 \begin_inset Newline newline
23750 \begin_layout LyX-Code
23751 NOWEB_SOURCE=myfile.nw
23752 \begin_inset Newline newline
23756 \begin_inset Newline newline
23760 code to extract files ...
23761 use NOWEB_OUTPUT_DIR here ...]
23762 \begin_inset Newline newline
23766 code to compile files ...]
23767 \begin_inset Newline newline
23773 \begin_layout Standard
23776 LIBDIR/examples/listerrors.lyx
23780 LIBDIR/examples/Literate.lyx
23782 which implement two versions of the
23783 \begin_inset Quotes eld
23787 \begin_inset Quotes erd
23790 program for some illustrations of how all of these pieces go together or
23793 LIBDIR/examples/noweb2lyx.lyx.
23796 Interestingly, these three files show off the language-indepence of the
23798 literate programming support since they are written in Python, C and Perl
23802 \begin_layout Subsubsection
23803 Configuring \SpecialChar LyX
23807 \begin_layout Standard
23808 All the Literate Programming support is configured by the
23810 Tools\SpecialChar menuseparator
23814 \begin_inset Quotes eld
23818 \begin_inset Quotes erd
23822 The important parts are:
23825 \begin_layout Description
23827 \begin_inset space ~
23831 \begin_inset Quotes eld
23835 \begin_inset Quotes erd
23839 \begin_inset space ~
23842 format Set up via the File Formats tab, this is where the Noweb-specific
23852 , the file extension is set to
23857 This tells \SpecialChar LyX
23858 to create a file with a
23862 extension in the first step of the conversion process.
23865 \begin_layout Description
23867 \begin_inset space ~
23875 \begin_inset space ~
23878 format This is an empty format whose sole purpose is to be the endpoint
23879 of a conversion (which then allows us to set up a converter for it).
23882 \begin_layout Description
23892 This converter performs the
23893 \begin_inset Quotes eld
23897 \begin_inset Quotes erd
23900 of the literate document.
23901 For Noweb, it is set to
23902 \begin_inset Quotes eld
23907 noweave -delay -index $$i > $$o
23910 \begin_inset Quotes erd
23916 \begin_layout Description
23926 \begin_inset Quotes eld
23930 \begin_inset Quotes erd
23934 As stated above, the Converter is set to
23935 \begin_inset Quotes eld
23943 \begin_inset Quotes erd
23946 , with Flags set to
23947 \begin_inset Newline newline
23951 \begin_inset Quotes eld
23956 parselog=$$s/scripts/listerrors
23959 \begin_inset Quotes erd
23965 \begin_layout Subsubsection
23969 \begin_layout Standard
23970 There is also a new function implemented in the \SpecialChar LyX
23972 \begin_inset Quotes eld
23975 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
23979 \begin_layout Standard
23980 When debugging code with ddd/gdb, it is possible to invoke a text editor
23981 at the current execution position with a single key stroke.
23982 The default ddd configuration for that is shift-ctrl-V.
23983 It happens that you can define the editor command line invocation in ddd
23986 Edit\SpecialChar menuseparator
23987 Preferences\SpecialChar menuseparator
23990 dialog and changing the "Edit Sources" entry.
23993 \begin_layout Standard
23994 I take advantage of the newly created \SpecialChar LyX
23995 server function and this ddd feature,
23997 \begin_inset Quotes eld
24001 \begin_inset Quotes erd
24007 \begin_layout LyX-Code
24008 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
24011 \begin_layout Standard
24012 With this, whenever you are using ddd and find a point in the program that
24013 you want to edit, you just press shift-ctrl-V (in the ddd window), and
24014 ddd will forward this information to \SpecialChar LyX
24015 through the \SpecialChar LyX
24016 server and then the
24018 window will show the same file with the cursor at the same position ddd
24020 No more guessing or long scrolling to locate a point in the program back
24024 \begin_layout Standard
24025 Note however that you must enable the \SpecialChar LyX
24026 server to get this feature working
24027 (it is disabled by default).
24029 \begin_inset space ~
24033 \begin_inset CommandInset ref
24035 reference "sec:Starting-the-Server"
24039 explains how to do that.
24042 \begin_layout Subsubsection
24046 \begin_layout Standard
24047 There are six new buttons that can be added to your \SpecialChar LyX
24049 Four of these buttons are short cuts to layout styles:
24067 , one for the custom inset
24072 The last one is a short cut to the
24073 \begin_inset Quotes eld
24077 \begin_inset Quotes erd
24084 \begin_layout Standard
24086 has a range of buttons that are available for tool bar customization.
24087 In my toolbar I like to combine the six short cuts above with two more:
24092 \SpecialChar menuseparator
24097 \SpecialChar menuseparator
24104 Document\SpecialChar menuseparator
24105 View\SpecialChar menuseparator
24109 Here is how it looks like:
24112 \begin_layout LyX-Code
24116 \begin_layout LyX-Code
24120 \begin_layout LyX-Code
24121 Icon "layout Standard"
24124 \begin_layout LyX-Code
24125 Icon "layout Section"
24128 \begin_layout LyX-Code
24129 Icon "layout \SpecialChar LaTeX
24133 \begin_layout LyX-Code
24134 Icon "layout \SpecialChar LyX
24138 \begin_layout LyX-Code
24139 Icon "flex.insert Chunk"
24142 \begin_layout LyX-Code
24146 \begin_layout LyX-Code
24150 \begin_layout LyX-Code
24151 Icon "buffer-typeset"
24154 \begin_layout LyX-Code
24155 Icon "build-program"
24158 \begin_layout LyX-Code
24162 \begin_layout LyX-Code
24166 \begin_layout LyX-Code
24170 \begin_layout LyX-Code
24174 \begin_layout LyX-Code
24178 \begin_layout Subsubsection
24179 Colors customization
24182 \begin_layout Standard
24183 There are a number of colors in \SpecialChar LyX
24184 that can be customized in
24189 One of the things that bothers people is the \SpecialChar LaTeX
24191 The default color is red, since the chunks uses \SpecialChar LaTeX
24192 font, and there is a lot
24193 of chunks in literate documents, you may get tired of seeing everything
24195 You can change it by going to the tabs
24204 \begin_layout Standard
24205 The next thing is the visible presence of the newline character in the screen.
24206 You can choose the color of this particular character and make it blend
24208 I recommend you choosing a color that is close to the background but not
24209 equal, that way you still can see it is there, but it is not bothering
24213 \begin_layout Subsection
24218 \begin_layout Standard
24227 is documented in the
24231 example file and in the Sweave manual (menu
24233 Help\SpecialChar menuseparator
24239 \begin_layout Chapter
24243 \begin_layout Standard
24244 You can do everything with \SpecialChar LyX
24245 that you can do with \SpecialChar LaTeX
24247 However, \SpecialChar LyX
24248 cannot support every \SpecialChar LaTeX
24250 But you can always use \SpecialChar TeX
24252 This chapter shows you some more special things you might want to use.
24253 For other special things you can do with figures, tables, floats, boxes
24254 and notes, have a look at the
24257 \begin_inset space ~
24265 \begin_layout Section
24266 Multiple Text Columns
24269 \begin_layout Standard
24270 This feature is independent of the option
24272 Two-column document
24274 in the document settings under
24279 If you want to have 2
24280 \begin_inset space ~
24283 columns for the whole document, it is recommended to use the
24285 Two-column document
24288 For all other cases use this feature.
24291 \begin_layout Standard
24292 To use multiple text columns in your document, you have to load the module
24299 Document\SpecialChar menuseparator
24300 Settings\SpecialChar menuseparator
24303 ) and must have the \SpecialChar LaTeX
24305 \begin_inset Flex Code
24308 \begin_layout Plain Layout
24317 \begin_layout Standard
24318 Footnotes within multiple columns will be placed at the bottom of the page
24319 and not under each column.
24320 Within the different columns you can use everything, with the limitation
24321 that for floats you need to use the float option
24328 \begin_layout Subsection
24332 \begin_layout Standard
24333 If you want to have 2
24334 \begin_inset space ~
24337 columns in your text, insert a multicolumn inset via the menu
24339 Insert\SpecialChar menuseparator
24341 \begin_inset space ~
24344 Insets\SpecialChar menuseparator
24346 \begin_inset space ~
24351 where the columns should start.
24352 Write all text that should be printed in 2
24353 \begin_inset space ~
24356 columns into this inset.
24359 \begin_layout Standard
24360 Here is an example:
24363 \begin_layout Standard
24365 \begin_inset Flex Multiple Columns
24368 \begin_layout Plain Layout
24373 The Adventure of the Empty House
24376 \begin_inset Newline newline
24379 by Sir Arthur Conan Doyle
24382 \begin_layout Plain Layout
24385 It was in the spring of the year 1894 that all London was interested, and
24386 the fashionable world dismayed, by the murder of the Honourable Ronald
24387 Adair under most unusual and inexplicable circumstances.
24388 The public has already learned those particulars of the crime which came
24389 out in the police investigation, but a good deal was suppressed upon that
24390 occasion, since the case for the prosecution was so overwhelmingly strong
24391 that it was not necessary to bring forward all the facts.
24392 Only now, at the end of nearly ten years, am I allowed to supply those
24393 missing links which make up the whole of that remarkable chain.
24394 The crime was of interest in itself, but that interest was as nothing to
24395 me compared to the inconceivable sequel, which afforded me the greatest
24396 shock and surprise of any event in my adventurous life.
24397 Even now, after this long interval, I find myself thrilling as I think
24398 of it, and feeling once more that sudden flood of joy, amazement, and increduli
24399 ty which utterly submerged my mind.
24400 Let me say to that public, which has shown some interest in those glimpses
24401 which I have occasionally given them of the thoughts and actions of a very
24402 remarkable man, that they are not to blame me if I have not shared my knowledge
24403 with them, for I should have considered it my first duty to do so, had
24404 I not been barred by a positive prohibition from his own lips, which was
24405 only withdrawn upon the third of last month.
24413 \begin_layout Standard
24414 To get 3 or more columns, set the cursor into the multicolumn inset and
24417 Insert\SpecialChar menuseparator
24419 \begin_inset space ~
24423 \begin_inset space ~
24429 The number of the desired columns is written into that inset (for 3
24430 \begin_inset space ~
24434 \begin_inset Quotes eld
24438 \begin_inset Quotes erd
24442 \begin_inset Newline newline
24445 Here is an example with 3
24446 \begin_inset space ~
24452 \begin_layout Standard
24453 \begin_inset Flex Multiple Columns
24456 \begin_layout Plain Layout
24459 \begin_inset Argument 1
24462 \begin_layout Plain Layout
24469 It can be imagined that my close intimacy with Sherlock Holmes had interested
24470 me deeply in crime, and that after his disappearance I never failed to
24471 read with care the various problems which came before the public.
24472 And I even attempted, more than once, for my own private satisfaction,
24473 to employ his methods in their solution, though with indifferent success.
24474 There was none, however, which appealed to me like this tragedy of Ronald
24476 As I read the evidence at the inquest, which led up to a verdict of willful
24477 murder against some person or persons unknown, I realized more clearly
24478 than I had ever done the loss which the community had sustained by the
24479 death of Sherlock Holmes.
24480 There were points about this strange business which would, I was sure,
24481 have specially appealed to him, and the efforts of the police would have
24482 been supplemented, or more probably anticipated, by the trained observation
24483 and the alert mind of the first criminal agent in Europe.
24484 All day, as I drove upon my round, I turned over the case in my mind and
24485 found no explanation which appeared to me to be adequate.
24486 At the risk of telling a twice-told tale, I will recapitulate the facts
24487 as they were known to the public at the conclusion of the inquest.
24495 \begin_layout Standard
24496 You can have up to 10
24497 \begin_inset space ~
24500 columns if you want to, but that might not be very pleasant for the readers
24504 \begin_layout Standard
24505 \begin_inset Newpage newpage
24511 \begin_layout Subsection
24512 Columns inside Columns
24515 \begin_layout Standard
24516 You can also have columns inside columns:
24519 \begin_layout Standard
24520 \begin_inset Flex Multiple Columns
24523 \begin_layout Plain Layout
24526 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
24527 at that time governor of one of the Australian colonies.
24528 Adair's mother had returned from Australia to undergo the operation for
24529 cataract, and she, her son Ronald, and her daughter Hilda were living together
24533 \begin_layout Plain Layout
24534 \begin_inset Flex Multiple Columns
24537 \begin_layout Plain Layout
24540 The youth moved in the best society
24541 \begin_inset space ~
24544 – had, so far as was known, no enemies and no particular vices.
24545 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
24546 had been broken off by mutual consent some months before, and there was
24547 no sign that it had left any very profound feeling behind it.
24548 For the rest {sic} the man's life moved in a narrow and conventional circle,
24549 for his habits were quiet and his nature unemotional.
24550 Yet it was upon this easy-going young aristocrat that death came, in most
24551 strange and unexpected form, between the hours of ten and eleven-twenty
24552 on the night of March 30, 1894.
24560 \begin_layout Plain Layout
24563 Ronald Adair was fond of cards
24564 \begin_inset space ~
24567 – playing continually, but never for such stakes as would hurt him.
24568 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
24569 It was shown that, after dinner on the day of his death, he had played
24570 a rubber of whist at the latter club.
24571 He had also played there in the afternoon.
24576 The evidence of those who had played with him
24577 \begin_inset space ~
24581 Murray, Sir John Hardy, and Colonel Moran
24582 \begin_inset space ~
24585 – showed that the game was whist, and that there was a fairly equal fall
24587 Adair might have lost five pounds, but not more.
24588 His fortune was a considerable one, and such a loss could not in any way
24590 He had played nearly every day at one club or other, but he was a cautious
24591 player, and usually rose a winner.
24592 It came out in evidence that, in partnership with Colonel Moran, he had
24593 actually won as much as four hundred and twenty pounds in a sitting, some
24594 weeks before, from Godfrey Milner and Lord Balmoral.
24595 So much for his recent history as it came out at the inquest.
24603 \begin_layout Subsection
24607 \begin_layout Standard
24608 The examples in this section show some more special features of multiple
24612 \begin_layout Standard
24613 For more features of multiple columns, have a look at the
24614 \begin_inset CommandInset href
24616 name "documentation"
24617 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
24622 of the \SpecialChar LaTeX
24624 \begin_inset Flex Code
24627 \begin_layout Plain Layout
24636 \begin_layout Subsubsection
24640 \begin_layout Standard
24641 To add a preface text for multiple columns, set the cursor into the multicolumn
24642 inset and use the menu
24644 Insert\SpecialChar menuseparator
24648 Write your preface text into that inset.
24649 \begin_inset Newline newline
24652 This is an example with some preface text:
24655 \begin_layout Standard
24656 \begin_inset VSpace bigskip
24662 \begin_layout Standard
24663 \begin_inset Flex Multiple Columns
24666 \begin_layout Plain Layout
24667 \begin_inset Argument 2
24670 \begin_layout Plain Layout
24671 And the story continues and continues and continues and continues\SpecialChar ldots
24679 On the evening of the crime, he returned from the club exactly at ten.
24680 His mother and sister were out spending the evening with a relation.
24681 The servant deposed that she heard him enter the front room on the second
24682 floor, generally used as his sitting-room.
24683 She had lit a fire there, and as it smoked she had opened the window.
24684 No sound was heard from the room until eleven-twenty, the hour of the return
24685 of Lady Maynooth and her daughter.
24686 Desiring to say good-night, she attempted to enter her son's room.
24687 The door was locked on the inside, and no answer could be got to their
24688 cries and knocking.
24689 Help was obtained, and the door forced.
24690 The unfortunate young man was found lying near the table.
24691 His head had been horribly mutilated by an expanding revolver bullet, but
24692 no weapon of any sort was to be found in the room.
24700 \begin_layout Standard
24701 You can also use a section heading as the preface if you use a section command
24702 as \SpecialChar TeX
24704 For example the command
24707 \begin_layout LyX-Code
24710 subsection{subsection title}
24713 \begin_layout Standard
24714 creates a subsection.
24715 In this example the preface is a subsubsection:
24718 \begin_layout Standard
24719 \begin_inset Flex Multiple Columns
24722 \begin_layout Plain Layout
24723 \begin_inset Argument 2
24726 \begin_layout Plain Layout
24730 \begin_layout Plain Layout
24739 This is a subsubsection heading as a preface
24743 \begin_layout Plain Layout
24757 A minute examination of the circumstances served only to make the case more
24759 In the first place, no reason could be given why the young man should have
24760 fastened the door upon the inside.
24761 There was the possibility that the murderer had done this, and had afterwards
24762 escaped by the window.
24763 The drop was at least twenty feet, however, and a bed of crocuses in full
24765 Neither the flowers nor the earth showed any sign of having been disturbed,
24766 nor were there any marks upon the narrow strip of grass which separated
24767 the house from the road.
24768 Apparently, therefore, it was the young man himself who had fastened the
24770 But how did he come by his death? No one could have climbed up to the window
24771 without leaving traces.
24772 Suppose a man had fired through the window, he would indeed be a remarkable
24773 shot who could with a revolver inflict so deadly a wound.
24774 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
24775 a hundred yards of the house.
24776 No one had heard a shot.
24784 \begin_layout Standard
24785 If there is less vertical space than 6
24786 \begin_inset space ~
24789 text lines is left on the page at the beginning of the multiple columns,
24790 a page break will be inserted before the multiple columns.
24791 Depending on the number of lines of the preface text, you might want to
24793 This is done by setting the cursor into the mulitcolumn inset behind the
24794 preface (if there is any) and using the menu
24796 Insert\SpecialChar menuseparator
24798 \begin_inset space ~
24802 \begin_inset space ~
24806 \begin_inset space ~
24812 Insert into that inset the amount of space like e.
24813 \begin_inset space \thinspace{}
24817 \begin_inset space \space{}
24821 \begin_inset Quotes eld
24825 \begin_inset Quotes erd
24829 \begin_inset Newline newline
24832 In this example the space is set to 7
24833 \begin_inset space ~
24836 text lines by using
24837 \begin_inset Flex Code
24840 \begin_layout Plain Layout
24849 \begin_inset Flex Code
24852 \begin_layout Plain Layout
24860 needs to be inserted as \SpecialChar TeX
24864 \begin_layout Standard
24865 \begin_inset Flex Multiple Columns
24868 \begin_layout Plain Layout
24869 \begin_inset Argument 3
24872 \begin_layout Plain Layout
24877 \begin_layout Plain Layout
24893 On the evening of the crime, he returned from the club exactly at ten.
24894 His mother and sister were out spending the evening with a relation.
24895 The servant deposed that she heard him enter the front room on the second
24896 floor, generally used as his sitting-room.
24897 She had lit a fire there, and as it smoked she had opened the window.
24898 No sound was heard from the room until eleven-twenty, the hour of the return
24899 of Lady Maynooth and her daughter.
24900 Desiring to say good-night, she attempted to enter her son's room.
24901 The door was locked on the inside, and no answer could be got to their
24902 cries and knocking.
24903 Help was obtained, and the door forced.
24904 The unfortunate young man was found lying near the table.
24905 His head had been horribly mutilated by an expanding revolver bullet, but
24906 no weapon of any sort was to be found in the room.
24914 \begin_layout Subsubsection
24918 \begin_layout Standard
24919 The amount of space before and after multiple columns can be changed by
24920 changing the length
24921 \begin_inset Flex Code
24924 \begin_layout Plain Layout
24933 For example the command
24936 \begin_layout LyX-Code
24944 \begin_layout Standard
24945 in \SpecialChar TeX
24946 Code changes its value to 3
24947 \begin_inset space \thinspace{}
24951 The change must be made before the multiple columns' start.
24952 The predefined value is 13
24953 \begin_inset space \thinspace{}
24959 \begin_layout Standard
24961 \begin_inset Flex Code
24964 \begin_layout Plain Layout
24973 \begin_inset space \thinspace{}
24979 \begin_layout Standard
24983 \begin_layout Plain Layout
24989 multicolsep}{2.5cm}
24997 \begin_layout Standard
24998 \begin_inset Flex Multiple Columns
25001 \begin_layout Plain Layout
25004 All day I turned these facts over in my mind, endeavouring to hit upon some
25005 theory which could reconcile them all, and to find that line of least resistanc
25006 e which my poor friend had declared to be the starting-point of every investigat
25008 I confess that I made little progress.
25009 In the evening I strolled across the Park, and found myself about six o'clock
25010 at the Oxford Street end of Park Lane.
25011 A group of loafers upon the pavements, all staring up at a particular window,
25012 directed me to the house which I had come to see.
25013 A tall, thin man with coloured glasses, whom I strongly suspected of being
25014 a plain-clothes detective, was pointing out some theory of his own, while
25015 the others crowded round to listen to what he said.
25016 I got as near him as I could, but his observations seemed to me to be absurd,
25017 so I withdrew again in some disgust.
25018 As I did so I struck against an elderly, deformed man, who had been behind
25019 me, and I knocked down several books which he was carrying.
25027 \begin_layout Standard
25028 \begin_inset Note Greyedout
25031 \begin_layout Plain Layout
25036 The values you set with
25037 \begin_inset Flex Code
25040 \begin_layout Plain Layout
25048 will be used for all following multiple columns until you change them again.
25056 \begin_layout Standard
25060 \begin_layout Plain Layout
25072 \begin_inset Note Note
25075 \begin_layout Plain Layout
25076 go back to the default
25084 \begin_layout Standard
25085 \begin_inset Newpage newpage
25091 \begin_layout Subsubsection
25095 \begin_layout Standard
25096 A column break can be forced by inserting the command
25097 \begin_inset Flex Code
25100 \begin_layout Plain Layout
25108 as \SpecialChar TeX
25109 Code to that position in the text where the column should be broken.
25110 Note that this leads in most cases to whitespace in the text.
25111 \begin_inset Newline newline
25114 Here is an example:
25117 \begin_layout Standard
25118 \begin_inset Flex Multiple Columns
25121 \begin_layout Plain Layout
25124 \begin_inset Quotes eld
25127 You're surprised to see me, sir,
25128 \begin_inset Quotes erd
25131 said he, in a strange, croaking voice.
25134 \begin_layout Plain Layout
25137 I acknowledged that I was.
25140 \begin_layout Plain Layout
25143 \begin_inset Quotes eld
25146 Well, I've a conscience, sir, and when I chanced to see you go into this
25147 house, as I came hobbling after you, I thought to myself, I'll just step
25148 in and see that kind gentleman, and tell him that if I was a bit gruff
25149 in my manner there was not any harm meant, and that I am much obliged to
25150 him for picking up my books.
25151 \begin_inset Quotes erd
25157 \begin_layout Plain Layout
25160 \begin_inset Quotes eld
25163 You make too much of a trifle,
25164 \begin_inset Quotes erd
25169 \begin_inset Quotes eld
25172 May I ask how you knew who I was?
25173 \begin_inset Quotes erd
25176 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
25180 \begin_layout Plain Layout
25192 \begin_layout Plain Layout
25195 \begin_inset Quotes eld
25198 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25199 you'll find my little bookshop at the corner of Church Street, and very
25200 happy to see you, I am sure.
25201 Maybe you collect yourself, sir.
25205 \begin_inset space ~
25219 \begin_inset space ~
25222 – a bargain, every one of them.
25223 With five volumes you could just fill that gap on that second shelf.
25224 It looks untidy, does it not, sir?
25225 \begin_inset Quotes erd
25236 \begin_layout Subsubsection
25240 \begin_layout Standard
25241 The width of the columns is automatically calculated, but you can modify
25242 the space between the columns.
25243 This is done by changing the length
25244 \begin_inset Flex Code
25247 \begin_layout Plain Layout
25256 Its predefined value is 10
25257 \begin_inset space \thinspace{}
25261 Here is an example where
25262 \begin_inset Flex Code
25265 \begin_layout Plain Layout
25274 \begin_inset space \thinspace{}
25280 \begin_layout Standard
25284 \begin_layout Plain Layout
25298 \begin_layout Standard
25299 \begin_inset Flex Multiple Columns
25302 \begin_layout Plain Layout
25305 My observations of No.
25306 \begin_inset space \space{}
25309 427 Park Lane did little to clear up the problem in which I was interested.
25310 The house was separated from the street by a low wall and railing, the
25311 whole not more than five feet high.
25312 It was perfectly easy, therefore, for anyone to get into the garden, but
25313 the window was entirely inaccessible, since there was no water pipe or
25314 anything which could help the most active man to climb it.
25315 More puzzled than ever, I retraced my steps to Kensington.
25316 I had not been in my study five minutes when the maid entered to say that
25317 a person desired to see me.
25318 To my astonishment it was none other than my strange old book collector,
25319 his sharp, wizened face peering out from a frame of white hair, and his
25320 precious volumes, a dozen of them at least, wedged under his right arm.
25328 \begin_layout Standard
25332 \begin_layout Plain Layout
25344 \begin_inset Note Note
25347 \begin_layout Plain Layout
25348 go back to the default
25356 \begin_layout Subsubsection
25360 \begin_layout Standard
25361 Between the columns a rule with a width of the length
25362 \begin_inset Flex Code
25365 \begin_layout Plain Layout
25374 If this rule width is set to 0
25375 \begin_inset space \thinspace{}
25378 pt (this is the default), the rule is suppressed.
25379 In the following example the rule is 2
25380 \begin_inset space \thinspace{}
25386 \begin_layout Standard
25390 \begin_layout Plain Layout
25396 columnseprule}{2pt}
25404 \begin_layout Standard
25405 \begin_inset Flex Multiple Columns
25408 \begin_layout Plain Layout
25411 \begin_inset Quotes eld
25414 You're surprised to see me, sir,
25415 \begin_inset Quotes erd
25418 said he, in a strange, croaking voice.
25421 \begin_layout Plain Layout
25424 I acknowledged that I was.
25427 \begin_layout Plain Layout
25430 \begin_inset Quotes eld
25433 Well, I've a conscience, sir, and when I chanced to see you go into this
25434 house, as I came hobbling after you, I thought to myself, I'll just step
25435 in and see that kind gentleman, and tell him that if I was a bit gruff
25436 in my manner there was not any harm meant, and that I am much obliged to
25437 him for picking up my books.
25438 \begin_inset Quotes erd
25444 \begin_layout Plain Layout
25447 \begin_inset Quotes eld
25450 You make too much of a trifle,
25451 \begin_inset Quotes erd
25456 \begin_inset Quotes eld
25459 May I ask how you knew who I was?
25460 \begin_inset Quotes erd
25466 \begin_layout Plain Layout
25469 \begin_inset Quotes eld
25472 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25473 you'll find my little bookshop at the corner of Church Street, and very
25474 happy to see you, I am sure.
25475 Maybe you collect yourself, sir.
25479 \begin_inset space ~
25493 \begin_inset space ~
25496 – a bargain, every one of them.
25497 With five volumes you could just fill that gap on that second shelf.
25498 It looks untidy, does it not, sir?
25499 \begin_inset Quotes erd
25510 \begin_layout Standard
25511 \begin_inset VSpace defskip
25517 \begin_layout Standard
25518 The rule can be colored by redefining the command
25519 \begin_inset Flex Code
25522 \begin_layout Plain Layout
25531 This is done by inserting the command
25534 \begin_layout LyX-Code
25539 columnseprulecolor}{
25544 \begin_layout Standard
25545 as \SpecialChar TeX
25546 Code before the multicolumn inset.
25548 \begin_inset Flex Code
25551 \begin_layout Plain Layout
25557 in this command by a color of your choice.
25558 You can use all pre- and self-defined colors.
25566 \begin_inset space ~
25571 for more information about pre- and self-defined colors.
25572 To go back to the default color insert the command
25575 \begin_layout LyX-Code
25580 columnseprulecolor}{
25585 \begin_layout Standard
25586 Here is the example with a cyan rule and 1
25587 \begin_inset space \thinspace{}
25590 cm column separation:
25593 \begin_layout Standard
25597 \begin_layout Plain Layout
25606 \begin_layout Plain Layout
25612 columnseprulecolor}{
25622 \begin_layout Standard
25623 \begin_inset Flex Multiple Columns
25626 \begin_layout Plain Layout
25629 \begin_inset Quotes eld
25632 You're surprised to see me, sir,
25633 \begin_inset Quotes erd
25636 said he, in a strange, croaking voice.
25639 \begin_layout Plain Layout
25642 I acknowledged that I was.
25645 \begin_layout Plain Layout
25648 \begin_inset Quotes eld
25651 Well, I've a conscience, sir, and when I chanced to see you go into this
25652 house, as I came hobbling after you, I thought to myself, I'll just step
25653 in and see that kind gentleman, and tell him that if I was a bit gruff
25654 in my manner there was not any harm meant, and that I am much obliged to
25655 him for picking up my books.
25656 \begin_inset Quotes erd
25662 \begin_layout Plain Layout
25665 \begin_inset Quotes eld
25668 You make too much of a trifle,
25669 \begin_inset Quotes erd
25674 \begin_inset Quotes eld
25677 May I ask how you knew who I was?
25678 \begin_inset Quotes erd
25684 \begin_layout Plain Layout
25687 \begin_inset Quotes eld
25690 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25691 you'll find my little bookshop at the corner of Church Street, and very
25692 happy to see you, I am sure.
25693 Maybe you collect yourself, sir.
25697 \begin_inset space ~
25711 \begin_inset space ~
25714 – a bargain, every one of them.
25715 With five volumes you could just fill that gap on that second shelf.
25716 It looks untidy, does it not, sir?
25717 \begin_inset Quotes erd
25728 \begin_layout Standard
25732 \begin_layout Plain Layout
25738 columnseprule}{0pt}
25741 \begin_layout Plain Layout
25747 columnseprulecolor}{
25755 \begin_inset Note Note
25758 \begin_layout Plain Layout
25759 go back to the default
25767 \begin_layout Section
25768 Non-standard Paragraph Shapes
25771 \begin_layout Standard
25774 as well as any other text processor uses by default rectangular paragraphs.
25775 For special cases like for example posters, invitation cards or poems you
25776 can modify the paragraph shape to one of your choice.
25777 This can be done by using the \SpecialChar LaTeX
25779 \begin_inset Flex Code
25782 \begin_layout Plain Layout
25788 which is loaded by using in the document settings the module
25790 Custom paragraph shapes
25795 \begin_layout Subsection
25799 \begin_layout Standard
25804 provides the following shapes:
25807 \begin_layout Standard
25808 \begin_inset Tabular
25809 <lyxtabular version="3" rows="13" columns="3">
25810 <features booktabs="true" islongtable="true" longtabularalignment="center">
25811 <column alignment="left" valignment="middle" width="16col%">
25812 <column alignment="left" valignment="middle" width="40col%">
25813 <column alignment="left" valignment="middle" width="35col%">
25814 <row endhead="true">
25815 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25818 \begin_layout Plain Layout
25827 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25830 \begin_layout Plain Layout
25839 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
25842 \begin_layout Plain Layout
25852 <row interlinespace="default">
25853 <cell alignment="left" valignment="top" usebox="none">
25856 \begin_layout Plain Layout
25864 <cell alignment="left" valignment="top" usebox="none">
25867 \begin_layout Plain Layout
25870 Circle with circular hole (in the size of a CD/DVD)
25875 <cell alignment="left" valignment="top" usebox="none">
25878 \begin_layout Plain Layout
25881 Cannot be scaled, take care there is not too much text
25887 <row interlinespace="default">
25888 <cell alignment="left" valignment="top" usebox="none">
25891 \begin_layout Plain Layout
25899 <cell alignment="left" valignment="top" usebox="none">
25902 \begin_layout Plain Layout
25910 <cell alignment="left" valignment="top" usebox="none">
25913 \begin_layout Plain Layout
25916 Fragile, calculation might fail
25922 <row interlinespace="default">
25923 <cell alignment="left" valignment="top" usebox="none">
25926 \begin_layout Plain Layout
25934 <cell alignment="left" valignment="top" usebox="none">
25937 \begin_layout Plain Layout
25940 Rhomboid (symbolizing a
25941 \begin_inset Quotes eld
25945 \begin_inset Quotes erd
25953 <cell alignment="left" valignment="top" usebox="none">
25956 \begin_layout Plain Layout
25965 <row interlinespace="default">
25966 <cell alignment="left" valignment="top" usebox="none">
25969 \begin_layout Plain Layout
25977 <cell alignment="left" valignment="top" usebox="none">
25980 \begin_layout Plain Layout
25988 <cell alignment="left" valignment="top" usebox="none">
25991 \begin_layout Plain Layout
26000 <row interlinespace="default">
26001 <cell alignment="left" valignment="top" usebox="none">
26004 \begin_layout Plain Layout
26012 <cell alignment="left" valignment="top" usebox="none">
26015 \begin_layout Plain Layout
26023 <cell alignment="left" valignment="top" usebox="none">
26026 \begin_layout Plain Layout
26035 <row interlinespace="default">
26036 <cell alignment="left" valignment="top" usebox="none">
26039 \begin_layout Plain Layout
26047 <cell alignment="left" valignment="top" usebox="none">
26050 \begin_layout Plain Layout
26053 Nut for bolt (hexagon with circular hole)
26058 <cell alignment="left" valignment="top" usebox="none">
26061 \begin_layout Plain Layout
26070 <row interlinespace="default">
26071 <cell alignment="left" valignment="top" usebox="none">
26074 \begin_layout Plain Layout
26082 <cell alignment="left" valignment="top" usebox="none">
26085 \begin_layout Plain Layout
26093 <cell alignment="left" valignment="top" usebox="none">
26096 \begin_layout Plain Layout
26105 <row interlinespace="default">
26106 <cell alignment="left" valignment="top" usebox="none">
26109 \begin_layout Plain Layout
26117 <cell alignment="left" valignment="top" usebox="none">
26120 \begin_layout Plain Layout
26128 <cell alignment="left" valignment="top" usebox="none">
26131 \begin_layout Plain Layout
26140 <row interlinespace="default">
26141 <cell alignment="left" valignment="top" usebox="none">
26144 \begin_layout Plain Layout
26152 <cell alignment="left" valignment="top" usebox="none">
26155 \begin_layout Plain Layout
26163 <cell alignment="left" valignment="top" usebox="none">
26166 \begin_layout Plain Layout
26175 <row interlinespace="default">
26176 <cell alignment="left" valignment="top" usebox="none">
26179 \begin_layout Plain Layout
26187 <cell alignment="left" valignment="top" usebox="none">
26190 \begin_layout Plain Layout
26193 Normal/reversed rain drop
26198 <cell alignment="left" valignment="top" usebox="none">
26201 \begin_layout Plain Layout
26204 Fragile, calculation might fail
26210 <row interlinespace="default">
26211 <cell alignment="left" valignment="top" usebox="none">
26214 \begin_layout Plain Layout
26223 <cell alignment="left" valignment="top" usebox="none">
26226 \begin_layout Plain Layout
26229 The \SpecialChar TeX
26235 <cell alignment="left" valignment="top" usebox="none">
26238 \begin_layout Plain Layout
26247 <row interlinespace="default">
26248 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
26251 \begin_layout Plain Layout
26255 \begin_inset Newline newline
26263 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
26266 \begin_layout Plain Layout
26269 Triangles in different orientations
26274 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
26277 \begin_layout Plain Layout
26293 \begin_layout Standard
26294 To use a shape for your paragraph, simply select it in \SpecialChar LyX
26296 for environments in the toolbar.
26299 \begin_layout Standard
26300 \begin_inset Newpage newpage
26306 \begin_layout Standard
26307 Here is an example paragraph in the shape of a nut:
26310 \begin_layout Standard
26311 \begin_inset VSpace bigskip
26320 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26321 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26323 At vero eos et accusam et justo duo dolores et ea rebum.
26324 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26326 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26327 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26331 \begin_layout Standard
26332 \begin_inset VSpace bigskip
26338 \begin_layout Standard
26339 \begin_inset Note Greyedout
26342 \begin_layout Plain Layout
26351 paragraphs cannot run over a page break.
26359 \begin_layout Standard
26360 \begin_inset VSpace bigskip
26366 \begin_layout Standard
26368 \begin_inset Flex Code
26371 \begin_layout Plain Layout
26377 takes care that the shape will always be preserved, no matter how much
26378 text is in the paragraph.
26379 Therefore the paragraph size changes with the amount of contained text.
26380 This can lead to paragraph sizes exceeding the page margins.
26381 To demonstrate the size scaling, here is the same example paragraph but
26382 with twice as much text:
26385 \begin_layout Standard
26386 \begin_inset Newpage newpage
26395 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26396 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26398 At vero eos et accusam et justo duo dolores et ea rebum.
26399 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26401 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26402 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26404 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26405 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26407 At vero eos et accusam et justo duo dolores et ea rebum.
26408 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26410 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26411 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26415 \begin_layout Standard
26416 \begin_inset VSpace bigskip
26422 \begin_layout Standard
26423 An exception is the shape
26428 It cannot be scaled because it must fit the size of a CD/DVD.
26429 Therefore the amount of text that fits into the shape is limited.
26430 \begin_inset Newline newline
26441 shape are fragile, meaning that the calculation of their size can fail,
26442 depending on the amount of text.
26443 You will then get the \SpecialChar LaTeX
26445 \begin_inset Quotes eld
26448 Arithmetic overflow
26449 \begin_inset Quotes erd
26453 In this case one can try to remove or add some text; if nothing works one
26454 has to use another shape.
26457 \begin_layout Standard
26458 \begin_inset VSpace bigskip
26464 \begin_layout Standard
26465 For shapes with tips you will maybe see that \SpecialChar LaTeX
26466 's hyphenation routine fails
26467 for text in the tips.
26468 Therefore it is often necessary to add hyphenation points
26473 arg "specialchar-insert hyphenation"
26478 ) to the corresponding text parts.
26481 \begin_layout Standard
26482 \begin_inset VSpace bigskip
26488 \begin_layout Standard
26489 Shapepar paragraphs are either always centered or placed on the page so
26490 that their left border touches the left page margin.
26491 You can therefore not use the paragraph dialog to align such paragraphs.
26492 A solution is to put the paragraph into a minipage or parbox and align
26494 The problem is hereby to find the right width for the box.
26495 Because if it is too wide and you center the box, the paragraph is not
26496 centered too because it sticks at the left side of the box.
26497 So you might have to play a bit with the width until it fits.
26498 Here are two heart-shaped paragraphs, the first one is not aligned, the
26499 second one is right-aligned:
26502 \begin_layout Standard
26503 \begin_inset Newpage newpage
26509 \begin_layout Heart
26513 Lo\SpecialChar softhyphen
26514 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26515 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26517 At vero eos et accusam et justo duo dolores et ea rebum.
26518 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26522 \begin_layout Standard
26523 \begin_inset VSpace bigskip
26529 \begin_layout Standard
26532 \begin_inset Box Frameless
26542 height_special "totalheight"
26547 backgroundcolor "none"
26550 \begin_layout Heart
26554 Lo\SpecialChar softhyphen
26555 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26556 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26558 At vero eos et accusam et justo duo dolores et ea rebum.
26559 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26568 \begin_layout Subsection
26572 \begin_layout Standard
26573 You can define any shape you want.
26574 Doing this manually is a lot of work because every coordinate must be specified.
26575 But there is a way to let the computer calculate the coordinates:
26578 \begin_layout Enumerate
26579 Install the program
26580 \begin_inset CommandInset href
26583 target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
26591 \begin_layout Enumerate
26598 TeX/LaTeX\SpecialChar menuseparator
26599 Settings\SpecialChar menuseparator
26602 and select the font size you are using in your document.
26603 For example this document uses the size 12
26604 \begin_inset space \thinspace{}
26610 \begin_layout Enumerate
26614 \begin_layout Enumerate
26617 TeX/LaTeX\SpecialChar menuseparator
26620 to export the shape to coordinates.
26621 In the appearing dialog use either the outline of your shape for the coordinate
26622 s or the path itself.
26626 \begin_layout Plain Layout
26627 For more information see
26628 \begin_inset CommandInset href
26630 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
26643 \begin_layout Standard
26644 The coordinates are written into a \SpecialChar TeX
26646 To use it for your \SpecialChar LyX
26650 \begin_layout Enumerate
26651 Place the cursor before the first character of your paragraph (or into a
26655 \begin_layout Enumerate
26656 Open in \SpecialChar LyX
26659 Insert\SpecialChar menuseparator
26660 File\SpecialChar menuseparator
26662 \begin_inset space ~
26667 , select the file and use
26676 \begin_layout Standard
26677 \begin_inset VSpace defskip
26683 \begin_layout Standard
26684 \begin_inset Note Greyedout
26687 \begin_layout Plain Layout
26692 : The changed shape only applies to the current paragraph; everything is
26693 reset to normal for the next paragraph.
26694 Therefore the shape definition file must be input into every paragraph
26695 with the desired shape.
26703 \begin_layout Standard
26704 \begin_inset VSpace bigskip
26710 \begin_layout Standard
26711 Here is an example:
26714 \begin_layout Standard
26715 \begin_inset VSpace bigskip
26721 \begin_layout Standard
26722 \begin_inset CommandInset include
26724 filename "SpecialParagraphShape.tex"
26731 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26732 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26734 At vero eos et accusam et justo duo dolores et ea rebum.
26735 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26737 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26738 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26742 \begin_layout Standard
26743 \begin_inset VSpace bigskip
26749 \begin_layout Standard
26754 to draw complexer shapes in
26758 you can draw the shape in a program of your choice and import the resulting
26764 Then you only need to draw a line or spline along the outline of the image.
26767 \begin_layout Standard
26768 \begin_inset VSpace bigskip
26774 \begin_layout Standard
26777 Custom paragraph shapes
26779 also provides the two commands
26787 which can be used to define custom shapes coordinate by coordinate.
26791 \begin_layout Plain Layout
26792 These commands are internally used for all shapes described here.
26797 For information how these styles are used and about further customization
26798 possibilities, have a look at the
26799 \begin_inset CommandInset href
26801 name "documentation"
26802 target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
26808 \begin_inset Flex Code
26811 \begin_layout Plain Layout