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 no
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
125 \postpone_fragile_content false
129 \docbook_table_output 0
130 \docbook_mathml_prefix 1
131 \author -712698321 "Jürgen Spitzmüller"
134 \author 244031559 "Yuriy"
135 \author 564990737 "John Lyx"
136 \author 630872221 "Jean-Pierre Chrétien" jeanpierre.chretien@free.fr
137 \author 1075283030 "Thibaut"
138 \author 1119979965 "Joel A. Kulesza"
144 Additional \SpecialChar LyX
148 \begin_layout Subtitle
150 \change_deleted 630872221 1622909155
152 \change_inserted 630872221 1622909155
159 by the \SpecialChar LyX
164 \begin_layout Plain Layout
166 Principal maintainer of this file is
168 Richard Kimberly Heck
171 If you have comments or error corrections, please send them to the \SpecialChar LyX
174 \begin_inset Flex Code
177 \begin_layout Plain Layout
178 <lyx-docs@lists.lyx.org>
191 \begin_layout Standard
192 \begin_inset CommandInset toc
193 LatexCommand tableofcontents
200 \begin_layout Chapter
204 \begin_layout Standard
205 This manual is essentially Part II of the
207 User's Guide\SpecialChar endofsentence
210 The reason for separating the two documents is simple: the
214 is already quite lengthy, and it contains information on all of the basic
215 features one needs to know in order to prepare most documents.
216 However, the \SpecialChar LyX
217 Team has worked to make \SpecialChar LyX
218 extensible through various configuration
219 files and external packages.
220 That means that if you want to support the Fizzwizzle \SpecialChar LaTeX
222 create a layout file (or module) for it without having to alter \SpecialChar LyX
224 We've already had contributions of several new features this way, and some
225 of them are documented here.
226 There are also some more `advanced' features, such as how to control the
227 presentation of bibliographies and how to work with multi-part documents,
228 that are not covered in the
232 and are discussed here.
235 \begin_layout Standard
236 This manual also documents some special features, like fax support
237 \change_deleted 244031559 1603802929
239 \change_inserted 244031559 1603802931
243 \change_deleted 244031559 1603802954
246 , which require additional software to work properly.
247 There is also a chapter on \SpecialChar LyX
249 And lastly, there's a chapter of \SpecialChar LaTeX
250 tools and tips, things you can use to
251 spruce up your documents by directly using the powerful features of \SpecialChar LaTeX
253 After all, \SpecialChar LyX
258 only WYSIWYM and will only ever interface to some, not all, \SpecialChar LaTeX
262 \begin_layout Standard
263 If you haven't read the
267 yet, you are definitely in the wrong manual.
272 is the first place to go, since it describes the notation and format of
274 You should also be thoroughly familiar with the
278 and all of the basic features of \SpecialChar LyX
279 before attempting to read this one.
282 \begin_layout Standard
283 Since many of the topics in this manual depend heavily on \SpecialChar LyX
285 with \SpecialChar LaTeX
286 , this first chapter covers the inner workings of \SpecialChar LyX
289 to generate exactly the \SpecialChar LaTeX
291 It is obviously for more seasoned \SpecialChar LyX
295 \begin_layout Chapter
297 and \SpecialChar LaTeX
301 \begin_layout Section
303 Uses \SpecialChar LaTeX
307 \begin_layout Standard
308 This chapter is for both \SpecialChar TeX
309 -nicians and the \SpecialChar LaTeX
311 In it, we'll explain how \SpecialChar LyX
312 and \SpecialChar LaTeX
313 work together to produce printable output.
314 This is the only place in any of the manuals where we assume you know something
315 about \SpecialChar LaTeX
319 \begin_layout Standard
320 At one time, \SpecialChar LyX
322 \begin_inset Quotes eld
325 WYSIWYM frontend to \SpecialChar LaTeX
327 \begin_inset Quotes erd
330 but that's no longer true.
331 There are frontends to \SpecialChar LaTeX
336 \begin_layout Plain Layout
337 Some familar ones are \SpecialChar TeX
338 maker and kile, on Linux, and \SpecialChar TeX
340 There are also the \SpecialChar LaTeX
341 modes for vi and emacs, of course.
346 These are basically text editors with the ability to run \SpecialChar LaTeX
348 errors in the file you're editing.
349 Although \SpecialChar LyX
358 run \SpecialChar LaTeX
359 , and it also indicates errors in the file, it also does much, much
361 For one thing, you don't need to know \SpecialChar LaTeX
362 to use \SpecialChar LyX
365 has added its own extensions to \SpecialChar LaTeX
367 Try the following sometime: select
368 \begin_inset Flex Noun
371 \begin_layout Plain Layout
372 Export\SpecialChar menuseparator
379 \begin_inset Flex Noun
382 \begin_layout Plain Layout
389 \begin_inset Flex Noun
392 \begin_layout Plain Layout
393 View\SpecialChar menuseparator
403 ), then look at the preamble of the resulting
404 \begin_inset Flex Code
407 \begin_layout Plain Layout
414 You'll notice a variety of new macros defined specifically by \SpecialChar LyX
416 These macros are defined automatically, according to the features you use
420 \begin_layout Standard
421 There are several commands that automatically invoke \SpecialChar LaTeX
426 \begin_layout Itemize
427 \begin_inset Flex Noun
430 \begin_layout Plain Layout
431 Document\SpecialChar menuseparator
440 \begin_layout Itemize
441 \begin_inset Flex Noun
444 \begin_layout Plain Layout
445 Document\SpecialChar menuseparator
454 \begin_layout Standard
455 They will only invoke \SpecialChar LaTeX
456 if the file has changed since the last time \SpecialChar LaTeX
462 \begin_layout Standard
463 When \SpecialChar LyX
464 runs \SpecialChar LaTeX
465 on the file you're editing, it performs these steps:
468 \begin_layout Enumerate
469 Convert the document to \SpecialChar LaTeX
470 and save to a file with the extension
471 \begin_inset Flex Code
474 \begin_layout Plain Layout
481 \begin_inset Flex Code
484 \begin_layout Plain Layout
493 \begin_layout Enumerate
494 Run \SpecialChar LaTeX
496 \begin_inset Flex Code
499 \begin_layout Plain Layout
505 file (maybe several times), and run any other commands (such as
506 \begin_inset Flex Code
509 \begin_layout Plain Layout
516 \begin_inset Flex Code
519 \begin_layout Plain Layout
525 ) needed to compile the \SpecialChar LaTeX
529 \begin_layout Enumerate
530 If there are any errors, show the error log.
533 \begin_layout Standard
534 If you have run \SpecialChar LaTeX
536 \begin_inset Flex Noun
539 \begin_layout Plain Layout
540 View\SpecialChar menuseparator
547 then runs a DVI viewer to display the DVI-file.
549 \begin_inset Flex Noun
552 \begin_layout Plain Layout
553 View\SpecialChar menuseparator
560 performs further steps:
563 \begin_layout Enumerate
565 \begin_inset Flex Code
568 \begin_layout Plain Layout
574 to convert the DVI file to PostScript.
577 \begin_layout Enumerate
578 Run a PostScript viewer, such as
579 \begin_inset Flex Code
582 \begin_layout Plain Layout
588 , to display the PostScript file.
591 \begin_layout Standard
593 does similar things when viewing, or exporting, other formats.
596 \begin_layout Section
597 Translating \SpecialChar LaTeX
598 files into \SpecialChar LyX
602 \begin_layout Standard
603 You can import a \SpecialChar LaTeX
604 file into \SpecialChar LyX
606 \begin_inset Flex Noun
609 \begin_layout Plain Layout
610 File\SpecialChar menuseparator
611 Import\SpecialChar menuseparator
617 command in \SpecialChar LyX
619 This will call a program named
620 \begin_inset Flex Code
623 \begin_layout Plain Layout
629 which will create a file
630 \begin_inset Flex Code
633 \begin_layout Plain Layout
640 \begin_inset Flex Code
643 \begin_layout Plain Layout
651 will then open that file.
655 \begin_layout Plain Layout
656 \begin_inset Flex Code
659 \begin_layout Plain Layout
665 can also be run from the command line, of course.
673 \begin_layout Standard
674 \begin_inset Flex Code
677 \begin_layout Plain Layout
683 will translate most legal \SpecialChar LaTeX
684 , but not everything.
685 It will put things it doesn't understand into \SpecialChar TeX
686 code, so after translating
688 \begin_inset Flex Code
691 \begin_layout Plain Layout
697 , you can look for \SpecialChar TeX
698 code and hand-edit it until it looks right.
701 \begin_layout Standard
702 If you don't know what \SpecialChar TeX
703 code is, read the next section.
706 \begin_layout Section
707 \begin_inset CommandInset label
709 name "sec:Inserting-TeX-Code"
713 Inserting \SpecialChar TeX
714 Code into \SpecialChar LyX
718 \begin_layout Standard
719 Anything you can do in \SpecialChar LaTeX
720 you can do in \SpecialChar LyX
721 , for a very simple reason: You can
722 always insert \SpecialChar TeX
723 code into any \SpecialChar LyX
726 cannot, and will never be able to, display every possible \SpecialChar LaTeX
728 If ever you need to insert \SpecialChar LaTeX
729 commands into your \SpecialChar LyX
730 document, you can use the
732 \begin_inset Flex Code
735 \begin_layout Plain Layout
742 box, which you can insert into your document with
743 \begin_inset Flex Noun
746 \begin_layout Plain Layout
747 Insert\SpecialChar menuseparator
757 or the keyboard shortcut
766 \begin_layout Standard
767 Here's an example of inserting \SpecialChar LaTeX
768 commands in a \SpecialChar LyX
770 The code looks like this:
773 \begin_layout LyX-Code
777 \begin_inset Newline newline
783 \begin_inset Newline newline
786 This is an example of a minipage environment.
788 \begin_inset Newline newline
791 can put nearly everything in it, even (non-floating)
792 \begin_inset Newline newline
797 \begin_inset Newline newline
803 \begin_inset Newline newline
807 \begin_inset Newline newline
813 \begin_inset Newline newline
819 \begin_inset Newline newline
825 \begin_inset Newline newline
830 \begin_inset Newline newline
836 \begin_inset Newline newline
842 \begin_inset Newline newline
848 \begin_inset Newline newline
856 \begin_layout LyX-Code
860 \begin_layout Standard
862 \begin_inset Flex Code
865 \begin_layout Plain Layout
872 box containing this text is directly after this paragraph.
873 Those of you reading the manual in \SpecialChar LyX
874 will only see the \SpecialChar TeX
876 Those reading a printed version of the manuals will see the actual results:
877 \begin_inset VSpace bigskip
883 \begin_layout Standard
887 \begin_layout Plain Layout
894 \begin_layout Plain Layout
901 \begin_layout Plain Layout
903 This is an example of a minipage environment.
904 You can put nearly everything in it, even (non-floating) figures and tables.
908 \begin_layout Plain Layout
915 \begin_layout Plain Layout
920 \begin_layout Plain Layout
927 \begin_layout Plain Layout
934 \begin_layout Plain Layout
941 \begin_layout Plain Layout
947 \begin_layout Plain Layout
954 \begin_layout Plain Layout
961 \begin_layout Plain Layout
968 \begin_layout Plain Layout
978 \begin_inset VSpace bigskip
984 \begin_layout Standard
985 In addition to using \SpecialChar TeX
986 code, you can also create a separate file containing
987 some complex \SpecialChar LaTeX
988 structure and then use
989 \begin_inset Flex Noun
992 \begin_layout Plain Layout
993 Insert\SpecialChar menuseparator
1003 to include your file (you should select the type
1004 \begin_inset Flex Code
1007 \begin_layout Plain Layout
1014 We recommend that you only do this if you have a
1015 \begin_inset Flex Code
1018 \begin_layout Plain Layout
1029 Otherwise, you'll have a big job tracking down \SpecialChar LaTeX
1033 \begin_layout Standard
1034 There are a few last points to emphasize:
1037 \begin_layout Itemize
1043 check if your \SpecialChar LaTeX
1047 \begin_layout Itemize
1048 Beware of reinventing the wheel.
1051 \begin_layout Standard
1052 On that last point, \SpecialChar LyX
1053 does have quite a few features tucked into it, and
1055 Be sure to check the manuals to make sure that \SpecialChar LyX
1056 doesn't have such-and-such
1057 feature before you decide you have to do it by hand.
1058 Moreover, there are numerous \SpecialChar LaTeX
1059 packages out there to do all sorts of things,
1060 from labels to envelopes to fancy multipage tables.
1062 \change_inserted 244031559 1603815732
1064 \begin_inset CommandInset href
1067 target "https://www.ctan.org/"
1073 \change_deleted 244031559 1603815732
1075 \begin_inset CommandInset href
1078 target "http://www.ctan.org/"
1088 \begin_layout Standard
1089 If you do need to do some wild and fancy things within your document, be
1090 sure to check out a good \SpecialChar LaTeX
1091 book for assistance.
1092 There are a number of them listed in the bibliography of the
1099 \begin_layout Section
1101 and the \SpecialChar LaTeX
1105 \begin_layout Subsection
1106 About the \SpecialChar LaTeX
1110 \begin_layout Standard
1111 If you already know \SpecialChar LaTeX
1112 , there is no need to explain here what the preamble
1114 If you don't, the following will give you some ideas—we recommend again
1115 that you consult a \SpecialChar LaTeX
1116 book for further information.
1117 In any case, you should read the points below, because they explain what
1118 you can do and what you don't need to do in the \SpecialChar LaTeX
1119 preamble of a \SpecialChar LyX
1123 \begin_layout Standard
1124 The \SpecialChar LaTeX
1125 preamble comes at the very beginning of a document,
1133 \begin_layout Itemize
1134 Declare the document class.
1136 \begin_inset Newline newline
1140 already does this for you.
1141 If you're a seasoned \SpecialChar LaTeX
1142 -nician, and you have a custom document class you
1143 want to use, check out the
1145 Customization Manual
1147 for information on how to make \SpecialChar LyX
1151 \begin_layout Itemize
1152 Declare the usage of packages.
1154 \begin_inset Newline newline
1158 packages provide special commands, which are only available within a document
1159 when the package has been declared in the preamble.
1160 In addition to providing special commands, the inclusion of a package can
1161 change the document.
1162 For example, the package
1163 \begin_inset Flex Code
1166 \begin_layout Plain Layout
1172 forces all paragraphs to be indented.
1173 There are other packages for labels, envelopes, margins, etc.
1177 \begin_layout Itemize
1178 Set counters, variables, lengths and widths.
1180 \begin_inset Newline newline
1183 There are several \SpecialChar LaTeX
1184 counters and variables that
1188 be set globally from within the preamble in order to have the desired effect.
1189 (There are variables that you can set and reset inside the document, too.)
1190 Margins are a good example of something that must be set in the preamble.
1191 Another example is the label format for lists.
1192 You can actually set these just about anywhere, but it's best to do it
1193 just once, inside the preamble.
1196 \begin_layout Itemize
1197 Declare user defined commands (with
1198 \begin_inset Flex Code
1201 \begin_layout Plain Layout
1210 \begin_inset Flex Code
1213 \begin_layout Plain Layout
1222 \begin_inset Newline newline
1225 These are abbreviations for \SpecialChar LaTeX
1226 commands which appear very often inside a document.
1227 Although the preamble is a good place to declare such commands, they
1231 be declared anywhere (before they are used for the first time, of course).
1232 This can be useful if there is a lot of raw \SpecialChar LaTeX
1233 code in your document, which
1234 normally should not be the case.
1237 \begin_layout Standard
1239 adds its own set of definitions to the preamble of the
1240 \begin_inset Flex Code
1243 \begin_layout Plain Layout
1250 This makes \SpecialChar LaTeX
1251 files generated by \SpecialChar LyX
1255 \begin_layout Subsection
1256 Changing the Preamble
1259 \begin_layout Standard
1260 The commands which \SpecialChar LyX
1261 adds to the preamble of a \SpecialChar LaTeX
1262 file are fixed; you can't
1263 change them without patching \SpecialChar LyX
1265 You can, however, add your own stuff to the preamble by selecting
1266 \begin_inset Flex Noun
1269 \begin_layout Plain Layout
1272 \begin_inset space ~
1281 \begin_inset Flex Noun
1284 \begin_layout Plain Layout
1285 Document\SpecialChar menuseparator
1293 adds anything in the
1294 \begin_inset Flex Noun
1297 \begin_layout Plain Layout
1303 dialog to its own built-in preamble.
1304 Before adding your own declarations in the preamble, you should make sure
1305 that \SpecialChar LyX
1306 doesn't already support what you want to do.
1307 (Remember what we said about reinventing the wheel?) Also,
1309 make sure your preamble code is correct
1313 doesn't check it for you.
1314 If there is an error, you're likely to get an error like
1315 \begin_inset Quotes eld
1319 \begin_inset Flex Code
1322 \begin_layout Plain Layout
1331 \begin_inset Quotes erd
1335 If you see this error, check your preamble.
1338 \begin_layout Subsection
1342 \begin_layout Standard
1343 Here are some examples of what you can add to a preamble, and what they
1347 \begin_layout Subsubsection
1351 \begin_layout Standard
1352 There are two variables under \SpecialChar LaTeX
1353 that control page position:
1354 \begin_inset Flex Code
1357 \begin_layout Plain Layout
1366 \begin_inset Flex Code
1369 \begin_layout Plain Layout
1378 Their names should be self-explanatory.
1379 These variables are useful if you think for a moment about computer labels.
1380 Sometimes, the size of a print medium and the area of the medium that you
1381 can actually print on aren't the same.
1383 \begin_inset Flex Code
1386 \begin_layout Plain Layout
1395 \begin_inset Flex Code
1398 \begin_layout Plain Layout
1409 \begin_layout Standard
1410 The default values for
1411 \begin_inset Flex Code
1414 \begin_layout Plain Layout
1423 \begin_inset Flex Code
1426 \begin_layout Plain Layout
1435 \begin_inset space \thinspace{}
1439 \begin_inset space \thinspace{}
1443 \begin_inset space \space{}
1446 the page isn't shifted.
1447 Unfortunately, some DVI drivers always seem to shift the page.
1448 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1449 If you're using \SpecialChar LyX
1450 on a system that you don't personally maintain, and your
1451 sysadmin is a doofus,
1452 \begin_inset Flex Code
1455 \begin_layout Plain Layout
1464 \begin_inset Flex Code
1467 \begin_layout Plain Layout
1476 Suppose your left and top margins are always 0.5
1477 \begin_inset space \thinspace{}
1481 You can add this to the preamble:
1484 \begin_layout LyX-Code
1492 \begin_layout LyX-Code
1500 \begin_layout Standard
1501 and your margins should now be correct.
1504 \begin_layout Subsubsection
1508 \begin_layout Standard
1509 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1510 There's a rather nice package, available at your nearest CTAN archive,
1511 for printing sheets of labels:
1512 \begin_inset Flex Code
1515 \begin_layout Plain Layout
1522 Now, your system may not have this package installed by default.
1523 We leave that up to you to check.
1524 You'll also want to read the documentation for it; we're not going to do
1526 Since this is an example, however, we'll give you an example of how you
1530 \begin_layout Standard
1531 First, make sure you're using the
1532 \begin_inset Flex Code
1535 \begin_layout Plain Layout
1542 Next, you need to put the following in your preamble:
1545 \begin_layout LyX-Code
1551 \begin_layout LyX-Code
1557 \begin_layout LyX-Code
1563 \begin_layout LyX-Code
1569 \begin_layout LyX-Code
1575 \begin_layout LyX-Code
1581 \begin_layout LyX-Code
1587 \begin_layout Standard
1588 This sets things up for Avery label sheets, stock #5360.
1589 You're now ready to print labels, but you'll need to insert \SpecialChar LaTeX
1592 \begin_inset Flex Code
1595 \begin_layout Plain Layout
1604 \begin_inset Flex Code
1607 \begin_layout Plain Layout
1615 around each label text.
1616 This and other special features of
1617 \begin_inset Flex Code
1620 \begin_layout Plain Layout
1626 are explained in its documentation.
1629 \begin_layout Standard
1630 Someday, someone may write a \SpecialChar LyX
1631 layout file to support this package directly.
1632 Maybe that someone is you.
1635 \begin_layout Subsubsection
1636 Example #3: Paragraph Indentation
1639 \begin_layout Standard
1640 Americans are trained to indent the first line of
1645 As with all of their other weird quirks, most Americans will whine and
1646 moan until they can have their way and indent the first line of all paragraphs.
1655 \begin_layout Standard
1656 Of course, this behavior isn't standard typography.
1657 In books, you typically only indent the first line of a paragraph
1661 it follows another one.
1662 The idea behind indenting the first line of a paragraph is to distinguish
1663 neighboring paragraphs from one another.
1664 If there is no previous paragraph—for example, if it follows a figure or
1665 is the first paragraph in a section—then there is no need for indentation.
1669 \begin_layout Standard
1670 If you're a typical American (we're still joking!), though, you don't care
1671 about such esoteric things; you want your indentation! Add this to the
1675 \begin_layout LyX-Code
1678 usepackage{indentfirst}
1681 \begin_layout Standard
1682 If your \SpecialChar TeX
1683 distribution isn't braindead, you'll have this package, and all
1684 of your paragraphs will get the indentation the Founding Fathers intended
1688 \begin_layout Subsubsection
1689 Example #4: This Document
1692 \begin_layout Standard
1693 You can also check out the preamble of this document to get an idea of some
1694 of the advanced things you can do.
1697 \begin_layout Section
1699 and \SpecialChar LaTeX
1703 \begin_layout Standard
1704 When \SpecialChar LyX
1705 calls \SpecialChar LaTeX
1706 , it tells \SpecialChar LaTeX
1707 to blithely ignore any errors and keep going.
1708 It then uses the logfile from the \SpecialChar LaTeX
1709 run to do a post-mortem.
1710 After analyzing the logfile, \SpecialChar LyX
1711 displays a dialog listing the errors.
1712 Clicking on any one of them will take you to the position in your \SpecialChar LyX
1714 where the error occurred.
1718 \begin_layout Plain Layout
1720 Analyzing the logfile is a tough job, and \SpecialChar LyX
1721 doesn't always go to the right
1723 There are also cases where \SpecialChar LaTeX
1724 reports the error on one line, but the actual
1726 This is not unlike forgetting a closing brace in a program: You'll get
1727 an error, but only later.
1735 \begin_layout Standard
1736 Some folks also like to look at the log file directly: It is available from
1738 \begin_inset Flex Noun
1741 \begin_layout Plain Layout
1742 Document\SpecialChar menuseparator
1744 \begin_inset space ~
1753 There are some fairly common error messages and warnings.
1754 We'll cover those here.
1755 You should look at a good \SpecialChar LaTeX
1756 book for a complete listing.
1759 \begin_layout Itemize
1760 \begin_inset Flex Code
1763 \begin_layout Plain Layout
1770 \begin_inset Newline newline
1773 Anything beginning with these words is a warning message for the purpose
1775 \begin_inset Quotes eld
1779 \begin_inset Quotes erd
1782 the \SpecialChar LaTeX
1784 You'll get messages like this if you added or changed cross-references
1785 or bibliography entries, in which case, \SpecialChar LaTeX
1786 is trying to tell you that you
1787 need to make another run.
1788 You can by-and-large ignore these.
1791 \begin_layout Itemize
1792 \begin_inset Flex Code
1795 \begin_layout Plain Layout
1802 \begin_inset Newline newline
1805 Another warning message, this time about fonts which \SpecialChar LaTeX
1807 The rest of the message will often say something about a replacement font
1808 that \SpecialChar LaTeX
1810 You can safely ignore these, too.
1813 \begin_layout Itemize
1814 \begin_inset Flex Code
1817 \begin_layout Plain Layout
1826 \begin_inset Newline newline
1835 It seems to generate at least one of these messages for just about any
1837 They are warnings about lines that were too long and run past the right
1839 This happens if \SpecialChar LaTeX
1840 does not find a reasonable way to break the lines (notoriously
1841 often with typewriter font, since this does not allow for automatic break
1843 In many cases, this is unnoticeable in the final output.
1844 (It can be just a point or two.) Sometimes, however, the lines run rather
1845 visibly into the margin; something you will not want to have in your final
1848 \begin_inset Newline newline
1851 There are several global ways to try to minimize the overfull lines.
1854 Enable micro-typographic extensions
1858 Document\SpecialChar menuseparator
1859 Settings\SpecialChar menuseparator
1862 might already improve things a lot.
1863 Furthermore, \SpecialChar LaTeX
1864 code such as the following in
1866 Document\SpecialChar menuseparator
1867 Settings\SpecialChar menuseparator
1870 usually reduces the overfull lines drastically (we use this in the preamble
1875 \begin_layout LyX-Code
1879 \begin_inset Newline newline
1885 \begin_inset Newline newline
1890 emergencystretch 1.5em
1891 \begin_inset Newline newline
1899 \begin_layout Standard
1900 In some cases, however, you eventually have to rewrite the text to get the
1901 line breaking right.
1905 \begin_layout Plain Layout
1906 For more information, see
1907 \begin_inset Flex URL
1910 \begin_layout Plain Layout
1912 http://www.tex.ac.uk/FAQ-overfull.html
1925 \begin_layout Standard
1926 In any case, you should check the respective lines, at least for the final
1927 version of your document.
1928 Your eyes will tell you if there's a problem with something that's too
1933 \begin_layout Plain Layout
1934 You can also enable the `draft' option in
1935 \begin_inset Flex Noun
1938 \begin_layout Plain Layout
1939 Document\SpecialChar menuseparator
1945 , and then \SpecialChar LaTeX
1946 will draw a black box in the margin of lines that are overfull.
1955 \begin_layout Itemize
1956 \begin_inset Flex Code
1959 \begin_layout Plain Layout
1968 \begin_inset Newline newline
1971 Not quite as common as its cousin.
1972 This happens again if \SpecialChar LaTeX
1973 does not find a reasonable break point and consequently
1974 generates too loose lines.
1975 As with the overfull lines, you should check if this is a visible problem.
1978 \begin_layout Itemize
1979 \begin_inset Flex Code
1982 \begin_layout Plain Layout
1991 \begin_inset Flex Code
1994 \begin_layout Plain Layout
2003 \begin_inset Newline newline
2006 Warnings about troubles breaking the page.
2007 Once again, just look at the output.
2008 Your eyes will tell you where something has gone wrong.
2011 \begin_layout Itemize
2012 \begin_inset Flex Code
2015 \begin_layout Plain Layout
2017 \begin_inset Quotes els
2021 \begin_inset Quotes ers
2030 \begin_inset Newline newline
2034 \begin_inset Quotes eld
2038 \begin_inset Quotes erd
2041 isn't installed on this system.
2042 This usually appears because some package your document needs isn't installed.
2043 If you didn't touch the preamble or didn't use the
2044 \begin_inset Flex Code
2047 \begin_layout Plain Layout
2055 command, then one of the packages \SpecialChar LyX
2056 tried to load is missing.
2058 \begin_inset Flex Noun
2061 \begin_layout Plain Layout
2062 Help\SpecialChar menuseparator
2069 to get a list of packages that \SpecialChar LyX
2071 This file is updated whenever you reconfigure \SpecialChar LyX
2073 \begin_inset Flex Noun
2076 \begin_layout Plain Layout
2077 Tools\SpecialChar menuseparator
2083 ) and tells you which packages have been detected and what they do.
2084 \begin_inset Newline newline
2088 \begin_inset Flex Code
2091 \begin_layout Plain Layout
2099 command and the package in question isn't installed, then you'll need to
2100 install it yourself.
2103 \begin_layout Itemize
2104 \begin_inset Flex Code
2107 \begin_layout Plain Layout
2108 LaTeX Error: Unknown option
2114 \begin_inset Newline newline
2117 Error messages beginning with this are trying to tell you that you specified
2118 a bad or undefined option to a package.
2119 Check the package's documentation.
2122 \begin_layout Itemize
2123 \begin_inset Flex Code
2126 \begin_layout Plain Layout
2127 Undefined control sequence
2133 \begin_inset Newline newline
2136 If you've inserted \SpecialChar LaTeX
2137 code into your document, but made a typo, you'll get
2139 You may have forgotten to load a package.
2140 In any case, this error message usually means that you used an undefined
2145 \begin_layout Standard
2146 There are other error and warning messages.
2147 Some are self-explanatory.
2148 These are usually \SpecialChar LaTeX
2150 Others are downright cryptic.
2151 These are usually \SpecialChar TeX
2152 error messages, and we really have
2156 what they mean or how to decipher them.
2160 \begin_layout Standard
2161 There's a general sequence you should follow if you get error messages:
2164 \begin_layout Enumerate
2165 Look at the \SpecialChar LaTeX
2166 code you inserted for typos.
2169 \begin_layout Enumerate
2170 If there are no typos, check that you used the command(s) correctly.
2173 \begin_layout Enumerate
2174 If you get a bunch of error boxes piled up at the very top of the document—and
2175 especially if you see a
2176 \begin_inset Quotes eld
2180 \begin_inset Flex Code
2183 \begin_layout Plain Layout
2192 \begin_inset Quotes erd
2195 error—it means that there are errors in the preamble.
2196 Start debugging your preamble.
2199 \begin_layout Enumerate
2200 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2202 document, the first suspect is your \SpecialChar LaTeX
2203 distribution itself.
2204 Check for missing packages and install them.
2207 \begin_layout Enumerate
2208 Okay, so there are no missing packages.
2209 Did you use any of the fine-tuning options in \SpecialChar LyX
2210 ? Specifically, did you
2214 any of them, like trying to manually insert lots of
2215 \begin_inset Flex Code
2218 \begin_layout Plain Layout
2220 \change_deleted 177693 1654669036
2222 \change_inserted 177693 1654669038
2226 \begin_inset space ~
2230 \change_deleted 177693 1654669040
2232 \change_inserted 177693 1654669041
2241 \begin_inset Flex Code
2244 \begin_layout Plain Layout
2251 \begin_inset Flex Code
2254 \begin_layout Plain Layout
2260 ? Did you try to kludge something together with these instead of using the
2261 appropriate paragraph environment?
2264 \begin_layout Enumerate
2265 All right, you didn't use any of the fine-tuning options, you played by
2267 Did you try to pull a fancy maneuver? Did you do something funky inside
2268 a table or an equation, like inserting a graphic into a table cell?
2271 \begin_layout Enumerate
2272 Do you have long sections of text where \SpecialChar LaTeX
2273 cannot find a place to break a
2274 line? By default, \SpecialChar LaTeX
2275 is rather strict about how much extra inter-word spacing
2276 it will add in order to break a line.
2277 Preferably, you should rework the paragraph to avoid the problem.
2280 \begin_layout Enumerate
2281 Did you go overboard with the nesting? \SpecialChar LyX
2282 (currently) doesn't check to make
2283 sure you're in the limits for nesting environments.
2284 If you nested a bunch of environments to the
2285 \begin_inset Formula $17^{\mathrm{th}}$
2288 level, that's the problem.
2289 (The limit in \SpecialChar LaTeX
2293 \begin_layout Enumerate
2294 Okay, you didn't get any error messages, but your output looks awful.
2295 If you have a table or figure that's too wide or long for the page, you
2300 \begin_layout Enumerate
2301 rescale the figure so it fits.
2304 \begin_layout Enumerate
2305 trim down the table so it fits.
2309 \begin_layout Enumerate
2310 If something else is wrong with the output, and you didn't try to pull anything
2311 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2314 \begin_layout Standard
2315 If all this doesn't help—well, then
2319 you might have found a bug in \SpecialChar LyX
2324 \begin_layout Chapter
2326 \change_inserted 564990737 1670439508
2330 \begin_layout Section
2332 \change_inserted 564990737 1670439533
2333 \begin_inset CommandInset label
2335 name "sec:Collections"
2342 \begin_layout Subsection
2343 AMS \SpecialChar LaTeX
2347 \begin_layout Standard
2354 Richard Kimberly Heck
2357 \begin_layout Standard
2358 \begin_inset VSpace bigskip
2364 \begin_layout Standard
2366 The AMS \SpecialChar LaTeX
2367 layouts are set up to conform to suggested styles for mathematical
2368 papers to be submitted to American Mathematical Society publications.
2369 The layouts are not tailored to a specific journal, but easily can be.
2370 You should refer to the AMS documentation for specific instructions for
2371 each journal (usually it will entail only changing a single line in the
2374 That documentation is available on the Web at
2375 \begin_inset Flex URL
2378 \begin_layout Plain Layout
2386 \begin_inset Flex URL
2389 \begin_layout Plain Layout
2391 ftp://ftp.ams.org/pub/tex/amslatex/
2397 These layouts are appropriate, and useful, for any mathematical writing.
2401 \begin_layout Standard
2402 There are two basic AMS \SpecialChar LaTeX
2406 \begin_layout Itemize
2407 amsart: The standard AMS article format.
2410 \begin_layout Itemize
2411 amsbook: the standard AMS book (really, monograph) format.
2415 \begin_layout Standard
2416 The layouts themselves contain only the minimum necessary to use the AMS
2418 They do not, in particular, contain any of the `theorem' environments used
2419 for setting theorems, lemmas, and the like.
2420 These are contained, instead, in the
2421 \begin_inset Flex Code
2424 \begin_layout Plain Layout
2430 module, which is loaded by default when you select one of the AMS classes.
2431 (It can also be used with other classes and can be removed, if you would
2432 rather use something else.) Less commonly used environments are in the
2433 \begin_inset Flex Code
2436 \begin_layout Plain Layout
2437 Theorems (AMS-Extended)
2442 module, which must be loaded manually.
2445 \begin_layout Standard
2446 By default, theorems and the like are numbered consecutively throughout
2447 the document, but this may be modified by loading the module
2448 \begin_inset Flex Code
2451 \begin_layout Plain Layout
2452 Theorems (Order by Section)
2457 or, if you are using
2458 \begin_inset Flex Code
2461 \begin_layout Plain Layout
2468 \begin_inset Flex Code
2471 \begin_layout Plain Layout
2472 Theorems (Order by Chapter)
2478 These will number the results as
2479 \begin_inset Formula $n.m$
2482 , where the first number refers to the section (or chapter) and the second
2483 refers to the total number of results so far in that section (or chapter).
2484 Many environments are also available unnumbered.
2485 These are indicated by an asterisk at the end.
2486 If you happen to want
2490 unnumbered results, the module
2491 \begin_inset Flex Code
2494 \begin_layout Plain Layout
2500 provides that option.
2503 \begin_layout Standard
2504 Note that these modules do not
2508 to be used with the AMS classes.
2509 It is perfectly possible to use the
2510 \begin_inset Flex Code
2513 \begin_layout Plain Layout
2519 module, and the others mentioned, with other classes, such as
2520 \begin_inset Flex Code
2523 \begin_layout Plain Layout
2530 \begin_inset Flex Code
2533 \begin_layout Plain Layout
2540 \begin_inset Flex Code
2543 \begin_layout Plain Layout
2552 \begin_layout Subsubsection
2553 What these layouts provide
2556 \begin_layout Standard
2557 There is a long list of included environments provided by these layouts.
2558 In AMS-\SpecialChar LaTeX
2559 , there is, in fact, an opportunity to define an unlimited variety
2560 of `theorem' environments.
2561 However, the AMS recommends the environments that are available in \SpecialChar LyX
2566 \begin_layout Standard
2567 The following environments—as well as the standard environments, such as
2569 \begin_inset Flex Noun
2572 \begin_layout Plain Layout
2579 \begin_inset Flex Noun
2582 \begin_layout Plain Layout
2589 \begin_inset Flex Noun
2592 \begin_layout Plain Layout
2599 \begin_inset Flex Noun
2602 \begin_layout Plain Layout
2609 \begin_inset Flex Noun
2612 \begin_layout Plain Layout
2619 \begin_inset Flex Code
2622 \begin_layout Plain Layout
2629 \begin_inset Flex Code
2632 \begin_layout Plain Layout
2641 \begin_layout Description
2642 Address This should be the author's permanent address.
2645 \begin_layout Description
2647 \begin_inset space ~
2650 Address This should be the author's temporary address at the time of submission,
2651 if different from the Address.
2654 \begin_layout Description
2655 Email Author's e-mail address
2658 \begin_layout Description
2659 URL Author's Web address, if desired.
2662 \begin_layout Description
2663 Keywords Key words or phrases used to identify specific topics discussed
2667 \begin_layout Description
2668 Subjectclass These refer to the AMS Subject Classifications, published and
2671 Mathematical Reviews
2674 These are also available online at the AMS cites listed above.
2677 \begin_layout Description
2681 \begin_layout Description
2685 \begin_layout Description
2689 \begin_layout Standard
2690 The following environments are provided by both the
2691 \begin_inset Flex Code
2694 \begin_layout Plain Layout
2701 \begin_inset Flex Code
2704 \begin_layout Plain Layout
2710 modules, in the latter case in both starred (unnumbered) and unstarred
2711 (numbered) versions.
2712 These same environments are provided only in the starred versions by the
2714 \begin_inset Flex Code
2717 \begin_layout Plain Layout
2726 \begin_layout Theorem
2727 This is typically used for the statements of major results.
2731 \begin_layout Corollary*
2732 This is used for statements which follow fairly directly from previous statement
2734 Again, these can be major results.
2739 These are smaller results needed to prove other statements.
2742 \begin_layout Proposition
2743 These are less major results which (hopefully) add to the general theory
2747 \begin_layout Conjecture
2748 These are statements provided without justification, which the author does
2749 not know how to prove, but which seem to be true (to the author, at least).
2752 \begin_layout Definition*
2753 Guess what this is for.
2754 The font is different for this environment than for the previous ones.
2758 \begin_layout Example*
2759 Used for examples illustrating proven results.
2762 \begin_layout Problem
2763 It's not really known what this is for.
2764 You should figure it out.
2767 \begin_layout Exercise*
2768 Write a description for this one.
2771 \begin_layout Remark
2772 This environment is also a type of theorem, usually a lesser sort of observation.
2775 \begin_layout Claim*
2776 Often used in the course of giving a proof of a larger result.
2780 Generally, these are used to break up long arguments, using specific instances
2786 The numbering scheme for cases is on its own, not together with other numbered
2792 At the end of this environment, a QED symbol (usually a square, but it can
2793 vary with different styles) is placed.
2794 If you want to have other environments within this one—for example, Case
2795 environments—and have the QED symbol appear only after them, then the other
2796 environments need to be nested within the proof environment.
2799 Nesting Environments
2805 for information on nesting.
2808 \begin_layout Standard
2809 And these environments are provided by
2810 \begin_inset Flex Code
2813 \begin_layout Plain Layout
2814 Theorems (AMS-Extended)
2822 \begin_layout Criterion*
2823 A required condition.
2826 \begin_layout Algorithm*
2827 A general procedure to be used.
2830 \begin_layout Axiom*
2831 This is a property or statement taken as true within the system being discussed.
2834 \begin_layout Condition*
2835 Sometimes used to state a condition assumed within the present context of
2840 Similar to a Remark.
2843 \begin_layout Notation*
2844 Used for the explanation of, yes, notation.
2847 \begin_layout Summary
2848 Do we really need to tell you?
2851 \begin_layout Acknowledgement*
2855 \begin_layout Conclusion*
2856 Sometimes used at the end of a long train of argument.
2860 Used in a way similar to Proposition, though perhaps lower on the scale.
2863 \begin_layout Standard
2864 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
2867 They need to be available on your system in order to use these environments.
2870 \begin_layout Subsection
2874 \begin_layout Standard
2880 \begin_layout Subsubsection
2884 \begin_layout Standard
2885 The \SpecialChar LyX
2888 article (koma-script)
2892 report (koma-script)
2910 correspond to the \SpecialChar LaTeX
2928 \begin_inset space ~
2931 of the Koma-Script family.
2932 They are replacements for the standard document classes
2948 , resp., and fit better to European typography conventions in a number of
2952 \begin_layout Itemize
2953 Standard character size is 11pt in
2955 article (koma-script)
2959 report (koma-script)
2967 letter (koma-script)
2972 \begin_layout Itemize
2973 Headings, labels of the description environment, and a number of elements
2976 letter (koma-script)
2978 document class are set in a bold sans serif font.
2982 \begin_layout Plain Layout
2983 There is a big difference between the bold sans serif old cm fonts and new
2984 ec fonts, especially in the appearance of headings.
2985 In comparison, the ec bold sans serif fonts look a bit thin.
2986 Here the \SpecialChar LaTeX
2995 helps to produce the
2996 \begin_inset Quotes eld
3000 \begin_inset Quotes erd
3003 appearance when using the ec fonts.
3008 The numbering of chapter headings is made in the same way as the numbering
3009 of section headings, that is without the extra line
3010 \begin_inset Quotes eld
3013 Chapter\SpecialChar ldots
3015 \begin_inset Quotes erd
3019 In addition, the appearance of the headings can be modified by using a
3020 number of options (in \SpecialChar LyX
3021 to be entered in the field
3024 \begin_inset space ~
3031 Layout\SpecialChar menuseparator
3038 \begin_layout Itemize
3039 The main means in the Koma-Script document classes to design the type area
3048 (in \SpecialChar LyX
3049 to be entered in the extra class options field in the dialog
3051 Document\SpecialChar menuseparator
3055 They make a clearer modification of page margins possible as do the options
3058 Document\SpecialChar menuseparator
3065 \begin_layout Itemize
3066 The \SpecialChar LaTeX
3067 document classes of the Koma-Script family define a number of additional
3069 Those part of it which makes sense in \SpecialChar LyX
3070 is implemented in corresponding
3074 \begin_layout Standard
3075 Detailed descriptions of the \SpecialChar LaTeX
3076 document classes of the Koma-Script family
3077 can be found in the Koma-Script documentation
3088 \begin_layout Subsubsection
3089 article (koma-script), report (koma-script), and book (koma-script)
3092 \begin_layout Standard
3093 The document classes
3095 article (koma-script)
3099 report (koma-script)
3109 are implemented in the layout files
3122 They contain all the paragraph types of the corresponding standard document
3135 , resp., partly modified, with the exception of the \SpecialChar LyX
3140 -type, which is replaced by the new
3144 -type having the same functionality.
3149 -Type there is a number of new paragraph types added.
3156 letter (koma-script)
3161 \begin_layout Itemize
3170 : are equivalents to
3178 , resp., additionally inserting an entry in the table of contents.
3187 are not contained in
3189 article (koma-script)
3194 \begin_layout Itemize
3211 , resp., additionally clearing running heads.
3218 article (koma-script)
3224 \begin_layout Plain Layout
3237 report (koma-script)
3239 , but since this is identical to
3243 , is has not been implemented in \SpecialChar LyX
3252 \begin_layout Itemize
3257 : generates a heading directly above the following paragraph in the standard
3258 character size without affecting the structure of the document.
3261 \begin_layout Itemize
3270 are special captions which respect the different space settings needed
3271 for captions placed above or below an element (if you follow strict typographic
3272 rules, you might want to place table captions always above the table).
3273 You can also use the class option
3290 You need at least Koma-Script version 2.8q to use this.
3293 \begin_layout Itemize
3298 : can be used to set a bonmot, e.
3299 \begin_inset space \thinspace{}
3303 \begin_inset space \space{}
3306 at the beginning of a chapter.
3307 If you use the optional argument (
3309 Insert\SpecialChar menuseparator
3311 \begin_inset space ~
3316 ), you can insert the dictum's author there.
3317 Dictum and author are separated by a line.
3318 You need at least Koma-Script version 2.8q to use this.
3325 article (koma-script)
3330 \begin_layout Standard
3331 The following types, together with the standard types
3343 , form the title area of the document.
3344 They must be entered ahead of the first
3345 \begin_inset Quotes eld
3349 \begin_inset Quotes erd
3356 \begin_layout Plain Layout
3357 The corresponding \SpecialChar LaTeX
3358 commands must appear before the
3369 When such a type is used more than once, the latter usage overwrites the
3370 former one, that means, for every type only the latest usage is valid.
3371 The order of the different types however has, like
3383 , no effect on the appearance of the produced document.
3386 \begin_layout Itemize
3391 : produces a centered paragraph above the ordinary title (
3403 ) for the subject of the document.
3406 \begin_layout Itemize
3411 : produces a centered paragraph below the ordinary title (
3423 ) for the publishers' name.
3426 \begin_layout Itemize
3433 report (koma-script)
3439 produces a centered paragraph on its own page behind the title page, or
3442 article (koma-script)
3444 produces a centered paragraph below the ordinary title (
3463 \begin_layout Itemize
3468 : produces a left aligned paragraph above the ordinary title (
3484 ) for a document`s head.
3487 \begin_layout Itemize
3492 : produces in a double-sided print in
3494 report (koma-script)
3500 a left-aligned paragraph at the top of the title page`s back or has no
3501 effect in a single-sided print or in
3503 article (koma-script)
3508 \begin_layout Itemize
3513 : produces in a double-sided print in
3515 report (koma-script)
3521 a left-aligned paragraph at the bottom of the title page`s back or has
3522 no effect in a single-sided print or in
3524 article (koma-script)
3529 \begin_layout Itemize
3534 : produces a special
3535 \begin_inset Quotes eld
3539 \begin_inset Quotes erd
3542 page ahead of the actual document containing a paragraph without special
3546 \begin_layout Standard
3547 The layout files for the document classes
3549 article (koma-script)
3553 report (koma-script)
3564 This is thought of as a place to define your own types.
3569 in your personal layout directory and edit the file!
3572 \begin_layout Subsubsection
3573 letter (koma-script)
3576 \begin_layout Description
3577 Note: This section discusses the obsolete
3579 KOMA-Script-Letter (v.
3580 \begin_inset space ~
3585 , which is not even included anymore in recent KOMA releases.
3586 Please refer to the next section for the current KOMA-Script-Letter class
3588 \begin_inset space ~
3594 \begin_layout Standard
3598 letter (koma-script)
3600 is implemented in the layout file
3605 It contains all the paragraph types of the corresponding standard document
3610 , partly modified, with the exception of the \SpecialChar LyX
3624 type, which is replaced by the new
3629 In addition, it contains, in contrast to the standard document class, the
3648 Furthermore, there are a number of new letter specific types.
3651 \begin_layout Standard
3652 The appearance of the letter produced by this document class can be controlled
3653 by a number of \SpecialChar LaTeX
3654 commands, which you can put in the \SpecialChar LaTeX
3659 \begin_layout Plain Layout
3660 For example, the standard appearance of the letter`s heading, consisting
3661 of name and address, is quite self-willed.
3663 \begin_inset Quotes eld
3667 \begin_inset Quotes erd
3670 heading is produced by the following \SpecialChar LaTeX
3671 commands in the preamble:
3674 \begin_layout LyX-Code
3684 \begin_layout LyX-Code
3700 \begin_layout LyX-Code
3710 \begin_layout LyX-Code
3730 A detailed German description of such \SpecialChar LaTeX
3731 commands can be found in the Koma-Script
3737 With it, the letter's author can produce his personal letter layout.
3740 \begin_layout Standard
3749 define the beginning of the letter and must be used in every letter.
3750 To emphasize them in the \SpecialChar LyX
3751 document class, they are marked with the letter
3761 \begin_inset space ~
3765 It is possible to write any number of letters in one file.
3770 type produces a new letter using the same addressee and a
3774 type produces a new addressee.
3791 are ordinary paragraph types and can also be used several times in one
3792 and the same letter.
3795 \begin_layout Itemize
3800 : produces a paragraph for the addressee and implicitly defines the beginning
3804 \begin_layout Itemize
3809 : produces a paragraph for the form of address and implicitly produces a
3813 \begin_layout Itemize
3818 : produces a paragraph for a close.
3821 \begin_layout Itemize
3826 : produces a paragraph for a postscript.
3829 \begin_layout Itemize
3834 : produces a paragraph for a distribution list.
3837 \begin_layout Itemize
3842 : produces a paragraph for enclosures.
3845 \begin_layout Standard
3886 are input types provided with a label to enter information, which will
3887 be processed by the document class.
3891 \begin_layout Plain Layout
3892 It could be seen as a matter of inconsequence, that the types
3900 described above are not such input types as well.
3901 Because of the special meaning of those types, however, I have implemented
3902 them as ordinary paragraph types with a one letter mark in the left margin.
3903 Moreover, it would affect my feeling of symmetry, if the
3911 type had such a serious different appearance.
3916 The types must be used ahead of the corresponding
3923 \begin_layout Standard
3924 An implementation of these types in a WYSIWYG fashion does not seem to make
3925 sense, because the real appearance of the produced letter does not only
3926 depend on the usage of the particular type, but also on other factors.
3927 For example, a signature entered in the
3931 type will in the standard behavior appear in the produced letter only,
3932 when in the same letter also a
3937 The entered value of the
3941 type will in the standard behavior not appear in the produced letter at
3943 The possibility to design the letter`s heading freely is already indicated
3944 in a footnote above.
3947 \begin_layout Standard
3948 The input types can also be used as empty paragraphs.
3950 \begin_inset space \thinspace{}
3954 \begin_inset space \space{}
3966 type is not used at all, in the standard behavior the value of the
3970 type is used as signature, whereas if an empty
3974 type is used, no signature value is defined.
3977 \begin_layout Standard
3978 By using the input types it is possible to write a letter template, containing
3979 filled input types with your personal dates (name, address, etc.) and empty
3980 input types for other dates you want to enter.
3983 \begin_layout Itemize
3988 : sender's name, in the standard behavior appears as a centered paragraph
3989 in small caps in the letter`s heading.
3992 \begin_layout Itemize
3997 : sender's signature, in the standard behavior appears below the
4006 type is used, the value of the
4010 type appears instead.
4013 \begin_layout Itemize
4018 : sender's address, in the standard behavior appears in a centered paragraph
4019 in the letter`s heading below the sender's name.
4022 \begin_layout Itemize
4027 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
4038 \begin_layout Itemize
4043 : place of the letter`s making.
4046 \begin_layout Itemize
4051 : date of the letter`s making.
4060 , in the standard behavior, produce the place and the date in a right-aligned
4061 line below the addressee's field.
4066 type is used, neither place nor date appear, independent of the value of
4076 type is used, the date of the letter `s production is used.
4079 \begin_layout Itemize
4084 : sender`s back address, in the standard behavior appears above the addressee's
4085 field in a small sans serif font.
4088 \begin_layout Itemize
4093 : special mail information, in the standard behavior appears underlined
4094 above the addressee's field below the back address.
4097 \begin_layout Itemize
4102 : additional information, in the standard behavior appears on right side
4103 below the addressee`s field.
4106 \begin_layout Itemize
4111 : the letter's title, in the standard behavior appears in a big, bold, sans
4112 serif font above the subject.
4115 \begin_layout Itemize
4120 : the letter's subject, in the standard behavior appears in a bold font
4128 \begin_layout Standard
4149 produce a business letter like line above the
4153 line containing the fields
4154 \begin_inset Quotes eld
4158 \begin_inset Quotes erd
4162 \begin_inset Quotes eld
4166 \begin_inset Quotes erd
4170 \begin_inset Quotes eld
4174 \begin_inset Quotes erd
4178 \begin_inset Quotes eld
4182 \begin_inset Quotes erd
4186 \begin_inset Quotes eld
4190 \begin_inset Quotes erd
4194 \begin_inset Quotes eld
4198 \begin_inset Quotes erd
4202 For the date field, the value of the
4208 \begin_inset Quotes eld
4211 business letter types
4212 \begin_inset Quotes erd
4215 is used, the value of the
4219 type however does not appear, but only the \SpecialChar LaTeX
4227 The ordinary output of place and date in a right-aligned line below the
4228 addressee`s field is suppressed.
4229 The types are implemented as input types provided with a label and must
4230 be used ahead of the corresponding
4237 \begin_layout Itemize
4245 \begin_layout Itemize
4253 \begin_layout Itemize
4261 \begin_layout Itemize
4269 \begin_layout Itemize
4277 \begin_layout Subsubsection
4278 The new letter class: letter (koma-script v.2)
4281 \begin_layout Standard
4287 \begin_layout Standard
4288 \begin_inset VSpace medskip
4294 \begin_layout Standard
4296 Koma-Script version 2.8 has introduced a new letter class
4300 which supersedes the now unsupported
4305 It has — on the \SpecialChar LaTeX
4306 side — a completely new interface and is not compatible
4308 Therefore, \SpecialChar LyX
4309 supports both, though it is recommended you use the new class.
4312 \begin_layout Standard
4313 This class covers the same functionality as
4315 letter (koma-script),
4322 (receiver's address, same as
4339 will start a new letter (i.
4340 \begin_inset space \thinspace{}
4344 \begin_inset space \space{}
4347 you can write several letters per document).
4348 New elements are sender's
4364 and the possibility to use a
4370 Insert\SpecialChar menuseparator
4376 \begin_layout Standard
4377 The biggest improvement is, though, that the letter's layout is configurable
4378 to meet almost any needs.
4379 This can be done via the preamble or with a special style file (Letter
4380 Class Option, extension
4384 ), that will be read in as a class option.
4388 \begin_layout Plain Layout
4389 The KOMA package comes with some default
4394 There is, for instance, a
4398 file that follows german typesetting rules, or a
4402 that provides the default layout of the old
4407 The latter can be loaded with the class option
4413 Layout\SpecialChar menuseparator
4414 Document\SpecialChar menuseparator
4426 template that is included in \SpecialChar LyX
4428 A detailed description is to be found in the Koma-Script documentation
4436 \begin_layout Subsubsection
4440 \begin_layout Standard
4441 Visualizing the Koma-Script document classes in \SpecialChar LyX
4442 , the \SpecialChar LyX
4443 internals cause some
4447 \begin_layout Itemize
4448 The chapter number of a
4452 type appears on a line of its own above the chapter heading instead of
4453 appearing in the same line ahead of it.
4454 The cause for that is the \SpecialChar LyX
4455 internal behavior for the labeltype
4462 \begin_layout Itemize
4463 The headings of the types
4472 \begin_inset Quotes eld
4476 \begin_inset Quotes erd
4480 table of contents, but not in the \SpecialChar LyX
4483 Document\SpecialChar menuseparator
4485 \begin_inset space ~
4489 \begin_inset space ~
4497 \begin_layout Itemize
4502 document class appear in a skip separation mode, not indented.
4503 This is the standard behavior, no special \SpecialChar LaTeX
4504 commands are needed for that.
4507 Document\SpecialChar menuseparator
4510 dialog the corresponding radio button indicates
4519 value always has the effect that extra \SpecialChar LaTeX
4520 commands are inserted in the document
4521 to produce the gap, which is not what is wanted in this case.
4524 \begin_layout Subsection
4526 \change_inserted 564990737 1670924924
4528 \begin_inset space \thinspace{}
4532 \begin_inset space \space{}
4536 \change_deleted 564990737 1670924933
4537 Article (mwart), book (mwbk) and report (mwrep)
4538 \begin_inset Argument status
4541 \begin_layout Plain Layout
4556 \begin_layout Standard
4562 \begin_layout Standard
4563 The \SpecialChar LyX
4580 correspond to the \SpecialChar LaTeX
4594 They are replacements for the standard document classes
4606 , resp., and fit better to Polish typography conventions in a number of points.
4610 \begin_layout Standard
4614 \begin_layout Itemize
4615 Unnumbered titles (with star, e.
4616 \begin_inset space \thinspace{}
4620 \begin_inset space \space{}
4627 ) are added into table of contents,
4630 \begin_layout Itemize
4631 Additional page styles:
4635 \begin_layout Description
4636 uheadings header with separated lines,
4639 \begin_layout Description
4640 myheadings custom header, contents headers via commands:
4655 \begin_layout Description
4656 myuheadings custom header with separated lines,
4659 \begin_layout Description
4660 outer page number is placed on outer side of page
4664 \begin_layout Itemize
4669 \begin_layout Description
4670 rmheadings serif titles — default,
4673 \begin_layout Description
4674 sfheadings sansserif titles,
4677 \begin_layout Description
4678 authortitle on title page first placed is author next title — default,
4681 \begin_layout Description
4682 titleauthor on title page first placed is title next author,
4685 \begin_layout Description
4686 withmarginpar reserve place on page for margins.
4690 \begin_layout Section
4692 \change_inserted 564990737 1670439534
4696 \begin_layout Standard
4698 \change_inserted 564990737 1670794710
4699 See also the document classes in the Collections (section
4700 \begin_inset space ~
4704 \begin_inset CommandInset ref
4706 reference "sec:Collections"
4713 \begin_layout Subsection
4715 \change_inserted 564990737 1670794716
4721 \begin_layout Standard
4723 \change_inserted 564990737 1670794716
4730 ; updated by the \SpecialChar LyX
4734 \begin_layout Subsubsection
4736 \change_inserted 564990737 1670794716
4742 \begin_layout Standard
4744 \change_inserted 564990737 1670794716
4747 This section describes how \SpecialChar LyX
4748 can be used to write articles for submission
4749 to the scientific journal
4751 Astronomy and Astrophysics
4754 \begin_inset CommandInset href
4757 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
4762 ) using Version 9.1 of the document class
4766 ; information about it is available at
4767 \begin_inset Flex URL
4770 \begin_layout Plain Layout
4772 \change_inserted 564990737 1670794716
4774 https://www.aanda.org/for-authors/latex-issues/texnical-background-information
4784 \begin_layout Standard
4786 \change_inserted 564990737 1670794716
4789 A manual comes together with the package and should be consulted before
4790 installing this document class as described in the
4792 Installing New Document Classe
4802 \begin_layout Standard
4804 \change_inserted 564990737 1670794716
4807 \begin_inset Note Greyedout
4810 \begin_layout Plain Layout
4812 \change_inserted 564990737 1670794716
4815 Please note that the publisher of the journal was changed from Springer
4816 to EDP Sciences starting January 1, 2001.
4817 That change also involved some slight changes to the style files, namely
4818 the removal of the thesaurus command.
4819 If you have an older version installed, please upgrade.
4820 For information about compatibility with the old (version 4) layout, please
4821 refer to the comments in
4824 Dir/layouts/aapaper.layout
4834 \begin_layout Subsubsection
4836 \change_inserted 564990737 1670794716
4842 \begin_layout Standard
4844 \change_inserted 564990737 1670794716
4847 It is recommended you start from the template
4856 ile\SpecialChar menuseparator
4858 \begin_inset space ~
4866 \begin_inset space ~
4872 If you are not using the template, note the following settings:
4875 \begin_layout Itemize
4877 \change_inserted 564990737 1670794716
4889 ocument\SpecialChar menuseparator
4894 ettings\SpecialChar menuseparator
4896 \begin_inset space ~
4901 dialog (OK, that one was obvious).
4904 \begin_layout Itemize
4906 \change_inserted 564990737 1670794716
4912 \begin_inset space ~
4924 \begin_inset space ~
4929 dialog: leave it set to
4934 The whole layout is done by the macros, you shouldn't change anything.
4937 \begin_layout Subsubsection
4939 \change_inserted 564990737 1670794716
4945 \begin_layout Standard
4947 \change_inserted 564990737 1670794716
4950 First thing to enter is the header information.
4951 It consists of five entries, of which one is optional.
4955 \begin_layout Itemize
4957 \change_inserted 564990737 1670794716
4966 \begin_layout Itemize
4968 \change_inserted 564990737 1670794716
4977 \begin_layout Itemize
4979 \change_inserted 564990737 1670794716
4988 \begin_layout Itemize
4990 \change_inserted 564990737 1670794716
4999 \begin_layout Itemize
5001 \change_inserted 564990737 1670794716
5010 Received: <date>; Accepted <date>
5013 \begin_layout Standard
5015 \change_inserted 564990737 1670794716
5018 Although the order of the single header entries doesn't matter it is advised
5019 to keep the above sequence, just to get the best optics and meets the layout
5020 of the real document.
5023 \begin_layout Standard
5025 \change_inserted 564990737 1670794716
5028 If you want to place footnotes in the header block, e.
5029 \begin_inset space \thinspace{}
5033 \begin_inset space \space{}
5036 to state your present address, just use the standard footnote via the menu
5042 nsert\SpecialChar menuseparator
5051 will automagically use the term
5060 \begin_layout Standard
5062 \change_inserted 564990737 1670794716
5065 In addition to these topics, the macros use three additional \SpecialChar LaTeX
5067 have no counterpart in \SpecialChar LyX
5071 \begin_layout Itemize
5073 \change_inserted 564990737 1670794716
5081 to separate different names for more than one author and institute, respectivel
5085 \begin_layout Itemize
5087 \change_inserted 564990737 1670794716
5095 to mark corresponding author/institute pairs.
5096 The institutes are numbered sequentially as they appear in the
5100 field, so you have to put a marker to each author.
5103 \begin_layout Itemize
5105 \change_inserted 564990737 1670794716
5113 to supply an email address for fast contact.
5116 \begin_layout Standard
5118 \change_inserted 564990737 1670794716
5121 In all cases, the appropriate command has to be entered as \SpecialChar TeX
5122 code in \SpecialChar LyX
5124 See the examples in the template and in the file
5136 \begin_layout Subsubsection
5138 \change_inserted 564990737 1670794716
5144 \begin_layout Standard
5146 \change_inserted 564990737 1670794716
5149 The abstract should immediately follow the header block and must contain
5159 \begin_layout Enumerate
5161 \change_inserted 564990737 1670794716
5167 (optional) {} leave it empty if necessary
5170 \begin_layout Enumerate
5172 \change_inserted 564990737 1670794716
5181 \begin_layout Enumerate
5183 \change_inserted 564990737 1670794716
5192 \begin_layout Enumerate
5194 \change_inserted 564990737 1670794716
5203 \begin_layout Enumerate
5205 \change_inserted 564990737 1670794716
5211 (optional) {} leave it empty if necessary
5214 \begin_layout Standard
5216 \change_inserted 564990737 1670794716
5220 This structure not shown in
5227 \begin_layout Subsubsection
5229 \change_inserted 564990737 1670794716
5232 Supported environments
5235 \begin_layout Standard
5237 \change_inserted 564990737 1670794716
5240 The A&A paper layout supports the following environments for structuring
5244 \begin_layout Itemize
5246 \change_inserted 564990737 1670794716
5253 \begin_layout Itemize
5255 \change_inserted 564990737 1670794716
5262 \begin_layout Itemize
5264 \change_inserted 564990737 1670794716
5271 \begin_layout Itemize
5273 \change_inserted 564990737 1670794716
5280 \begin_layout Itemize
5282 \change_inserted 564990737 1670794716
5289 \begin_layout Itemize
5291 \change_inserted 564990737 1670794716
5298 \begin_layout Itemize
5300 \change_inserted 564990737 1670794716
5307 \begin_layout Itemize
5309 \change_inserted 564990737 1670794716
5316 \begin_layout Itemize
5318 \change_inserted 564990737 1670794716
5325 \begin_layout Itemize
5327 \change_inserted 564990737 1670794716
5334 \begin_layout Itemize
5336 \change_inserted 564990737 1670794716
5343 \begin_layout Itemize
5345 \change_inserted 564990737 1670794716
5353 \begin_layout Subsubsection
5355 \change_inserted 564990737 1670794716
5358 Commands not supported by \SpecialChar LyX
5362 \begin_layout Standard
5364 \change_inserted 564990737 1670794716
5367 Some commands are not yet supported by the
5371 layout for \SpecialChar LyX
5373 Some have already been mentioned.
5374 For the sake of completeness, they are listed all together here:
5377 \begin_layout Itemize
5379 \change_inserted 564990737 1670794716
5388 \begin_layout Itemize
5390 \change_inserted 564990737 1670794716
5399 \begin_layout Itemize
5401 \change_inserted 564990737 1670794716
5410 \begin_layout Itemize
5412 \change_inserted 564990737 1670794716
5421 \begin_layout Itemize
5423 \change_inserted 564990737 1670794716
5432 \begin_layout Standard
5434 \change_inserted 564990737 1670794716
5437 If you want to use any of these commands, you have to enter them yourself.
5440 Do not forget to use
5446 nsert\SpecialChar menuseparator
5449 \begin_inset space ~
5458 \begin_layout Subsubsection
5460 \change_inserted 564990737 1670794716
5463 Figure and Table Floats
5466 \begin_layout Standard
5468 \change_inserted 564990737 1670794716
5472 provides support for the necessary float environments
5474 figure, figure*, table
5480 , therefore we won't tell much about it here.
5484 \begin_inset space ~
5490 Just remember that tables should be left-aligned.
5491 For that, select the table and change the alignment in
5496 dit\SpecialChar menuseparator
5502 \begin_inset space ~
5508 \begin_layout Standard
5510 \change_inserted 564990737 1670794716
5513 There is only one special thing: the figures with a caption beside the figure.
5514 To create such a figure, you have to do the following:
5517 \begin_layout Enumerate
5519 \change_inserted 564990737 1670794716
5522 Create a wide figure float:
5527 nsert\SpecialChar menuseparator
5532 t\SpecialChar menuseparator
5535 , then, from within the float, use the menu
5540 dit\SpecialChar menuseparator
5546 \begin_inset space ~
5557 \begin_inset space ~
5569 \begin_layout Enumerate
5571 \change_inserted 564990737 1670794716
5574 Enter your caption text.
5577 \begin_layout Enumerate
5579 \change_inserted 564990737 1670794716
5586 to move the cursor above the caption.
5589 \begin_layout Enumerate
5591 \change_inserted 564990737 1670794716
5597 \begin_layout Enumerate
5599 \change_inserted 564990737 1670794716
5602 Position the cursor after the figure and insert a horizontal fill by using
5608 nsert\SpecialChar menuseparator
5613 rmatting\SpecialChar menuseparator
5619 \begin_inset space ~
5628 dialog and select the
5642 \begin_layout Enumerate
5644 \change_inserted 564990737 1670794716
5647 Switch to \SpecialChar LaTeX
5651 \begin_inset space ~
5659 \begin_layout Enumerate
5661 \change_inserted 564990737 1670794716
5672 Do not close the brace!
5675 \begin_layout Enumerate
5677 \change_inserted 564990737 1670794716
5680 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
5685 \begin_inset space ~
5697 \begin_layout Standard
5699 \change_inserted 564990737 1670794716
5702 Also, refer to the figures in the file
5713 \begin_layout Subsubsection
5715 \change_inserted 564990737 1670794716
5721 \begin_layout Standard
5723 \change_inserted 564990737 1670794716
5726 For submission, the paper has to be formatted in a special double-spacing
5728 For this purpose, you have to add the option
5739 \begin_inset space ~
5749 ocument\SpecialChar menuseparator
5754 ettings\SpecialChar menuseparator
5756 \begin_inset space ~
5765 \begin_layout Subsubsection
5767 \change_inserted 564990737 1670794716
5773 \begin_layout Standard
5775 \change_inserted 564990737 1670794716
5782 was written with \SpecialChar LyX
5784 It is the example paper from the original macro package,
5789 \begin_inset CommandInset href
5792 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
5797 , but translated to \SpecialChar LyX
5798 using the older unstructured abstract type.
5799 Use it for inspiration, and compare the \SpecialChar LaTeX
5804 with the \SpecialChar LyX
5808 \begin_layout Subsection
5813 \begin_layout Standard
5819 \begin_layout Subsubsection
5823 \begin_layout Standard
5825 is a set of macros produced by the American Astronomical Society to
5826 facilitate electronic manuscript submission to the three journals they
5827 publish: the Astrophysical Journal (including the Letters and Supplement),
5828 the Astronomical Journal, and the Publications of the Astronomical Society
5831 has proven to be an excellent tool for generating these documents, especially
5832 given its equation, citation, and figure handling capabilities.
5834 requires version 5.0 (or higher) of these macros; preferably 6.0, which
5835 is the version described here, or higher.
5836 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
5837 2.09 and are fundamentally
5838 incompatible with \SpecialChar LyX
5840 The AAS\SpecialChar TeX
5841 package may be downloaded from the AAS\SpecialChar TeX
5845 \begin_layout Standard
5846 \begin_inset VSpace medskip
5852 \begin_layout Standard
5854 \begin_inset Flex URL
5857 \begin_layout Plain Layout
5859 https://aas.org/aastex/aastex-downloads
5867 \begin_layout Standard
5868 \begin_inset VSpace medskip
5874 \begin_layout Standard
5875 A complete user guide is contained in that package and you should familiarize
5876 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
5879 will not reduce the need to figure out all the AAS\SpecialChar TeX
5880 commands, it will only
5881 reduce the drudgery of typing everything in.
5882 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
5884 completely to the requirements of the journal to which you are submitting
5888 \begin_layout Subsubsection
5889 Starting a New Paper
5892 \begin_layout Standard
5893 I strongly suggest that you start with the AAS\SpecialChar TeX
5897 File\SpecialChar menuseparator
5904 , enter the new file name, then choose the
5909 This will show the most common fields found in a manuscript.
5910 Simply overwrite the existing text (including the brackets,
5914 ) with the correct information.
5915 Many of the AAS\SpecialChar TeX
5916 commands and environments can be implemented directly in
5919 For commands such as these, the \SpecialChar LaTeX
5920 code must be entered directly and marked
5922 Such commands are referred to as \SpecialChar TeX
5923 code, or Evil Red Text.
5924 I tried to minimize the amount of \SpecialChar TeX
5925 code needed in an AAS\SpecialChar TeX
5929 \begin_layout Subsubsection
5930 Finishing Your Paper
5933 \begin_layout Standard
5934 When the paper is finished to your satisfaction and previews/prints correctly,
5936 \begin_inset Quotes eld
5940 \begin_inset Quotes erd
5943 actions which need to be done before you submit it to the journals.
5947 \begin_layout Enumerate
5948 Export your paper as a \SpecialChar LaTeX
5951 File\SpecialChar menuseparator
5952 Export\SpecialChar menuseparator
5960 \begin_layout Enumerate
5965 file with your favorite text editor
5969 \begin_layout Enumerate
5970 remove the comment lines before the
5979 \begin_layout Enumerate
5984 usepackage...{fontenc}
5986 line if it appears (usually just after
6001 \begin_layout Enumerate
6002 remove everything between (and including) the
6014 commands, except for any commands you specifically put into the \SpecialChar LaTeX
6016 (which should appear immediately after the
6017 \begin_inset Quotes eld
6020 User specified \SpecialChar LaTeX
6022 \begin_inset Quotes erd
6033 \begin_layout Enumerate
6034 Run the resulting file through \SpecialChar LaTeX
6035 to make sure it still processes correctly.
6038 \begin_layout Enumerate
6039 Reread the journal requirements to make sure your filenames and formats
6043 \begin_layout Enumerate
6047 \begin_layout Subsubsection
6048 Comments On Specific Commands
6051 \begin_layout Standard
6052 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
6059 ) gives a good description of each.
6060 Thus it's probably easiest for me to go down the list as found in the guide
6061 and offer comments where necessary.
6062 So let's begin \SpecialChar ldots
6066 \begin_layout Paragraph
6067 Things that work as expected
6070 \begin_layout Standard
6071 Because they work as you might expect, I simply list them and the section
6172 begin{thebibliography}
6180 (2.13.2), all the cite commands and their variations (2.13.2), the generic
6181 graphicx figure commands (2.14.1),
6205 (2.15.4, amongst other places),
6232 \begin_layout Standard
6233 The following style options also work correctly:
6254 Simply put them in the
6260 Layout\SpecialChar menuseparator
6266 \begin_layout Paragraph
6267 Things that work, but require more comment
6270 \begin_layout Standard
6271 The following items work, but require a little more discussion:
6274 \begin_layout Itemize
6275 These items are reserved for use by the journal editors, but you can put
6276 them into the \SpecialChar LaTeX
6277 preamble if you feel compelled to do so:
6310 \begin_layout Itemize
6311 These items may be placed in the \SpecialChar LaTeX
6312 preamble, and are included as blanks in
6334 \begin_layout Itemize
6341 (2.3) – can only be used
6342 \begin_inset Quotes eld
6346 \begin_inset Quotes erd
6349 , not in the middle of a paragraph.
6350 Use \SpecialChar TeX
6351 code if you need to embed it.
6354 \begin_layout Itemize
6361 (2.3) – will have extra {} after it.
6362 This should not cause an error.
6365 \begin_layout Itemize
6372 (2.6) – can only be used
6373 \begin_inset Quotes eld
6377 \begin_inset Quotes erd
6380 , not in the middle of a paragraph.
6381 Use \SpecialChar TeX
6382 code if you need to embed it.
6385 \begin_layout Itemize
6392 (2.8) – can't insert a cross-reference tag, you must type the tag name by
6396 \begin_layout Itemize
6410 \begin_layout Itemize
6417 (2.9) – will have extra {} after it.
6418 This should not cause an error.
6421 \begin_layout Itemize
6428 (2.11) – will have extra {} after it.
6429 This should not cause an error.
6432 \begin_layout Itemize
6439 (2.14.2) – you can insert an optional filename argument by placing the cursor
6440 at the beginning of the text and selecting
6442 Insert\SpecialChar menuseparator
6447 \begin_inset Quotes eld
6451 \begin_inset Quotes erd
6454 inserts an optional argument of the type needed by
6461 Hopefully it will be renamed someday.
6464 \begin_layout Itemize
6477 for the catalog ID optional parameter
6480 \begin_layout Itemize
6493 for the catalog ID optional parameter
6496 \begin_layout Paragraph
6497 Things not implemented, use \SpecialChar TeX
6501 \begin_layout Standard
6512 setcounter{equation}
6514 (2.12), Journal name abbreviations (2.13.4),
6550 (2.15.4, insert it as the first element in the lefthand cell after where
6552 Don't use any of \SpecialChar LyX
6553 's rules in the table),
6565 (2.15.5), much of Misc (2.17, except
6616 \begin_layout Paragraph
6617 Things that cannot be implemented
6620 \begin_layout Standard
6622 at least in any meaningful sort of way, so I suggest ignoring them.
6623 They are the references environment (2.13.3), and the deluxetable environment
6625 If you really, really need to use deluxetable, I suggest editing it in
6626 a separate file with a text editor, then using
6628 Insert\SpecialChar menuseparator
6630 \begin_inset space ~
6635 to include it in your \SpecialChar LyX
6641 file to see an example of this.
6644 \begin_layout Subsubsection
6645 FAQs, Tips, Tricks, and Other Ruminations
6648 \begin_layout Paragraph
6649 Getting \SpecialChar LyX
6650 and AAS\SpecialChar TeX
6654 \begin_layout Standard
6655 It can be a bit tricky to get \SpecialChar LyX
6656 to recognize a new layout and document class.
6657 When all else fails, do this:
6660 \begin_layout Enumerate
6661 Make certain that \SpecialChar LaTeX
6662 can find AAS\SpecialChar TeX
6664 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
6666 directory completely unrelated to \SpecialChar LaTeX
6667 or AAS\SpecialChar TeX
6668 and run \SpecialChar LaTeX
6676 \begin_layout Enumerate
6681 appears in \SpecialChar LyX
6689 \begin_layout Enumerate
6692 Tools\SpecialChar menuseparator
6696 , then restart \SpecialChar LyX
6700 \begin_layout Enumerate
6701 Open a regular new file, not from a template.
6702 Does AAS\SpecialChar TeX
6703 appear in the class list in
6705 Document\SpecialChar menuseparator
6711 \begin_layout Standard
6712 If you get a warning from an existing AAS\SpecialChar TeX
6713 document about not being able
6714 to find the AAS\SpecialChar TeX
6715 layout or a message about
6716 \begin_inset Quotes eld
6719 You should not mix title layouts with normal ones
6720 \begin_inset Quotes erd
6723 , things haven't been installed correctly.
6726 \begin_layout Paragraph
6728 error processing a table
6731 \begin_layout Standard
6733 , by default, attempts to center the table caption/title.
6734 This seems to produce a bad interaction in AAS\SpecialChar TeX
6735 so you should click somewhere
6736 in the caption/title, then select
6738 Edit\SpecialChar menuseparator
6740 \begin_inset space ~
6754 This took care of it for me.
6757 \begin_layout Paragraph
6761 \begin_layout Standard
6762 A couple of things: 1) I have noticed some funny spacing in the reference
6763 entries in the text.
6764 When you enter the bibliography item data, make sure their is
6768 space between the last author and the parenthesis setting off the year;
6772 \begin_inset space \thinspace{}
6776 \begin_inset space \space{}
6790 2) Entering the references at all is not obvious.
6791 The easiest thing is to start typing your first reference at the end of
6792 the document, then mark it as type
6797 That will put a small gray box in front of what you just typed.
6798 Click on the box to fill in the rest of the information.
6799 For new references, go to the end of an existing reference and press return.
6800 That will create a new line with its own box, etc.
6803 \begin_layout Paragraph
6807 \begin_layout Standard
6808 Even though AAS\SpecialChar TeX
6809 provides its own figure commands (
6815 , for example), I much prefer \SpecialChar LaTeX
6816 's standard figure commands (with the default
6825 \begin_inset space ~
6828 commands as \SpecialChar TeX
6829 code into a Figure Float box if you desire, but I never have
6830 much luck getting the layout right.
6831 With the standard graphics, \SpecialChar LyX
6836 usepackage{graphicx}
6838 command into the \SpecialChar LaTeX
6839 preamble and handle the figures in the standard \SpecialChar LaTeX2e
6841 interspersing the figures in the text.
6842 I believe ApJ accepts figures exactly this way now; AJ might still use
6844 \begin_inset Quotes eld
6847 stack everything at the end
6848 \begin_inset Quotes erd
6854 \begin_layout Paragraph
6855 Things I could have done, but didn't
6858 \begin_layout Standard
6860 \begin_inset Quotes eld
6864 \begin_inset Quotes erd
6867 things I could have implemented, but chose not to.
6868 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
6870 even though it is double-spaced in the paper manuscript.
6871 Also, I chose not to make separate layouts for the preprint and preprint2
6873 Since I assume you will spend most of your time in the plain manuscript
6874 mode anyway, I decided not to chew up more disk space with this.
6878 \begin_layout Subsubsection
6882 \begin_layout Standard
6883 Your mileage may vary.
6884 I've now had papers published by both ApJ and AJ that have had 98% of the
6885 effort done in \SpecialChar LyX
6886 ; the last 2% was the \SpecialChar LaTeX
6887 post-processing and a few cleanups.
6888 I have had no trouble with the submission process, and I'm sure the journals
6889 were never aware that there might be a difference.
6890 So, go forth and publish!
6893 \begin_layout Subsection
6895 \change_inserted 564990737 1671042028
6901 \begin_layout Standard
6903 \change_inserted 564990737 1671042028
6909 \begin_inset space \thinspace{}
6919 This provides the following additional environments:
6922 \begin_inset space ~
6930 \begin_inset space ~
6938 \begin_inset space ~
6961 is available in the menu
6966 ile\SpecialChar menuseparator
6968 \begin_inset space ~
6976 \begin_inset space ~
6982 It has been customized with further environments and contains all the informati
6984 However, the documentation is also available from
6985 \begin_inset CommandInset href
6988 target "http://mirrors.ctan.org/macros/latex/contrib/elsarticle/doc/elsdoc.pdf"
6996 \begin_layout Subsection
6998 \change_inserted 564990737 1671042046
7004 \begin_layout Standard
7006 \change_inserted 564990737 1671042046
7012 \begin_inset space \thinspace{}
7017 provides an alternative to the
7022 It provides similar functionality, but you might prefer this layout with
7023 sans serif sections, headings, and more.
7026 \begin_layout Subsection
7031 \begin_layout Standard
7037 \begin_layout Standard
7038 \begin_inset VSpace bigskip
7044 \begin_layout Standard
7049 \begin_inset space ~
7054 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
7056 \begin_inset Formula $\beta$
7059 release of May, 1999) class.
7062 \begin_layout Standard
7068 textclass, which works with Rev\SpecialChar TeX
7070 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
7072 That means that it doesn't interact very well with \SpecialChar LyX
7073 , which requires \SpecialChar LaTeX2e
7075 it has been kludged to work.
7076 Since Rev\SpecialChar TeX
7077 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
7084 \begin_inset space ~
7089 textclass should also be pretty easy to use.
7092 \begin_layout Standard
7093 These documents are supposed to be used in
7097 to the Rev\SpecialChar TeX
7098 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
7100 and assume you'll know what to put in the preamble if necessary.
7103 \begin_layout Subsubsection
7107 \begin_layout Standard
7108 All you need to do is install Rev\SpecialChar TeX
7109 4, as described in the package's README
7111 The package can be found at The Rev\SpecialChar TeX
7113 \begin_inset Flex URL
7116 \begin_layout Plain Layout
7118 http://publish.aps.org/revtex4/
7124 Install it somewhere that \SpecialChar LaTeX
7126 Test it by trying to \SpecialChar LaTeX
7127 a short Rev\SpecialChar TeX
7128 4 document in some random directory (i.
7129 \begin_inset space \thinspace{}
7133 \begin_inset space \space{}
7136 not the directory where you installed the class file.) Then, if you reconfigure
7138 , it will find the class file and let you use the Rev\SpecialChar TeX
7142 \begin_layout Standard
7143 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
7152 \begin_inset space ~
7157 template, found in the templates directory.
7160 \begin_layout Subsubsection
7164 \begin_layout Standard
7165 Optional arguments to
7172 \begin_inset Quotes eld
7176 \begin_inset Quotes erd
7180 \begin_inset Quotes eld
7184 \begin_inset Quotes erd
7190 \begin_inset space ~
7198 \begin_inset space ~
7204 Remember that in Rev\SpecialChar TeX
7205 , at least one optional argument is required!
7208 \begin_layout Standard
7209 Other preamble matter, like
7216 \begin_inset space ~
7223 \begin_inset space ~
7228 dialog, also as usual.
7231 \begin_layout Subsubsection
7235 \begin_layout Standard
7236 The layouts basically correspond to the commands in Rev\SpecialChar TeX
7238 For example, the Email layout corresponds to
7245 Note that (at least as of Rev\SpecialChar TeX
7254 layouts are exactly equivalent, so you shouldn't need to use both.
7258 \begin_layout Plain Layout
7259 In case you're curious, both were included so that
7263 would be able to translate both
7283 \begin_layout Subsubsection
7287 \begin_layout Standard
7288 There are a couple of important unique aspects of Rev\SpecialChar TeX
7290 bugs that will be even more confusing in \SpecialChar LyX
7294 \begin_layout Standard
7295 In Rev\SpecialChar TeX
7313 The \SpecialChar LyX
7314 equivalent is that there is a separate Thanks layout.
7319 write footnotes in the
7323 layout, or weird things may happen.
7324 See the Rev\SpecialChar TeX
7325 4 documentation for more details.
7328 \begin_layout Standard
7332 \begin_inset space ~
7340 \begin_inset space ~
7349 layouts must be placed
7357 layout and the corresponding
7374 , the \SpecialChar LaTeX
7378 \begin_layout Subsection
7380 \change_inserted 564990737 1671042072
7386 \begin_layout Standard
7388 \change_inserted 564990737 1671042072
7395 classes were replaced in 2013 with a completely new
7400 This package provides a \SpecialChar LaTeX
7401 class and templates for books to be published
7402 at Springer Gabler Research, Springer Vieweg Research, Springer Spektrum
7403 Research, Springer VS Research, or Springer VS Forschung.
7404 The documentation is available in German from
7405 \begin_inset CommandInset href
7408 target "http://mirrors.ctan.org/macros/latex/contrib/springer/sr-vorl/sr-vorl.pdf"
7416 \begin_layout Section
7418 \change_inserted 564990737 1670439560
7422 \begin_layout Standard
7424 \change_inserted 564990737 1670439581
7425 See also the document classes in the Collections (section
7426 \begin_inset space ~
7430 \begin_inset CommandInset ref
7432 reference "sec:Collections"
7439 \begin_layout Subsection
7443 \begin_layout Standard
7449 \begin_layout Subsubsection
7453 \begin_layout Standard
7454 Memoir is a very powerful and constantly evolving class.
7455 It has been designed with regard to fictional and non-fictional literature.
7456 Its aim is to let the user have maximum control over the typesetting of
7458 Memoir is based on the standard book class, but it can also emulate the
7459 article class (see below).
7462 \begin_layout Standard
7463 Peter Wilson, the developer of Memoir, is known as the author of lots of
7464 useful packages in the \SpecialChar LaTeX
7466 Most of them have been merged with Memoir.
7467 Therefore, it is much easier to layout the table of contents, appendices,
7468 chapter designs and such.
7470 , though, does not support all of these goodies natively.
7471 Some of them might be added to forthcoming releases
7475 \begin_layout Plain Layout
7476 You are invited to send suggestions to
7477 \begin_inset Flex URL
7480 \begin_layout Plain Layout
7482 lyx-devel@lists.lyx.org
7492 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
7494 Of course you can still use all features with the help of some native \SpecialChar LaTeX
7496 commands (\SpecialChar TeX
7501 \begin_layout Plain Layout
7506 \begin_layout Plain Layout
7516 \begin_inset space ~
7520 \begin_inset CommandInset ref
7522 reference "sec:Inserting-TeX-Code"
7532 In this section, we can only list those features that are natively supported
7535 For detailed descriptions (and for the rest of features) we recommend you
7536 have a look at the detailed manual of the Memoir class
7540 \begin_layout Plain Layout
7545 \begin_layout Plain Layout
7555 \begin_inset Flex URL
7558 \begin_layout Plain Layout
7560 CTAN:/macros/latex/memoir/memman.pdf
7570 , which is not only a user guide for the class, but also both a comprehensive
7571 description on good typesetting and a superb example for good typesetting
7575 \begin_layout Subsubsection
7576 Basic features and restrictions
7579 \begin_layout Standard
7580 Memoir supports basically all features of the standard book classes.
7581 There are, however, some differences, as follows:
7584 \begin_layout Description
7586 \begin_inset space ~
7589 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
7592 \begin_layout Description
7594 \begin_inset space ~
7597 style: The fancy page style is not supported, due to a command clash between
7598 Memoir and the fancyhdr package (they both define a command with the same
7599 name, which confuses \SpecialChar LaTeX
7601 Instead, Memoir comes with a number of its own page styles (see
7603 Document\SpecialChar menuseparator
7604 Settings\SpecialChar menuseparator
7606 \begin_inset space ~
7612 If you want to use these for the chapter pages, you have to use the command
7619 in the main text or in preamble (e.
7620 \begin_inset space \thinspace{}
7624 \begin_inset space \space{}
7631 chapterstyle{companion}
7636 \begin_layout Description
7637 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
7638 optional argument in the standard classes.
7639 With this, you can specify an alternative version of the title for the
7640 table of contents and the headers (for instance, if the title is too long).
7642 , you can do this via
7644 Insert\SpecialChar menuseparator
7646 \begin_inset space ~
7651 at the beginning of a chapter/section.
7652 Memoir features a second optional argument and thus separates the table
7653 of contents from the header.
7654 You can define three variants of a title with this: one for the main text,
7655 one for the table of contents, and one for the headers.
7657 makes these available in form of specific
7668 \begin_layout Description
7669 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
7670 of contents, the list of figures and the list of table start a new page
7672 Memoir does not follow this route.
7673 You have to insert a page break yourself, if you want to have one.
7676 \begin_layout Description
7677 Titlepage: For some unknown reason, Memoir uses pagination on the title
7678 page (in the standard classes, title pages are
7679 \begin_inset Quotes eld
7683 \begin_inset Quotes erd
7687 If you want an empty title page, type
7691 aliaspagestyle{title}{empty}
7696 \begin_layout Description
7697 Article: With the class option
7703 Document\SpecialChar menuseparator
7704 Settings\SpecialChar menuseparator
7705 Class Settings\SpecialChar menuseparator
7707 \begin_inset space ~
7712 ), you can emulate article style.
7713 That is, counters (footnotes, figures, tables etc.) will not be reset on
7714 new chapters, chapters don't start a new page (but are—in contrary to
7715 \begin_inset Quotes eld
7719 \begin_inset Quotes erd
7722 article classes—still allowed), parts, though, use their own page, as in
7726 \begin_layout Description
7727 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
7728 font commands, which have been used in the old \SpecialChar LaTeX
7730 \begin_inset space \thinspace{}
7734 \begin_inset space \space{}
7750 It produces an error and stops \SpecialChar LaTeX
7751 whenever such a command appears.
7756 reallows the commands and spits out warnings instead (which does at least
7757 not stop \SpecialChar LaTeX
7759 Since a lot of packages and particularly Bib\SpecialChar TeX
7760 style files are still using
7761 those commands, we have decided to use this option by default.
7764 \begin_layout Subsubsection
7768 \begin_layout Standard
7769 We will only describe the features supported by \SpecialChar LyX
7770 (which is not much currently).
7771 Please consult the Memoir manual
7775 \begin_layout Plain Layout
7780 \begin_layout Plain Layout
7790 \begin_inset Flex URL
7793 \begin_layout Plain Layout
7795 CTAN:/macros/latex/memoir/memman.pdf
7808 \begin_layout Description
7809 Abstract: You may wonder why an abstract is an extra feature.
7810 Well, it is in book class.
7811 Usually books don't have abstracts.
7812 Memoir, however, has.
7813 You can use it wherever and how often you like.
7816 \begin_layout Description
7817 Chapterprecis: You may know this older typesetting style: The contents of
7818 a chapter are summarized below the title and also in the table of contents
7820 \begin_inset space \thinspace{}
7824 \begin_inset space \space{}
7829 Our hero arrives in Troia; he loses some friends; he finds others
7832 Chapterprecis does exactly this.
7833 It is therefore only sensible below a chapter.
7836 \begin_layout Description
7837 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
7838 The epigraph environment provides an elegant way of typesetting such a
7840 The motto itself (text) and its (optional) author (source) are divided
7842 The author (source) can be inserted via
7844 Insert\SpecialChar menuseparator
7851 \begin_layout Description
7852 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
7853 complex figurative poems).
7855 can only support a few of them.
7856 One is poemtitle, which is a centered title for poems, which will also
7857 be added to the table of contents (verse is the standard environment for
7859 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
7861 because they have to be nested inside regular verse environments, which
7862 is not possible with \SpecialChar LyX
7866 \begin_layout Description
7867 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
7870 \begin_layout Section
7872 \change_inserted 564990737 1670439605
7876 \begin_layout Section
7878 \change_inserted 564990737 1671041968
7882 \begin_layout Subsection
7884 \change_inserted 564990737 1671041970
7890 \begin_layout Standard
7892 \change_inserted 564990737 1671041970
7903 document class for writing letters according to the
7905 Deutsches Institut für Normung
7917 ile\SpecialChar menuseparator
7919 \begin_inset space ~
7927 \begin_inset space ~
7932 offers guidance on its use.
7933 The documentation is available from
7934 \begin_inset CommandInset href
7937 target "http://mirrors.ctan.org/macros/latex/contrib/dinbrief/liesmich"
7945 \begin_layout Section
7947 \change_inserted 564990737 1670439660
7951 \begin_layout Subsection
7954 Foil\SpecialChar TeX
7958 \begin_inset CommandInset label
7967 \begin_layout Standard
7973 \begin_layout Subsubsection
7977 \begin_layout Standard
7978 This section describes how to use \SpecialChar LyX
7979 to make slides for overhead projectors.
7980 There are two document classes that can do this: the default slides class
7983 Foil\SpecialChar TeX
7987 This section documents the latter.
7990 \begin_layout Standard
7991 I'm going to say this again, nice and clear, so that there's no misunderstanding
7995 \begin_layout Standard
7996 \begin_inset VSpace bigskip
8002 \begin_layout Standard
8006 This section documents the class
8007 \begin_inset Quotes eld
8015 \begin_inset Quotes erd
8023 \begin_layout Standard
8024 \begin_inset VSpace bigskip
8030 \begin_layout Standard
8031 If you're looking for the documentation for
8032 \begin_inset Quotes eld
8040 \begin_inset Quotes erd
8044 \begin_inset space ~
8048 \begin_inset CommandInset ref
8050 reference "sec:slitex"
8055 If your machine doesn't have the
8063 installed, you'll probably have to use the default
8067 class, which isn't quite as good as
8072 \begin_layout Standard
8077 class is designed for use with version
8078 \begin_inset space ~
8086 class file which is now an integral part of \SpecialChar LaTeX2e
8090 \begin_layout Subsubsection
8094 \begin_layout Standard
8095 Obviously, to use this document class, you need to select
8106 \begin_inset space ~
8112 There are some settings in the
8115 \begin_inset space ~
8120 dialog that you should know about that are specific to this class:
8123 \begin_layout Itemize
8124 Don't change the options
8135 \begin_inset space ~
8141 They're ignored by the
8148 \begin_layout Itemize
8149 The default font size is 20
8150 \begin_inset space \thinspace{}
8153 pt with the other options being 17
8154 \begin_inset space \thinspace{}
8158 \begin_inset space \thinspace{}
8162 \begin_inset space \thinspace{}
8168 \begin_layout Itemize
8177 but all math equations are still typeset in the usual roman font.
8180 \begin_layout Itemize
8183 Foil\SpecialChar TeX
8186 supports A4 and Letter paper sizes as well as a special size for working
8188 \begin_inset space \thinspace{}
8192 It doesn't support A5, B5, legal or executive paper sizes.
8195 \begin_layout Itemize
8196 Don't bother changing the
8200 settings because they are ignored anyway.
8201 All floats appear where they are defined in the text.
8204 \begin_layout Itemize
8209 setting behaves a bit differently for this class.
8212 Foil\SpecialChar TeX
8215 provides extensive footer and header capabilities including a user-defined
8218 \begin_inset space ~
8222 \begin_inset CommandInset ref
8224 reference "sec:foilfoot"
8229 The title page is treated differently to all other pages in the document
8238 has the logo centered at the bottom of the page (if one is defined).
8239 The possible page style choices and what they do are as follows:
8243 \begin_layout Labeling
8244 \labelwidthstring MMMMMMM
8251 The final output contains no page numbers, or other headers or footers
8252 (except footnotes of course).
8256 \begin_layout Labeling
8257 \labelwidthstring MMMMMMM
8264 The final output contains page numbers centered at the bottom of the page.
8265 No other headings or footers (other than footnotes).
8268 \begin_layout Labeling
8269 \labelwidthstring MMMMMMM
8274 Page numbers in lower right corner.
8275 Additional headers and footers are also shown.
8276 This is also the default.
8279 \begin_layout Labeling
8280 \labelwidthstring MMMMMMM
8285 Gives you access to the
8289 package although its use with
8291 Foil\SpecialChar TeX
8294 is discouraged by the writer of the
8296 Foil\SpecialChar TeX
8299 package because of some potential page layout clashes.
8303 \begin_layout Paragraph
8307 \begin_layout Standard
8308 The following options may be used in the extra class options in the
8310 Document\SpecialChar menuseparator
8316 \begin_layout Labeling
8317 \labelwidthstring MMMMMMx
8322 This sets up the page layout for 7.33
8323 \begin_inset space \thinspace{}
8327 \begin_inset space \thinspace{}
8330 in paper, which is about the same aspect ratio as a 35
8331 \begin_inset space \thinspace{}
8334 mm slide, making it a bit easier to work with this medium.
8337 \begin_layout Labeling
8338 \labelwidthstring MMMMMMx
8343 Places a rule across the page below the header on every page except the
8347 \begin_layout Labeling
8348 \labelwidthstring MMMMMMx
8353 Places a rule across the page above the footer on every page except the
8357 \begin_layout Labeling
8358 \labelwidthstring MMMMMMx
8363 This is automatically set each time you create a new
8370 Foil\SpecialChar TeX
8373 to use the dvips driver to rotate those pages that are set as landscape
8377 \begin_layout Labeling
8378 \labelwidthstring MMMMMMx
8383 Simply changes the page dimensions to those of a landscape page but doesn't
8385 Thus if you use this option you need to use an external program to rotate
8386 each page or feed your paper through your printer as landscape.
8387 Note that this option effectively reverses the roles of the
8395 environments (don't worry these are described in the next section).
8398 \begin_layout Labeling
8399 \labelwidthstring MMMMMMx
8404 Equation numbers on the left.
8407 \begin_layout Labeling
8408 \labelwidthstring MMMMMMx
8413 Flush-left equations.
8416 \begin_layout Subsubsection
8417 Supported Environments
8420 \begin_layout Standard
8421 Most of the environments commonly supported in other classes are also supported
8427 There are several additional environments provided by
8429 Foil\SpecialChar TeX
8432 as well as a couple added by \SpecialChar LyX
8434 The following environments are shared with other classes:
8437 \begin_layout Standard
8438 \begin_inset Flex Multiple Columns
8441 \begin_layout Itemize
8447 \begin_layout Itemize
8453 \begin_layout Itemize
8459 \begin_layout Itemize
8465 \begin_layout Itemize
8471 \begin_layout Itemize
8478 \begin_layout Itemize
8484 \begin_layout Itemize
8490 \begin_layout Itemize
8496 \begin_layout Itemize
8502 \begin_layout Itemize
8508 \begin_layout Itemize
8514 \begin_layout Itemize
8520 \begin_layout Itemize
8526 \begin_layout Itemize
8537 \begin_layout Standard
8538 That is, all the major environments apart from the sectioning environments.
8539 Since foils are essentially self-contained sections, with a title and body,
8542 Foil\SpecialChar TeX
8545 provides specific commands for starting new foils and these are:
8548 \begin_layout Itemize
8554 \begin_layout Itemize
8560 \begin_layout Standard
8562 also provides slightly modified versions of these two environments called:
8565 \begin_layout Itemize
8571 \begin_layout Itemize
8577 \begin_layout Standard
8578 and the differences will be explained in the next section.
8581 \begin_layout Standard
8582 Since foils are often used in presenting ideas or new theorems and such
8585 Foil\SpecialChar TeX
8588 also provides a comprehensive box of goodies for presenting them:
8591 \begin_layout Standard
8592 \begin_inset Flex Multiple Columns
8595 \begin_layout Itemize
8601 \begin_layout Itemize
8607 \begin_layout Itemize
8613 \begin_layout Itemize
8619 \begin_layout Itemize
8625 \begin_layout Itemize
8631 \begin_layout Itemize
8637 \begin_layout Itemize
8643 \begin_layout Itemize
8649 \begin_layout Itemize
8655 \begin_layout Itemize
8666 \begin_layout Standard
8667 The starred versions are unnumbered while the unstarred versions are numbered.
8668 There are also two list environments added by \SpecialChar LyX
8672 \begin_layout Itemize
8678 \begin_layout Itemize
8684 \begin_layout Standard
8687 Foil\SpecialChar TeX
8690 provides some powerful header and footer capabilities that are best set
8691 in the preamble although they may be set at any point in a document.
8692 If you want to change these settings in your document the best place to
8693 do so is at the very top of a foil, i.
8694 \begin_inset space \thinspace{}
8700 \begin_inset space \space{}
8705 straight after the foilhead.
8708 \begin_layout Standard
8709 For this purpose, the following command styles are provided [
8716 \begin_layout Standard
8717 \begin_inset Flex Multiple Columns
8720 \begin_layout Itemize
8724 \begin_inset space ~
8730 \begin_layout Itemize
8736 \begin_layout Itemize
8740 \begin_inset space ~
8746 \begin_layout Itemize
8750 \begin_inset space ~
8756 \begin_layout Itemize
8760 \begin_inset space ~
8767 \begin_layout Plain Layout
8768 \begin_inset space ~
8780 \begin_layout Standard
8781 There are also a few commands provided by
8783 Foil\SpecialChar TeX
8786 that aren't directly supported by \SpecialChar LyX
8787 but I'll tell you what they do and how
8788 to use them in section
8789 \begin_inset space ~
8793 \begin_inset CommandInset ref
8795 reference "sec:unsuppfoils"
8802 \begin_layout Subsubsection
8803 Building a Set of Foils
8806 \begin_layout Standard
8807 This section will give a simple introduction to using the different environments
8808 to build a set of foils.
8809 If you want to see an example set of foils, take a look at the
8813 file you find in \SpecialChar LyX
8821 \begin_layout Paragraph
8822 Give It a Title Page
8825 \begin_layout Standard
8826 Unlike other classes that provide
8846 creates the title on a page of its own.
8847 If you leave out the
8851 environment \SpecialChar LaTeX
8852 will substitute the current date (every time you regenerate
8856 \begin_layout Paragraph
8860 \begin_layout Standard
8861 As I mentioned earlier, there are four ways of starting a new foil.
8862 For portrait foils you should use
8871 The difference between these two environments is the amount of space between
8872 the title of the foil (the foilhead) and the body of the foil.
8875 \begin_layout Standard
8876 Landscape foils are generated using the
8885 Again the only difference is the spacing between foilhead and body.
8886 Both of the short versions have 0.5
8887 \begin_inset space ~
8890 inches less separation between the foilhead and the body.
8894 \begin_layout Standard
8895 One problem with the support for landscape foils is the requirement that
8900 driver to generate the PostScript output otherwise the foils won't be rotated.
8901 It is possible to get landscape foils even if you haven't got the
8905 driver provided you can feed your foils sideways through your printer ;-)
8908 \begin_layout Paragraph
8909 Theorems, Lemmas, Proofs and more
8912 \begin_layout Standard
8913 You can't have two of the same type of these environments directly following
8915 If you use a normal paragraph break, , you will just be extending the previous
8916 environment as if you had merged the two environments together.
8917 Rather than that, you need to insert a so-called separator.
8918 Please refer to the section entitled
8929 \begin_layout Paragraph
8933 \begin_layout Standard
8934 You get all the commonly supported list styles found in other classes as
8935 well as two new ones.
8936 I'll only describe the new ones here.
8937 If you want to find out more about the other list environments check out
8943 If you intend to use itemized lists you might also want to read about the
8947 \begin_inset space ~
8951 \begin_inset space ~
8956 dialog described above in section
8957 \begin_inset space ~
8961 \begin_inset CommandInset ref
8963 reference "sec:bullet"
8970 \begin_layout Standard
8971 The two new list styles,
8979 , are designed to make it easier for you to create lists of do's and don'ts
8980 or right and wrong by providing dedicated environments that use a tick
8981 or a cross as the label of the list.
8982 These lists are in fact dedicated variants of the
8987 They do however require that you have the
8994 \begin_layout Paragraph
8998 \begin_layout Standard
9001 Foil\SpecialChar TeX
9004 redefines the floating tables and figures so that they appear exactly where
9005 they are in the text rather than pushing them to the top of the page or
9006 to some user specified location.
9007 In fact if you change the float placement settings they are simply ignored.
9010 \begin_layout Paragraph
9011 Page Headers and Footers
9012 \begin_inset CommandInset label
9021 \begin_layout Standard
9025 \begin_inset space ~
9034 are two commands used to control the left-footer text string.
9035 The first is meant to allow you to include a graphic logo on your foils
9037 \begin_inset Quotes eld
9042 Foil\SpecialChar TeX
9046 \begin_inset Quotes erd
9050 While the second is meant to provide a classification for the audience,
9054 \begin_inset space \thinspace{}
9060 \begin_inset space \space{}
9064 It is empty by default.
9067 \begin_layout Standard
9068 The remaining page corners can be filled by
9071 \begin_inset space ~
9076 (which defaults to page numbers),
9079 \begin_inset space ~
9087 \begin_inset space ~
9095 \begin_layout Subsubsection
9098 Foil\SpecialChar TeX
9102 \begin_inset CommandInset label
9104 name "sec:unsuppfoils"
9111 \begin_layout Standard
9112 All the commands mentioned below need to be set in a
9122 within another environment.
9125 \begin_layout Paragraph
9129 \begin_layout Standard
9130 All lengths are adjusted using the
9153 should be replaced by the name given to the length you want to change and
9158 is the length value.
9159 All lengths should be specified in units of length such as inches (
9171 ) or relative to some document or font-based length such as
9181 \begin_layout Standard
9182 It's possible to change the spacing between a foilhead and the body of the
9183 foil by adjusting the length specified by
9190 For example, to make
9195 \begin_inset space \space{}
9198 in closer to their bodies put the following in the preamble:
9204 foilheadskip}{-0.5in}
9207 \begin_layout Standard
9208 The spacings around floats can be adjusted by setting these lengths:
9211 \begin_layout Labeling
9212 \labelwidthstring MMMMMMMMMMM
9219 Separation between the text and the top of the float
9222 \begin_layout Labeling
9223 \labelwidthstring MMMMMMMMMMM
9230 Separation between the float and the caption
9233 \begin_layout Labeling
9234 \labelwidthstring MMMMMMMMMMM
9241 Separation between the caption and the following text
9244 \begin_layout Labeling
9245 \labelwidthstring MMMMMMMMMMM
9252 You can make the captions narrower than the surrounding text by adjusting
9254 Best done relative to
9263 \begin_layout Standard
9264 There are also several title page related lengths that you may find useful
9265 if you have a long title or several authors:
9268 \begin_layout Labeling
9269 \labelwidthstring MMMMMMMMMMM
9276 Separation from headers to
9281 \begin_layout Labeling
9282 \labelwidthstring MMMMMMMMMMM
9300 \begin_layout Labeling
9301 \labelwidthstring MMMMMMMMMMM
9315 \begin_layout Labeling
9316 \labelwidthstring MMMMMMMMMMM
9332 \begin_layout Labeling
9333 \labelwidthstring MMMMMMMMMMM
9349 \begin_layout Standard
9350 The last length related command affects all the list environments.
9361 a list environment then all the vertical spacing between the list items
9363 Note that this is a command not a length so it doesn't require
9369 like the stuff mentioned above.
9372 \begin_layout Paragraph
9376 \begin_layout Standard
9389 commands control whether the logo in the
9393 definition appear on a given page.
9400 in the preamble then none of the foils will have the logo on them.
9401 If you don't want the logo on a particular page place the
9407 directly after the foilhead of that page and the
9413 directly after the next foilhead.
9416 \begin_layout Standard
9417 If you decide to use the
9421 page style setting in the
9424 \begin_inset space ~
9429 dialog you should probably add
9439 to your preamble so headers and footers on landscape pages are correctly
9440 placed when rotated.
9441 This is due to some clashes between the page layouts provided by the
9452 \begin_layout Subsection
9459 \begin_inset CommandInset label
9468 \begin_layout Standard
9476 \begin_layout Subsubsection
9480 \begin_layout Standard
9481 This section describes how to use \SpecialChar LyX
9482 to make slides for overhead projectors.
9483 There are two document classes that can do this: the default slides class
9486 Foil\SpecialChar TeX
9490 This section documents the former.
9493 \begin_layout Standard
9494 I'm going to say this again, nice and clear, so that there's no misunderstanding
9498 \begin_layout Standard
9499 \begin_inset VSpace bigskip
9505 \begin_layout Standard
9509 This section documents the class
9510 \begin_inset Quotes eld
9518 \begin_inset Quotes erd
9526 \begin_layout Standard
9527 \begin_inset VSpace bigskip
9533 \begin_layout Standard
9534 If you're looking for the documentation for
9535 \begin_inset Quotes eld
9540 slides (Foil\SpecialChar TeX
9544 \begin_inset Quotes erd
9548 \begin_inset space ~
9552 \begin_inset CommandInset ref
9554 reference "sec:foiltex"
9564 \begin_inset Quotes eld
9569 slides (Foil\SpecialChar TeX
9573 \begin_inset Quotes erd
9576 ] is actually somewhat better than the default
9584 \begin_layout Plain Layout
9586 or so I've been told repeatedly by its advocates.
9587 Having never used it, I have no idea if this claim is true or not.
9592 which this section documents.
9595 \begin_layout Standard
9596 This class is the \SpecialChar LaTeX2e
9597 improvement of the old
9603 Every \SpecialChar LaTeX2e
9604 distribution includes this class [which I'll just refer to as
9605 \begin_inset Quotes eld
9613 \begin_inset Quotes erd
9616 from now on], so you're bound to have it.
9617 As I noted earlier, there are other classes, such as
9621 , which also produce slides for overhead projectors and do a better job
9623 However, there are some things which
9627 can do which the others can't, such as generate overlays.
9628 Read on to learn more!
9631 \begin_layout Subsubsection
9633 \begin_inset CommandInset label
9635 name "sec:slidesetup"
9642 \begin_layout Standard
9643 Obviously, to use this document class, you need to select
9644 \begin_inset Quotes eld
9652 \begin_inset Quotes erd
9655 from the class list in the
9657 Document\SpecialChar menuseparator
9661 There are some other special things you should know about this class:
9664 \begin_layout Itemize
9665 Don't bother changing the options
9670 They're not supported by the
9677 \begin_layout Itemize
9681 \begin_inset space ~
9686 behaves a bit differently for this class.
9687 The possible choices and what they do are as follows:
9691 \begin_layout Description
9696 The final output contains page numbers in the lower right corner.
9699 \begin_layout Description
9708 , but also prints out any time markers you've put in.
9709 This is the default.
9712 \begin_layout Description
9717 The final output contains no page numbers, time markers, or alignment markers.
9721 \begin_layout Itemize
9726 class has an extra option:
9732 \begin_inset Quotes eld
9740 \begin_inset Quotes erd
9743 in the extra class options.
9747 \begin_layout Standard
9748 Using this options allows you to add time markers to
9754 \begin_inset space ~
9758 \begin_inset CommandInset ref
9760 reference "sec:slideNote"
9768 \begin_layout Standard
9769 You can also use the template file
9770 \begin_inset Quotes eld
9778 \begin_inset Quotes erd
9781 to automatically set up a document to use the
9787 File\SpecialChar menuseparator
9789 \begin_inset space ~
9793 \begin_inset space ~
9798 to open your new document].
9799 The template file also contains some examples of the special paragraph
9800 environments used by this class.
9801 I'll describe those next.
9804 \begin_layout Subsubsection
9805 Paragraph Environments
9808 \begin_layout Paragraph
9809 Supported Environments
9812 \begin_layout Standard
9813 The first thing you'll notice when you start up a new
9817 document is the font size and type: it's the equivalent of the size
9818 \begin_inset Quotes eld
9826 \begin_inset Quotes erd
9832 \begin_inset space ~
9838 This is also what's used in the output.
9840 \begin_inset Quotes eld
9844 \begin_inset Quotes erd
9847 to remind you that this is a slide.
9848 Your final slides will use a larger font; ergo, you'll have less space.
9849 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
9852 \begin_layout Standard
9853 The next thing that becomes obvious is the changes to the paragraph environment
9854 pull-down box [at the far-left end of the toolbar].
9855 Most of the paragraph environments you're used to seeing are missing.
9856 There are also five new ones.
9861 class itself only supports certain paragraph environments:
9864 \begin_layout Itemize
9870 \begin_layout Itemize
9876 \begin_layout Itemize
9882 \begin_layout Itemize
9888 \begin_layout Itemize
9894 \begin_layout Itemize
9900 \begin_layout Itemize
9906 \begin_layout Itemize
9912 \begin_layout Itemize
9918 \begin_layout Itemize
9925 \begin_layout Standard
9926 All of the other standard environments, including the section-heading environmen
9927 ts, aren't used in the
9934 \begin_layout Standard
9935 On the other hand, you'll notice the following new environments:
9938 \begin_layout Itemize
9944 \begin_layout Itemize
9950 \begin_layout Itemize
9956 \begin_layout Itemize
9962 \begin_layout Itemize
9968 \begin_layout Standard
9969 These five are kind of quirky, due to a
9970 \begin_inset Quotes eld
9974 \begin_inset Quotes erd
9979 You see, \SpecialChar LyX
9980 doesn't permit you to nest any other paragraph environment into
9981 an empty environment.
9982 Now, that's fine and dandy, but it means that you wouldn't be able to start
9983 a slide with anything except plain text.
9984 To deal with this, I've performed a little
9985 \begin_inset Quotes eld
9990 \begin_inset Quotes erd
9996 \begin_layout Paragraph
9997 Quirks of the New Environments
9998 \begin_inset CommandInset label
10000 name "sec:slideQuirk"
10007 \begin_layout Standard
10008 All five of the new paragraph environments are somewhat quirky due to inherent
10009 limitiations in the current version of \SpecialChar LyX
10011 As I just mentioned, \SpecialChar LyX
10012 forbids environments that begin with another environment.
10013 To get around this, the
10017 environment isn't a paragraph environment as described in the
10025 \begin_layout Standard
10026 You should consider
10039 \begin_inset Quotes eld
10042 pseudo-environments.
10043 \begin_inset Quotes erd
10046 They look like a section heading or a
10047 \begin_inset Quotes eld
10055 \begin_inset Quotes erd
10058 but really begin a [and, if necessary, end the previous] paragraph environment.
10068 \begin_inset Quotes eld
10072 \begin_inset Quotes erd
10075 These two perform some action.
10078 \begin_layout Standard
10079 A common feature of all five environments,
10099 , is a rather long-ish label.
10100 The text following this label — ordinarily the contents of the paragraph
10101 environment — is utterly irrelevant for
10123 completely ignores it.
10124 In fact, you can leave these five environments completely empty.
10128 \begin_layout Standard
10133 to put any text after the rather long-ish label, you might want to.
10134 This could be a short description of the contents of the
10139 In that case, enter your descriptive comment and hit
10143 as you normally would.
10146 \begin_layout Standard
10147 If, on the other hand, you don't want to enter any descriptive text, you'll
10148 hit another \SpecialChar LyX
10151 , like nature, abhors a vacuum, and will not let you start a new paragraph
10152 environment until you put something in the old one.
10156 \begin_layout Itemize
10157 Start entering the text that will
10185 \begin_layout Itemize
10186 Now move to the beginning of that paragraph.
10190 \begin_layout Itemize
10199 \begin_layout Itemize
10200 Finally, change this new, empty paragraph to a
10224 \begin_layout Standard
10225 Some future version of \SpecialChar LyX
10226 will, hopefully, resolve this quirkiness\SpecialChar ldots
10230 \begin_layout Subsubsection
10231 Making a Presentation with
10244 \begin_layout Paragraph
10252 \begin_layout Standard
10253 If you're expecting this section to teach you how to actually make a presentatio
10254 n, you'll be sorely disappointed.
10255 Naturally, I'll describe all of the ways the
10259 class can assist you in preparing the materials for a presentation.
10260 Filling in the contents, however, is up to you.
10265 the \SpecialChar LyX
10269 \begin_layout Standard
10274 environment [in the manner described in section
10275 \begin_inset space ~
10279 \begin_inset CommandInset ref
10281 reference "sec:slideQuirk"
10285 ] tells \SpecialChar LyX
10286 to begin a new slide [duh].
10287 The label for this environment/
10288 \begin_inset Quotes erd
10292 \begin_inset Quotes erd
10296 \begin_inset Quotes eld
10300 \begin_inset Quotes erd
10303 in cool blue, followed by the label,
10304 \begin_inset Quotes eld
10308 \begin_inset Quotes erd
10312 Any text or paragraph environments that follow this one go on the new slide.
10316 \begin_layout Standard
10317 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
10319 (this can be specified in the
10324 In fact, you'll want to, once you finish entering the contents of one slide.
10325 If you've entered more text than can physically fit on a slide, the extra
10326 overflows onto a new slide.
10327 I don't recommend doing this, however, since the overflow slide won't have
10328 any page number on it.
10329 Furthermore, it may interfere with any
10333 you've made to accompany the oversized
10340 \begin_layout Standard
10349 environments work the same way as the
10354 They both create an
10355 \begin_inset Quotes eld
10359 \begin_inset Quotes erd
10362 followed by a label [
10363 \begin_inset Quotes eld
10367 \begin_inset Quotes erd
10371 \begin_inset Quotes eld
10375 \begin_inset Quotes erd
10379 The color is a stunning magenta instead of blue, and the
10380 \begin_inset Quotes eld
10384 \begin_inset Quotes erd
10387 will look different, in style and in length.
10388 The label fonts of all three also differ from one another.
10391 \begin_layout Standard
10396 , if the contents of a
10404 exceed the physical size of a slide or sheet of paper, the extra will overflow
10406 Again, you should avoid this.
10407 It defeats the whole purpose of
10418 \begin_layout Paragraph
10428 \begin_layout Standard
10433 is a slide that sits atop another slide.
10434 Perhaps you wish to discuss a figure on the main
10438 before displaying the text associated with it.
10439 One way to accomplish this is tape a flap of dark paper over the part of
10444 you want to display later.
10445 This method fails, however, if you wish to overlap one graph with another,
10447 You would then have to fumble while speaking to align the two separate,
10452 s to align the two graphs.
10457 environment in both cases makes life much easier.
10460 \begin_layout Standard
10465 receives the page number of its
10466 \begin_inset Quotes eld
10470 \begin_inset Quotes erd
10478 \begin_inset Quotes eld
10486 \begin_inset Quotes erd
10493 \begin_layout Plain Layout
10494 Presumably, mutliple
10499 \begin_inset Quotes eld
10507 \begin_inset Quotes erd
10511 \begin_inset Quotes eld
10519 \begin_inset Quotes erd
10523 \begin_inset Quotes eld
10531 \begin_inset Quotes erd
10535 \begin_inset space ~
10538 appended to the page number of the parent
10548 Clearly, you want the contents of both the
10556 to each fit on a single physical slide! You should probably consider an
10562 \begin_inset Quotes eld
10566 \begin_inset Quotes erd
10574 Indeed, the \SpecialChar LyX
10579 class provides a visual cue for this: the label at the start of an
10583 is shorter than that at the start of a
10588 Lastly, when you generate printable output, you'll find alignment markers
10589 in all four corners of both the
10593 page and its parent
10598 These will assist you in lining up the two physical slides.
10601 \begin_layout Standard
10602 The major problem in overlaying two slides is aligning the contents of the
10603 two transparencies.
10604 How much space should you leave for that graph on the second slide? Worse
10605 still, what if you want a graph and a sentence on second slide, but there
10606 is text on the main transparency that goes in between them? You could try
10607 and insert vertical space of the right size.
10608 The better way is to use
10619 \begin_layout Standard
10620 As their names imply,
10628 are two command-like paragraph environments that make all subsequent text
10629 invisible and visible, respectively.
10631 \begin_inset space ~
10635 \begin_inset CommandInset ref
10637 reference "sec:slideQuirk"
10641 that you don't place anything
10645 these two environments, however.
10650 , it inserts a centered, sky-blue label into the page reading
10651 \begin_inset Quotes eld
10654 <Invisible Text Follows>
10655 \begin_inset Quotes erd
10659 For paragraphs following this label, the parts of the
10667 ; it doesn't matter which] where they would be contain instead blank space.
10671 \begin_layout Standard
10676 , the corresponding centered label is
10677 \begin_inset Quotes eld
10680 <Visible Text Follows>
10681 \begin_inset Quotes erd
10685 Paragraphs following this label behave normally.
10686 Note that the beginning of a new
10698 automatically shuts off an
10703 It's therefore not necessary to use
10714 \begin_layout Standard
10715 By now, it should be obvious how to create overlay transparencies using
10716 the proper combination of
10735 \begin_layout Enumerate
10740 , including everything that will appear on it, whether on the main slide
10748 \begin_layout Enumerate
10749 Before each figure or paragraph that will appear only on the
10758 If necessary, insert a
10762 environment after the
10769 \begin_layout Enumerate
10774 immediately following the
10781 \begin_layout Enumerate
10782 Copy the contents of this
10793 \begin_layout Enumerate
10798 , change all of the
10809 \begin_layout Standard
10811 You've just made an
10818 \begin_layout Standard
10819 There's one problem with the way I've designed the \SpecialChar LyX
10824 class: you can't make text in the middle of a paragraph invisible, nor
10825 make text in the middle of an invisible paragraph visible again.
10826 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
10831 \begin_layout Plain Layout
10832 The commands of interest are:
10835 \begin_layout Itemize
10840 invisible \SpecialChar ldots
10844 \begin_layout Itemize
10849 visible \SpecialChar ldots
10853 \begin_layout Plain Layout
10855 and need to be marked as \SpecialChar TeX
10858 \begin_inset Quotes eld
10862 \begin_inset Quotes erd
10865 you wish to change goes in between the brackets [and after the
10878 If you don't know how to mark text as \SpecialChar TeX
10879 , see the appropriate section of
10892 \begin_layout Paragraph
10902 \begin_inset CommandInset label
10904 name "sec:slideNote"
10911 \begin_layout Standard
10920 is associated with a
10921 \begin_inset Quotes eld
10925 \begin_inset Quotes erd
10933 Here, too, the \SpecialChar LyX
10938 class provides visual cues.
10943 is shorter than that of a
10947 [yet longer than that of an
10951 ] and, like the label of an
10955 is shockingly magenta.
10956 Additionally, the printed
10960 has the page number of its
10961 \begin_inset Quotes eld
10965 \begin_inset Quotes erd
10973 \begin_inset Quotes eld
10981 \begin_inset Quotes erd
10985 \begin_inset Quotes eld
10993 \begin_inset Quotes erd
10997 \begin_inset Quotes eld
11005 \begin_inset Quotes erd
11009 You can have multiple
11013 s associated with a single
11025 , you'll probably want to break up long
11029 s so that they fit on a single sheet of paper.
11032 \begin_layout Standard
11037 is obvious: it contains anything additional you might want to say about
11043 It could also be used as a sheet of reminders for a particular
11048 In the case of the latter, you might want to make use of time markers.
11049 Currently, the \SpecialChar LyX
11055 \begin_inset Quotes eld
11059 \begin_inset Quotes erd
11062 support for time markers, a
11064 Sli\SpecialChar TeX
11068 So, you'll have to resort to using the \SpecialChar LaTeX
11072 \begin_layout Standard
11073 To use time markers, you'll need to specify the extra class option
11074 \begin_inset Quotes eld
11082 \begin_inset Quotes erd
11086 \begin_inset space ~
11090 \begin_inset CommandInset ref
11092 reference "sec:slidesetup"
11097 This option turns on timing marks, which will appear in the lower-left-hand
11103 To set what appears in the time marker, you use the \SpecialChar LaTeX
11105 \begin_inset Quotes eld
11115 \begin_inset Quotes erd
11119 \begin_inset Quotes eld
11129 \begin_inset Quotes erd
11133 The arguments of both commands are time measured in seconds.
11135 \begin_inset Quotes eld
11145 \begin_inset Quotes erd
11148 sets the time marker to a given time.
11150 \begin_inset Quotes eld
11160 \begin_inset Quotes erd
11163 increments the time marker by the specified amount.
11164 Using time markers and
11168 s in this fashion, you can remind yourself how much time to spend on a particula
11176 \begin_layout Standard
11177 There's one last feature to describe.
11178 Clearly, you'd like to print out all of your
11186 s on transparencies while printing all of your
11203 with which it is associated.
11204 What's a person to do?
11207 \begin_layout Standard
11208 Luckily, there are two \SpecialChar LaTeX
11209 commands that allow you to select what to print
11211 Both must be placed into the preamble of your document.
11213 \begin_inset Quotes eld
11225 \begin_inset Quotes erd
11228 will cause the output to contain only the
11237 Correspondingly, the command
11238 \begin_inset Quotes eld
11250 \begin_inset Quotes erd
11253 prevents the output of anything but
11258 I'd advise placing both commands in the preamble and initially comment
11260 You can then preview your entire presentation as you write.
11261 When you're done writing, you can then uncomment one of the two to select
11262 what you want to print.
11263 I like to uncomment
11264 \begin_inset Quotes eld
11276 \begin_inset Quotes erd
11279 , print to a file with
11280 \begin_inset Quotes eld
11288 \begin_inset Quotes erd
11291 in its name, comment it back out, then uncomment
11292 \begin_inset Quotes eld
11304 \begin_inset Quotes erd
11308 \begin_inset Quotes eld
11316 \begin_inset Quotes erd
11320 I can then send either file to a printer, loading transparencies or plain
11321 paper as appropriate.
11324 \begin_layout Standard
11325 You can also provide other arguments to the
11326 \begin_inset Quotes eld
11336 \begin_inset Quotes erd
11340 \begin_inset Quotes eld
11350 \begin_inset Quotes erd
11354 See a good \SpecialChar LaTeX
11358 \begin_layout Subsubsection
11363 Class Template File
11366 \begin_layout Standard
11367 I have also provided a template file,
11368 \begin_inset Quotes eld
11376 \begin_inset Quotes erd
11384 To use it, begin your new presentation with
11386 File\SpecialChar menuseparator
11388 \begin_inset space ~
11392 \begin_inset space ~
11398 Your new \SpecialChar LyX
11399 presentation file will contain an example
11420 additionally contain an example of the use of
11429 Lastly, the preamble will contain:
11432 \begin_layout LyX-Code
11433 % Uncomment to print out only slides and overlays
11436 \begin_layout LyX-Code
11440 \begin_layout LyX-Code
11446 \begin_inset Newline newline
11452 \begin_layout LyX-Code
11453 % Uncomment to print out only notes
11456 \begin_layout LyX-Code
11460 \begin_layout LyX-Code
11468 \begin_layout Standard
11469 One final thing: I created this class to support the \SpecialChar LaTeX2e
11471 \begin_inset Quotes eld
11476 Sli\SpecialChar TeX
11480 \begin_inset Quotes erd
11483 class, one of the built-in \SpecialChar LaTeX2e
11485 Neither I nor the rest of the \SpecialChar LyX
11486 Team endorse or oppose the use of this built-in
11488 It's here if you want it or need it.
11489 There exist other \SpecialChar LaTeX2e
11490 classes for creating presentations, such as the
11495 \begin_inset space ~
11499 \begin_inset CommandInset ref
11501 reference "sec:foiltex"
11506 \begin_inset Quotes eld
11514 \begin_inset Quotes erd
11517 package [present on some \SpecialChar TeX
11519 The latter is not yet supported under \SpecialChar LyX
11524 \begin_layout Plain Layout
11525 Perhaps you can take on the task\SpecialChar ldots
11531 I know nothing about these other classes.
11532 Try them out to see what sort of alternative they provide.
11535 \begin_layout Section
11537 \change_inserted 564990737 1670439661
11541 \begin_layout Subsection
11543 \change_inserted 564990737 1670439661
11547 \begin_layout Standard
11549 \change_inserted 564990737 1670439661
11558 document class for preparing reports.
11563 document class, this provides parts, chapters and sections but does not
11564 provide the paragraph styles needed for a book; like the
11568 document class, it provides the abstract paragraph style.
11569 In two-sided mode, it does not start a new chapter on the right hand page.
11572 \begin_layout Standard
11574 \change_inserted 564990737 1670439674
11579 document classes are described in the Collections (section
11580 \begin_inset space ~
11584 \begin_inset CommandInset ref
11586 reference "sec:Collections"
11593 \begin_layout Section
11595 \change_inserted 564990737 1670439674
11599 \begin_layout Subsection
11603 \begin_layout Standard
11609 \begin_layout Subsubsection
11613 \begin_layout Standard
11614 Broadway is for writing plays.
11615 The format is more decorative than Hollywood, and much less standardized.
11616 This format should be suitable for workshops.
11619 \begin_layout Subsubsection
11623 \begin_layout Standard
11624 The same as in Hollywood.
11627 \begin_layout Subsubsection
11631 \begin_layout Standard
11636 names as labels then cross-reference the label to insert the name.
11637 The cross-reference dialog will show the current cast of characters.
11640 \begin_layout Subsubsection
11641 Paper size and Margins
11644 \begin_layout Standard
11645 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
11648 \begin_layout Subsubsection
11652 \begin_layout Standard
11653 The following environments are available.
11654 You can use broadway.bind to get the bind keys shown at the right.
11657 \begin_layout Itemize
11661 \begin_inset Newline newline
11666 You should not have to use this, but it is here for anything that does not
11670 \begin_layout Itemize
11674 \begin_inset space \hfill{}
11678 \begin_inset Newline newline
11683 Used to describe stage setting and the action.
11684 First use of speaker names in all CAPs.
11687 \begin_layout Itemize
11691 \begin_inset space \hfill{}
11695 \begin_inset Newline newline
11700 Automatically numbered.
11701 On screen it will be arabic, but will print as Roman.
11704 \begin_layout Itemize
11708 \begin_inset space \hfill{}
11712 \begin_inset Newline newline
11722 It is just centered text.
11725 \begin_layout Itemize
11729 \begin_inset space \hfill{}
11733 \begin_inset Newline newline
11738 Not automatically numbered.
11739 You supply the number.
11740 This is because I couldn't figure out how.
11743 \begin_layout Itemize
11747 \begin_inset space \hfill{}
11751 \begin_inset Newline newline
11756 A special case of Narrative to describe the setting and action as the curtain
11760 \begin_layout Itemize
11764 \begin_inset space \hfill{}
11768 \begin_inset Newline newline
11773 The speaker's (actor's) title, centered in all CAPS.
11776 \begin_layout Itemize
11780 \begin_inset space \hfill{}
11784 \begin_inset Newline newline
11789 Instructions to the speaker.
11790 The parentheses are automatically inserted.
11791 The ( will appear on screen, but both will be in the printed play.
11792 This environment is only used within
11799 \begin_layout Itemize
11803 \begin_inset space \hfill{}
11807 \begin_inset Newline newline
11812 What the Speaker says.
11815 \begin_layout Itemize
11819 \begin_inset space \hfill{}
11823 \begin_inset Newline newline
11828 The curtain comes down.
11831 \begin_layout Itemize
11835 \begin_inset space \hfill{}
11841 \begin_layout Itemize
11845 \begin_inset space \hfill{}
11851 \begin_layout Itemize
11855 \begin_inset space \hfill{}
11861 \begin_layout Standard
11865 \begin_layout Subsection
11866 Hollywood (Hollywood spec scripts)
11869 \begin_layout Standard
11875 \begin_layout Subsubsection
11879 \begin_layout Standard
11880 Getting the format of a Hollywood script right is a
11881 \begin_inset Quotes eld
11885 \begin_inset Quotes erd
11888 It is designed to make the readers focus on content and to be easy and
11889 familiar for the actors to read.
11890 Each page of a script should be one minute of film.
11891 Nothing goes in a script that you cannot see or hear on screen.
11892 The courier 12 pt font should be used throughout.
11896 \begin_layout Subsubsection
11900 \begin_layout Standard
11901 Speakers' lines should NEVER break in mid-sentence.
11902 If a speaker's lines continue over a page break, repeat the
11906 title followed by (Cont'd).
11909 \begin_layout Subsubsection
11913 \begin_layout Standard
11918 names as labels then cross-reference the label to insert the name.
11919 The cross-reference dialog will show the current cast of characters.
11920 You can use this to insert the speaker name in narratives also.
11923 \begin_layout Subsubsection
11924 Paper size and Margins
11927 \begin_layout Standard
11928 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
11931 \begin_layout Subsubsection
11935 \begin_layout Standard
11936 The following environments are available.
11937 You can use hollywood.bind to get the bind keys shown at the right.
11940 \begin_layout Itemize
11944 \begin_inset Newline newline
11949 Used where nothing else works.
11953 \begin_layout Itemize
11959 \begin_inset space \hfill{}
11967 \begin_inset Newline newline
11970 Usually followed by something like
11971 \begin_inset Quotes eld
11974 on Sally waking up.
11975 \begin_inset Quotes erd
11981 \begin_layout Itemize
11985 \begin_inset space \hfill{}
11989 \begin_inset Newline newline
11994 Introduces a new INTERIOR camera set-up.
11995 Always followed by DAY or NIGHT, or something similar to define the lighting
11997 Everthing on this line in CAPS.
12000 \begin_layout Itemize
12004 \begin_inset space \hfill{}
12008 \begin_inset Newline newline
12013 Introduces a new EXTERIOR camera set-up.
12014 Everthing on this line in CAPS.
12017 \begin_layout Itemize
12021 \begin_inset space \hfill{}
12025 \begin_inset Newline newline
12030 The character speaking.
12033 \begin_layout Itemize
12037 \begin_inset space \hfill{}
12041 \begin_inset Newline newline
12046 Instructions to the speaker.
12047 The () are automatically inserted.
12050 \begin_layout Itemize
12054 \begin_inset space \hfill{}
12058 \begin_inset Newline newline
12070 \begin_layout Itemize
12074 \begin_inset space \hfill{}
12078 \begin_inset Newline newline
12083 Camera movement instruction.
12085 \begin_inset space \thinspace{}
12089 \begin_inset space \space{}
12095 \begin_layout Itemize
12099 \begin_inset space \hfill{}
12105 \begin_layout Itemize
12109 \begin_inset space \hfill{}
12115 \begin_layout Itemize
12119 \begin_inset space \hfill{}
12125 \begin_layout Itemize
12129 \begin_inset space \hfill{}
12135 \begin_layout Subsubsection
12139 \begin_layout Itemize
12143 \begin_layout Itemize
12147 \begin_layout Itemize
12149 \begin_inset space \thinspace{}
12156 \begin_layout Itemize
12161 \begin_layout Itemize
12162 PAN — camera movement
12165 \begin_layout Itemize
12166 INSERT — cut to close-up of
12169 \begin_layout Chapter
12171 \change_inserted 564990737 1671185876
12175 \begin_layout Section
12176 Multiple Text Columns
12179 \begin_layout Standard
12180 This feature is independent of the option
12182 Two-column document
12184 in the document settings under
12189 If you want to have 2
12190 \begin_inset space ~
12193 columns for the whole document, it is recommended to use the
12195 Two-column document
12198 For all other cases use this feature.
12201 \begin_layout Standard
12202 To use multiple text columns in your document, you have to load the module
12209 Document\SpecialChar menuseparator
12210 Settings\SpecialChar menuseparator
12213 ) and must have the \SpecialChar LaTeX
12215 \begin_inset Flex Code
12218 \begin_layout Plain Layout
12227 \begin_layout Standard
12228 Footnotes within multiple columns will be placed at the bottom of the page
12229 and not under each column.
12230 Within the different columns you can use everything, with the limitation
12231 that for floats you need to use the float option
12238 \begin_layout Subsection
12242 \begin_layout Standard
12243 If you want to have 2
12244 \begin_inset space ~
12247 columns in your text, insert a multicolumn inset via the menu
12249 Insert\SpecialChar menuseparator
12251 \begin_inset space ~
12254 Insets\SpecialChar menuseparator
12256 \begin_inset space ~
12261 where the columns should start.
12262 Write all text that should be printed in 2
12263 \begin_inset space ~
12266 columns into this inset.
12269 \begin_layout Standard
12270 Here is an example:
12273 \begin_layout Standard
12275 \begin_inset Flex Multiple Columns
12278 \begin_layout Plain Layout
12283 The Adventure of the Empty House
12286 \begin_inset Newline newline
12289 by Sir Arthur Conan Doyle
12292 \begin_layout Plain Layout
12295 It was in the spring of the year 1894 that all London was interested, and
12296 the fashionable world dismayed, by the murder of the Honourable Ronald
12297 Adair under most unusual and inexplicable circumstances.
12298 The public has already learned those particulars of the crime which came
12299 out in the police investigation, but a good deal was suppressed upon that
12300 occasion, since the case for the prosecution was so overwhelmingly strong
12301 that it was not necessary to bring forward all the facts.
12302 Only now, at the end of nearly ten years, am I allowed to supply those
12303 missing links which make up the whole of that remarkable chain.
12304 The crime was of interest in itself, but that interest was as nothing to
12305 me compared to the inconceivable sequel, which afforded me the greatest
12306 shock and surprise of any event in my adventurous life.
12307 Even now, after this long interval, I find myself thrilling as I think
12308 of it, and feeling once more that sudden flood of joy, amazement, and increduli
12309 ty which utterly submerged my mind.
12310 Let me say to that public, which has shown some interest in those glimpses
12311 which I have occasionally given them of the thoughts and actions of a very
12312 remarkable man, that they are not to blame me if I have not shared my knowledge
12313 with them, for I should have considered it my first duty to do so, had
12314 I not been barred by a positive prohibition from his own lips, which was
12315 only withdrawn upon the third of last month.
12323 \begin_layout Standard
12324 To get 3 or more columns, set the cursor into the multicolumn inset and
12327 Insert\SpecialChar menuseparator
12329 \begin_inset space ~
12333 \begin_inset space ~
12339 The number of the desired columns is written into that inset (for 3
12340 \begin_inset space ~
12344 \begin_inset Quotes eld
12348 \begin_inset Quotes erd
12352 \begin_inset Newline newline
12355 Here is an example with 3
12356 \begin_inset space ~
12362 \begin_layout Standard
12363 \begin_inset Flex Multiple Columns
12366 \begin_layout Plain Layout
12369 \begin_inset Argument 1
12372 \begin_layout Plain Layout
12379 It can be imagined that my close intimacy with Sherlock Holmes had interested
12380 me deeply in crime, and that after his disappearance I never failed to
12381 read with care the various problems which came before the public.
12382 And I even attempted, more than once, for my own private satisfaction,
12383 to employ his methods in their solution, though with indifferent success.
12384 There was none, however, which appealed to me like this tragedy of Ronald
12386 As I read the evidence at the inquest, which led up to a verdict of willful
12387 murder against some person or persons unknown, I realized more clearly
12388 than I had ever done the loss which the community had sustained by the
12389 death of Sherlock Holmes.
12390 There were points about this strange business which would, I was sure,
12391 have specially appealed to him, and the efforts of the police would have
12392 been supplemented, or more probably anticipated, by the trained observation
12393 and the alert mind of the first criminal agent in Europe.
12394 All day, as I drove upon my round, I turned over the case in my mind and
12395 found no explanation which appeared to me to be adequate.
12396 At the risk of telling a twice-told tale, I will recapitulate the facts
12397 as they were known to the public at the conclusion of the inquest.
12405 \begin_layout Standard
12406 You can have up to 10
12407 \begin_inset space ~
12410 columns if you want to, but that might not be very pleasant for the readers
12414 \begin_layout Standard
12415 \begin_inset Newpage newpage
12421 \begin_layout Subsection
12422 Columns inside Columns
12425 \begin_layout Standard
12426 You can also have columns inside columns:
12429 \begin_layout Standard
12430 \begin_inset Flex Multiple Columns
12433 \begin_layout Plain Layout
12436 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
12437 at that time governor of one of the Australian colonies.
12438 Adair's mother had returned from Australia to undergo the operation for
12439 cataract, and she, her son Ronald, and her daughter Hilda were living together
12443 \begin_layout Plain Layout
12444 \begin_inset Flex Multiple Columns
12447 \begin_layout Plain Layout
12450 The youth moved in the best society
12451 \begin_inset space ~
12454 – had, so far as was known, no enemies and no particular vices.
12455 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
12456 had been broken off by mutual consent some months before, and there was
12457 no sign that it had left any very profound feeling behind it.
12458 For the rest {sic} the man's life moved in a narrow and conventional circle,
12459 for his habits were quiet and his nature unemotional.
12460 Yet it was upon this easy-going young aristocrat that death came, in most
12461 strange and unexpected form, between the hours of ten and eleven-twenty
12462 on the night of March 30, 1894.
12470 \begin_layout Plain Layout
12473 Ronald Adair was fond of cards
12474 \begin_inset space ~
12477 – playing continually, but never for such stakes as would hurt him.
12478 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
12479 It was shown that, after dinner on the day of his death, he had played
12480 a rubber of whist at the latter club.
12481 He had also played there in the afternoon.
12486 The evidence of those who had played with him
12487 \begin_inset space ~
12491 Murray, Sir John Hardy, and Colonel Moran
12492 \begin_inset space ~
12495 – showed that the game was whist, and that there was a fairly equal fall
12497 Adair might have lost five pounds, but not more.
12498 His fortune was a considerable one, and such a loss could not in any way
12500 He had played nearly every day at one club or other, but he was a cautious
12501 player, and usually rose a winner.
12502 It came out in evidence that, in partnership with Colonel Moran, he had
12503 actually won as much as four hundred and twenty pounds in a sitting, some
12504 weeks before, from Godfrey Milner and Lord Balmoral.
12505 So much for his recent history as it came out at the inquest.
12513 \begin_layout Subsection
12517 \begin_layout Standard
12518 The examples in this section show some more special features of multiple
12522 \begin_layout Standard
12523 For more features of multiple columns, have a look at the
12524 \begin_inset CommandInset href
12526 name "documentation"
12527 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
12532 of the \SpecialChar LaTeX
12534 \begin_inset Flex Code
12537 \begin_layout Plain Layout
12546 \begin_layout Subsubsection
12550 \begin_layout Standard
12551 To add a preface text for multiple columns, set the cursor into the multicolumn
12552 inset and use the menu
12554 Insert\SpecialChar menuseparator
12558 Write your preface text into that inset.
12559 \begin_inset Newline newline
12562 This is an example with some preface text:
12565 \begin_layout Standard
12566 \begin_inset VSpace bigskip
12572 \begin_layout Standard
12573 \begin_inset Flex Multiple Columns
12576 \begin_layout Plain Layout
12577 \begin_inset Argument 2
12580 \begin_layout Plain Layout
12581 And the story continues and continues and continues and continues\SpecialChar ldots
12589 On the evening of the crime, he returned from the club exactly at ten.
12590 His mother and sister were out spending the evening with a relation.
12591 The servant deposed that she heard him enter the front room on the second
12592 floor, generally used as his sitting-room.
12593 She had lit a fire there, and as it smoked she had opened the window.
12594 No sound was heard from the room until eleven-twenty, the hour of the return
12595 of Lady Maynooth and her daughter.
12596 Desiring to say good-night, she attempted to enter her son's room.
12597 The door was locked on the inside, and no answer could be got to their
12598 cries and knocking.
12599 Help was obtained, and the door forced.
12600 The unfortunate young man was found lying near the table.
12601 His head had been horribly mutilated by an expanding revolver bullet, but
12602 no weapon of any sort was to be found in the room.
12610 \begin_layout Standard
12611 You can also use a section heading as the preface if you use a section command
12612 as \SpecialChar TeX
12614 For example the command
12617 \begin_layout LyX-Code
12620 subsection{subsection title}
12623 \begin_layout Standard
12624 creates a subsection.
12625 In this example the preface is a subsubsection:
12628 \begin_layout Standard
12629 \begin_inset Flex Multiple Columns
12632 \begin_layout Plain Layout
12633 \begin_inset Argument 2
12636 \begin_layout Plain Layout
12640 \begin_layout Plain Layout
12649 This is a subsubsection heading as a preface
12653 \begin_layout Plain Layout
12667 A minute examination of the circumstances served only to make the case more
12669 In the first place, no reason could be given why the young man should have
12670 fastened the door upon the inside.
12671 There was the possibility that the murderer had done this, and had afterwards
12672 escaped by the window.
12673 The drop was at least twenty feet, however, and a bed of crocuses in full
12675 Neither the flowers nor the earth showed any sign of having been disturbed,
12676 nor were there any marks upon the narrow strip of grass which separated
12677 the house from the road.
12678 Apparently, therefore, it was the young man himself who had fastened the
12680 But how did he come by his death? No one could have climbed up to the window
12681 without leaving traces.
12682 Suppose a man had fired through the window, he would indeed be a remarkable
12683 shot who could with a revolver inflict so deadly a wound.
12684 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
12685 a hundred yards of the house.
12686 No one had heard a shot.
12694 \begin_layout Standard
12695 If there is less vertical space than 6
12696 \begin_inset space ~
12699 text lines is left on the page at the beginning of the multiple columns,
12700 a page break will be inserted before the multiple columns.
12701 Depending on the number of lines of the preface text, you might want to
12703 This is done by setting the cursor into the mulitcolumn inset behind the
12704 preface (if there is any) and using the menu
12706 Insert\SpecialChar menuseparator
12708 \begin_inset space ~
12712 \begin_inset space ~
12716 \begin_inset space ~
12722 Insert into that inset the amount of space like e.
12723 \begin_inset space \thinspace{}
12727 \begin_inset space \space{}
12731 \begin_inset Quotes eld
12735 \begin_inset Quotes erd
12739 \begin_inset Newline newline
12742 In this example the space is set to 7
12743 \begin_inset space ~
12746 text lines by using
12747 \begin_inset Flex Code
12750 \begin_layout Plain Layout
12759 \begin_inset Flex Code
12762 \begin_layout Plain Layout
12770 needs to be inserted as \SpecialChar TeX
12774 \begin_layout Standard
12775 \begin_inset Flex Multiple Columns
12778 \begin_layout Plain Layout
12779 \begin_inset Argument 3
12782 \begin_layout Plain Layout
12787 \begin_layout Plain Layout
12803 On the evening of the crime, he returned from the club exactly at ten.
12804 His mother and sister were out spending the evening with a relation.
12805 The servant deposed that she heard him enter the front room on the second
12806 floor, generally used as his sitting-room.
12807 She had lit a fire there, and as it smoked she had opened the window.
12808 No sound was heard from the room until eleven-twenty, the hour of the return
12809 of Lady Maynooth and her daughter.
12810 Desiring to say good-night, she attempted to enter her son's room.
12811 The door was locked on the inside, and no answer could be got to their
12812 cries and knocking.
12813 Help was obtained, and the door forced.
12814 The unfortunate young man was found lying near the table.
12815 His head had been horribly mutilated by an expanding revolver bullet, but
12816 no weapon of any sort was to be found in the room.
12824 \begin_layout Subsubsection
12828 \begin_layout Standard
12829 The amount of space before and after multiple columns can be changed by
12830 changing the length
12831 \begin_inset Flex Code
12834 \begin_layout Plain Layout
12843 For example the command
12846 \begin_layout LyX-Code
12854 \begin_layout Standard
12855 in \SpecialChar TeX
12856 Code changes its value to 3
12857 \begin_inset space \thinspace{}
12861 The change must be made before the multiple columns' start.
12862 The predefined value is 13
12863 \begin_inset space \thinspace{}
12869 \begin_layout Standard
12871 \begin_inset Flex Code
12874 \begin_layout Plain Layout
12883 \begin_inset space \thinspace{}
12889 \begin_layout Standard
12893 \begin_layout Plain Layout
12899 multicolsep}{2.5cm}
12907 \begin_layout Standard
12908 \begin_inset Flex Multiple Columns
12911 \begin_layout Plain Layout
12914 All day I turned these facts over in my mind, endeavouring to hit upon some
12915 theory which could reconcile them all, and to find that line of least resistanc
12916 e which my poor friend had declared to be the starting-point of every investigat
12918 I confess that I made little progress.
12919 In the evening I strolled across the Park, and found myself about six o'clock
12920 at the Oxford Street end of Park Lane.
12921 A group of loafers upon the pavements, all staring up at a particular window,
12922 directed me to the house which I had come to see.
12923 A tall, thin man with coloured glasses, whom I strongly suspected of being
12924 a plain-clothes detective, was pointing out some theory of his own, while
12925 the others crowded round to listen to what he said.
12926 I got as near him as I could, but his observations seemed to me to be absurd,
12927 so I withdrew again in some disgust.
12928 As I did so I struck against an elderly, deformed man, who had been behind
12929 me, and I knocked down several books which he was carrying.
12937 \begin_layout Standard
12938 \begin_inset Note Greyedout
12941 \begin_layout Plain Layout
12946 The values you set with
12947 \begin_inset Flex Code
12950 \begin_layout Plain Layout
12958 will be used for all following multiple columns until you change them again.
12966 \begin_layout Standard
12970 \begin_layout Plain Layout
12982 \begin_inset Note Note
12985 \begin_layout Plain Layout
12986 go back to the default
12994 \begin_layout Standard
12995 \begin_inset Newpage newpage
13001 \begin_layout Subsubsection
13005 \begin_layout Standard
13006 A column break can be forced by inserting the command
13007 \begin_inset Flex Code
13010 \begin_layout Plain Layout
13018 as \SpecialChar TeX
13019 Code to that position in the text where the column should be broken.
13020 Note that this leads in most cases to whitespace in the text.
13021 \begin_inset Newline newline
13024 Here is an example:
13027 \begin_layout Standard
13028 \begin_inset Flex Multiple Columns
13031 \begin_layout Plain Layout
13034 \begin_inset Quotes eld
13037 You're surprised to see me, sir,
13038 \begin_inset Quotes erd
13041 said he, in a strange, croaking voice.
13044 \begin_layout Plain Layout
13047 I acknowledged that I was.
13050 \begin_layout Plain Layout
13053 \begin_inset Quotes eld
13056 Well, I've a conscience, sir, and when I chanced to see you go into this
13057 house, as I came hobbling after you, I thought to myself, I'll just step
13058 in and see that kind gentleman, and tell him that if I was a bit gruff
13059 in my manner there was not any harm meant, and that I am much obliged to
13060 him for picking up my books.
13061 \begin_inset Quotes erd
13067 \begin_layout Plain Layout
13070 \begin_inset Quotes eld
13073 You make too much of a trifle,
13074 \begin_inset Quotes erd
13079 \begin_inset Quotes eld
13082 May I ask how you knew who I was?
13083 \begin_inset Quotes erd
13086 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
13090 \begin_layout Plain Layout
13102 \begin_layout Plain Layout
13105 \begin_inset Quotes eld
13108 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
13109 you'll find my little bookshop at the corner of Church Street, and very
13110 happy to see you, I am sure.
13111 Maybe you collect yourself, sir.
13115 \begin_inset space ~
13129 \begin_inset space ~
13132 – a bargain, every one of them.
13133 With five volumes you could just fill that gap on that second shelf.
13134 It looks untidy, does it not, sir?
13135 \begin_inset Quotes erd
13146 \begin_layout Subsubsection
13150 \begin_layout Standard
13151 The width of the columns is automatically calculated, but you can modify
13152 the space between the columns.
13153 This is done by changing the length
13154 \begin_inset Flex Code
13157 \begin_layout Plain Layout
13166 Its predefined value is 10
13167 \begin_inset space \thinspace{}
13171 Here is an example where
13172 \begin_inset Flex Code
13175 \begin_layout Plain Layout
13184 \begin_inset space \thinspace{}
13190 \begin_layout Standard
13194 \begin_layout Plain Layout
13208 \begin_layout Standard
13209 \begin_inset Flex Multiple Columns
13212 \begin_layout Plain Layout
13215 My observations of No.
13216 \begin_inset space \space{}
13219 427 Park Lane did little to clear up the problem in which I was interested.
13220 The house was separated from the street by a low wall and railing, the
13221 whole not more than five feet high.
13222 It was perfectly easy, therefore, for anyone to get into the garden, but
13223 the window was entirely inaccessible, since there was no water pipe or
13224 anything which could help the most active man to climb it.
13225 More puzzled than ever, I retraced my steps to Kensington.
13226 I had not been in my study five minutes when the maid entered to say that
13227 a person desired to see me.
13228 To my astonishment it was none other than my strange old book collector,
13229 his sharp, wizened face peering out from a frame of white hair, and his
13230 precious volumes, a dozen of them at least, wedged under his right arm.
13238 \begin_layout Standard
13242 \begin_layout Plain Layout
13254 \begin_inset Note Note
13257 \begin_layout Plain Layout
13258 go back to the default
13266 \begin_layout Subsubsection
13270 \begin_layout Standard
13271 Between the columns a rule with a width of the length
13272 \begin_inset Flex Code
13275 \begin_layout Plain Layout
13284 If this rule width is set to 0
13285 \begin_inset space \thinspace{}
13288 pt (this is the default), the rule is suppressed.
13289 In the following example the rule is 2
13290 \begin_inset space \thinspace{}
13296 \begin_layout Standard
13300 \begin_layout Plain Layout
13306 columnseprule}{2pt}
13314 \begin_layout Standard
13315 \begin_inset Flex Multiple Columns
13318 \begin_layout Plain Layout
13321 \begin_inset Quotes eld
13324 You're surprised to see me, sir,
13325 \begin_inset Quotes erd
13328 said he, in a strange, croaking voice.
13331 \begin_layout Plain Layout
13334 I acknowledged that I was.
13337 \begin_layout Plain Layout
13340 \begin_inset Quotes eld
13343 Well, I've a conscience, sir, and when I chanced to see you go into this
13344 house, as I came hobbling after you, I thought to myself, I'll just step
13345 in and see that kind gentleman, and tell him that if I was a bit gruff
13346 in my manner there was not any harm meant, and that I am much obliged to
13347 him for picking up my books.
13348 \begin_inset Quotes erd
13354 \begin_layout Plain Layout
13357 \begin_inset Quotes eld
13360 You make too much of a trifle,
13361 \begin_inset Quotes erd
13366 \begin_inset Quotes eld
13369 May I ask how you knew who I was?
13370 \begin_inset Quotes erd
13376 \begin_layout Plain Layout
13379 \begin_inset Quotes eld
13382 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
13383 you'll find my little bookshop at the corner of Church Street, and very
13384 happy to see you, I am sure.
13385 Maybe you collect yourself, sir.
13389 \begin_inset space ~
13403 \begin_inset space ~
13406 – a bargain, every one of them.
13407 With five volumes you could just fill that gap on that second shelf.
13408 It looks untidy, does it not, sir?
13409 \begin_inset Quotes erd
13420 \begin_layout Standard
13421 \begin_inset VSpace defskip
13427 \begin_layout Standard
13428 The rule can be colored by redefining the command
13429 \begin_inset Flex Code
13432 \begin_layout Plain Layout
13441 This is done by inserting the command
13444 \begin_layout LyX-Code
13449 columnseprulecolor}{
13454 \begin_layout Standard
13455 as \SpecialChar TeX
13456 Code before the multicolumn inset.
13458 \begin_inset Flex Code
13461 \begin_layout Plain Layout
13467 in this command by a color of your choice.
13468 You can use all pre- and self-defined colors.
13476 \begin_inset space ~
13481 for more information about pre- and self-defined colors.
13482 To go back to the default color insert the command
13485 \begin_layout LyX-Code
13490 columnseprulecolor}{
13495 \begin_layout Standard
13496 Here is the example with a cyan rule and 1
13497 \begin_inset space \thinspace{}
13500 cm column separation:
13503 \begin_layout Standard
13507 \begin_layout Plain Layout
13516 \begin_layout Plain Layout
13522 columnseprulecolor}{
13532 \begin_layout Standard
13533 \begin_inset Flex Multiple Columns
13536 \begin_layout Plain Layout
13539 \begin_inset Quotes eld
13542 You're surprised to see me, sir,
13543 \begin_inset Quotes erd
13546 said he, in a strange, croaking voice.
13549 \begin_layout Plain Layout
13552 I acknowledged that I was.
13555 \begin_layout Plain Layout
13558 \begin_inset Quotes eld
13561 Well, I've a conscience, sir, and when I chanced to see you go into this
13562 house, as I came hobbling after you, I thought to myself, I'll just step
13563 in and see that kind gentleman, and tell him that if I was a bit gruff
13564 in my manner there was not any harm meant, and that I am much obliged to
13565 him for picking up my books.
13566 \begin_inset Quotes erd
13572 \begin_layout Plain Layout
13575 \begin_inset Quotes eld
13578 You make too much of a trifle,
13579 \begin_inset Quotes erd
13584 \begin_inset Quotes eld
13587 May I ask how you knew who I was?
13588 \begin_inset Quotes erd
13594 \begin_layout Plain Layout
13597 \begin_inset Quotes eld
13600 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
13601 you'll find my little bookshop at the corner of Church Street, and very
13602 happy to see you, I am sure.
13603 Maybe you collect yourself, sir.
13607 \begin_inset space ~
13621 \begin_inset space ~
13624 – a bargain, every one of them.
13625 With five volumes you could just fill that gap on that second shelf.
13626 It looks untidy, does it not, sir?
13627 \begin_inset Quotes erd
13638 \begin_layout Standard
13642 \begin_layout Plain Layout
13648 columnseprule}{0pt}
13651 \begin_layout Plain Layout
13657 columnseprulecolor}{
13665 \begin_inset Note Note
13668 \begin_layout Plain Layout
13669 go back to the default
13677 \begin_layout Chapter
13681 \begin_layout Section
13682 Customizing Bibliographies with Bib\SpecialChar TeX
13686 \begin_layout Standard
13687 The most basic information about how to use Bib\SpecialChar TeX
13692 with \SpecialChar LyX
13693 is contained in the section
13695 Bibliography databases
13702 The following subsections explain special bibliography features supported
13703 by \SpecialChar LyX
13707 \begin_layout Subsection
13708 Alternative Citation Styles
13711 \begin_layout Standard
13712 Standard Bib\SpecialChar TeX
13714 \begin_inset space \thinspace{}
13718 \begin_inset space \space{}
13722 \begin_inset Quotes eld
13726 \begin_inset Quotes erd
13729 ) to refer to a cited work.
13730 However, in many scientific disciplines, other citation styles are in use.
13731 The most common one is the author-year style (e.
13732 \begin_inset space \thinspace{}
13736 \begin_inset space \space{}
13740 \begin_inset Quotes eld
13744 \begin_inset Quotes erd
13749 supports three packages that provide this style,
13750 \begin_inset Flex Code
13753 \begin_layout Plain Layout
13760 \begin_inset Flex Code
13763 \begin_layout Plain Layout
13770 \begin_inset Flex Code
13773 \begin_layout Plain Layout
13780 Each of these packages has their pros and cons, which cannot be listed
13782 If you only want to have simple author-year (or author-numerical) style,
13783 or if you want to use one of the countless style files for
13784 \begin_inset Flex Code
13787 \begin_layout Plain Layout
13793 , then the established
13794 \begin_inset Flex Code
13797 \begin_layout Plain Layout
13803 package is probably your choice.
13804 If you look for specific citation styles common in law studies, you might
13806 \begin_inset Flex Code
13809 \begin_layout Plain Layout
13816 If you want to have full control over the formatting or look for advanced
13817 features such as ibidem, footnote citations, full title citations, advanced
13818 date formats (such as 400 BC) or full localization to other languages than
13819 English, you should definitely consider
13820 \begin_inset Flex Code
13823 \begin_layout Plain Layout
13829 , which exceeds all other packages in terms of features, but is also quite
13830 heavy and more resource-hungry.
13833 \begin_layout Standard
13834 The handling of these packages in \SpecialChar LyX
13835 is basically the same.
13837 \begin_inset Flex Noun
13840 \begin_layout Plain Layout
13841 Document\SpecialChar menuseparator
13848 \begin_inset Flex Noun
13851 \begin_layout Plain Layout
13858 \begin_inset Flex Noun
13861 \begin_layout Plain Layout
13868 \begin_inset Flex Noun
13871 \begin_layout Plain Layout
13878 \begin_inset Flex Noun
13881 \begin_layout Plain Layout
13888 \begin_inset Flex Noun
13891 \begin_layout Plain Layout
13892 Biblatex (Natbib mode)
13898 \begin_inset Flex Noun
13901 \begin_layout Plain Layout
13908 \begin_inset Flex Noun
13911 \begin_layout Plain Layout
13918 \begin_inset space ~
13921 6.5.3 in the User's Guide for more information on these choices).
13922 With all these packages, you will get some extra features in the citation
13923 dialog and you can select the style of the reference (
13924 \begin_inset Quotes eld
13928 \begin_inset Quotes erd
13932 \begin_inset Quotes eld
13936 \begin_inset Quotes erd
13940 \begin_inset Quotes eld
13944 \begin_inset Quotes erd
13948 \begin_inset Quotes eld
13952 \begin_inset Quotes erd
13956 Note that either package needs specifically designed style files.
13957 They all ship their own, but there are lots of additional style files,
13958 and there is even an interactive style file builder
13962 \begin_layout Plain Layout
13964 \begin_inset Flex URL
13967 \begin_layout Plain Layout
13969 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
13980 \begin_inset Flex Code
13983 \begin_layout Plain Layout
13992 \begin_layout Subsection
13993 Subdivided Bibliographies
13996 \begin_layout Standard
13997 Sometimes you might need to divide your bibliography into several sections.
13998 If you are for instance a historian, the possibility to separate sources
13999 and scientific works is most likely a
14000 \begin_inset Quotes eld
14004 \begin_inset Quotes erd
14008 Unfortunately, Bib\SpecialChar TeX
14009 itself does not allow you to do this.
14010 But with the help of some \SpecialChar LaTeX
14011 packages, Bib\SpecialChar TeX
14012 can be extended to fit your needs.
14015 \begin_layout Standard
14017 provides native support for one of these packages,
14025 \begin_layout Plain Layout
14027 \begin_inset Flex URL
14030 \begin_layout Plain Layout
14032 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
14042 The advantage of this package (compared to other packages such as
14046 ) is that you don't need to define new citation commands.
14047 Instead, you need to prepare different bibliographic databases which include
14048 the entries for the different sections of the bibliography.
14049 For example: If you want to divide your bibliography into the sections
14051 \begin_inset Quotes eld
14055 \begin_inset Quotes erd
14059 \begin_inset Quotes eld
14063 \begin_inset Quotes erd
14066 , you first need to create two bibliographic databases, e.
14067 \begin_inset space \thinspace{}
14071 \begin_inset space \space{}
14075 \begin_inset Flex Code
14078 \begin_layout Plain Layout
14085 \begin_inset Flex Code
14088 \begin_layout Plain Layout
14098 \begin_layout Standard
14100 \begin_inset Flex Noun
14103 \begin_layout Plain Layout
14104 Document\SpecialChar menuseparator
14111 \begin_inset Flex Noun
14114 \begin_layout Plain Layout
14121 \begin_inset Flex Noun
14124 \begin_layout Plain Layout
14125 Subdivided bibliography
14131 Now you can insert multiple Bib\SpecialChar TeX
14132 bibliographies, one for each section of
14134 Returning to our example: Insert the Bib\SpecialChar TeX
14136 \begin_inset Flex Code
14139 \begin_layout Plain Layout
14145 and a second one for the database
14146 \begin_inset Flex Code
14149 \begin_layout Plain Layout
14156 You are free to use the same or different styles for each section.
14157 Additionally, you can choose if the bibliography section should contain
14159 \begin_inset Quotes eld
14162 all cited references
14163 \begin_inset Quotes erd
14166 of the specified database(s) (which is the default),
14167 \begin_inset Quotes eld
14170 all uncited references
14171 \begin_inset Quotes erd
14175 \begin_inset Quotes eld
14179 \begin_inset Quotes erd
14183 This might be useful if you would like to separate your bibliography into
14185 \begin_inset Quotes eld
14189 \begin_inset Quotes erd
14193 \begin_inset Quotes eld
14197 \begin_inset Quotes erd
14201 \begin_inset Quotes eld
14205 \begin_inset Quotes erd
14209 The titles for the sections can be added as ordinary sections or subsections.
14211 \begin_inset Flex Code
14214 \begin_layout Plain Layout
14220 removes the bibliography title, you have to manually re-add that, too (as
14221 a chapter* or section*, for instance).
14224 \begin_layout Standard
14229 , the procedure is a bit different.
14238 , the aforementioned
14239 \begin_inset Flex Noun
14242 \begin_layout Plain Layout
14243 Subdivided bibliography
14248 option is disabled if you use
14257 provides its own means to generate subdivided bibliographies.
14258 You can either add keywords to bibliography entries via the
14259 \begin_inset Flex Code
14262 \begin_layout Plain Layout
14268 entry option and then filter bibliography sections by keyword (by adding
14270 \begin_inset Flex Code
14273 \begin_layout Plain Layout
14280 \begin_inset Flex Noun
14283 \begin_layout Plain Layout
14289 field of the dialog that opens if you left-click on the
14290 \begin_inset Flex Noun
14293 \begin_layout Plain Layout
14294 Biblatex Generated Bibliography
14299 button), or you can filter by entry types (such as
14308 \begin_inset space \thinspace{}
14313 \begin_inset Flex Code
14316 \begin_layout Plain Layout
14323 \begin_inset Flex Code
14326 \begin_layout Plain Layout
14333 \begin_inset Flex Noun
14336 \begin_layout Plain Layout
14342 field, or you can create so-called
14343 \begin_inset Quotes eld
14346 Bibliography Categories
14347 \begin_inset Quotes erd
14350 to which you can assign individual entries.
14351 Please refer to the Biblatex manual, section
14353 Subdivided Bibliographies
14358 \begin_layout Subsection
14359 Multiple Bibliographies
14360 \begin_inset CommandInset label
14362 name "subsec:Multiple-Bibliographies"
14369 \begin_layout Standard
14370 Multiple bibliographies, e.
14371 \begin_inset space \thinspace{}
14375 \begin_inset space \space{}
14378 a bibliography for each part, chapter, section, subsection or child (sub-documen
14379 t) of the document, are also supported by \SpecialChar LyX
14381 In order to enable it, go to
14382 \begin_inset Flex Noun
14385 \begin_layout Plain Layout
14386 Document\SpecialChar menuseparator
14387 Settings\SpecialChar menuseparator
14393 and select the relevant unit (e.
14394 \begin_inset space \thinspace{}
14398 \begin_inset Quotes eld
14402 \begin_inset Quotes erd
14406 \begin_inset Flex Noun
14409 \begin_layout Plain Layout
14410 Multiple Bibliographies
14416 Then add a Bib(la)\SpecialChar TeX
14417 bibliography to each unit (e.
14418 \begin_inset space \thinspace{}
14421 g., section) of your document.
14422 In the output, a separate bibliography, containing only the references
14423 done in the current unit is generated.
14426 \begin_layout Standard
14427 If you use Bib\SpecialChar TeX
14429 \begin_inset Flex Code
14432 \begin_layout Plain Layout
14439 \begin_inset Flex Code
14442 \begin_layout Plain Layout
14448 package is used to create multiple bibliographies.
14449 The former package is used if you select
14450 \begin_inset Quotes eld
14454 \begin_inset Quotes erd
14462 \begin_inset Flex Noun
14465 \begin_layout Plain Layout
14466 Sectioned Bibliography
14472 In all other cases,
14473 \begin_inset Flex Code
14476 \begin_layout Plain Layout
14486 \begin_layout Plain Layout
14487 An alternative approach, if you are willing to use some
14488 \begin_inset Flex Noun
14491 \begin_layout Plain Layout
14499 \begin_inset space ~
14503 \begin_inset CommandInset ref
14505 reference "sec:Inserting-TeX-Code"
14510 \begin_inset Flex Code
14513 \begin_layout Plain Layout
14525 \begin_inset Flex Code
14528 \begin_layout Plain Layout
14534 is used, \SpecialChar LyX
14535 encloses the specified units in
14536 \begin_inset Flex Code
14539 \begin_layout Plain Layout
14546 \begin_inset Flex Code
14549 \begin_layout Plain Layout
14558 \begin_inset Flex Code
14561 \begin_layout Plain Layout
14569 in order to create the units.
14570 Note that this approach has some limitations.
14571 First, every citation reference has to be inside some
14572 \begin_inset Flex Code
14575 \begin_layout Plain Layout
14582 So citations outside a defined unit (e.
14583 \begin_inset space \thinspace{}
14586 g., before the first section if you use
14587 \begin_inset Quotes eld
14591 \begin_inset Quotes erd
14595 \begin_inset Quotes eld
14599 \begin_inset Quotes erd
14603 You can also create your own units by entering
14604 \begin_inset Flex Code
14607 \begin_layout Plain Layout
14616 \begin_inset Flex Code
14619 \begin_layout Plain Layout
14627 as \SpecialChar TeX
14628 code (for instance to work around the mentioned limitation).
14630 \begin_inset Flex Code
14633 \begin_layout Plain Layout
14639 s cannot be nested.
14640 A second limitation is that
14641 \begin_inset Flex Code
14644 \begin_layout Plain Layout
14650 always processes all references of a bibliography database, even if they
14652 This can result in odd labels (e.
14653 \begin_inset space \thinspace{}
14658 \begin_inset Quotes eld
14662 \begin_inset Quotes erd
14665 if two works of this author from 2014 are in the database, even if only
14669 \begin_layout Standard
14675 \begin_inset Flex Code
14678 \begin_layout Plain Layout
14684 option is used instead.
14685 If you need specific units, you can start them with the \SpecialChar TeX
14687 \begin_inset Flex Code
14690 \begin_layout Plain Layout
14699 \begin_inset Flex Code
14702 \begin_layout Plain Layout
14711 If you also want to control the end of the unit, use the environment
14712 \begin_inset Flex Code
14715 \begin_layout Plain Layout
14725 \begin_inset Flex Code
14728 \begin_layout Plain Layout
14738 \begin_inset Flex Code
14741 \begin_layout Plain Layout
14747 s cannot be nested.
14748 In addition to the individual bibliography of the current unit,
14752 also provides an easy way to output all bibliographies, subsequently, at
14754 \begin_inset space \thinspace{}
14757 g., at the end of the document).
14759 \begin_inset Quotes eld
14762 all reference units
14763 \begin_inset Quotes erd
14766 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve
14768 Please refer to the
14772 manual for more information on this topic.
14775 \begin_layout Section
14776 Multipart Documents
14779 \begin_layout Subsection
14783 \begin_layout Standard
14784 When you are working on a large file with many sections, it is often convenient
14785 to break up the document into several files, or perhaps you have something
14786 where a table may change from time to time, but the preceding text does
14788 In these cases, you should seriously consider using multipart documents.
14789 For example, scientific papers often have five major sections: the introduction
14790 , observations, results, discussion, and conclusion.
14791 Each of these could be its own separate \SpecialChar LyX
14793 \begin_inset Quotes eld
14797 \begin_inset Quotes erd
14800 file which contains the title, authors, abstract, references, etc., plus
14801 the five included files.
14802 It is important to note that each of these files is a full \SpecialChar LyX
14804 can be formatted and printed on its own, as well as included in a master
14806 Each of these files must have the same document class, however—don't attempt
14807 to mix book classes with article classes.
14808 You may also include \SpecialChar LaTeX
14809 files; however, these files must not have their own
14811 \begin_inset space \thinspace{}
14815 \begin_inset space \space{}
14818 everything up to and including the
14819 \begin_inset Flex Code
14822 \begin_layout Plain Layout
14830 line as well as the
14831 \begin_inset Flex Code
14834 \begin_layout Plain Layout
14842 line must be deleted) or else errors will be generated when you try to
14846 \begin_layout Standard
14848 allows you to include files quite easily with
14849 \begin_inset Flex Noun
14852 \begin_layout Plain Layout
14853 Insert\SpecialChar menuseparator
14855 \begin_inset space ~
14864 When you click on this selection a small box is inserted into the file
14865 at the current cursor location.
14866 Clicking on the box raises a dialog which allows you to select the file
14867 to be included, and the method of its inclusion.
14871 \begin_layout Standard
14872 The file selection box should by now be obvious.
14873 The three inclusion methods are
14874 \begin_inset Quotes eld
14878 \begin_inset Quotes erd
14882 \begin_inset Quotes eld
14886 \begin_inset Quotes erd
14890 \begin_inset Quotes eld
14894 \begin_inset Quotes erd
14899 \begin_inset Quotes eld
14903 \begin_inset Quotes erd
14907 \begin_inset Quotes eld
14911 \begin_inset Quotes erd
14914 are similar in many ways, but there are also some notable differences:
14917 \begin_layout Enumerate
14919 \begin_inset Quotes eld
14923 \begin_inset Quotes erd
14926 are typeset beginning on a new page, while files that are
14927 \begin_inset Quotes eld
14931 \begin_inset Quotes erd
14934 are typeset starting on the current page.
14937 \begin_layout Enumerate
14938 \begin_inset Quotes eld
14942 \begin_inset Quotes erd
14945 files cannot themselves
14946 \begin_inset Quotes eld
14950 \begin_inset Quotes erd
14954 \begin_inset Quotes eld
14958 \begin_inset Quotes erd
14963 \begin_inset Quotes eld
14967 \begin_inset Quotes erd
14970 , on the other hand, infinite sub-inputting is possible.
14973 \begin_layout Enumerate
14974 \begin_inset Quotes eld
14978 \begin_inset Quotes erd
14981 allow for the output of only selected
14982 \begin_inset Quotes eld
14986 \begin_inset Quotes erd
14989 files, while maintaining the actual counters (pagination etc.) and references
14990 (please refer to the section
14993 \begin_inset space ~
15001 \begin_inset space ~
15006 manual for details).
15009 \begin_layout Standard
15011 \begin_inset Quotes eld
15015 \begin_inset Quotes erd
15018 is the preferred method for chapters that are outsourced to child documents,
15020 \begin_inset Quotes eld
15024 \begin_inset Quotes erd
15027 is more suitable for arbitrary file inheritance.
15030 \begin_layout Standard
15032 \begin_inset Quotes eld
15036 \begin_inset Quotes erd
15039 included file allows you to include a file typeset exactly as it appears
15041 \begin_inset space \thinspace{}
15045 \begin_inset space \space{}
15049 \begin_inset Flex Code
15052 \begin_layout Plain Layout
15058 mode, with the characters set in a fixed-width typewriter font.
15059 Normally, spaces in this file are invisible, though two consecutive spaces
15060 are conserved, unlike \SpecialChar LyX
15061 's normal treatment of spaces.
15062 However, setting the
15063 \begin_inset Flex Noun
15066 \begin_layout Plain Layout
15068 \begin_inset space ~
15072 \begin_inset space ~
15076 \begin_inset space ~
15084 checkbox typesets a mark to unambiguously define the presence of a space.
15088 \begin_layout Standard
15089 Generally, the master file is converted into a full \SpecialChar LaTeX
15090 file before typesetting,
15091 while the included files are converted to \SpecialChar LaTeX
15092 files that do not have all the
15093 preamble information.
15096 \begin_layout Subsection
15097 Cross-References Between Files
15100 \begin_layout Standard
15101 \begin_inset Box Shadowbox
15111 height_special "totalheight"
15116 backgroundcolor "none"
15119 \begin_layout Plain Layout
15120 This section is somewhat out of date.
15121 Need to describe default master documents and how children are opened when
15131 \begin_layout Standard
15132 It is possible to set up cross-references between the different files.
15133 First, open all the files in question: let's call them A and B in a two
15134 file example, where B is included in A.
15135 Let's say you insert a label in A, then want to reference it in B.
15136 Open the cross-reference dialog whilst in document B, and you can select
15138 \begin_inset Quotes eld
15142 \begin_inset Quotes erd
15148 \begin_layout Subsection
15149 Bibliography Lists in all Subdocuments
15152 \begin_layout Standard
15153 If you work with child documents, you might want to have only one main bibliogra
15154 phy at the end, but still be able to have a selected bibliography for the
15155 child if you output it on its own.
15156 Here is how to achieve this.
15159 \begin_layout Standard
15160 For the main document, you just insert a bibliography inset at the place
15161 where the main bibliography has to appear (within the master file or within
15163 If the bibliography inset is in the master file, the references will be
15164 inherited by all children, so they are available in the citation dialog
15168 \begin_layout Standard
15169 For child-specific bibliographies, insert bibliography insets within the
15170 child documents, at the place where the bibliography should appear when
15171 the child is compiled separately.
15172 However, the trick is to insert them into a branch (
15174 Insert\SpecialChar menuseparator
15175 Branch\SpecialChar menuseparator
15176 Insert New Branch...
15179 \begin_inset space \thinspace{}
15184 \begin_inset Quotes eld
15188 \begin_inset Quotes erd
15192 Within the children, activate the branch (
15194 Document\SpecialChar menuseparator
15195 Settings...\SpecialChar menuseparator
15199 Within the master, deactivate the branch (
15201 Document\SpecialChar menuseparator
15202 Settings...\SpecialChar menuseparator
15206 Now the child's bibliography will be ignored by the master, but considered
15210 \begin_layout Standard
15211 If you need multiple bibliographies (e.
15212 \begin_inset space \thinspace{}
15215 g., one per child in the
15219 ), please refer to sec.
15220 \begin_inset space ~
15224 \begin_inset CommandInset ref
15226 reference "subsec:Multiple-Bibliographies"
15233 \begin_layout Section
15238 \begin_layout Standard
15239 Users sometimes need to be able to
15240 \begin_inset Quotes eld
15244 \begin_inset Quotes erd
15248 file together with all the images (and other files) on which it depends,
15249 either for sending to a publisher or for sharing with a co-author.
15251 includes a Python script (
15252 \begin_inset Flex Code
15255 \begin_layout Plain Layout
15261 ) that automates this process.
15262 To use it, you must have either the
15263 \begin_inset Flex Code
15266 \begin_layout Plain Layout
15273 \begin_inset Flex Code
15276 \begin_layout Plain Layout
15282 python modules installed on your system.
15283 By default, the script prefers the
15284 \begin_inset Flex Code
15287 \begin_layout Plain Layout
15294 \begin_inset Flex Code
15297 \begin_layout Plain Layout
15303 format on Unix-like systems and the
15304 \begin_inset Flex Code
15307 \begin_layout Plain Layout
15316 \begin_layout Standard
15318 's configuration process will set the script up to export a `\SpecialChar LyX
15320 and this format will then be available under
15321 \begin_inset Flex Code
15324 \begin_layout Plain Layout
15325 File\SpecialChar menuseparator
15334 \begin_layout Standard
15335 Independently of the platform, the generation of a particular archive format
15336 can be forced by adding either the
15337 \begin_inset Flex Code
15340 \begin_layout Plain Layout
15347 \begin_inset Flex Code
15350 \begin_layout Plain Layout
15357 \begin_inset Flex Code
15360 \begin_layout Plain Layout
15367 \begin_inset Flex Code
15370 \begin_layout Plain Layout
15376 format) switch to the
15377 \begin_inset Flex Code
15380 \begin_layout Plain Layout
15382 \SpecialChar menuseparator
15390 \begin_inset Flex Code
15393 \begin_layout Plain Layout
15394 Tools\SpecialChar menuseparator
15395 Preferences\SpecialChar menuseparator
15396 File Handling\SpecialChar menuseparator
15403 (Make sure you add the switch after the script name, not before it.)
15406 \begin_layout Section
15407 Fancy Headers and Footers
15410 \begin_layout Standard
15411 The default page layout is rather plain; for an
15412 \begin_inset Flex Code
15415 \begin_layout Plain Layout
15421 document class, all you get is a centered page number at the bottom of
15423 This document uses KOMA-script's book class, so it appears to be a bit
15425 But to really put on a show, you need to set the document page style to
15427 \begin_inset Quotes eld
15431 \begin_inset Quotes erd
15434 , as mentioned in the
15439 This section describes the \SpecialChar LaTeX
15440 code you need to insert in your \SpecialChar LaTeX
15442 order to get the desired effects.
15445 \begin_layout Standard
15446 For more information on fancy headers, see the
15447 \begin_inset Flex Code
15450 \begin_layout Plain Layout
15456 package documentation.
15458 \begin_inset Flex URL
15461 \begin_layout Plain Layout
15463 https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
15471 \begin_layout Standard
15472 The page header is divided into three fields, not surprisingly labeled
15473 \begin_inset Quotes eld
15477 \begin_inset Quotes erd
15481 \begin_inset Quotes eld
15485 \begin_inset Quotes erd
15489 \begin_inset Quotes eld
15493 \begin_inset Quotes erd
15497 The footer is also divided into these three fields.
15498 The \SpecialChar LaTeX
15499 commands to set these fields in the simplest manner are
15500 \begin_inset Flex Code
15503 \begin_layout Plain Layout
15512 \begin_inset Flex Code
15515 \begin_layout Plain Layout
15524 \begin_inset Flex Code
15527 \begin_layout Plain Layout
15536 \begin_inset Flex Code
15539 \begin_layout Plain Layout
15548 Suppose you wish to put your name in the upper left hand corner of each
15550 Simply insert the following command in the preamble:
15553 \begin_layout Standard
15562 \begin_layout Standard
15563 You will now see your name in the upper left.
15564 If a field has a default entry that you would like to get rid of (often
15565 the page number appears in the central footer) simply include a command
15566 with a blank argument, e.
15567 \begin_inset space \thinspace{}
15573 \begin_layout Standard
15581 \begin_layout Standard
15582 Let's get really fancy: lets put the section number with the word
15583 \begin_inset Quotes eld
15587 \begin_inset Quotes erd
15591 \begin_inset space \thinspace{}
15595 \begin_inset space \space{}
15598 Section 3) in the upper left, the page number (e.
15599 \begin_inset space \thinspace{}
15603 \begin_inset space \space{}
15606 Page 4) in the upper right, your name in the lower left, and the date in
15608 The following commands should now appear in the preamble:
15611 \begin_layout Standard
15621 \begin_layout Standard
15629 \begin_layout Standard
15639 \begin_layout Standard
15648 \begin_layout Standard
15656 \begin_layout Standard
15666 \begin_layout Standard
15668 \begin_inset Flex Code
15671 \begin_layout Plain Layout
15680 \begin_inset Flex Code
15683 \begin_layout Plain Layout
15691 access \SpecialChar LaTeX
15692 's section and page counters, and so print out the current section
15695 \begin_inset Flex Code
15698 \begin_layout Plain Layout
15706 simply prints out today's date.
15709 \begin_layout Standard
15710 The thicknesses of the horizontal rules drawn beneath the header and above
15711 the footer can also be modified.
15712 If you don't want one of the rules, set its thickness to 0.
15713 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
15719 \begin_inset Flex Code
15722 \begin_layout Plain Layout
15727 headrulewidth}{0.4pt}
15733 \begin_inset Flex Code
15736 \begin_layout Plain Layout
15741 footrulewidth}{0.4pt}
15746 to set the thicknesses.
15749 \begin_layout Standard
15750 You can switch the header/footer settings on and off for individual pages
15751 using commands like
15752 \begin_inset Flex Code
15755 \begin_layout Plain Layout
15758 thispagestyle{empty}
15764 \begin_inset Flex Code
15767 \begin_layout Plain Layout
15770 thispagestyle{plain}
15776 \begin_inset Flex Code
15779 \begin_layout Plain Layout
15782 thispagestyle{fancy}
15788 Simply insert them in the text on the page you want changed and mark them
15789 as \SpecialChar TeX
15791 In fact, title pages are marked as plain by default, while following pages
15792 are marked fancy when using the global fancy setting.
15795 \begin_layout Standard
15796 As a final example, it is possible to include an image in the header or
15798 Suppose you want to put a company logo in the upper lefthand corner.
15799 You might try something like
15802 \begin_layout Standard
15811 includegraphics{logo.eps}}}
15814 \begin_layout Standard
15816 (you may need to preface this with
15817 \begin_inset Flex Code
15820 \begin_layout Plain Layout
15823 usepackage{graphics}
15828 if you don't include graphics elsewhere in your document).
15831 \begin_layout Section
15832 Itemize Bullet Selection
15833 \begin_inset CommandInset label
15842 \begin_layout Standard
15848 \begin_layout Subsection
15852 \begin_layout Standard
15854 provides 216 bullet shapes that can be accessed from a simple dialog.
15855 Using this dialog you can easily specify what bullet shape to use at each
15856 level of an itemized list.
15857 These settings are document-wide so you won't be able to specify different
15858 sets of bullets for different paragraphs.
15862 \begin_layout Plain Layout
15863 Well, actually you can but you'll have to do it by hand.
15871 \begin_layout Subsection
15875 \begin_layout Standard
15876 Open the dialog by selecting the
15877 \begin_inset Flex Noun
15880 \begin_layout Plain Layout
15881 Document\SpecialChar menuseparator
15887 menu item and then select the
15888 \begin_inset Flex Noun
15891 \begin_layout Plain Layout
15900 \begin_layout Standard
15901 The dialog provides you with a table of bullet shapes.
15902 A column of buttons on the left of the table provides access to the six
15903 different panels of bullet shapes.
15904 The row of buttons across the top is used to select which bullet depth
15907 \change_deleted 244031559 1603875981
15908 A text entry under the table shows the currently selected bullet shape's
15910 equivalent and this can be edited if desired.
15911 If you do modify the text you will also need to specify any needed packages
15912 in the \SpecialChar LaTeX
15918 \begin_layout Standard
15919 The six panels are divided up by the packages they require.
15920 The following table shows the mappings from button name to \SpecialChar LaTeX
15924 \begin_layout Standard
15926 \begin_inset Tabular
15927 <lyxtabular version="3" rows="7" columns="2">
15928 <features tabularvalignment="middle">
15929 <column alignment="center" valignment="top" width="0pt">
15930 <column alignment="center" valignment="top" width="0pt">
15932 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
15935 \begin_layout Plain Layout
15950 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
15953 \begin_layout Plain Layout
15970 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
15973 \begin_layout Plain Layout
15988 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
15991 \begin_layout Plain Layout
16000 base \SpecialChar LaTeX
16008 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
16011 \begin_layout Plain Layout
16026 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
16029 \begin_layout Plain Layout
16046 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
16049 \begin_layout Plain Layout
16064 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
16067 \begin_layout Plain Layout
16084 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
16087 \begin_layout Plain Layout
16102 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
16105 \begin_layout Plain Layout
16122 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
16125 \begin_layout Plain Layout
16140 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
16143 \begin_layout Plain Layout
16160 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
16163 \begin_layout Plain Layout
16178 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
16181 \begin_layout Plain Layout
16204 \begin_layout Standard
16206 doesn't stop you using bullets from packages you don't have.
16207 If you get errors from \SpecialChar LaTeX
16208 when you try to view or print the file, then it
16209 is likely you are missing a package.
16213 \begin_layout Plain Layout
16215 doesn't restrict your use since you may be editing locally and exporting
16224 \begin_layout Subsection
16228 \begin_layout Standard
16229 Select which bullet depth you want to change then select the bullet shape
16231 Any changes will not be visible in \SpecialChar LyX
16232 , but are visible when viewing the document.
16235 \begin_layout Standard
16236 You can reset a bullet shape to the default simply by clicking your right
16237 mouse button on the appropriate bullet depth button.
16241 \begin_layout Plain Layout
16246 want to have multiple sets of paragraphs with different sets of bullets
16247 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
16249 The bullet selection dialog can help though because it provides you with
16250 the \SpecialChar LaTeX
16251 code for a wide range of bullet shapes.
16252 To make your own custom paragraphs you have the following options:
16255 \begin_layout Plain Layout
16259 \begin_layout Plain Layout
16275 \begin_layout Plain Layout
16279 \begin_layout Plain Layout
16301 \begin_layout Itemize
16302 Use the \SpecialChar LaTeX
16304 \begin_inset Flex Code
16307 \begin_layout Plain Layout
16315 to specify a new bullet shape for a given depth.
16316 You'll also need to save the current bullet shape so you can restore it
16318 In this itemized list the following \SpecialChar LaTeX
16319 code was used to change the bullet
16320 used for the first depth.
16324 \begin_layout LyX-Code
16334 \begin_layout LyX-Code
16351 \begin_layout Itemize
16352 Note that the itemize depth is specified in Roman numerals as part of the
16362 \begin_layout Itemize
16363 \begin_inset Argument item:1
16366 \begin_layout Plain Layout
16370 \begin_layout Plain Layout
16388 Specify each individual entry by starting each item with the bullet shape
16390 \begin_inset Quotes eld
16394 \begin_inset Quotes erd
16397 inset (available at
16399 Insert\SpecialChar menuseparator
16403 \begin_inset Flex Noun
16406 \begin_layout Plain Layout
16414 For example, this item was started with
16415 \begin_inset Flex Code
16418 \begin_layout Plain Layout
16433 \begin_layout Plain Layout
16437 \begin_layout Plain Layout
16453 \begin_layout Plain Layout
16454 You'll also need to revert the labelitem back to its previous setting for
16455 the global bullet shape settings to remain in effect.
16456 The way used here was:
16459 \begin_layout LyX-Code
16474 \begin_layout Chapter
16476 and the World Wide Web
16479 \begin_layout Standard
16481 has long supported the export of documents to various web-friendly formats,
16483 Before version 2.0, however, HTML export was always accomplished by the
16484 use of external converters.
16488 \begin_layout Plain Layout
16489 For details on the use of external converters with \SpecialChar LyX
16494 section of the Customization manual.
16499 These fall into two large groups: there are converters that use \SpecialChar LaTeX
16501 intermediate format, such as
16502 \begin_inset Flex Code
16505 \begin_layout Plain Layout
16512 \begin_inset Flex Code
16515 \begin_layout Plain Layout
16522 \begin_inset Flex Code
16525 \begin_layout Plain Layout
16531 , relying upon \SpecialChar LyX
16532 to produce the \SpecialChar LaTeX
16533 ; and there is a converter that works directly
16534 on \SpecialChar LyX
16536 \begin_inset Flex Code
16539 \begin_layout Plain Layout
16547 All of these have different advantages and disadvantages.
16551 \begin_layout Standard
16552 The \SpecialChar LaTeX
16553 -based converters have the advantage that, in principle, they know everythin
16554 g about the exported document that \SpecialChar LaTeX
16556 Such converters do not care, for example, if a certain block of code was
16557 produced by \SpecialChar LyX
16558 or was Evil Red Text.
16559 These converters know about
16560 \begin_inset Flex Code
16563 \begin_layout Plain Layout
16569 files, counters, and references, and can often make use of the
16570 \begin_inset Flex Code
16573 \begin_layout Plain Layout
16579 files generated by Bib\SpecialChar TeX
16581 On the other hand, \SpecialChar LaTeX
16582 is a very hard language to parse—it is sometimes said
16583 that only \SpecialChar TeX
16584 itself understands \SpecialChar TeX
16585 —and \SpecialChar LaTeX
16586 -based converters will often choke on
16587 what seem to be quite simple constructs; complex ones can throw them completely
16588 , and as of this writing, for example, the
16592 manual will not export with
16593 \begin_inset Flex Code
16596 \begin_layout Plain Layout
16602 , though the others will.
16603 The other issue concerns how math is handled.
16604 These converters typically convert the formulae into little pictures that
16605 are then linked from the HTML document.
16606 Since these are actually generated by \SpecialChar LaTeX
16607 , they are accurate.
16608 But they do not scale well, and just getting them to look as if they are
16609 actually meant to be in your document—so that the font sizes seem to be
16610 roughly the same—can be a challenge.
16613 \begin_layout Standard
16615 \begin_inset Flex Code
16618 \begin_layout Plain Layout
16626 \begin_inset CommandInset href
16628 name "http://pinchito.es/elyxer/"
16629 target "http://pinchito.es/elyxer/"
16634 ) solves some of these problems.
16635 In particular, the formulae it produces scale perfectly, since it renders
16636 math using a combination of HTML and CSS rather than converting the formulae
16638 But even moderately complex formula are rendered less well than with
16639 \begin_inset Flex Code
16642 \begin_layout Plain Layout
16648 ; this reflects the limitations of HTML.
16652 \begin_layout Plain Layout
16654 \begin_inset Flex Code
16657 \begin_layout Plain Layout
16664 can also use jsMath and MathJax for equations, but this setting is only
16665 available globally and requires one to have access to a server that runs
16671 More importantly (as of version 1.1.1, at least),
16672 \begin_inset Flex Code
16675 \begin_layout Plain Layout
16682 has limited support for math macros and no support for user-defined paragraph
16683 or character styles.
16684 These limitations make
16685 \begin_inset Flex Code
16688 \begin_layout Plain Layout
16695 unsuitable for many of the documents \SpecialChar LyX
16697 In principle, of course, these problems could be solved, but the \SpecialChar LyX
16699 have decided to follow a different path and have made \SpecialChar LyX
16701 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
16702 , DocBook, and plaintext.
16705 \begin_layout Standard
16706 As of this writing, XHTML output remains under development and should probably
16708 \begin_inset Quotes eld
16712 \begin_inset Quotes erd
16719 \begin_layout Plain Layout
16721 \begin_inset Flex Code
16724 \begin_layout Plain Layout
16725 development/HTML/HTML.notes
16730 , which can be found in the \SpecialChar LyX
16732 \begin_inset CommandInset href
16734 name "accessed online"
16735 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
16740 , usually contains up-to-date information about the state of XHTML output.
16741 See also the list of XHTML bugs on
16742 \begin_inset CommandInset href
16744 name "the bug tracker"
16745 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"
16755 Still, the developers have chosen this approach because it has several
16756 potential advantages over the other two.
16759 \begin_layout Standard
16760 These advantages are primarily due to the fact that the XHTML output routines,
16761 since they are part of \SpecialChar LyX
16762 , know everything \SpecialChar LyX
16763 knows about the document being
16768 \begin_layout Plain Layout
16769 Another advantage is that, since these routines are internal to \SpecialChar LyX
16771 immune to changes in \SpecialChar LyX
16772 's file format, or to changes in the semantics of
16778 So they know about the table of contents (as displayed in the outline),
16779 about the counters associated with different paragraph styles, and about
16780 user-defined styles.
16781 The XHTML output routines know what \SpecialChar LyX
16782 knows about internationalization,
16783 too, so they will output
16784 \begin_inset Quotes eld
16788 \begin_inset Quotes erd
16792 \begin_inset Quotes eld
16800 \begin_inset Quotes erd
16803 , depending upon the language in effect at the time.
16807 \begin_layout Standard
16808 Quite generally, the output routines know what \SpecialChar LyX
16809 knows about document layout,
16810 that is, about how the document is to be rendered on screen.
16811 We use this information when we output the document as XHTML.
16812 In particular, \SpecialChar LyX
16817 generates CSS style information corresponding to the layout information
16818 it uses to render the document on screen: if section headings are supposed
16819 to be sans-serif and bold as seen in \SpecialChar LyX
16820 , then (by default) they will be sans-seri
16821 f and bold when viewed in a web browser, too.
16822 And this is true not just for pre-defined styles, like Section, but for
16823 any style, including user-defined styles.
16824 Indeed, the XHTML output routines make no distinction between user-defined
16826 \change_deleted 244031559 1603876931
16828 \change_inserted 244031559 1603876940
16831 styles and \SpecialChar LyX
16832 's own pre-defined styles: in each case, everything \SpecialChar LyX
16834 the styles is contained in the layout files.
16835 And much the same is true as regards pre-defined textual insets, such as
16836 footnotes, and various custom insets.
16840 \begin_layout Standard
16841 The result is that XHTML output can be customized and extended in exactly
16842 the same way \SpecialChar LaTeX
16843 output can be customized and extended: through layout files
16845 See chapter five of the
16849 manual for the details.
16852 \begin_layout Standard
16853 The remainder of this chapter contains more detailed information on XHTML
16854 output, its limitations, and ways to work around those limitations.
16857 \begin_layout Section
16858 Math Output in XHTML
16861 \begin_layout Standard
16863 offers four choices for how math is rendered.
16864 These have various advantages and disadvantages:
16867 \begin_layout Itemize
16869 \begin_inset Newline newline
16872 MathML is a dialect of XML designed specifically for mathematics on the
16873 web, and it typically renders very well in browsers that support it.
16874 The disadvantage is that not all browsers support MathML, and support is
16875 not complete even in the Gecko-based browsers, such as Firefox.
16876 \begin_inset Newline newline
16879 If \SpecialChar LyX
16880 is unable to render a formula as MathML—for example, if the formula
16882 \begin_inset Flex Code
16885 \begin_layout Plain Layout
16891 package or ERT—then it will instead output the formula as an image.
16895 \begin_layout Itemize
16897 \begin_inset Newline newline
16900 As mentioned above,
16901 \begin_inset Flex Code
16904 \begin_layout Plain Layout
16910 outputs math as HTML, styled by CSS.
16914 \begin_layout Plain Layout
16916 has borrowed some of the CSS for its HTML output from
16917 \begin_inset Flex Code
16920 \begin_layout Plain Layout
16931 For simple formulae, this can work quite well, though with more complicated
16932 formulae it tends to break down.
16933 Still, this method has the advantage that it is very widely supported and
16934 so it may be appropriate for documents that contain only a little, fairly
16936 \begin_inset Newline newline
16939 If Lyx is unable to render a formula as HTML—for example, if the formula
16941 \begin_inset Flex Code
16944 \begin_layout Plain Layout
16950 package or ERT—then it will instead output the formula as an image.
16954 \begin_layout Itemize
16956 \begin_inset Newline newline
16960 \begin_inset Flex Code
16963 \begin_layout Plain Layout
16970 will output formulae as images, the very same images, in fact, that are
16971 used for instant preview.
16975 \begin_layout Plain Layout
16976 Instant preview does
16980 have to be on for images to be output, however.
16985 The advantage to this method is that the images are simply generated by
16987 , so they are very accurate.
16988 The disadvantage, as mentioned earlier, is that these are bitmapped images,
16989 so they do not scale terribly well, and one cannot copy them, etc.
16990 \begin_inset Newline newline
16993 The size of the images can be controlled by setting the
16994 \begin_inset Quotes eld
16997 Math Images Scaling
16998 \begin_inset Quotes erd
17002 \begin_inset Flex Noun
17005 \begin_layout Plain Layout
17006 Document\SpecialChar menuseparator
17007 Settings\SpecialChar menuseparator
17017 \begin_layout Plain Layout
17018 For those who want to know, this controls the resolution of the image in
17019 dots per inch and is based upon a default of 75 dpi.
17025 \begin_inset Newline newline
17028 If \SpecialChar LyX
17029 for some reason fails to create an image for a formula (e.g., if a required
17031 package is not installed), then it will fall back to outputing the raw
17036 \begin_layout Itemize
17039 \begin_inset Newline newline
17042 Finally, \SpecialChar LyX
17043 will happily output math as \SpecialChar LaTeX
17045 As well as being the output of last resort, this method can be used with
17047 \begin_inset CommandInset href
17050 target "http://www.math.union.edu/~dpvc/jsMath/"
17055 , which uses JavaScript to render \SpecialChar LaTeX
17056 embedded in HTML documents.
17058 wraps the \SpecialChar LaTeX
17060 \begin_inset Flex Code
17063 \begin_layout Plain Layout
17069 (for inline formulas) or
17070 \begin_inset Flex Code
17073 \begin_layout Plain Layout
17079 (for displayed formulas) with
17080 \begin_inset Flex Code
17083 \begin_layout Plain Layout
17089 , as is required for jsMath.
17092 \begin_layout Standard
17093 One of these output methods must be selected under
17094 \begin_inset Flex Noun
17097 \begin_layout Plain Layout
17098 Document\SpecialChar menuseparator
17099 Settings\SpecialChar menuseparator
17106 By default, \SpecialChar LyX
17108 This is a document-wide setting, therefore.
17111 \begin_layout Standard
17112 Eventually, \SpecialChar LyX
17113 will offer the user the option to select an alternate output
17114 method for a particular inset, say, one that isn't being rendered very
17119 \begin_layout Plain Layout
17120 That said, since \SpecialChar LyX
17121 falls back to images if the inset contains ERT, then one
17122 can force output as an image by putting some harmless ERT into the math,
17124 \begin_inset Formula $a=b\relax$
17135 \begin_layout Section
17136 Bibliography and Citations
17139 \begin_layout Standard
17140 XHTML output fully supports bibliographies and citations.
17144 \begin_layout Standard
17145 Citation labels are generated by the same machinery that generates \SpecialChar LyX
17147 labels, so the labels will look in the output much as they do in \SpecialChar LyX
17150 If you are using numerical citations, then \SpecialChar LyX
17151 will output numerical labels,
17152 such as [1] or [17], rather than simply showing the citation key in square
17153 brackets, as it does on-screen.
17154 If you are using author-year citations, then \SpecialChar LyX
17155 will add lowercase letters
17156 to the years, just as Bib\SpecialChar TeX
17157 does, if it finds more than one citation for
17158 a given author-year combination.
17159 The labels will be printed with the bibliography entries.
17160 Note that there is, at present, no way to customize the appearance of the
17161 labels, for example, to choose between square brackets and parentheses.
17164 \begin_layout Standard
17165 Bibliography output is handled by the same machinery that handles the presentati
17166 on of reference information in the citation dialog, so you will see in the
17167 XHTML output pretty much what you would see if you were to look at a given
17168 entry in the citation dialog.
17169 The formatting can be customized in your layout file or, preferably, in
17175 manual for the details.
17178 \begin_layout Standard
17179 The main defect at present is that cross-referenced information is printed
17180 with every entry with which it is associated.
17181 So you can see things like this:
17184 \begin_layout Quote
17186 \begin_inset Quotes eld
17189 Context and Logical Form
17190 \begin_inset Quotes erd
17195 Language in Context: Selected Essays
17197 (Oxford: Oxford University Press, 2007), pp.
17201 \begin_layout Quote
17203 \begin_inset Quotes eld
17206 Semantics in Context
17207 \begin_inset Quotes erd
17212 Language in Context: Selected Essays
17214 (Oxford: Oxford University Press, 2007), pp.
17218 \begin_layout Standard
17219 This should be fixed before long.
17222 \begin_layout Standard
17223 There is no support at present for sectioned bibliographies.
17224 If you have multiple bibliographies, then \SpecialChar LyX
17225 will print the same bibliography
17229 \begin_layout Section
17233 \begin_layout Standard
17235 will happily export indexes as XHTML, but with certain limitations at the
17239 \begin_layout Standard
17240 Index export will be most reliable when you do not attempt to use the fancy
17241 constructs that are described in the section on indexes in the
17249 \begin_layout Plain Layout
17250 The main issue here is that \SpecialChar LyX
17251 itself does not really handle these.
17252 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
17258 We'll describe how they are handled using the subsection headings from
17262 \begin_layout Itemize
17263 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
17264 makes an effort to support these,
17265 but the entries must be separated by
17266 \begin_inset Quotes eld
17270 \begin_inset Quotes erd
17273 , that is, there must be spaces around the exclamation point.
17274 This is because it is otherwise too difficult to check for escaped exclamation
17275 points, ones in math, and so forth.
17278 \begin_layout Itemize
17279 Page Ranges: There is no support at all for page ranges, since these make
17280 no sense with XHMTL.
17281 Instead, you will just get two index entries, one at either end.
17284 \begin_layout Itemize
17285 Cross-referencing: There is no support for cross-referencing.
17286 If \SpecialChar LyX
17287 finds an entry containing the
17288 \begin_inset Quotes eld
17291 |see\SpecialChar ldots
17293 \begin_inset Quotes erd
17296 construct, it is just dropped, and the rest is treated as an ordinary index
17300 \begin_layout Itemize
17301 Index Entry Order: \SpecialChar LyX
17302 does support attempts to fix the sorting order.
17303 It will take what is before the first `@' it finds and use that for sorting,
17304 taking what follows the first `@' to be the actual entry.
17305 At present, \SpecialChar LyX
17306 does not check for escaped `@', so do not try to index email
17310 \begin_layout Itemize
17311 Index Entry Layout: You can format entries by using the text style dialog,
17312 or by using any other method available within \SpecialChar LyX
17314 There is no support for constructs like:
17315 \begin_inset Quotes eld
17319 \begin_inset Quotes erd
17323 Indeed, if \SpecialChar LyX
17324 finds a pipe symbol, `|', in an entry, it will delete it and
17325 everything that follows it.
17328 \begin_layout Itemize
17329 Multiple Indexes: There is no support for multiple indexes.
17330 Rather, all index entries will be printed as one large index.
17331 To avoid our printing several versions of the index, we print only the
17332 main index, so make sure you have one.
17335 \begin_layout Section
17336 Nomenclature and Glossary
17339 \begin_layout Standard
17340 There is at present no support for glossaries.
17341 Adding it would be fairly trivial, and welcome.
17344 \begin_layout Chapter
17346 \change_inserted 1075283030 1616534180
17350 \begin_layout Standard
17352 \change_inserted 1075283030 1616534386
17353 Apart from HTML, \SpecialChar LyX
17354 can generate documents in the DocBook XML vocabulary.
17355 With versions 2.3 and before, only select templates could be used to generate
17356 DocBook documents (only version 4).
17357 Starting with \SpecialChar LyX
17358 2.4, most \SpecialChar LyX
17359 layouts can generate valid DocBook documents (only
17361 This feature is built into \SpecialChar LyX
17362 and does not require the use of external tools.
17365 \begin_layout Standard
17367 \change_inserted 1075283030 1616534437
17368 The result is that the DocBook output can be customized and extended in
17369 exactly the same way \SpecialChar LaTeX
17370 output can be customized and extended: through layout
17372 See chapter five of the
17376 manual for the details.
17379 \begin_layout Standard
17381 \change_inserted 1075283030 1616534475
17382 Most \SpecialChar LyX
17383 features are supported with DocBook, like math output.
17386 \begin_layout Itemize
17388 \change_inserted 1075283030 1616534741
17389 Math output is performed mostly in MathML (the major exception being constructio
17390 ns not supported by \SpecialChar LyX
17393 All formulae are also available in raw \SpecialChar TeX
17394 in the DocBook output for further
17398 \begin_layout Itemize
17400 \change_inserted 1075283030 1616534852
17401 Bibliographies and citations are implemented, including with an external
17403 Bibliography entries are not prerendered when the detailed information
17404 are available, but rather output with the standard DocBook constructs.
17405 The external DocBook processor is expected to handle the rendering of entries.
17408 \begin_layout Itemize
17410 \change_inserted 1075283030 1616534863
17411 Indexes are supported, including multiple indices.
17416 ), page ranges, and cross-references (
17420 ) are supported, with the exception of the same symbols escaped.
17429 ) are not supported.
17430 There is no support for escaping of index entries.
17433 \begin_layout Itemize
17435 \change_inserted 1075283030 1616534884
17436 Glossaries are implemented.
17439 \begin_layout Standard
17441 \change_inserted 1075283030 1616534894
17442 Two major parameters can be set at the document level.
17445 \begin_layout Itemize
17447 \change_inserted 1075283030 1616534948
17448 Format for tables: \SpecialChar LyX
17449 can generate tables either as HTML (default value) or
17450 CALS, depending on the user's requirements.
17451 Most DocBook processors accept both formats.
17454 \begin_layout Itemize
17456 \change_inserted 1075283030 1616535006
17457 MathML prefix: in DocBook, MathML is included within its own name space,
17459 The implication is that there must be an indication of the tags belonging
17460 to the MathML standard.
17461 Three choices are offered:
17465 \begin_layout Itemize
17467 \change_inserted 1075283030 1616535044
17468 Inline: the MathML name space is defined for each formula (using the
17472 attribute on each formula)
17475 \begin_layout Itemize
17477 \change_inserted 1075283030 1616535090
17482 prefix (default): the MathML name space is defined at the document level
17487 attribute on the root element).
17488 Each MathML is prefixed with
17497 \begin_layout Itemize
17499 \change_inserted 1075283030 1616620405
17504 prefix: similar to the
17513 \begin_layout Standard
17515 \change_inserted 1075283030 1616620470
17516 This option is especially useful if you want \SpecialChar LyX
17517 to match your personal style
17518 or to work with buggy software that only accepts one prefix for MathML.
17524 \begin_layout Chapter
17525 The \SpecialChar LyX
17529 \begin_layout Section
17533 \begin_layout Standard
17534 The `\SpecialChar LyX
17535 server' allows other programs to talk to \SpecialChar LyX
17536 , invoke \SpecialChar LyX
17537 commands, and retrieve
17538 information about the \SpecialChar LyX
17540 This is only intended for advanced users, but they should find it useful.
17541 It is by writing to the \SpecialChar LyX
17542 server, for example, that bibliography managers,
17543 such as JabRef, are able to
17544 \begin_inset Quotes eld
17548 \begin_inset Quotes erd
17551 citations to \SpecialChar LyX
17555 \begin_layout Section
17556 Starting the \SpecialChar LyX
17558 \begin_inset CommandInset label
17560 name "sec:Starting-the-Server"
17567 \begin_layout Standard
17568 The \SpecialChar LyX
17569 server works through the use of a pair of named pipes.
17570 These are usually located in
17571 \begin_inset Flex Code
17574 \begin_layout Plain Layout
17580 , (except on Windows, where
17584 named pipes are special objects located in
17585 \begin_inset Flex Code
17588 \begin_layout Plain Layout
17600 ) and have the names
17601 \begin_inset Quotes eld
17605 \begin_inset Flex Code
17608 \begin_layout Plain Layout
17615 \begin_inset Quotes erd
17619 \begin_inset Quotes eld
17623 \begin_inset Flex Code
17626 \begin_layout Plain Layout
17633 \begin_inset Quotes erd
17637 External programs write into
17638 \begin_inset Flex Code
17641 \begin_layout Plain Layout
17647 and read back data from
17648 \begin_inset Flex Code
17651 \begin_layout Plain Layout
17658 The stem of the pipe names can be defined in the
17659 \begin_inset Flex Noun
17662 \begin_layout Plain Layout
17663 Tools\SpecialChar menuseparator
17669 dialog, for example
17670 \begin_inset Flex Code
17673 \begin_layout Plain Layout
17674 "/home/myhome/lyxpipe"
17680 \begin_inset Flex Code
17683 \begin_layout Plain Layout
17697 on Windows (where any working path instead of lyxpipe can be used, for
17699 \begin_inset Flex Code
17702 \begin_layout Plain Layout
17725 configure this manually in order for the server to start.
17728 \begin_layout Standard
17731 \begin_inset Flex Code
17734 \begin_layout Plain Layout
17741 \begin_inset Flex Code
17744 \begin_layout Plain Layout
17750 ' to create the pipes.
17751 If one of the pipes already exists, \SpecialChar LyX
17752 will assume that another \SpecialChar LyX
17754 is already running and will not start the server.
17755 On POSIX (Unix like) systems, if for some other reason, an unused
17756 \begin_inset Quotes eld
17760 \begin_inset Quotes erd
17763 pipe is left in existence when \SpecialChar LyX
17764 closes, then \SpecialChar LyX
17765 will try to delete it.
17766 If this fails for some reason, you will need to delete the pipes manually
17767 and then restart \SpecialChar LyX
17769 On Windows, pipes are deleted by the OS on program termination or crash,
17771 \begin_inset Quotes eld
17775 \begin_inset Quotes erd
17778 pipes should not be possible.
17781 \begin_layout Standard
17782 To have several \SpecialChar LyX
17783 processes with servers at the same time, you have to use
17784 different configurations, perhaps by using separate user directories, each
17786 \begin_inset Flex Code
17789 \begin_layout Plain Layout
17795 file, for each process.
17798 \begin_layout Standard
17799 If you are developing a client program, you might find it useful to enable
17800 debugging information from the \SpecialChar LyX
17802 Do this by starting \SpecialChar LyX
17804 \begin_inset Flex Code
17807 \begin_layout Plain Layout
17816 \begin_layout Standard
17817 You can find a complete example client written in C++ in the source distribution
17819 \begin_inset Flex Code
17822 \begin_layout Plain Layout
17823 development/lyxserver/server_monitor.cpp
17831 \begin_layout Standard
17832 Another useful tool is the command-line based client found in
17833 \begin_inset Flex Code
17836 \begin_layout Plain Layout
17837 src/client/lyxclient
17845 \begin_layout Section
17846 Normal communication
17849 \begin_layout Standard
17850 To issue a \SpecialChar LyX
17851 call, the client writes a line of ASCII text into the input
17853 This line has the following format:
17856 \begin_layout Quote
17870 \begin_layout Description
17871 clientname is a name that the client can choose arbitrarily.
17872 Its only use is that \SpecialChar LyX
17873 will echo it if it sends an answer—so a client can
17874 dispatch results from different requesters.
17877 \begin_layout Description
17878 function is the function you want \SpecialChar LyX
17880 It is the same as the commands you'd use in the minibuffer.
17883 \begin_layout Description
17884 argument is an optional argument which is meaningful only to some functions
17886 \begin_inset Quotes eld
17890 \begin_inset Quotes erd
17893 LFUN will insert the argument as text at the cursor position).
17896 \begin_layout Standard
17897 The answer from \SpecialChar LyX
17898 will arrive in the output pipe and be of the form
17901 \begin_layout Quote
17915 \begin_layout Standard
17924 are just echoed from the command request, while
17928 is more or less useful information filled according to how the command
17929 execution worked out.
17930 Some commands, such as
17931 \begin_inset Quotes eld
17935 \begin_inset Quotes erd
17938 , will return information about the internal state of \SpecialChar LyX
17940 return an empty data-response.
17941 This means that the command execution went fine.
17944 \begin_layout Standard
17945 In case of errors, the response from \SpecialChar LyX
17946 will have this form
17949 \begin_layout Quote
17963 \begin_layout Standard
17968 should contain an explanation of why the command failed.
17971 \begin_layout Standard
17975 \begin_layout LyX-Code
17976 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
17977 \begin_inset Newline newline
17980 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
17981 \begin_inset Newline newline
17984 read a <~/.lyxpipe.out
17985 \begin_inset Newline newline
17991 \begin_layout Subsection
17992 AppleScript (Mac OS X)
17995 \begin_layout Standard
17996 Since \SpecialChar LyX
17997 2.1, \SpecialChar LyX
17998 supports basic interactions with AppleScript for normal communicatio
17999 n through the command run.
18000 This command takes a direct argument (the
18004 to perform) and an optional argument.
18005 It either returns the output of the function or triggers an error with
18006 the error message and code.
18009 \begin_layout Standard
18013 \begin_layout LyX-Code
18014 tell application "\SpecialChar LyX
18018 \begin_layout LyX-Code
18022 \begin_layout LyX-Code
18023 -- Stores the current file name into f
18026 \begin_layout LyX-Code
18027 set f to (run "server-get-filename" with argument "")
18030 \begin_layout LyX-Code
18031 on error the error_message number the error_number
18034 \begin_layout LyX-Code
18035 display dialog "Error: " & the error_number & ".
18039 \begin_layout LyX-Code
18040 & the error_message buttons {"OK"} default button 1
18043 \begin_layout LyX-Code
18047 \begin_layout LyX-Code
18051 \begin_layout Section
18055 \begin_layout Standard
18057 can notify clients of events going on asynchronously.
18058 Currently it will only do this if the user binds a key sequence with the
18060 \begin_inset Quotes eld
18064 \begin_inset Quotes erd
18068 The format of the string \SpecialChar LyX
18069 sends is as follows:
18072 \begin_layout Quote
18073 \begin_inset Flex Code
18076 \begin_layout Plain Layout
18087 \begin_layout Standard
18092 is the printed representation of the key sequence that was actually typed
18096 \begin_layout Standard
18097 This mechanism can be used to extend \SpecialChar LyX
18098 's command set and implement macros.
18099 Bind some key sequence to
18100 \begin_inset Quotes eld
18104 \begin_inset Quotes erd
18108 Then start a client that listens on the output pipe, dispatches the command
18109 according to the sequence, and starts a function that may use \SpecialChar LyX
18112 requests to issue a command or a series of commands to \SpecialChar LyX
18116 \begin_layout Section
18117 The simple \SpecialChar LyX
18121 \begin_layout Standard
18123 implements a simple protocol that can be used for session management.
18124 All messages are of the form
18127 \begin_layout Quote
18137 \begin_layout Standard
18143 \begin_inset Quotes eld
18147 \begin_inset Quotes erd
18151 \begin_inset Quotes eld
18155 \begin_inset Quotes erd
18160 \begin_inset Quotes eld
18164 \begin_inset Quotes erd
18167 is received from a client, \SpecialChar LyX
18168 will report back to inform the client that
18169 it's listening to it's messages, while
18170 \begin_inset Quotes eld
18174 \begin_inset Quotes erd
18177 sent from \SpecialChar LyX
18178 will inform clients that \SpecialChar LyX
18182 \begin_layout Section
18183 Reverse DVI/PDF search
18186 \begin_layout Standard
18187 Some DVI/PDF viewers
18191 \begin_layout Plain Layout
18192 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
18193 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
18202 facility (also called
18207 This means that you can tell \SpecialChar LyX
18208 to put the cursor to a specific line in the
18209 document by clicking at the respective position in the DVI/PDF output.
18210 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
18212 This is done via the \SpecialChar LyX
18213 server either by using the named pipe (
18217 ), or the UNIX domain socket (
18221 ) that \SpecialChar LyX
18222 creates in its temporary directory (this is the way the
18223 \begin_inset Flex Code
18226 \begin_layout Plain Layout
18232 program communicates with \SpecialChar LyX
18234 In some cases, you need a helper script that mediates between the viewer
18235 and \SpecialChar LyX
18236 , in others, the viewer can communicate with \SpecialChar LyX
18238 This depends on the selected viewer and on your operating system.
18239 The same applies to the way viewers need to be configured and the way the
18240 reverse search is actually performed.
18241 In what follows, we will thus describe how to setup reverse search for
18243 Before we turn to this, though, we will explain what needs to be done generally
18244 to enable reverse search in the DVI/PDF output.
18247 \begin_layout Subsection
18249 \begin_inset CommandInset label
18251 name "subsec:rev-search"
18258 \begin_layout Standard
18259 In most cases \SpecialChar LyX
18260 will do the work for you by pressing the following button
18264 arg "buffer-toggle-output-sync"
18268 Alternatively, you can also enable the feature by checking
18270 Synchronize with Output
18273 \begin_inset Flex Noun
18276 \begin_layout Plain Layout
18277 Document\SpecialChar menuseparator
18278 Settings\SpecialChar menuseparator
18285 In such a case \SpecialChar LyX
18286 will automatically insert the necessary Sync\SpecialChar TeX
18288 PDF) or load the srcltx package (for DVI) respectively.
18289 This option can be easily reached also on
18290 \begin_inset Flex Code
18293 \begin_layout Plain Layout
18302 \begin_layout Standard
18303 If you need a different setting, you can select or input a custom macro
18304 from the drop down box just below
18305 \begin_inset Flex Noun
18308 \begin_layout Plain Layout
18309 Document\SpecialChar menuseparator
18310 Settings\SpecialChar menuseparator
18311 Output\SpecialChar menuseparator
18312 Synchronize with Output
18320 \begin_layout Standard
18321 Note that the method
18322 \begin_inset Flex Code
18325 \begin_layout Plain Layout
18333 enables gzip compression.
18334 If your viewer does not support it, you should instead use
18335 \begin_inset Flex Code
18338 \begin_layout Plain Layout
18349 \begin_layout Standard
18350 Please also note that including the
18351 \begin_inset Flex Code
18354 \begin_layout Plain Layout
18361 \begin_inset Flex Code
18364 \begin_layout Plain Layout
18370 sometimes has an undesired impact on the typesetting.
18371 Thus, you should switch output synchronization off for the final typesetting
18373 \begin_inset Flex Code
18376 \begin_layout Plain Layout
18383 \begin_inset Flex Code
18386 \begin_layout Plain Layout
18396 \begin_layout Standard
18397 In case you need some more special settings that are not covered by the
18398 automatic settings, read the next section about how to set up output synchroniz
18400 If the automatic setup suits your needs, you can readily jump to section
18401 \begin_inset space ~
18405 \begin_inset CommandInset ref
18407 reference "subsec:configuring-viewers"
18411 , where the necessary configuration steps in your viewer – needed both with
18412 the automatic and the manual setup – are described.
18415 \begin_layout Subsection
18419 \begin_layout Standard
18421 provides several different methods for reverse search.
18422 Some are built-in in the
18423 \begin_inset Flex Code
18426 \begin_layout Plain Layout
18432 program, some are provided by external packages.
18433 Your choice depends on whether your \SpecialChar LaTeX
18434 distribution already provides a given
18435 method (the built-in methods are rather new) and whether your viewer can
18437 The available methods are described in the following.
18440 \begin_layout Subsubsection*
18441 Built-in DVI-search via src-specials (DVI only)
18444 \begin_layout Standard
18445 This method provides the DVI file with the necessary information for reverse
18447 It is available in \SpecialChar LaTeX
18448 since quite some time (any somewhat recent \SpecialChar LaTeX
18450 should include it), and it works reliably.
18451 To enable it, change the
18452 \begin_inset Flex Noun
18455 \begin_layout Plain Layout
18466 \begin_inset Flex Noun
18469 \begin_layout Plain Layout
18480 \begin_inset Flex Noun
18483 \begin_layout Plain Layout
18484 Preferences\SpecialChar menuseparator
18485 File Handling\SpecialChar menuseparator
18492 \begin_inset Flex Code
18495 \begin_layout Plain Layout
18496 latex -src-specials $$i
18502 If this doesn't work, check if your \SpecialChar TeX
18503 engine needs different options (the
18504 syntax might differ in some distributions).
18507 \begin_layout Subsubsection*
18508 External Packages (PDFSync and scrltx)
18511 \begin_layout Standard
18520 provide reverse search facility for PDF output (via pdflatex) and DVI output,
18522 In order to enable it, load the packages in the \SpecialChar LyX
18526 \begin_layout Itemize
18527 \begin_inset Flex Code
18530 \begin_layout Plain Layout
18533 usepackage{pdfsync}
18538 for reverse PDF search,
18541 \begin_layout Itemize
18542 \begin_inset Flex Code
18545 \begin_layout Plain Layout
18548 usepackage[active]{srcltx}
18553 for reverse DVI search.
18556 \begin_layout Standard
18557 If you want to be able to perform both DVI and PDF reverse searches, you
18558 can also insert in the preamble the following lines
18561 \begin_layout LyX-Code
18565 \begin_inset Newline newline
18571 \begin_inset Newline newline
18576 usepackage{pdfsync}
18577 \begin_inset Newline newline
18583 \begin_inset Newline newline
18588 usepackage[active]{srcltx}
18589 \begin_inset Newline newline
18597 \begin_layout Standard
18598 This way, you can preview the file as either DVI or PDF (pdflatex) and the
18599 right package will be used.
18602 \begin_layout Standard
18603 Note that PDFSync might affect the output layout of your document.
18604 It is therefore advised to disable PDFsync for final documents.
18607 \begin_layout Subsubsection*
18608 Built-in reverse search via Sync\SpecialChar TeX
18612 \begin_layout Standard
18614 \begin_inset Flex Code
18617 \begin_layout Plain Layout
18623 have built-in support for both PDF and DVI reverse search.
18626 Sync\SpecialChar TeX
18629 facility is basically the result of the integration of the PDFSync package
18630 to the pdftex program and its merge with the
18635 You need at least \SpecialChar TeX
18636 Live 2008 or a recent Mik\SpecialChar TeX
18637 distribution in order to use
18642 \begin_layout Plain Layout
18643 For some reason, Mik\SpecialChar TeX
18644 does not understand/obey the command \SpecialChar LyX
18646 the preamble when you check the "Enable Forward/Reverse Search" button
18647 in the toolbar and does not generate the necessary info.
18650 \begin_layout Plain Layout
18651 The generation of the required info can be forced by changing the converter
18652 "\SpecialChar LaTeX
18653 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
18654 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
18655 the -synctex=1 switch).
18660 Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
18661 Skim on the Mac, SumatraPDF on Windows; see the next section for details)
18662 already provide Sync\SpecialChar TeX
18666 \begin_layout Standard
18667 To enable Sync\SpecialChar TeX
18668 for DVI output, change the
18669 \begin_inset Flex Noun
18672 \begin_layout Plain Layout
18683 \begin_inset Flex Noun
18686 \begin_layout Plain Layout
18691 (plain) -> DraftDVI
18697 \begin_inset Flex Noun
18700 \begin_layout Plain Layout
18701 Preferences\SpecialChar menuseparator
18702 File Handling\SpecialChar menuseparator
18709 \begin_inset Flex Code
18712 \begin_layout Plain Layout
18713 latex -synctex=1 $$i
18718 , and for PDF output, change the
18719 \begin_inset Flex Noun
18722 \begin_layout Plain Layout
18727 (pdflatex) -> PDF (pdflatex)
18733 \begin_inset Flex Code
18736 \begin_layout Plain Layout
18737 pdflatex -synctex=1 $$i
18743 Should your viewer not be considered in the following description, or in
18744 case of missing success, please check the documentation of your viewer
18745 whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
18750 \begin_layout Plain Layout
18751 Note that the option
18752 \begin_inset Flex Code
18755 \begin_layout Plain Layout
18761 option enables gzip compression.
18762 If your viewer does not support it, you should instead use
18763 \begin_inset Flex Code
18766 \begin_layout Plain Layout
18780 \begin_layout Subsection
18781 Configuring and using specific viewers
18782 \begin_inset CommandInset label
18784 name "subsec:configuring-viewers"
18791 \begin_layout Subsubsection*
18792 Xdvi (all platforms)
18795 \begin_layout Standard
18797 \begin_inset Flex Code
18800 \begin_layout Plain Layout
18806 , you don't need to do anything else for performing a reverse DVI search,
18807 as \SpecialChar LyX
18808 already provides the necessary hooks for automatically using the
18809 \begin_inset Flex Code
18812 \begin_layout Plain Layout
18819 Just setup your document as described above (reverse search is triggered
18820 by Ctrl-click or Alt-click on Mac OSX, respectively).
18823 \begin_layout Standard
18824 However, if for whatever reason you want to use the named pipe instead of
18825 the socket for communicating with \SpecialChar LyX
18826 , simply change the DVI viewer in
18827 \begin_inset Flex Noun
18830 \begin_layout Plain Layout
18831 Preferences\SpecialChar menuseparator
18832 File Handling\SpecialChar menuseparator
18842 \begin_layout Plain Layout
18843 On Mac OSX you have to use
18844 \begin_inset Flex Code
18847 \begin_layout Plain Layout
18848 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
18859 \begin_inset Flex Code
18862 \begin_layout Plain Layout
18863 xdvi -editor "lyxeditor.sh %f %l"
18869 \begin_inset Flex Code
18872 \begin_layout Plain Layout
18878 is a suitable script.
18879 For example, a minimal shell script is the following one:
18882 \begin_layout LyX-Code
18884 \begin_inset Newline newline
18887 LYXPIPE="/path/to/lyxpipe"
18888 \begin_inset Newline newline
18891 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
18892 \begin_inset Newline newline
18895 echo "$COMMAND" > "${LYXPIPE}".in || exit
18896 \begin_inset Newline newline
18899 read TMP < "${LYXPIPE}".out || exit
18902 \begin_layout Standard
18904 \begin_inset Flex Code
18907 \begin_layout Plain Layout
18913 is the LyXServer pipe path specified in
18914 \begin_inset Flex Noun
18917 \begin_layout Plain Layout
18918 Preferences\SpecialChar menuseparator
18928 \begin_layout Plain Layout
18930 \begin_inset Flex Code
18933 \begin_layout Plain Layout
18939 folder of a source distribution you can find a
18940 \begin_inset Flex Code
18943 \begin_layout Plain Layout
18949 script which is able to locate the
18953 based on your preferences.
18961 \begin_layout Subsubsection*
18965 \begin_layout Standard
18967 \begin_inset Flex Code
18970 \begin_layout Plain Layout
18971 /Applications/MacDviX_Folder/calleditor.script
18976 , add the following lines:
18979 \begin_layout LyX-Code
18980 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
18981 \begin_inset Newline newline
18987 \begin_layout Standard
18988 Modify the lines accordingly if you install \SpecialChar LyX
18989 somewhere else than in the
18990 Applications folder.
18993 \begin_layout Standard
18994 Reverse search is triggered by Alt-click (OPTION-click).
18997 \begin_layout Subsubsection*
19001 \begin_layout Standard
19003 \begin_inset Flex Code
19006 \begin_layout Plain Layout
19007 open -a Skim.app $$i
19012 to the viewer setting in
19013 \begin_inset Flex Noun
19016 \begin_layout Plain Layout
19017 Preferences\SpecialChar menuseparator
19018 File Handling\SpecialChar menuseparator
19019 File formats\SpecialChar menuseparator
19026 \begin_inset Flex Noun
19029 \begin_layout Plain Layout
19030 Skim\SpecialChar menuseparator
19031 Preferences\SpecialChar menuseparator
19038 \begin_inset Flex Noun
19041 \begin_layout Plain Layout
19047 preset and enter command
19048 \begin_inset Flex Noun
19051 \begin_layout Plain Layout
19052 /Applications/\SpecialChar LyX
19053 .app/Contents/MacOS/lyxeditor
19061 \begin_layout Standard
19062 Reverse search is triggered by COMMAND-SHIFT-click
19065 \begin_layout Subsubsection*
19069 \begin_layout Standard
19070 Reverse search with evince does not work out of the box, but it can be achieved
19071 by means of some third party helper scripts.
19073 \begin_inset CommandInset href
19075 target "https://wiki.lyx.org/LyX/SyncTeX"
19083 \begin_layout Subsubsection*
19087 \begin_layout Standard
19089 \begin_inset Flex Noun
19092 \begin_layout Plain Layout
19093 Settings\SpecialChar menuseparator
19094 Configure Okular\SpecialChar menuseparator
19101 \begin_inset Quotes erd
19105 This inserts the appropriate command (
19106 \begin_inset Flex Code
19109 \begin_layout Plain Layout
19118 \begin_layout Standard
19119 Reverse search is triggered by SHIFT-click.
19121 \change_inserted -712698321 1578211026
19122 Note that this only works if Okular is in
19123 \begin_inset Quotes eld
19127 \begin_inset Quotes erd
19131 \begin_inset space \thinspace{}
19134 e., the hand symbol is clicked).
19139 \begin_layout Subsubsection*
19143 \begin_layout Standard
19144 Qpdfview supports Sync\SpecialChar TeX
19145 since version 0.3.5.
19147 \begin_inset Flex Noun
19150 \begin_layout Plain Layout
19151 Edit\SpecialChar menuseparator
19152 Settings\SpecialChar menuseparator
19158 , click on the input field of the
19159 \begin_inset Quotes eld
19163 \begin_inset Quotes erd
19166 item and add the command
19167 \begin_inset Flex Code
19170 \begin_layout Plain Layout
19179 \begin_layout Standard
19180 Reverse search is triggered by double-click or, in more recent versions,
19184 \begin_layout Subsubsection*
19188 \begin_layout Standard
19189 Launch yap, choose its
19190 \begin_inset Flex Noun
19193 \begin_layout Plain Layout
19194 View\SpecialChar menuseparator
19200 menu and select the
19201 \begin_inset Quotes eld
19205 \begin_inset Quotes erd
19210 \begin_inset Quotes eld
19213 New\SpecialChar ldots
19215 \begin_inset Quotes erd
19218 button and, in the window that opens, enter
19219 \begin_inset Quotes eld
19224 \begin_inset Quotes erd
19227 (or any other name you like) in the
19228 \begin_inset Quotes eld
19232 \begin_inset Quotes erd
19236 Now click on the button labeled
19237 \begin_inset Quotes eld
19242 \begin_inset Quotes erd
19245 to open a file dialog and navigate to the directory containing the batch
19247 \begin_inset Flex Code
19250 \begin_layout Plain Layout
19258 \begin_inset Flex Code
19261 \begin_layout Plain Layout
19267 and then specify the program arguments as
19268 \begin_inset Flex Code
19271 \begin_layout Plain Layout
19279 \begin_inset Flex Code
19282 \begin_layout Plain Layout
19288 wrapper is used for communicating with \SpecialChar LyX
19296 \begin_layout LyX-Code
19298 \begin_inset Newline newline
19301 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
19310 \begin_inset Newline newline
19324 \begin_layout Standard
19325 Make sure that the \SpecialChar LyX
19326 Server pipe path you specified in \SpecialChar LyX
19328 \begin_inset Flex Code
19331 \begin_layout Plain Layout
19345 , otherwise change the
19346 \begin_inset Flex Code
19349 \begin_layout Plain Layout
19355 wrapper accordingly.
19358 \begin_layout Standard
19359 In yap, reverse search is triggered by double-click.
19362 \begin_layout Subsubsection*
19363 SumatraPDF (Windows)
19366 \begin_layout Standard
19367 In order to use SumatraPDF for inverse search, enter
19368 \begin_inset Flex Code
19371 \begin_layout Plain Layout
19372 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
19377 in the viewer setting in
19378 \begin_inset Flex Noun
19381 \begin_layout Plain Layout
19382 Preferences\SpecialChar menuseparator
19383 File Handling\SpecialChar menuseparator
19384 File formats\SpecialChar menuseparator
19391 \begin_inset Flex Code
19394 \begin_layout Plain Layout
19400 is the previous wrapper.
19401 If SumatraPDF.exe is not in your command PATH, use its full file name.
19404 \begin_layout Standard
19405 Reverse search is triggered by double-click.
19408 \begin_layout Subsubsection*
19412 \begin_layout Standard
19413 First of all, make sure that yap is your default DVI viewer in the Windows
19414 environment, then launch it, choose its
19415 \begin_inset Flex Noun
19418 \begin_layout Plain Layout
19419 View\SpecialChar menuseparator
19425 menu and select the
19426 \begin_inset Quotes eld
19430 \begin_inset Quotes erd
19435 \begin_inset Quotes eld
19438 New\SpecialChar ldots
19440 \begin_inset Quotes erd
19443 button and, in the window that opens, enter
19444 \begin_inset Quotes eld
19449 \begin_inset Quotes erd
19452 (or any other name you like) in the
19453 \begin_inset Quotes eld
19457 \begin_inset Quotes erd
19461 Now click on the button labeled
19462 \begin_inset Quotes eld
19467 \begin_inset Quotes erd
19470 to open a file dialog and navigate to the directory containing the
19471 \begin_inset Flex Code
19474 \begin_layout Plain Layout
19480 program (which is installed by default on Cygwin along with the \SpecialChar LyX
19483 \begin_inset Flex Code
19486 \begin_layout Plain Layout
19492 and then specify the program arguments as
19493 \begin_inset Flex Code
19496 \begin_layout Plain Layout
19503 In this way, you will be using the
19507 for communicating with \SpecialChar LyX
19509 If, for whatever reason, you want to use the
19514 \begin_inset Flex Code
19517 \begin_layout Plain Layout
19523 option and be sure to specify the \SpecialChar LyX
19524 Server pipe path in the \SpecialChar LyX
19528 \begin_layout Standard
19529 In yap, reverse search is triggered by double-click.
19532 \begin_layout Subsubsection*
19533 SumatraPDF (Cygwin)
19536 \begin_layout Standard
19537 In order to use SumatraPDF for inverse search, enter
19538 \begin_inset Flex Code
19541 \begin_layout Plain Layout
19542 SumatraPDF -inverse-search "lyxeditor -g %f %l"
19547 in the viewer setting in
19548 \begin_inset Flex Noun
19551 \begin_layout Plain Layout
19552 Preferences\SpecialChar menuseparator
19553 File Handling\SpecialChar menuseparator
19554 File formats\SpecialChar menuseparator
19561 If SumatraPDF.exe is not in your command PATH, use its full posix path.
19563 \begin_inset Flex Code
19566 \begin_layout Plain Layout
19572 enables communication via the
19578 \begin_inset Flex Code
19581 \begin_layout Plain Layout
19587 option if you want to use the
19591 , and be sure to specify the \SpecialChar LyX
19592 Server pipe path in the \SpecialChar LyX
19596 \begin_layout Standard
19597 Reverse search is triggered by double-click.
19600 \begin_layout Section
19604 \begin_layout Standard
19605 Forward search is, as the name implies, in a sense the
19606 \begin_inset Quotes eld
19610 \begin_inset Quotes erd
19614 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
19616 If forward search is set up (as described in what follows), you can put
19617 the cursor anywhere in your \SpecialChar LyX
19619 \begin_inset Flex Noun
19622 \begin_layout Plain Layout
19623 Navigate\SpecialChar menuseparator
19630 \begin_inset Flex Noun
19633 \begin_layout Plain Layout
19639 in the context menu via right mouse click), and then the viewer will jump
19640 to that position as well.
19641 This implies, of course, that your viewer supports this function.
19644 \begin_layout Standard
19645 To make forward search possible, you first need to provide the generated
19646 output PDF/DVI file with additional information about the \SpecialChar TeX
19648 This can be done via the methods described in the section
19649 \begin_inset CommandInset ref
19651 reference "subsec:rev-search"
19658 \begin_layout Standard
19659 Additionally, you need to configure \SpecialChar LyX
19660 for using your viewers in
19661 \begin_inset Flex Noun
19664 \begin_layout Plain Layout
19665 Tools\SpecialChar menuseparator
19666 Preferences\SpecialChar menuseparator
19667 Output\SpecialChar menuseparator
19674 We provide a range of tested configurations for some viewers, which you
19675 can select from the drop down list.
19676 If none of these configurations suits you, you have to find out and enter
19677 a suitable configuration yourself.
19678 The definition syntax uses the following placeholders:
19681 \begin_layout Itemize
19683 \begin_inset Flex Code
19686 \begin_layout Plain Layout
19695 \begin_layout Itemize
19697 \begin_inset Flex Code
19700 \begin_layout Plain Layout
19706 : name of the (temporary) exported .tex file (without path)
19709 \begin_layout Itemize
19711 \begin_inset Flex Code
19714 \begin_layout Plain Layout
19720 : name of the (temporary) exported .tex file (including path)
19723 \begin_layout Itemize
19725 \begin_inset Flex Code
19728 \begin_layout Plain Layout
19734 : name of the exported output file (either dvi or pdf, depending on which
19735 one exists in the temporary directory)
19738 \begin_layout Standard
19739 Note that only some of the viewers provide full and usable forward search
19740 functionality out of the box, among them yap, xdvi, okular
19744 \begin_layout Plain Layout
19745 You might want to set
19746 \begin_inset Flex Code
19749 \begin_layout Plain Layout
19756 \begin_inset Flex Noun
19759 \begin_layout Plain Layout
19760 Tools\SpecialChar menuseparator
19761 Preferences\SpecialChar menuseparator
19762 File Handling\SpecialChar menuseparator
19764 \begin_inset space ~
19777 , qpdfview, and SumatraPDF
19781 \begin_layout Plain Layout
19782 SumatraPDF can also use DDE commands through the external program CMCDDE
19783 — downloadable from
19784 \begin_inset CommandInset href
19786 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
19797 Others, such as evince
19801 \begin_layout Plain Layout
19802 Forward search with evince can be achieved by means of third party helper
19805 \begin_inset CommandInset href
19807 target "https://wiki.lyx.org/LyX/SyncTeX"
19817 , require some extra tools in order to use forward search.
19818 While many of the widespread PDF viewers (most notably Adobe Reader) do
19819 not support forward search at all, some other viewers – e.
19820 \begin_inset space \thinspace{}
19824 xpdf – allow at least to reload the document and jump to a specific page
19825 of the file, so you can at least navigate
19826 \begin_inset Quotes eld
19830 \begin_inset Quotes erd
19834 This latter functionality is provided by an external call of synctex (see
19835 the predefined example configurations).
19839 \begin_layout Standard
19840 Forward search works both with DVI and PDF output.
19842 simply checks which preview format you have used before (i.
19843 \begin_inset space \thinspace{}
19846 e., which format is already there in the temporary directory) and chooses
19847 the appropriate configuration for the respective format.
19850 \begin_layout Chapter
19852 \change_deleted 564990737 1671097409
19853 Special Document Classes
19858 \begin_layout Section
19860 \change_deleted 564990737 1669742044
19864 \begin_layout Standard
19866 \change_deleted 564990737 1669742044
19872 \begin_layout Subsection
19874 \change_deleted 564990737 1669742044
19878 \begin_layout Standard
19880 \change_deleted 564990737 1669742044
19881 This section describes how \SpecialChar LyX
19882 can be used to write articles for submission
19883 to the scientific journal
19885 Astronomy and Astrophysics
19888 \begin_inset Flex URL
19891 \begin_layout Plain Layout
19893 https://www.aanda.org/
19898 ) using Version 5.01 of the document class
19903 This package can be downloaded from the ftp site
19906 \begin_layout Standard
19908 \change_deleted 564990737 1669742044
19909 \begin_inset VSpace medskip
19915 \begin_layout Standard
19918 \change_deleted 564990737 1669742044
19919 \begin_inset Flex URL
19922 \begin_layout Plain Layout
19924 ftp://ftp.edpsciences.org/pub/aa/readme.html
19932 \begin_layout Standard
19934 \change_deleted 564990737 1669742044
19935 \begin_inset VSpace medskip
19941 \begin_layout Standard
19943 \change_deleted 564990737 1669742044
19944 A manual comes together with that package, and this text is not meant to
19945 replace the original manual but is merely a short guide in how to realize
19946 the correct form of your paper.
19950 \begin_layout Standard
19952 \change_deleted 564990737 1669742044
19953 Please note that the publisher of the journal was changed from Springer
19954 to EDP Sciences starting January 1, 2001.
19955 That change involved also some slight changes to the style files, namely
19956 the removal of the thesaurus command.
19957 The \SpecialChar LyX
19958 class aa supports the newest version of these style files, V 5.01.
19959 If you have an older version installed, please upgrade.
19960 For compatibility, the old (version 4) layout has been kept as
19965 Please refer to the comments in
19968 Dir/layouts/aapaper.layout
19973 \begin_layout Subsection
19975 \change_deleted 564990737 1669742044
19979 \begin_layout Standard
19981 \change_deleted 564990737 1669742044
19982 It is recommended you start from the example template distributed with \SpecialChar LyX
19984 If you are not using a template, note the following settings:
19987 \begin_layout Itemize
19989 \change_deleted 564990737 1669742044
19996 Document\SpecialChar menuseparator
19999 dialog (OK, that one was obvious).
20002 \begin_layout Itemize
20004 \change_deleted 564990737 1669742044
20005 Don't change the option
20008 \begin_inset space ~
20018 The whole layout is done by the macros, you shouldn't change anything.
20021 \begin_layout Subsection
20023 \change_deleted 564990737 1669742044
20027 \begin_layout Standard
20029 \change_deleted 564990737 1669742044
20030 First thing to enter is the header information.
20031 It consists of seven entries, of which some are optional.
20035 \begin_layout Itemize
20037 \change_deleted 564990737 1669742044
20045 \begin_layout Itemize
20047 \change_deleted 564990737 1669742044
20055 \begin_layout Itemize
20057 \change_deleted 564990737 1669742044
20065 \begin_layout Itemize
20067 \change_deleted 564990737 1669742044
20075 \begin_layout Itemize
20077 \change_deleted 564990737 1669742044
20082 : [optional] if more than one author: whom to contact for offprint requests.
20085 \begin_layout Itemize
20087 \change_deleted 564990737 1669742044
20092 : [optional] mail address for contacts.
20095 \begin_layout Itemize
20097 \change_deleted 564990737 1669742044
20103 Suggested format is
20105 Received: <date>; Accepted <date>
20108 \begin_layout Standard
20110 \change_deleted 564990737 1669742044
20111 There is no need to issue the
20117 command, this is done automatically by \SpecialChar LyX
20118 when the header is finished.
20119 Although the order of the single header entries doesn't matter it is advised
20120 to keep the above sequence, just to get the best optics and meets the layout
20121 of the real document.
20124 \begin_layout Standard
20126 \change_deleted 564990737 1669742044
20127 If you want to place footnotes in the header block, e.
20128 \begin_inset space \thinspace{}
20132 \begin_inset space \space{}
20135 to state your present address, just use the standard footnote via the menu
20138 Insert\SpecialChar menuseparator
20143 will automagically use the term
20152 \begin_layout Standard
20154 \change_deleted 564990737 1669742044
20157 Edit\SpecialChar menuseparator
20160 , you'll find two insets which are relevant for the titling:
20163 \begin_layout Itemize
20165 \change_deleted 564990737 1669742044
20172 to mark corresponding author\SpecialChar breakableslash
20174 The institutes are numbered sequentially as they appear in the
20178 field, so you have to put a marker to each author.
20181 \begin_layout Itemize
20183 \change_deleted 564990737 1669742044
20188 to supply an email address for fast contact.
20191 \begin_layout Standard
20193 \change_deleted 564990737 1669742044
20194 In addition to these topics, the macros use one additional \SpecialChar LaTeX
20196 has no counterpart in \SpecialChar LyX
20200 \begin_layout Itemize
20202 \change_deleted 564990737 1669742044
20209 to separate different names for more than one author and institute, respectivel
20213 \begin_layout Standard
20215 \change_deleted 564990737 1669742044
20216 The appropriate command has to be entered in \SpecialChar LyX
20217 and marked as \SpecialChar LaTeX
20223 \begin_layout Subsection
20225 \change_deleted 564990737 1669742044
20229 \begin_layout Standard
20231 \change_deleted 564990737 1669742044
20232 The abstract should immediately follow the header block.
20233 With version 5 the abstract environment was changed to a command, and there
20234 is now a restriction to only one paragraph.
20235 In addition, it should contain an entry with the keywords.
20236 This is done via the paragraph style
20241 Refer to the example paper.
20244 \begin_layout Subsection
20246 \change_deleted 564990737 1669742044
20247 Supported environments
20250 \begin_layout Standard
20252 \change_deleted 564990737 1669742044
20253 The A&A paper layout supports the following environments for structuring
20257 \begin_layout Itemize
20259 \change_deleted 564990737 1669742044
20265 \begin_layout Itemize
20267 \change_deleted 564990737 1669742044
20273 \begin_layout Itemize
20275 \change_deleted 564990737 1669742044
20281 \begin_layout Itemize
20283 \change_deleted 564990737 1669742044
20289 \begin_layout Itemize
20291 \change_deleted 564990737 1669742044
20297 \begin_layout Itemize
20299 \change_deleted 564990737 1669742044
20305 \begin_layout Itemize
20307 \change_deleted 564990737 1669742044
20313 \begin_layout Itemize
20315 \change_deleted 564990737 1669742044
20321 \begin_layout Itemize
20323 \change_deleted 564990737 1669742044
20329 \begin_layout Itemize
20331 \change_deleted 564990737 1669742044
20337 \begin_layout Itemize
20339 \change_deleted 564990737 1669742044
20345 \begin_layout Itemize
20347 \change_deleted 564990737 1669742044
20354 \begin_layout Subsection
20356 \change_deleted 564990737 1669742044
20357 Commands not supported by \SpecialChar LyX
20361 \begin_layout Standard
20363 \change_deleted 564990737 1669742044
20364 Some commands are not yet supported by the
20368 layout for \SpecialChar LyX
20370 Some have already been mentioned.
20371 For the sake of completeness, they are listed all together here:
20374 \begin_layout Itemize
20376 \change_deleted 564990737 1669742044
20384 \begin_layout Itemize
20386 \change_deleted 564990737 1669742044
20394 \begin_layout Itemize
20396 \change_deleted 564990737 1669742044
20404 \begin_layout Itemize
20406 \change_deleted 564990737 1669742044
20414 \begin_layout Standard
20416 \change_deleted 564990737 1669742044
20417 If you want to use any of these commands, you have to enter them yourself.
20420 Do not forget to mark them as \SpecialChar LaTeX
20424 \begin_layout Subsection
20426 \change_deleted 564990737 1669742044
20427 Figure and Table Floats
20430 \begin_layout Standard
20432 \change_deleted 564990737 1669742044
20434 provides support for the necessary float environments
20436 figure, figure*, table
20442 , therefore we won't tell much about it here.
20446 \begin_inset space ~
20452 Just remember that tables should be left-aligned.
20453 For that, select the table and change the alignment in
20455 Edit\SpecialChar menuseparator
20457 \begin_inset space ~
20463 \begin_layout Standard
20465 \change_deleted 564990737 1669742044
20466 There is only one special thing: the figures with caption besides the figure.
20467 To create such a figure, you have to do the following:
20470 \begin_layout Enumerate
20472 \change_deleted 564990737 1669742044
20473 Create a wide figure float:
20475 Insert\SpecialChar menuseparator
20476 Float\SpecialChar menuseparator
20479 , then right click in the figure and select
20482 \begin_inset space ~
20490 \begin_layout Enumerate
20492 \change_deleted 564990737 1669742044
20493 Enter your caption text.
20496 \begin_layout Enumerate
20498 \change_deleted 564990737 1669742044
20503 to move the cursor above the caption.
20506 \begin_layout Enumerate
20508 \change_deleted 564990737 1669742044
20512 \begin_layout Enumerate
20514 \change_deleted 564990737 1669742044
20515 Position the cursor behind the figure and insert a horizontal fill:
20517 Insert\SpecialChar menuseparator
20519 \begin_inset space ~
20522 Character\SpecialChar menuseparator
20524 \begin_inset space ~
20532 \begin_layout Enumerate
20534 \change_deleted 564990737 1669742044
20535 Switch to \SpecialChar LaTeX
20539 \begin_inset space ~
20547 \begin_layout Enumerate
20549 \change_deleted 564990737 1669742044
20559 Do not close the brace!
20562 \begin_layout Enumerate
20564 \change_deleted 564990737 1669742044
20565 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
20570 \begin_inset space ~
20582 \begin_layout Standard
20584 \change_deleted 564990737 1669742044
20585 Also, refer to the figures in the example paper.
20588 \begin_layout Subsection
20590 \change_deleted 564990737 1669742044
20594 \begin_layout Standard
20596 \change_deleted 564990737 1669742044
20597 For submission, the paper has to be formated in a special double-spacing
20599 For this purpose, you have to give the option
20603 to the document class.
20604 This must be done using the custom class options field in the
20606 Document\SpecialChar menuseparator
20610 Just enter the string
20617 \begin_layout Subsection
20619 \change_deleted 564990737 1669742044
20623 \begin_layout Standard
20625 \change_deleted 564990737 1669742044
20630 directory contains an example paper written with \SpecialChar LyX
20632 It is the example paper from the original macro package, translated to
20635 Use it for inspiration, and compare the original \SpecialChar LaTeX
20636 code with \SpecialChar LyX
20640 \begin_layout Section
20642 \change_deleted 564990737 1671097429
20646 \begin_layout Standard
20648 \change_deleted 564990737 1671097429
20653 can be used to type letters according to German conventions.
20654 A template file is included in
20656 .../lyx/share/templates
20658 for you to use as a starting point.
20661 \begin_layout Section
20663 \change_deleted 564990737 1671097429
20667 \begin_layout Standard
20669 \change_deleted 564990737 1671097429
20670 See the \SpecialChar LyX
20676 It contains all infos you need.
20679 \begin_layout Section
20681 \change_deleted 564990737 1669755802
20685 \begin_layout Standard
20687 \change_deleted 564990737 1669755802
20690 Panayotis Papasotiriou
20693 \begin_layout Subsection
20695 \change_deleted 564990737 1669755802
20699 \begin_layout Standard
20701 \change_deleted 564990737 1669755802
20702 The ijmpc package is a set of macros that facilitates electronic manuscript
20705 International Journal of Modern Physics C
20708 Similarly, the ijmpd package is for creating manuscripts to be submitted
20711 International Journal of Modern Physics D
20714 Both journals are published by World Scientific.
20715 The corresponding document classes are named
20724 These files, together with instructions for the authors, can be downloaded
20726 \begin_inset Flex URL
20729 \begin_layout Plain Layout
20731 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
20737 \begin_inset Flex URL
20740 \begin_layout Plain Layout
20742 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
20748 Both packages are modified versions of the standard
20749 \begin_inset Quotes eld
20753 \begin_inset Quotes erd
20756 package, and they are almost (but not exactly) identical.
20757 Most of their features are supported by \SpecialChar LyX
20759 I have used \SpecialChar LyX
20760 successfully to write articles submitted to both journals
20761 without any problem.
20764 \begin_layout Subsection
20766 \change_deleted 564990737 1669755802
20770 \begin_layout Standard
20772 \change_deleted 564990737 1669755802
20773 As usual, the easiest way to write a paper is to start with a template.
20776 File\SpecialChar menuseparator
20792 This will give an (almost) empty document that includes the most common
20793 fields found in a manuscript.
20794 Simply overwrite the existing text (including the brackets,
20799 You should keep in mind the following remarks.
20802 \begin_layout Enumerate
20804 \change_deleted 564990737 1669755802
20806 won't let you change the font size and the page style of the document,
20807 because such modifications are not allowed by both packages.
20810 \begin_layout Enumerate
20812 \change_deleted 564990737 1669755802
20813 The language of the document should not be changed.
20814 Before previewing your paper, be sure that the babel package is not used.
20815 To do this, click on
20818 arg "dialog-show document"
20823 \SpecialChar menuseparator
20827 \begin_inset Quotes eld
20831 \begin_inset Quotes erd
20841 \begin_layout Enumerate
20843 \change_deleted 564990737 1669755802
20845 \begin_inset Quotes eld
20849 \begin_inset Quotes erd
20852 style must be used to define keywords.
20855 \begin_layout Enumerate
20857 \change_deleted 564990737 1669755802
20858 The ijmpc package provides a style named
20859 \begin_inset Quotes eld
20862 Classification Codes
20863 \begin_inset Quotes erd
20866 , which can be used to define classification codes, such as PACS numbers.
20867 Note that this facility is not supported by the ijmpd package.
20870 \begin_layout Enumerate
20872 \change_deleted 564990737 1669755802
20873 Several new environments are available:
20874 \begin_inset Quotes eld
20878 \begin_inset Quotes erd
20882 \begin_inset Quotes eld
20886 \begin_inset Quotes erd
20890 \begin_inset Quotes eld
20894 \begin_inset Quotes erd
20898 \begin_inset Quotes eld
20902 \begin_inset Quotes erd
20906 \begin_inset Quotes eld
20910 \begin_inset Quotes erd
20914 \begin_inset Quotes eld
20918 \begin_inset Quotes erd
20922 \begin_inset Quotes eld
20926 \begin_inset Quotes erd
20930 \begin_inset Quotes eld
20934 \begin_inset Quotes erd
20938 \begin_inset Quotes eld
20942 \begin_inset Quotes erd
20946 \begin_inset Quotes eld
20950 \begin_inset Quotes erd
20954 \begin_inset Quotes eld
20958 \begin_inset Quotes erd
20962 \begin_inset Quotes eld
20966 \begin_inset Quotes erd
20970 \begin_inset Quotes eld
20974 \begin_inset Quotes erd
20978 \begin_inset Quotes eld
20982 \begin_inset Quotes erd
20986 Their use is more or less obvious.
20988 supports all these environments; it will use the proper label, text style,
20989 and numbering scheme for each of them.
20992 \begin_layout Enumerate
20994 \change_deleted 564990737 1669755802
20995 Both packages use basic citations; the natbib package should not be used.
20996 In \SpecialChar LyX
20997 , citation references are shown as usual; in the output, citations are
20998 shown as superscripts.
20999 If you want to use a citation as normal text, you should use the
21004 \begin_inset space \thinspace{}
21008 \begin_inset space \space{}
21012 \begin_inset Quotes eld
21016 \begin_inset space \space{}
21026 \begin_inset Quotes erd
21032 \begin_layout Enumerate
21034 \change_deleted 564990737 1669755802
21036 \begin_inset Quotes eld
21040 \begin_inset Quotes erd
21043 section in both packages.
21044 To put acknowledgments, just use the
21045 \begin_inset Quotes eld
21049 \begin_inset Quotes erd
21055 \begin_layout Enumerate
21057 \change_deleted 564990737 1669755802
21058 Appendices may be added to the paper,
21062 the Acknowledgments and
21068 provides a special environment, called
21069 \begin_inset Quotes eld
21073 \begin_inset Quotes erd
21076 which marks the beginning of the appendices.
21077 This environment should be left blank; it just sends a \SpecialChar LaTeX
21078 command, but nothing
21080 In \SpecialChar LyX
21082 \begin_inset Quotes eld
21086 \begin_inset Quotes erd
21089 is printed with blue letters, as a signal that all sections after that
21090 point are appendices.
21091 To write an appendix, use the
21092 \begin_inset Quotes eld
21096 \begin_inset Quotes erd
21101 will number each appendix with capital letters, as required by both journals.
21103 \begin_inset Quotes eld
21107 \begin_inset Quotes erd
21114 be present before the first appendix; if not, all appendices will be numbered
21115 as normal sections in the output.
21118 \begin_layout Enumerate
21120 \change_deleted 564990737 1669755802
21121 The ijmpc and the ijmpd packages use the
21125 command to implement table captions.
21126 As a result, a table created by \SpecialChar LyX
21127 is printed correctly, but its caption
21129 However, you can use some \SpecialChar TeX
21130 code to overcome this problem, so that captions
21131 are printed as expected.
21132 To do so, create a float table as usual, remove the caption, and replace
21133 it with the \SpecialChar TeX
21144 (sic); you must also the \SpecialChar TeX
21149 immediately after the tabular material.
21150 Study the example table included in the template files to see how this
21151 trick is implemented.
21152 Alternatively, If you need table captions, you should implement the whole
21157 file, then include this file to the \SpecialChar LyX
21160 Insert\SpecialChar menuseparator
21161 File\SpecialChar menuseparator
21163 \begin_inset space ~
21169 Details on how to create a table float can be found in the files
21177 , included in the corresponding packages.
21180 \begin_layout Subsection
21182 \change_deleted 564990737 1669755802
21183 Preparing a paper for submission
21186 \begin_layout Standard
21188 \change_deleted 564990737 1669755802
21189 Before you submit your paper you must export the \SpecialChar LyX
21190 document as a \SpecialChar LaTeX
21193 File\SpecialChar menuseparator
21194 Export\SpecialChar menuseparator
21202 \begin_layout Plain Layout
21203 Actually you have the choice between \SpecialChar LaTeX
21204 (plain) and pdflatex.
21205 If you intend to use pdflatex to prepare the paper, you should use the
21206 pdflatex option so that included graphics are converted to PDF format,
21207 ready for use by pdflatex.
21212 , then make the following changes to the resulting
21219 \begin_layout Enumerate
21221 \change_deleted 564990737 1669755802
21222 Remove the comment lines before the
21231 \begin_layout Enumerate
21233 \change_deleted 564990737 1669755802
21234 Remove everything between (and including) the
21246 commands, except for any commands you specifically put into the \SpecialChar LaTeX
21250 \begin_layout Standard
21252 \change_deleted 564990737 1669755802
21257 file should be saved and processed through \SpecialChar LaTeX
21258 as many times as necessary.
21259 You may also want to check the resulting
21268 \begin_layout Section
21270 \change_deleted 564990737 1669801478
21274 \begin_layout Standard
21276 \change_deleted 564990737 1669801478
21282 \begin_layout Subsection
21284 \change_deleted 564990737 1669801478
21288 \begin_layout Standard
21290 \change_deleted 564990737 1669801478
21291 The iopart package provides a document class to create electronic manuscript
21292 submission to the journals published by the Institute of Physics.
21293 Instructions for the authors how to create a paper using the iopart class
21294 can be downloaded together with the iopart package from the site
21295 \begin_inset Flex URL
21298 \begin_layout Plain Layout
21300 ftp://ftp.iop.org/pub/journals/latex2e
21308 \begin_layout Subsection
21310 \change_deleted 564990737 1669801478
21314 \begin_layout Standard
21316 \change_deleted 564990737 1669801478
21317 The easiest way to write a paper is to start with the template
21321 that is available via
21323 File\SpecialChar menuseparator
21326 The template explains how to use the special text environments.
21327 Here are the most important advices:
21330 \begin_layout Itemize
21332 \change_deleted 564990737 1669801478
21333 To be able to compile your document to a PDF, PS, or DVI, ensure that the
21334 no AMS packages are loaded in
21336 Document\SpecialChar menuseparator
21337 Settings\SpecialChar menuseparator
21343 \begin_layout Itemize
21345 \change_deleted 564990737 1669801478
21348 The title environment defines the kind of your paper.
21349 So use one of the following environments for the title:
21353 \begin_layout Itemize
21355 \change_deleted 564990737 1669801478
21364 \begin_layout Itemize
21366 \change_deleted 564990737 1669801478
21375 \begin_layout Itemize
21377 \change_deleted 564990737 1669801478
21383 for a Topical review
21386 \begin_layout Itemize
21388 \change_deleted 564990737 1669801478
21397 \begin_layout Itemize
21399 \change_deleted 564990737 1669801478
21408 \begin_layout Itemize
21410 \change_deleted 564990737 1669801478
21416 for a Paper (same as Title)
21419 \begin_layout Itemize
21421 \change_deleted 564990737 1669801478
21427 for a Preliminary communication
21430 \begin_layout Itemize
21432 \change_deleted 564990737 1669801478
21438 for a Rapid communication
21441 \begin_layout Itemize
21443 \change_deleted 564990737 1669801478
21449 for a Letter to the editor
21453 \begin_layout Itemize
21455 \change_deleted 564990737 1669801478
21458 All title environments except of
21462 can have an optional short title.
21465 \begin_layout Itemize
21467 \change_deleted 564990737 1669801478
21468 There is a general title environment
21472 which is not directly supported by \SpecialChar LyX
21474 This can be used as \SpecialChar TeX
21475 code when your document doesn't fit into one of the
21479 \begin_layout Standard
21481 \change_deleted 564990737 1669801478
21482 For more informations like hints for special table and formula formatting,
21483 look at the IOP author guidelines.
21488 \begin_layout Section
21490 \change_deleted 564990737 1670317155
21494 \begin_layout Standard
21496 \change_deleted 564990737 1670317155
21499 Panayotis Papasotiriou
21502 \begin_layout Subsection
21504 \change_deleted 564990737 1670317155
21508 \begin_layout Standard
21510 \change_deleted 564990737 1670317155
21511 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
21512 that facilitates electronic manuscript submission to the journals they
21514 Most known of them (at least in my domain of interest) are
21516 Astrophysics and Space Science
21522 , but there are many others (see a complete list at
21523 \begin_inset Flex URL
21526 \begin_layout Plain Layout
21528 http://www.wkap.nl/jrnllist.htm/JRNLHOME
21534 The Kluwer package may be downloaded from the site
21535 \begin_inset Flex URL
21538 \begin_layout Plain Layout
21540 http://www.wkap.nl/kaphtml.htm/STYLEFILES
21546 A complete user guide is contained in that package (but it can also be
21547 downloaded separately).
21550 \begin_layout Standard
21552 \change_deleted 564990737 1670317155
21554 supports many features of the package but not everything.
21555 However, the \SpecialChar TeX
21556 code needed is reduced to some
21557 \begin_inset Quotes eld
21561 \begin_inset Quotes erd
21564 commands of the package (see
21565 \begin_inset space ~
21569 \begin_inset CommandInset ref
21571 reference "subsec:kluwer_peculiarities"
21576 I have recently used \SpecialChar LyX
21577 to write an article submitted to the
21579 Astrophysics and Space Science
21581 without any problem.
21584 \begin_layout Subsection
21586 \change_deleted 564990737 1670317155
21590 \begin_layout Standard
21592 \change_deleted 564990737 1670317155
21593 The easiest way to write a paper is to start with the Kluwer template file.
21596 File\SpecialChar menuseparator
21608 This will give an (almost) empty document that includes the most common
21609 fields found in a manuscript and a short description of their use.
21610 As in most templates, simply overwrite the existing text (including the
21615 ) with the correct information.
21618 \begin_layout Subsection
21620 \change_deleted 564990737 1670317155
21621 Preparing a paper for submission
21624 \begin_layout Standard
21626 \change_deleted 564990737 1670317155
21627 As in the AAS\SpecialChar TeX
21628 package, before you submit your paper to a journal you must
21630 \begin_inset Quotes eld
21634 \begin_inset Quotes erd
21640 \begin_layout Enumerate
21642 \change_deleted 564990737 1670317155
21643 Export your paper as a \SpecialChar LaTeX
21645 To do this, click on
21647 File\SpecialChar menuseparator
21648 Export\SpecialChar menuseparator
21656 \begin_layout Enumerate
21658 \change_deleted 564990737 1670317155
21663 file with a text editor and make the following changes
21667 \begin_layout Enumerate
21669 \change_deleted 564990737 1670317155
21670 remove the comment lines before the
21679 \begin_layout Enumerate
21681 \change_deleted 564990737 1670317155
21682 remove everything between (and including) the
21694 commands, except for any commands you specifically put into the \SpecialChar LaTeX
21698 \begin_layout Standard
21700 \change_deleted 564990737 1670317155
21709 \begin_layout Enumerate
21711 \change_deleted 564990737 1670317155
21716 file through \SpecialChar LaTeX
21717 as many times as necessary (usually up to three).
21720 \begin_layout Enumerate
21722 \change_deleted 564990737 1670317155
21728 \begin_inset space \thinspace{}
21732 \begin_inset space \space{}
21739 , and check if everything is OK (it should, if you didn't make any mistake).
21742 \begin_layout Subsection
21744 \change_deleted 564990737 1670317155
21745 \begin_inset Quotes eld
21749 \begin_inset Quotes erd
21752 of the Kluwer package
21753 \begin_inset CommandInset label
21755 name "subsec:kluwer_peculiarities"
21762 \begin_layout Standard
21764 \change_deleted 564990737 1670317155
21765 The Kluwer package has the following
21766 \begin_inset Quotes eld
21770 \begin_inset Quotes erd
21776 \begin_layout Enumerate
21778 \change_deleted 564990737 1670317155
21779 It is possible to write multiple articles in the same \SpecialChar LaTeX
21784 \begin_layout Plain Layout
21785 I can't imagine any good reason to do this.
21791 Each article must be included in the environment
21792 \begin_inset Quotes eld
21796 \begin_inset Quotes erd
21800 Unfortunately, this environment cannot be omitted, even if you write just
21802 Therefore, each article starts with the command
21808 and, obviously, ends with the command
21815 Although this can be implemented in \SpecialChar LyX
21816 , I didn't included it, since it looks
21817 ugly and can confuse the novice user.
21818 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
21821 \begin_inset Quotes eld
21826 \begin_inset Quotes erd
21832 \begin_layout Enumerate
21834 \change_deleted 564990737 1670317155
21835 Information given at the beginning of the article (i.
21836 \begin_inset space \thinspace{}
21840 \begin_inset space \space{}
21843 title, subtitle, author, institution, running title, running author, abstract
21844 and keywords) must be included in an environment called
21845 \begin_inset Quotes eld
21849 \begin_inset Quotes erd
21853 This is not implemented in \SpecialChar LyX
21854 , so you must enter title, subtitle etc.
21855 \begin_inset space ~
21858 between two \SpecialChar TeX
21874 \begin_layout Enumerate
21876 \change_deleted 564990737 1670317155
21877 According to the user manual, the label of each bibliography item must be
21901 \begin_layout Standard
21903 \change_deleted 564990737 1670317155
21908 template takes care of all these
21909 \begin_inset Quotes eld
21913 \begin_inset Quotes erd
21917 If you start a new paper using this template you don't need to do anything
21922 \begin_layout Enumerate
21924 \change_deleted 564990737 1670317155
21925 don't delete the \SpecialChar TeX
21926 code included in the template, and
21929 \begin_layout Enumerate
21931 \change_deleted 564990737 1670317155
21932 copy the example bibliography item included in the template and modify it
21933 as necessary to enter new bibliography items.
21936 \begin_layout Section
21938 \change_deleted 564990737 1671097446
21942 \begin_layout Standard
21944 \change_deleted 564990737 1671097446
21949 provides an alternative to the standard
21954 It provides similar functionality, but you might prefer this layout with
21955 sans serif sections, headings, and more.
21958 \begin_layout Section
21960 \change_deleted 564990737 1671097446
21961 Springer Journals (
21968 \begin_layout Standard
21970 \change_deleted 564990737 1671097446
21976 \begin_layout Subsection
21978 \change_deleted 564990737 1671097446
21982 \begin_layout Standard
21984 \change_deleted 564990737 1671097446
21985 These are the layout files for some of the journal formats used by Springer
21986 Verlag and listed on
21987 \begin_inset Flex URL
21990 \begin_layout Plain Layout
21992 http://www.springer.de/author/tex/help-journals.html
21997 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
21999 It is a modular system: the things common to all journals are implemented
22004 , which journal-specific layout files (such as, e.
22005 \begin_inset space \thinspace{}
22009 \begin_inset space \space{}
22016 for Journal of Geodesy) can include.
22019 \begin_layout Standard
22021 \change_deleted 564990737 1671097446
22022 This means that implementing support for any other Springer journal on this
22023 list is as simple as writing your own
22031 file following the outline given in
22039 \begin_layout Standard
22041 \change_deleted 564990737 1671097446
22042 It is reasonably well tested only for the Journal of Geodesy.
22051 come with the standard \SpecialChar LyX
22053 Install the relevant class file (downloaded from Springer) in a proper
22054 directory, reconfigure \SpecialChar LaTeX
22055 (in the te\SpecialChar TeX
22060 , as root if necessary — doesn't \SpecialChar LyX
22061 take care of this?), reconfigure \SpecialChar LyX
22066 \begin_layout Subsection
22068 \change_deleted 564990737 1671097446
22072 \begin_layout Standard
22074 \change_deleted 564990737 1671097446
22075 A large number of theorem-like styles —
22087 \begin_layout Standard
22089 \change_deleted 564990737 1671097446
22092 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
22093 _Title, Author_Running, Institute,
22094 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
22097 See the Springer class file documentation for details.
22100 \begin_layout Subsection
22102 \change_deleted 564990737 1671097446
22106 \begin_layout Itemize
22108 \change_deleted 564990737 1671097446
22120 \begin_layout Itemize
22122 \change_deleted 564990737 1671097446
22125 Probability Theory and Related Fields
22131 — Jean-Marc Lasgouttes
22134 \begin_layout Standard
22136 \change_deleted 564990737 1671097446
22137 Add your own, it isn't so hard!
22140 \begin_layout Subsection
22142 \change_deleted 564990737 1671097446
22146 \begin_layout Standard
22148 \change_deleted 564990737 1671097446
22149 These files are partly based on the older
22153 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
22155 file from Springer.
22160 layout, are now defunct.
22161 Jean-Marc Lasgouttes helped out big in making me find my way around the
22163 layout file mechanism.
22166 \begin_layout Subsection
22168 \change_deleted 564990737 1671097446
22172 \begin_layout Standard
22174 \change_deleted 564990737 1671097446
22176 But probably less than in the old hacked-\SpecialChar LaTeX
22184 \begin_layout Chapter
22186 Features needing Extra Software
22189 \begin_layout Section
22190 Checking \SpecialChar TeX
22194 \begin_layout Standard
22200 \begin_layout Subsection
22204 \begin_layout Standard
22213 \begin_layout Plain Layout
22218 is not yet available when you are using the \SpecialChar LaTeX
22219 distribution MiK\SpecialChar TeX
22225 , you'll find in the
22232 \begin_inset space ~
22243 \begin_inset Newline newline
22247 \begin_inset CommandInset href
22249 target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
22257 \begin_layout Standard
22260 Chk\SpecialChar TeX
22263 package is a program that was written by
22264 \begin_inset Flex Noun
22267 \begin_layout Plain Layout
22269 \begin_inset space ~
22277 in frustration because some constructs in \SpecialChar LaTeX
22278 are sometimes non-intuitive,
22279 and easy to forget.
22280 The program runs over your \SpecialChar LaTeX
22281 file, checks the integrity of the file, and
22282 flags some common errors.
22283 In other technical words, it is
22287 for \SpecialChar LaTeX
22291 \begin_layout Standard
22292 Well, what is a syntax checker doing in \SpecialChar LyX
22293 which is supposed to produce correct
22295 anyways? The answer is simple: Just as
22299 not only checks the
22303 of C programs, but also does
22307 checks for type-errors,
22309 Chk\SpecialChar TeX
22312 catches some common
22316 errors, in addition to the syntactical ones.
22319 Chk\SpecialChar TeX
22322 is capable of detecting several common errors, such as
22325 \begin_layout Itemize
22326 Ellipsis detection:
22327 \begin_inset Newline newline
22330 Use \SpecialChar ldots
22334 \begin_layout Itemize
22335 No space in front of/after parenthesis:
22336 \begin_inset Newline newline
22342 \begin_layout Itemize
22343 Enforcement of normal space after common abbreviations:
22344 \begin_inset Newline newline
22348 \begin_inset space \thinspace{}
22352 \begin_inset space \space{}
22355 is too wide spacing.
22358 \begin_layout Itemize
22359 Enforcement of end-of-sentence space when the last sentence ends with a
22361 \begin_inset Newline newline
22365 And this is wrong spacing.
22368 \begin_layout Itemize
22369 Space in front of labels and similar commands:
22370 \begin_inset Newline newline
22373 The label should stick right up to the text to avoid falling to a wrong
22376 \begin_inset CommandInset label
22386 \begin_layout Plain Layout
22387 This footnote is in danger of falling off to a wrong page
22392 The label is separated too much.
22395 \begin_layout Itemize
22396 Space in front of references, instead of hard spaces:
22397 \begin_inset Newline newline
22400 If you have bad luck, the text will break right between the referenced text
22401 and reference number, and that's a pity.
22403 \begin_inset CommandInset ref
22405 reference "sec:chktex"
22412 \begin_layout Itemize
22414 \begin_inset Quotes eld
22418 \begin_inset Quotes erd
22422 \begin_inset Formula $\times$
22426 \begin_inset Newline newline
22429 2x2 looks cheap compared to
22430 \begin_inset Formula $2\times2$
22436 \begin_layout Standard
22437 and more \SpecialChar ldots
22438 It is an invaluable tool when you are
22439 \begin_inset Quotes eld
22443 \begin_inset Quotes erd
22446 your document before printing, and you should run it right after the obligatory
22447 spelling check, and before you go fine tuning the typesetting.
22450 \begin_layout Subsection
22454 \begin_layout Standard
22455 If you have the program installed, usage is as simple as choosing
22457 Tools\SpecialChar menuseparator
22459 \begin_inset space ~
22465 This will make \SpecialChar LyX
22466 generate a \SpecialChar LaTeX
22467 file of your document, start
22469 Chk\SpecialChar TeX
22472 to check it, and then make \SpecialChar LyX
22474 \begin_inset Quotes eld
22478 \begin_inset Quotes erd
22481 with the warnings from
22483 Chk\SpecialChar TeX
22486 , if there were any.
22487 The warnings will be placed close to the point of the mistake, and you
22488 can quickly find them by using the
22490 Navigate\SpecialChar menuseparator
22493 menu item, or the shortcut key
22502 Open the error boxes by clicking on them with the mouse, or use the shortcut
22511 bindings, or the corresponding
22520 Read the warning and correct the mistake, if it is a mistake.
22521 If you have trouble understanding what the warning is about, you can safely
22523 Remember that there is a hidden layer between the document on screen and
22524 the technical details in invoking
22526 Chk\SpecialChar TeX
22529 , and this gap can make some warnings seem arcane or just plain silly.
22532 \begin_layout Standard
22533 This document is an excellent testing bed for the feature, and it should
22534 provide quite a few warnings for you to fiddle with.
22535 Since computers are only so smart, expect most of the warnings to be false
22539 \begin_layout Subsection
22540 How to fine tune it
22543 \begin_layout Standard
22544 Sometimes, you'll find that
22546 Chk\SpecialChar TeX
22549 makes more noise than suits your mood.
22550 Then you can choose not to use it, wait until your mood changes, or try
22553 Chk\SpecialChar TeX
22556 to get better along with you.
22559 \begin_layout Standard
22562 Chk\SpecialChar TeX
22569 very configurable and extensible, you should not expect to solve all problems
22572 Chk\SpecialChar TeX
22575 in \SpecialChar LyX
22577 Since \SpecialChar LyX
22578 has to generate a somewhat special \SpecialChar LaTeX
22579 file to be able to match the
22580 line numbers from the
22582 Chk\SpecialChar TeX
22589 \begin_layout Plain Layout
22590 You can inspect the specific output from
22596 Document\SpecialChar menuseparator
22599 \begin_inset space ~
22613 to the internal document structure, some of the warnings will not appear
22615 There are two things you can do about this:
22618 \begin_layout Itemize
22621 Chk\SpecialChar TeX
22624 invocation command line in
22625 \begin_inset Flex Noun
22628 \begin_layout Plain Layout
22629 Tools\SpecialChar menuseparator
22630 Preferences\SpecialChar menuseparator
22631 Output\SpecialChar menuseparator
22632 LaTeX\SpecialChar menuseparator
22640 Chk\SpecialChar TeX
22643 installation configuration file (usually with the file
22648 See below to learn what warnings can be enabled and disabled on the command
22652 \begin_layout Itemize
22653 Export your document as a raw \SpecialChar LaTeX
22656 File\SpecialChar menuseparator
22657 Export\SpecialChar menuseparator
22666 Invoked in this way, it can be a hassle to find the corresponding place
22667 in the document inside \SpecialChar LyX
22668 , but with a little patience, you should be able
22672 \begin_layout Standard
22673 Here follows the warning messages that can be enabled and disabled in
22682 to disable a warning, and
22686 to enable a warning.
22687 The emphasized entries are disabled by default, because the default is
22690 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
22695 \begin_layout Standard
22696 Notice that you should only use the options that enable and disable warnings,
22697 because \SpecialChar LyX
22698 relies on some of the other command line parameters to be set
22699 in a specific way to have a chance to communicate with
22706 \begin_layout Enumerate
22710 Command terminated with space.
22713 \begin_layout Enumerate
22716 Non-breaking space (
22717 \begin_inset Quotes eld
22725 \begin_inset Quotes erd
22728 ) should have been used.
22731 \begin_layout Enumerate
22735 You should enclose the previous parenthesis with
22736 \begin_inset Quotes eld
22744 \begin_inset Quotes erd
22750 \begin_layout Enumerate
22753 Italic correction (
22754 \begin_inset Quotes eld
22764 \begin_inset Quotes erd
22767 ) found in non-italic buffer.
22770 \begin_layout Enumerate
22773 Italic correction (
22774 \begin_inset Quotes eld
22784 \begin_inset Quotes erd
22787 ) found more than once.
22790 \begin_layout Enumerate
22794 No italic correction (
22795 \begin_inset Quotes eld
22805 \begin_inset Quotes erd
22811 \begin_layout Enumerate
22815 \begin_inset Quotes eld
22823 \begin_inset Quotes erd
22827 \begin_inset Quotes eld
22835 \begin_inset Quotes erd
22841 \begin_layout Enumerate
22844 Wrong length of dash may have been used.
22847 \begin_layout Enumerate
22851 \begin_inset Quotes eld
22859 \begin_inset Quotes erd
22863 \begin_inset Quotes eld
22871 \begin_inset Quotes erd
22877 \begin_layout Enumerate
22881 \begin_inset Quotes eld
22889 \begin_inset Quotes erd
22895 \begin_layout Enumerate
22899 \begin_inset Quotes eld
22907 \begin_inset Quotes erd
22910 to achieve an ellipsis.
22913 \begin_layout Enumerate
22916 Inter-word spacing (
22917 \begin_inset Quotes eld
22927 \begin_inset Quotes eld
22930 ) should perhaps be used.
22933 \begin_layout Enumerate
22936 Inter-sentence spacing (
22937 \begin_inset Quotes eld
22947 \begin_inset Quotes erd
22950 ) should perhaps be used.
22953 \begin_layout Enumerate
22956 Could not find argument for command.
22959 \begin_layout Enumerate
22963 \begin_inset Quotes eld
22971 \begin_inset Quotes erd
22977 \begin_layout Enumerate
22980 Math mode still on at end of \SpecialChar LaTeX
22984 \begin_layout Enumerate
22988 \begin_inset Quotes eld
22996 \begin_inset Quotes erd
22999 doesn't match the number of
23000 \begin_inset Quotes eld
23008 \begin_inset Quotes erd
23014 \begin_layout Enumerate
23017 You should use either
23020 \begin_inset Quotes eld
23028 \begin_inset Quotes erd
23033 as an alternative to
23034 \begin_inset Quotes eld
23042 \begin_inset Quotes erd
23048 \begin_layout Enumerate
23055 " (ASCII 39) instead of "
23062 \begin_layout Enumerate
23065 User-specified pattern found.
23068 \begin_layout Enumerate
23071 This command might not be intended.
23074 \begin_layout Enumerate
23081 \begin_layout Enumerate
23099 \begin_layout Enumerate
23102 Delete this space to maintain correct page references.
23105 \begin_layout Enumerate
23109 You might wish to put this between a pair of
23110 \begin_inset Quotes eld
23118 \begin_inset Quotes erd
23124 \begin_layout Enumerate
23127 You ought to remove spaces in front of punctuation.
23130 \begin_layout Enumerate
23133 Could not execute \SpecialChar LaTeX
23137 \begin_layout Enumerate
23146 in front of small punctuation.
23149 \begin_layout Enumerate
23157 may look prettier here.
23160 \begin_layout Enumerate
23164 Multiple spaces detected in output.
23167 \begin_layout Enumerate
23170 This text may be ignored.
23173 \begin_layout Enumerate
23179 \begin_inset Quotes eld
23184 to begin quotation, not
23191 \begin_layout Enumerate
23198 to end quotation, not
23201 \begin_inset Quotes eld
23209 \begin_layout Enumerate
23215 \begin_layout Enumerate
23218 You should perhaps use
23219 \begin_inset Quotes eld
23227 \begin_inset Quotes erd
23233 \begin_layout Enumerate
23236 You should put a space in front of/after parenthesis.
23239 \begin_layout Enumerate
23242 You should avoid spaces in front of/after parenthesis.
23245 \begin_layout Enumerate
23249 You should not use punctuation in front of/after quotes.
23252 \begin_layout Enumerate
23255 Double space found.
23258 \begin_layout Enumerate
23261 You should put punctuation outside inner/inside display math mode.
23264 \begin_layout Enumerate
23267 You ought to not use primitive \SpecialChar TeX
23268 in \SpecialChar LaTeX
23272 \begin_layout Enumerate
23275 You should remove spaces in front of
23276 \begin_inset Quotes eld
23284 \begin_inset Quotes erd
23290 \begin_layout Enumerate
23293 \begin_inset Quotes eld
23301 \begin_inset Quotes erd
23304 is normally not followed by
23305 \begin_inset Quotes eld
23313 \begin_inset Quotes erd
23319 \begin_layout Standard
23320 In later versions of \SpecialChar LyX
23321 , we hope to provide a more complete interface to this
23322 tool (and it's smaller cousin
23326 ) to exploit the full power of it.
23327 But it's not exactly useless as it is now: go try it on one of your existing
23328 documents of a certain length and be surprised.
23331 \begin_layout Section
23332 Version Control in \SpecialChar LyX
23336 \begin_layout Standard
23339 Lars Gullik Bjønnes
23346 \begin_layout Subsection
23350 \begin_layout Standard
23352 supports some of the most basic RCS/CVS/SVN/GIT commands.
23353 If you need something a bit more sophisticated you will have to do that
23354 manually in a terminal.
23357 \begin_layout Standard
23358 Also note that CVS support is not as good as subversion support, so we advise
23360 A good place to start learning Subversion is the SVN Book
23364 \begin_layout Plain Layout
23365 \begin_inset CommandInset href
23367 target "http://svnbook.red-bean.com/"
23378 In the case of RCS you should read
23379 \begin_inset Quotes eld
23383 \begin_inset Quotes erd
23386 (a man file, read it with
23391 This file describes all the basic features of RCS.
23392 You should especially notice the comment about a RCS directory, and the
23393 notion of a master RCS file (the file ending in
23400 \begin_layout Standard
23401 Before you begin to use the version control features in \SpecialChar LyX
23403 familiar with RCS/CVS/SVN/GIT usage.
23404 The implementation in \SpecialChar LyX
23405 assumes a recent version of the GNU RCS or CVS/SVN
23406 package — no guarantees are made for older versions.
23407 Most of the log messages are not currently displayed after operations —
23408 you can check them in the Messages pane if you are unsure.
23409 Regular users of version control will appreciate the VC toolbar, which
23412 View\SpecialChar menuseparator
23413 Toolbars\SpecialChar menuseparator
23415 \begin_inset space ~
23423 \begin_layout Standard
23424 For introducing your own external commands consult
23425 \begin_inset Flex Code
23428 \begin_layout Plain Layout
23442 \begin_layout Standard
23443 It is strongly recommended to store documents in uncompressed format if
23444 using version control (uncheck
23446 Document\SpecialChar menuseparator
23449 if it is checked): Uncompressed LyX documents are text files and therefore
23450 for merging two different versions by version control systems.
23451 Compressed LyX documents are binary files, which cannot be merged by version
23455 \begin_layout Subsection
23456 RCS commands in \SpecialChar LyX
23460 \begin_layout Standard
23461 The following sections describe the RCS commands supported by \SpecialChar LyX
23463 You can find them in the
23465 File\SpecialChar menuseparator
23467 \begin_inset space ~
23474 was tested against RCS 5.7/5.8.
23477 \begin_layout Subsubsection
23483 \begin_layout Standard
23484 If your document is not under revision control, this is the only item shown
23486 And if it is under revision control, the
23490 item is not visible.
23494 \begin_layout Standard
23495 This command registers your document with RCS (unless you are under the
23496 directory managed by CVS)\SpecialChar endofsentence
23497 You are asked interactively to supply an initial
23498 description of the document.
23499 The document is now set in Read-Only mode and you have to
23502 \begin_inset space ~
23506 \begin_inset space ~
23510 \begin_inset space ~
23515 , before making any changes to it.
23516 A document under revision control has a
23517 \begin_inset Quotes eld
23520 [RCS:<version> <locker>]
23521 \begin_inset Quotes erd
23524 item tagged to the filename in the minibuffer.
23527 \begin_layout Standard
23528 RCS command that is run:
23531 \begin_layout LyX-Code
23534 ci -q -u -i -t-"<initial description>" <file-name>
23537 \begin_layout Standard
23542 to understand the switches.
23546 \begin_layout Subsubsection
23552 \begin_layout Standard
23553 When you are finished editing a file, you check in your changes.
23554 When you do this, you are asked for a description of the changes.
23555 This is stored in the history log.
23556 The version number is bumped, your changes are applied to the master RCS
23557 file, the document is unlocked and set to Read-Only mode.
23560 \begin_layout Itemize
23563 ci -q -u -m"<description>" <file-name>
23566 \begin_layout Subsubsection
23572 \begin_layout Standard
23573 By doing this you lock the document so that only you can edit it.
23574 This will also make the document Read-Write only for you.
23575 You will usually continue editing for a while and when you are finished
23576 you check in your changes.
23577 The status line is changed to reflect that you have locked the file.
23580 \begin_layout Itemize
23583 co -q -l <file-name>
23586 \begin_layout Subsubsection
23589 Revert To Repository Version
23592 \begin_layout Standard
23593 This will discard all changes made to the document since the last check
23595 You get a warning before changes are discarded.
23598 \begin_layout Itemize
23601 co -f -u<version> <file-name>
23604 \begin_layout Subsubsection
23610 \begin_layout Standard
23611 This will create a copy of the current document.
23612 Since RCS does not support copy operations natively, the version history
23613 is not preserved, and the copy is added as a new file.
23614 It requires a clean document without any changes since the last checkin.
23615 You are asked for a file name and a description of the copy operation.
23616 After that the copy is created, both locally and in the repository.
23617 If the parent directories of the copied and original document differ, all
23618 relative paths of included files of the copy are adjusted (like in
23620 File\SpecialChar menuseparator
23625 Finally, the copy is loaded instead of the original document.
23628 \begin_layout Labeling
23629 \labelwidthstring 00.00.0000
23631 \begin_inset space ~
23635 \begin_inset space ~
23639 \begin_inset Newline newline
23643 \begin_inset Flex Code
23646 \begin_layout Plain Layout
23649 \begin_inset Quotes qld
23653 \begin_inset Quotes qld
23662 \begin_inset Flex Code
23665 \begin_layout Plain Layout
23668 \begin_inset Quotes qld
23672 \begin_inset Quotes qld
23681 \begin_inset Newline newline
23685 \begin_inset Flex Code
23688 \begin_layout Plain Layout
23692 \begin_inset Quotes qld
23696 \begin_inset Quotes qld
23707 \begin_layout Subsubsection
23713 \begin_layout Standard
23714 This makes as if the last check in never happened.
23715 No changes are made to the document loaded into \SpecialChar LyX
23716 , but the last version
23717 is removed from the master RCS file.
23720 \begin_layout Itemize
23723 rcs -o<version> <file-name>
23726 \begin_layout Subsubsection
23732 \begin_layout Standard
23733 This shows the complete history of the RCS document.
23738 is shown in a browser.
23746 \begin_layout Subsubsection
23750 \begin_layout Standard
23752 supports RCS version number, author name, date and time of last commit.
23753 All those are extracted from
23755 rlog -r <file-name>
23759 \begin_inset CommandInset ref
23761 reference "subsec:VCS-Revision-Information"
23768 \begin_layout Subsection
23769 CVS commands in \SpecialChar LyX
23773 \begin_layout Standard
23774 A subset of CVS operations is supported by \SpecialChar LyX
23776 You can find the commands in the
23778 File\SpecialChar menuseparator
23780 \begin_inset space ~
23786 The version control system SVN is more powerful, so please use it instead
23787 of CVS if possible.
23790 \begin_layout Subsubsection
23796 \begin_layout Standard
23797 If you start from scratch with CVS you have to create your repository and
23798 checkout the working copy with external tools.
23799 If you're using a client-server setup you may need to login before doing
23800 the first repository checkout.
23803 \begin_layout Standard
23804 If your documents are under revision control and others are using the same
23805 repository problems arise when different changes to the same document at
23806 the same location happen.
23807 Standard CVS repositories don't operate with a file locking mechanism.
23808 This may be surprising, but conflicts only occur if people disagree on
23809 the proper content of the same part of a document.
23810 So, if co-workers are used to communicate regularly, these conflicts occur
23812 If they don't communicate they have a fundamental problem anyway.
23813 Nevertheless some people like to work with so called
23814 \begin_inset Quotes eld
23818 \begin_inset Quotes erd
23822 If they do so the working copy of all files is readonly when checked out
23823 first and the user starts editing after using a special command to make
23824 the working copy writable.
23825 When the changes are checked in the working copy returns to readonly state.
23826 With \SpecialChar LyX
23827 one has to edit the
23828 \begin_inset Flex Code
23831 \begin_layout Plain Layout
23837 file and add the line
23838 \begin_inset Flex Code
23841 \begin_layout Plain Layout
23847 to work with reserved checkouts.
23848 The benefit is the possibility to see who is using a writable copy of some
23850 It's not guaranteed only one user makes a copy writable.
23853 \begin_layout Standard
23855 tries to guess if you're using reserved or non-reserved checkouts.
23856 If your working copy is readonly or it is writable and an additional copy
23857 of your document exists in the CVS/Base sub-directory a reserved otherwise
23858 a non-reserved checkout is assumed.
23859 When a reserved checkout is detected you have to use
23860 \begin_inset Flex Noun
23863 \begin_layout Plain Layout
23869 to make your working copy writable if it's readonly.
23871 \begin_inset Flex Noun
23874 \begin_layout Plain Layout
23880 operation is possible and that makes your working copy readonly again after
23881 transferring your changes to the repository.
23884 \begin_layout Standard
23885 More information about CVS can be found here
23886 \begin_inset Flex URL
23889 \begin_layout Plain Layout
23891 http://www.nongnu.org/cvs
23897 \begin_inset Flex URL
23900 \begin_layout Plain Layout
23902 http://ximbiot.com/cvs
23910 \begin_layout Standard
23915 to understand the sub-commands and the switches mentioned below.
23918 \begin_layout Subsubsection
23924 \begin_layout Standard
23925 If your document is not under revision control, this is the only item shown
23927 And if it is under revision control, the
23931 item is not visible.
23935 \begin_layout Standard
23936 This command registers in CVS your document
23937 \begin_inset Flex Strong
23940 \begin_layout Plain Layout
23948 in the case you have already the documents directory under CVS control
23954 This means you have to create or checkout the archive by yourself using
23956 (In case you forget that step \SpecialChar LyX
23957 registers the document with RCS.)
23960 \begin_layout Standard
23961 Then you are asked interactively to supply an initial description of the
23963 Don't forget that registered file is not yet checked in.
23966 \begin_layout Standard
23967 CVS command that is run:
23969 cvs -q add -m"<entered message>" "<file-name>"
23972 \begin_layout Standard
23977 above and for all other CVS commands is an abbreviation for
23978 \begin_inset Quotes eld
23981 change the current working directory to file location and use the file name
23982 without path component as argument
23983 \begin_inset Quotes erd
23989 \begin_layout Subsubsection
23995 \begin_layout Standard
23996 When you are finished editing a file, you commit your changes.
23997 When you do this and you had changed the document, you are asked for a
23998 description of the changes.
23999 After that changes are written to the repository.
24000 In case you didn't change the document and a reserved checkout is detected
24001 the reservation made on
24002 \begin_inset Flex Noun
24005 \begin_layout Plain Layout
24014 \begin_layout Labeling
24015 \labelwidthstring 00.00.0000
24017 \begin_inset space ~
24021 \begin_inset space ~
24025 \begin_inset Newline newline
24029 \begin_inset Flex Code
24032 \begin_layout Plain Layout
24035 -q commit -m"<description>" "<file-name>"
24041 \begin_inset Newline newline
24045 \begin_inset Flex Code
24048 \begin_layout Plain Layout
24059 \begin_layout Subsubsection
24065 \begin_layout Standard
24066 When you are sharing a repository with others, you may have to incorporate
24067 their changes into your working copy.
24070 \begin_layout Standard
24073 cvs -q update "<file-name>"
24076 \begin_layout Standard
24077 If a readonly checkout is detected the working copy is made writable and
24081 \begin_layout Standard
24084 cvs -q edit "<file-name>"
24087 \begin_layout Subsubsection
24090 Revert To Repository Version
24093 \begin_layout Standard
24094 This will discard all changes made to the document since the last check
24096 You get a warning before changes are discarded.
24097 Firstly the file is deleted, secondly CVS update command is run.
24100 \begin_layout Standard
24103 cvs -q update "<file-name>"
24106 \begin_layout Standard
24107 If a reserved checkout is detected and the working copy has no changes only
24108 the reservation is undone.
24111 \begin_layout Standard
24114 cvs -q unedit "<file-name>"
24117 \begin_layout Subsubsection
24123 \begin_layout Standard
24124 This will create a copy of the current document.
24125 Since CVS does not support copy operations natively, the version history
24126 is not preserved, and the copy is added as a new file.
24127 It requires a clean document without any changes since the last checkin.
24128 You are asked for a file name and a description of the copy operation.
24129 After that the copy is created, both locally and in the repository.
24130 If the parent directories of the copied and original document differ, all
24131 relative paths of included files of the copy are adjusted (like in
24133 File\SpecialChar menuseparator
24138 Finally, the copy is loaded instead of the original document.
24141 \begin_layout Labeling
24142 \labelwidthstring 00.00.0000
24144 \begin_inset space ~
24148 \begin_inset space ~
24152 \begin_inset Newline newline
24156 \begin_inset Flex Code
24159 \begin_layout Plain Layout
24166 \begin_inset Flex Code
24169 \begin_layout Plain Layout
24176 \begin_inset Newline newline
24180 \begin_inset Flex Code
24183 \begin_layout Plain Layout
24184 cvs -q add "<new-file-name>"
24192 \begin_layout Subsubsection
24198 \begin_layout Standard
24199 This will rename the current document.
24200 Since CVS does not support rename operations natively, the version history
24201 is not preserved, the renamed document is added as a new file, and the
24202 original document is deleted.
24203 It requires a clean document without any changes since the last checkin.
24204 You are asked for a file name and a description of the rename operation.
24205 After that the document is renamed, both locally and in the repository.
24206 If the parent directories of the new and old file names differ, all relative
24207 paths of included files are adjusted (like in
24209 File\SpecialChar menuseparator
24214 Finally, the document is reloaded using the new name.
24217 \begin_layout Labeling
24218 \labelwidthstring 00.00.0000
24220 \begin_inset space ~
24224 \begin_inset space ~
24228 \begin_inset Newline newline
24232 \begin_inset Flex Code
24235 \begin_layout Plain Layout
24242 \begin_inset Flex Code
24245 \begin_layout Plain Layout
24252 \begin_inset Newline newline
24256 \begin_inset Flex Code
24259 \begin_layout Plain Layout
24260 cvs -q add "<new-file-name>"
24266 \begin_inset Newline newline
24270 \begin_inset Flex Code
24273 \begin_layout Plain Layout
24274 cvs -q remove "<file-name>"
24282 \begin_layout Subsubsection
24283 Update of the local directory checkout from repository
24286 \begin_layout Standard
24287 Once your documents gets more complex, containing sub-documents and pictures,
24289 \begin_inset Flex Code
24292 \begin_layout Plain Layout
24298 files and so on using version control becomes more complicated.
24300 supports updating the whole tree in which resides the document.
24301 This become especially useful once you cooperate with people which neither
24302 have detailed knowledge about CVS usage nor they have ambition to commit
24303 additional material to the repository.
24304 You have to organize the files structure so that all external files are
24305 in the same directory or subdirectories of the document.
24306 It's good practice anyway to store multipart documents in an extra directory.
24309 \begin_layout Standard
24311 \begin_inset Flex Code
24314 \begin_layout Plain Layout
24315 Update local directory from repository
24320 command updates the whole directory.
24321 If local changes are detected user is warned before update starts.
24322 In case of merge conflicts both versions of the conflicting document parts
24323 are placed in the final document.
24324 You have to review and correct the result of the merge.
24325 You'll find the conflicts enclosed in pairs of
24326 \begin_inset Flex Code
24329 \begin_layout Plain Layout
24336 \begin_inset Flex Code
24339 \begin_layout Plain Layout
24346 \begin_inset Flex Code
24349 \begin_layout Plain Layout
24356 The first part is your version as before the update operation with the
24357 document name prepended.
24358 The second one is the repository version with the version number after
24360 \begin_inset Flex Code
24363 \begin_layout Plain Layout
24372 \begin_layout Labeling
24373 \labelwidthstring 00.00.0000
24375 \begin_inset space ~
24379 \begin_inset space ~
24383 \begin_inset Newline newline
24387 \begin_inset Flex Code
24390 \begin_layout Plain Layout
24398 (Ask if changes are detected.)
24399 \begin_inset Newline newline
24403 \begin_inset Flex Code
24406 \begin_layout Plain Layout
24407 cd $path; cvs -q update
24417 \begin_layout Standard
24419 \begin_inset Flex Code
24422 \begin_layout Plain Layout
24428 stands for the path to the document.
24431 \begin_layout Subsubsection
24437 \begin_layout Standard
24438 This shows the complete history of the CVS document.
24441 cvs log "<file-name>"
24443 is shown in a browser.
24446 \begin_layout Subsubsection
24450 \begin_layout Standard
24452 supports CVS version number, author name, date and time of last commit.
24453 All those are extracted from
24455 cvs log -r <file-name>
24459 \begin_inset CommandInset ref
24461 reference "subsec:VCS-Revision-Information"
24468 \begin_layout Subsection
24469 SVN commands in \SpecialChar LyX
24473 \begin_layout Standard
24474 SVN is now partially supported by \SpecialChar LyX
24476 You can find the commands in the
24478 File\SpecialChar menuseparator
24480 \begin_inset space ~
24486 Please note that if you use password protected access to repository via
24487 ssh, you will be asked in terminal window.
24489 was tested against SVN 1.5, 1.6, 1.7 and 1.8
24493 \begin_layout Plain Layout
24494 Most of the commands will work with 1.4 too, see
24495 \begin_inset CommandInset ref
24497 reference "subsec:SVN-Repo-Update"
24502 There seems to be currently unresolved permissions problem under SVN 1.8
24503 with reverting changes when file is locked.
24511 \begin_layout Subsubsection
24517 \begin_layout Standard
24518 If your document is not under revision control, this is the only item shown
24520 And if it is under revision control, the
24524 item is not visible.
24527 \begin_layout Standard
24528 This command registers in SVN your document ONLY in case you have already
24529 the documents directory under SVN control (in particular
24534 This means you have to checkout the archive by yourself.
24537 \begin_layout Standard
24538 Then you are asked interactively to supply an initial description of the
24540 Don't forget that registered file is not yet commited.
24543 \begin_layout Standard
24544 SVN command that is run:
24547 \begin_inset Quotes qld
24551 \begin_inset Quotes qld
24557 \begin_layout Standard
24562 to understand the switches.
24565 \begin_layout Subsubsection
24571 \begin_layout Standard
24572 When you are finished editing a file, you commit your changes.
24573 When you do this, you are asked for a description of the changes.
24574 After that changes are commited.
24577 \begin_layout Standard
24582 \begin_layout Plain Layout
24583 In case locking is not enabled.
24585 \begin_inset CommandInset ref
24587 reference "subsec:SVN-File-Locking"
24598 svn commit -q -m"<description>" <file-name>
24601 \begin_layout Subsubsection
24607 \begin_layout Standard
24608 Updates the changes of this file from the repository.
24609 Be sure you understand SVN merging and conflicts resolving before using
24610 this function, because all conflicts has to be resolved manually by you!
24613 \begin_layout Standard
24618 \begin_layout Plain Layout
24626 svn update --non-interactive
24627 \begin_inset Quotes qld
24631 \begin_inset Quotes qld
24637 \begin_layout Subsubsection
24640 Revert To Repository Version
24643 \begin_layout Standard
24644 This will discard all changes made to the document since the last check
24646 You get a warning before changes are discarded.
24649 \begin_layout Standard
24653 \begin_inset Quotes qld
24657 \begin_inset Quotes qld
24663 \begin_layout Subsubsection
24669 \begin_layout Standard
24670 This will create a copy of the current document including the version history.
24671 It requires a clean document without any changes since the last checkin.
24672 You are asked for a file name and a description of the copy operation.
24673 After that the copy is created, both locally and in the repository.
24674 If the parent directories of the copied and original document differ, all
24675 relative paths of included files of the copy are adjusted (like in
24677 File\SpecialChar menuseparator
24682 Finally, the copy is loaded instead of the original document.
24685 \begin_layout Labeling
24686 \labelwidthstring 00.00.0000
24688 \begin_inset space ~
24692 \begin_inset space ~
24696 \begin_inset Newline newline
24700 \begin_inset Flex Code
24703 \begin_layout Plain Layout
24707 \begin_inset Quotes qld
24711 \begin_inset Quotes qld
24715 \begin_inset Quotes qld
24719 \begin_inset Quotes qld
24728 \begin_inset Newline newline
24732 \begin_inset Flex Code
24735 \begin_layout Plain Layout
24744 \begin_layout Subsubsection
24750 \begin_layout Standard
24751 This will rename the current document including the version history.
24752 It requires a clean document without any changes since the last checkin.
24753 You are asked for a file name and a description of the rename operation.
24754 After that the document is renamed, both locally and in the repository.
24755 If the parent directories of the new and old file names differ, all relative
24756 paths of included files are adjusted (like in
24758 File\SpecialChar menuseparator
24763 Finally, the document is reloaded using the new name.
24766 \begin_layout Labeling
24767 \labelwidthstring 00.00.0000
24769 \begin_inset space ~
24773 \begin_inset space ~
24777 \begin_inset Newline newline
24781 \begin_inset Flex Code
24784 \begin_layout Plain Layout
24788 \begin_inset Quotes qld
24792 \begin_inset Quotes qld
24796 \begin_inset Quotes qld
24800 \begin_inset Quotes qld
24809 \begin_inset Newline newline
24813 \begin_inset Flex Code
24816 \begin_layout Plain Layout
24825 \begin_layout Subsubsection
24826 \begin_inset CommandInset label
24828 name "subsec:SVN-Repo-Update"
24832 Update of the local directory checkout from repository
24836 \begin_layout Plain Layout
24837 Note that this command will work only with subversion
24838 \begin_inset Formula $\geqq1.5$
24849 \begin_layout Standard
24850 All the commands above have one shortcoming – they deal with the current
24852 Once your document contains pictures, includes external
24853 \begin_inset Flex Code
24856 \begin_layout Plain Layout
24862 files and so on administration becomes more complicated.
24864 now supports updating the whole tree in which resides the document
24868 \begin_layout Plain Layout
24869 One need to organize the files structure so that all external files are
24870 in the same directory or subdirectories of the document.
24877 This become especially useful once you cooperate with people which neither
24878 know about subversion management nor they have ambition to commit additional
24879 material to the repository.
24883 \begin_layout Standard
24884 \begin_inset Flex Code
24887 \begin_layout Plain Layout
24888 Update local directory from repository
24893 command updates the whole directory and in case of merge conflicts local
24894 version of the files are left, so no unintended data loss occurs.
24895 If local changes are detected user is warned before update starts.
24898 \begin_layout Labeling
24899 \labelwidthstring 00.00.0000
24901 \begin_inset space ~
24905 \begin_inset space ~
24909 \begin_inset Newline newline
24913 \begin_inset Flex Code
24916 \begin_layout Plain Layout
24922 (Ask if changes are detected.)
24923 \begin_inset Newline newline
24927 \begin_inset Flex Code
24930 \begin_layout Plain Layout
24931 svn update --accept mine-full $path
24939 \begin_layout Standard
24941 \begin_inset Flex Code
24944 \begin_layout Plain Layout
24950 stands for the path to the document.
24953 \begin_layout Subsubsection
24959 \begin_layout Standard
24960 This shows the complete history of the SVN document.
24964 \begin_inset Quotes qld
24968 \begin_inset Quotes qld
24973 is shown in a browser.
24976 \begin_layout Subsubsection
24978 \begin_inset CommandInset label
24980 name "subsec:SVN-File-Locking"
24987 \begin_layout Standard
24988 The file exchange through various revision control systems brings the problem
24989 of merge conflicts in case two different users try to edit the same (parts
24991 When such a conflict happens it needs manual resolving and one reasonable
24992 alternative is to provide some kind of locking mechanism, which guarantees
24993 that only one user is allowed to edit file at the given time.
24996 \begin_layout Standard
24997 SVN has two such mechanisms to provide mutual exclusivity for file access
24998 – locks and automatic setting of write permissions (see sec.
25000 \begin_inset CommandInset ref
25002 reference "subsec:Automatical-Locking-Property"
25007 \begin_inset Flex Code
25010 \begin_layout Plain Layout
25020 \begin_layout Plain Layout
25021 \begin_inset Flex URL
25024 \begin_layout Plain Layout
25026 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
25037 If this property is detected for a given document \SpecialChar LyX
25038 starts to use SVN locks
25039 for document editing automatically and the whole check-in/out mechanism
25040 switches to the same regimen as for RCS.
25041 This in particular means there are two different modes of file use in \SpecialChar LyX
25045 \begin_layout Itemize
25047 The loaded file is in the read-only mode.
25048 For editing on needs to check-out.
25053 consists of updating from the repository and gaining write lock.
25054 If the lock is not possible to obtain, we remain in unlocked state.
25057 \begin_layout Itemize
25059 The loaded file is in the
25060 \begin_inset Quotes els
25064 \begin_inset Quotes ers
25068 No other user is allowed to edit the file.
25073 consists of commiting changes and releasing write-lock.
25074 If no changes have been made to the document, no commit will be produced
25078 \begin_layout Plain Layout
25079 Don't be puzzled by the fact that you will be asked for commit message anyway.
25084 and only the write-lock will be released.
25087 \begin_layout Standard
25091 \begin_layout Labeling
25092 \labelwidthstring 00.00.0000
25095 svn commit -q -m"<description>" "<file-name>"
25096 \begin_inset Newline newline
25099 svn unlock "<file-name>"
25102 \begin_layout Labeling
25103 \labelwidthstring 00.00.0000
25106 svn update "<file-name>"
25107 \begin_inset Newline newline
25110 svn lock "<file-name>"
25113 \begin_layout Subsubsection
25116 \begin_inset CommandInset label
25118 name "subsec:Automatical-Locking-Property"
25124 Automatic Locking Property
25127 \begin_layout Standard
25128 The above mentioned automatic setting of write permissions of the .lyx file
25131 File\SpecialChar menuseparator
25133 \begin_inset space ~
25136 Control\SpecialChar menuseparator
25137 Use Locking Property
25140 This command is active only when the file is not locked on the svn server
25142 you need to check-out before proceeding).
25145 \begin_layout Labeling
25146 \labelwidthstring 00.00.0000
25148 \begin_inset space ~
25154 \begin_layout Labeling
25155 \labelwidthstring 00.00.0000
25158 svn propset svn:needs-lock ON "<file-name>"
25161 \begin_layout Labeling
25162 \labelwidthstring 00.00.0000
25165 svn propdel svn:needs-lock "<file-name>"
25168 \begin_layout Subsubsection
25169 \begin_inset CommandInset label
25171 name "subsec:VCS-Revision-Information"
25175 Revision Information in Documents
25178 \begin_layout Standard
25179 There are more possibilities how to activate revision information in our
25183 \begin_layout Itemize
25189 \begin_layout Itemize
25190 tree revision information (
25191 \begin_inset Flex Code
25194 \begin_layout Plain Layout
25201 The result is the output of the
25202 \begin_inset Flex Code
25205 \begin_layout Plain Layout
25211 command, the following table gives you an idea, how to read the results.
25214 \begin_layout Standard
25216 \begin_inset Tabular
25217 <lyxtabular version="3" rows="6" columns="2">
25218 <features tabularvalignment="middle">
25219 <column alignment="left" valignment="top">
25220 <column alignment="left" valignment="top">
25222 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25225 \begin_layout Plain Layout
25233 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
25236 \begin_layout Plain Layout
25246 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
25249 \begin_layout Plain Layout
25255 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25258 \begin_layout Plain Layout
25259 mixed revision working copy
25266 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
25269 \begin_layout Plain Layout
25275 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25278 \begin_layout Plain Layout
25279 modified working copy
25286 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
25289 \begin_layout Plain Layout
25295 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25298 \begin_layout Plain Layout
25299 switched working copy
25306 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
25309 \begin_layout Plain Layout
25315 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25318 \begin_layout Plain Layout
25319 partial working copy, from a sparse checkout
25326 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25329 \begin_layout Plain Layout
25335 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
25338 \begin_layout Plain Layout
25339 mixed revision, modified, switched working copy
25352 \begin_layout Itemize
25353 file revision information.
25354 The result comes from parsing the output of
25355 \begin_inset Flex Code
25358 \begin_layout Plain Layout
25360 \begin_inset space ~
25364 \begin_inset space ~
25368 \begin_inset space ~
25377 Supported flags are:
25381 \begin_layout Itemize
25382 version number of the last commit (
25383 \begin_inset Flex Code
25386 \begin_layout Plain Layout
25395 \begin_layout Itemize
25396 author of the last commit (
25397 \begin_inset Flex Code
25400 \begin_layout Plain Layout
25409 \begin_layout Itemize
25410 date of the last commit (
25411 \begin_inset Flex Code
25414 \begin_layout Plain Layout
25423 \begin_layout Itemize
25424 time of the last commit (
25425 \begin_inset Flex Code
25428 \begin_layout Plain Layout
25438 \begin_layout Standard
25439 You can obtain this info via InsetInfo (
25440 \change_inserted 5863208 1564400022
25443 Insert\SpecialChar menuseparator
25444 Field\SpecialChar menuseparator
25445 Version Control Revision
25446 \change_deleted 5863208 1564399852
25451 \begin_inset Flex Code
25454 \begin_layout Plain Layout
25455 info-insert buffer vcs-date
25463 The information will be available only when you have the file stored under
25464 svn managment (i.e.
25466 \begin_inset Flex Code
25469 \begin_layout Plain Layout
25475 directory is available with your document).
25479 \begin_layout Itemize
25480 Another—a hacking one—possibility is to use svn keywords
25484 \begin_layout Plain Layout
25485 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
25491 In short – you set file keywords property (e.g.
25494 svn propset svn:keywords 'Rev' file.lyx
25496 ) and then paste keyword \SpecialChar TeX
25501 \begin_layout Plain Layout
25502 This is an easy way how to ensure that \SpecialChar LyX
25503 won't break the line in the middle
25509 tag in your document (e.g.
25511 \begin_inset Flex Code
25514 \begin_layout Plain Layout
25521 This way svn client will automatically substitute revision number (e.g.
25523 \begin_inset Flex Code
25526 \begin_layout Plain Layout
25532 ) after each update and commit.
25533 There are more problems with this approach.
25534 Firstly, the '$' character is used in \SpecialChar TeX
25535 world for math equations, so any
25536 occurence of math formula
25537 \begin_inset Formula $Rev$
25541 \begin_inset Formula $Rev:59$
25544 in your \SpecialChar LyX
25546 Similarly for other keywords like Id, Date, Author, etc.
25547 Secondly svn output is dependent on your locales, so its very easy that
25548 svn would produce some problematic strings once Date is used.
25549 Thirdly you get the whole 'Rev: 59' string in your document instead of
25551 Until subversion implements user's custom keywords it will be hard to use
25552 this approach reliably or let \SpecialChar LyX
25553 to support it directly.
25556 \begin_layout Subsection
25557 SVN and Windows Environment
25560 \begin_layout Quote
25561 My inclination is to say that if the user cannot figure out the command
25562 line operations on their own fairly quickly, they would be well advised
25563 to use TortoiseSVN.
25569 \begin_layout Subsubsection
25573 \begin_layout Standard
25574 In addition to installing \SpecialChar LyX
25575 , and having access to a Subversion repository,
25576 the user will need to install the Subversion client program.
25577 A Windows installer for the client program is available from
25578 \begin_inset CommandInset href
25581 target "http://www.collab.net/nonav/downloads/subversion/"
25587 The user may also want to install
25588 \begin_inset CommandInset href
25591 target "http://tortoisesvn.tigris.org/"
25596 , which integrates Subversion operations into the context (rightclick) menu
25597 of Windows Explorer.
25598 Operations done outside \SpecialChar LyX
25599 will typically be more convenient using the Explorer
25601 Note that TortoiseSVN is not a replacement for the client program, which
25602 is what \SpecialChar LyX
25606 \begin_layout Subsubsection
25607 Bringing a document under Subversion control
25610 \begin_layout Standard
25611 Before a \SpecialChar LyX
25612 document can be brought under version control in Subversion, its
25613 parent directory needs to be under version control.
25614 If the document is being added to a project already in the repository,
25615 this is accomplished by checking the project out to the directory where
25616 the new document will be placed.
25617 If the project itself is not yet under version control (for instance, if
25618 this document starts a new project), the directory must be imported into
25620 This is done outside \SpecialChar LyX
25622 Both import and checkout are easily accomplished from the Explorer context
25623 menu using TortoiseSVN, or alternatively can be done using the command
25624 line client at a DOS prompt.
25625 The procedure for importing the project using TortoiseSVN is described
25626 below, assuming an existing repository and a new project being started
25634 For information on using the Subversion client program, run
25641 \begin_layout Enumerate
25648 in Windows Explorer, right click it, and select
25650 TortoiseSVN\SpecialChar menuseparator
25654 If necessary, adjust the URL for the repository, then click OK.
25657 \begin_layout Enumerate
25658 Right click the level of the repository under which you want to place the
25659 new project folder (typically the top level) and click
25663 Supply a name for the project folder and click OK.
25664 Add a message for the log file if desired, then click OK again.
25665 The new project folder should appear in the repository.
25666 Finally, click OK again to exit the repository browser.
25669 \begin_layout Enumerate
25670 Once again right click
25676 , this time selecting SVN Checkout\SpecialChar ldots
25677 Select the URL of the project folder
25678 you just created in the repository, and set the checkout directory to
25686 You will be warned about a non-empty folder; click OK to proceed.
25687 You should now have a
25698 \begin_layout Enumerate
25699 Create or open your document in \SpecialChar LyX
25702 File\SpecialChar menuseparator
25704 \begin_inset space ~
25707 Control\SpecialChar menuseparator
25711 Add a log message and click OK to commit the document to version control.
25714 \begin_layout Standard
25715 From this point onward, you should have full functionality in the
25717 File\SpecialChar menuseparator
25719 \begin_inset space ~
25725 You also have the option of checking the document in and out, viewing its
25727 using the TortoiseSVN context menu in Windows Explorer or the Subversion
25728 client program from a command prompt.
25731 \begin_layout Subsubsection
25732 SSH tunnel used with SVN under Windows
25735 \begin_layout Standard
25736 Compared with Linux setting up an svn client to communicate over ssh under
25737 Windows is a rather troublesome task.
25738 We will at least offer some hints how to setup the client side but prior
25739 knowledge about ssh and the Windows command line is needed, also be prepared
25740 for a great deal of frustration\SpecialChar ldots
25744 \begin_layout Enumerate
25745 Get an svn client for windows, as described in the previous sections.
25746 When it is a fresh install run some svn command (e.g.
25748 \begin_inset Flex Code
25751 \begin_layout Plain Layout
25757 ) to create config files, which you will need to change later on.
25760 \begin_layout Enumerate
25761 Choose an ssh client for Windows.
25762 There are several possibilities, we will use the one from Putty tools
25766 \begin_layout Plain Layout
25767 \begin_inset Flex URL
25770 \begin_layout Plain Layout
25772 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
25783 You will need to set the connection up so that the client doesn't ask for
25784 any password from you.
25785 To keep things easy we will use only keys without any additional password
25790 \begin_layout Enumerate
25792 \begin_inset Flex Code
25795 \begin_layout Plain Layout
25802 Save your private .ppk key file and put the public one on the server side.
25803 If the SVN server runs on Linux, note that the format of the public key
25804 is not compatible with Linux openssh and you will need to direcly copy-paste
25806 \begin_inset Quotes eld
25811 Public key for pasting into OpenSSH authorized_keys file
25814 \begin_inset Quotes erd
25817 edit field into the server's
25818 \begin_inset Flex Code
25821 \begin_layout Plain Layout
25822 ~/.ssh/authorized_keys
25828 \begin_inset Flex Code
25831 \begin_layout Plain Layout
25840 \begin_layout Enumerate
25842 \begin_inset Flex Code
25845 \begin_layout Plain Layout
25852 In the SVN config file
25856 \begin_layout Plain Layout
25857 Exact path depends on Windows version, usually somewhere around
25858 \begin_inset Flex Code
25861 \begin_layout Plain Layout
25864 Documents and Settings
25878 \begin_inset Flex Code
25881 \begin_layout Plain Layout
25896 , section [tunnels], setup ssh command, e.g.
25898 \begin_inset Flex Code
25901 \begin_layout Plain Layout
25902 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
25911 \begin_layout Plain Layout
25912 It will usually take a lot of time to get exact command right and it depends
25914 For example do not have some remote server saved as a default session in
25916 If things fail, try to connect via plink without SVN first.
25925 \begin_layout Enumerate
25926 Checkout the SVN archive, e.
25927 \begin_inset space \thinspace{}
25931 \begin_inset Newline newline
25935 \begin_inset Flex Code
25938 \begin_layout Plain Layout
25939 svn co svn+ssh://user@server/repository_path
25947 \begin_layout Subsubsection
25948 End-of-Line Conversions
25951 \begin_layout Standard
25952 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
25954 use different line endings inside the .lyx files.
25955 This is not a problem as far as \SpecialChar LyX
25956 functionality is concerned, but the commit
25957 diffs will be huge and merge-conflicts prone.
25958 Fortunately SVN itself knows
25962 \begin_layout Plain Layout
25963 \begin_inset Flex URL
25966 \begin_layout Plain Layout
25968 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
25978 how to deal with CR/LF problems when switching .lyx files to the
25979 \begin_inset Flex Code
25982 \begin_layout Plain Layout
25992 \begin_layout Plain Layout
25994 \begin_inset Flex Code
25997 \begin_layout Plain Layout
25998 svn propset svn:eol-style native FILE_NAME
26011 \begin_layout Subsection
26012 GIT commands in \SpecialChar LyX
26016 \begin_layout Standard
26017 A minimal subset of GIT commands is now supported by \SpecialChar LyX
26019 You can find the commands in the
26021 File\SpecialChar menuseparator
26023 \begin_inset space ~
26029 Please note that if you use password protected access to repository via
26030 ssh, you will be asked in terminal window.
26032 was tested against GIT 1.7.
26036 \begin_layout Plain Layout
26037 Windows users please note that you need to ensure that git is on the path.
26038 This can be set from within \SpecialChar LyX
26041 Tools\SpecialChar menuseparator
26042 Preferences\SpecialChar menuseparator
26043 Paths\SpecialChar menuseparator
26054 \begin_layout Standard
26055 One big difference of GIT and the other supported version control systems
26056 is the distributed nature of GIT: With traditional version control systems
26057 there is one central server which hosts the repository.
26058 Users commit their changes to the server, and get updates made by other
26060 With GIT, users commit to a local repository.
26061 The local repository can be synchronized with one or more remote repositories
26063 \begin_inset Flex Code
26066 \begin_layout Plain Layout
26073 \begin_inset Flex Code
26076 \begin_layout Plain Layout
26084 does not interact in any way with remote GIT repositories.
26085 It works exclusively with the local repository in a very similar way as
26086 with a central CVS or SVN repository.
26087 If you use remote GIT repositories you need to do the
26088 \begin_inset Flex Code
26091 \begin_layout Plain Layout
26098 \begin_inset Flex Code
26101 \begin_layout Plain Layout
26107 operations with your favourite GIT client.
26110 \begin_layout Subsubsection
26116 \begin_layout Standard
26117 If your document is not under revision control, this is the only item shown
26119 And if it is under revision control, the
26123 item is not visible.
26126 \begin_layout Standard
26127 This command registers in GIT your document ONLY in case you have already
26128 the documents directory under GIT control (in particular
26133 This means you have to checkout the archive by yourself.
26136 \begin_layout Standard
26137 Then you are asked interactively to supply an initial description of the
26139 Don't forget that registered file is not yet committed.
26142 \begin_layout Standard
26143 GIT command that is run:
26146 \begin_inset Quotes qld
26150 \begin_inset Quotes qld
26156 \begin_layout Standard
26161 to understand the switches.
26164 \begin_layout Subsubsection
26170 \begin_layout Standard
26171 When you are finished editing a file, you commit your changes.
26172 When you do this, you are asked for a description of the changes.
26173 After that changes are committed.
26176 \begin_layout Standard
26179 git commit -q -m"<description>" <file-name>
26182 \begin_layout Subsubsection
26185 Revert To Repository Version
26188 \begin_layout Standard
26189 This will discard all changes made to the document since the last check
26191 You get a warning before changes are discarded.
26194 \begin_layout Standard
26198 \begin_inset Quotes qld
26202 \begin_inset Quotes qld
26208 \begin_layout Subsubsection
26214 \begin_layout Standard
26215 This will rename the current document including the version history.
26216 It requires a clean document without any changes since the last checkin.
26217 You are asked for a file name and a description of the rename operation.
26218 After that the document is renamed, both locally and in the repository.
26219 If the parent directories of the new and old file names differ, all relative
26220 paths of included files are adjusted (like in
26222 File\SpecialChar menuseparator
26227 Finally, the document is reloaded using the new name.
26230 \begin_layout Labeling
26231 \labelwidthstring 00.00.0000
26233 \begin_inset space ~
26237 \begin_inset space ~
26241 \begin_inset Newline newline
26245 \begin_inset Flex Code
26248 \begin_layout Plain Layout
26252 \begin_inset Quotes qld
26256 \begin_inset Quotes qld
26260 \begin_inset Quotes qld
26264 \begin_inset Quotes qld
26273 \begin_inset Newline newline
26277 \begin_inset Flex Code
26280 \begin_layout Plain Layout
26289 \begin_layout Subsubsection
26295 \begin_layout Standard
26296 This shows the complete history of the GIT document.
26300 \begin_inset Quotes qld
26304 \begin_inset Quotes qld
26309 is shown in a browser.
26312 \begin_layout Subsubsection
26316 \begin_layout Standard
26318 supports GIT hash number of the last commit to the file,
26319 \change_inserted 1119979965 1564297456
26320 its abbreviated form,
26322 author name, date and time of last commit.
26323 All those are extracted from
26325 git log -n 1 --pretty=format:%H%n
26326 \change_inserted 1119979965 1564297427
26332 Tree version information is obtained via
26334 git describe --abbrev --dirty --long
26338 \begin_inset CommandInset ref
26340 reference "subsec:VCS-Revision-Information"
26347 \begin_layout Subsection
26351 \begin_layout Standard
26352 With the recent addition of the
26353 \begin_inset Flex Code
26356 \begin_layout Plain Layout
26362 function \SpecialChar LyX
26363 power users are allowed to create their own commands for revision
26367 \begin_layout Standard
26368 As an example you can see how two TortoiseSVN commands could be integrated
26372 \begin_layout Description
26374 \begin_inset Flex Code
26377 \begin_layout Plain Layout
26378 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
26386 \begin_layout Description
26388 \begin_inset Flex Code
26391 \begin_layout Plain Layout
26392 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
26400 \begin_layout Subsection
26401 Version control and Document comparison
26404 \begin_layout Standard
26405 One of the typical uses of version control is to inspect the changes between
26406 revisions, usually by creating
26407 \begin_inset Flex Code
26410 \begin_layout Plain Layout
26417 While this is useful for plain text files, it is much less useful in the
26418 case of \SpecialChar LyX
26419 files, which have more a complicated structure.
26420 Hence we provide binding to the Document comparison feature.
26421 There are two ways of calling this feature – either by direct call of
26422 \begin_inset Flex Code
26425 \begin_layout Plain Layout
26432 function (for details see \SpecialChar LyX
26433 functions manual) or by the toolbar icon
26446 One can either compare two chosen revisions of the document or he can simply
26447 compare the current version of edited text with older revisions (where
26449 \begin_inset Flex Noun
26452 \begin_layout Plain Layout
26458 ' revisions back means comparison of the edited file with last commited
26463 \begin_layout Standard
26464 This feature is supported for SVN and RCS though due to the more complicated
26465 versioning scheme of RCS there is a constraint – when addressing the revisions
26466 in dialog, numbers always point to the last number in RCS revision number,
26469 We don't currently support GIT addressing of revisions, one can just compare
26470 edited document with its revision X steps backs, where X is addressed as
26472 \begin_inset Flex Code
26475 \begin_layout Plain Layout
26484 \begin_layout Section
26485 Literate Programming
26488 \begin_layout Standard
26493 (kayvan@sylvan.com)
26497 original documentation written by
26499 Edmar Wienskoski Jr.
26502 (edmar-w-jr@technologist.com)
26505 \begin_layout Subsection
26509 \begin_layout Standard
26510 The main purpose of this documentation is to show you how to use \SpecialChar LyX
26512 programming, where it is assumed that you are familiar with this programming
26513 technique, and know what
26514 \begin_inset Quotes eld
26518 \begin_inset Quotes erd
26522 \begin_inset Quotes eld
26526 \begin_inset Quotes erd
26530 If that is not the case, please follow the web links provided in the following
26532 There is a lot of good documentation out there covering old development
26533 history to the latest tools tips.
26536 \begin_layout Standard
26537 It is also assumed that you are familiar with \SpecialChar LyX
26538 itself to a point that you
26539 are comfortable changing your \SpecialChar LyX
26540 preferences, and X resources file.
26541 If that is not the case please refer to other \SpecialChar LyX
26542 documentation to cover your
26546 \begin_layout Subsection
26547 Literate Programming
26550 \begin_layout Standard
26551 From the Literate Programming FAQ:
26554 \begin_layout Quotation
26555 Literate programming is the combination of documentation and source together
26556 in a fashion suited for reading by human beings.
26557 In fact, literate programs should be enjoyable reading, even inviting!
26558 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
26559 and documentation in a single file.
26560 Literate programming tools then parse the file to produce either readable
26561 documentation or compilable source.
26562 The WEB style of literate programming was created by D.
26563 \begin_inset space \thinspace{}
26567 Knuth during the development of his \SpecialChar TeX
26568 typesetting software.
26572 \begin_layout Standard
26573 Another excerpt says:
26576 \begin_layout Quotation
26579 How is literate programming different from verbose commenting?
26582 \begin_layout Quotation
26583 There are three distinguishing characteristics.
26584 In order of importance, they are:
26588 \begin_layout Itemize
26589 flexible order of elaboration
26592 \begin_layout Itemize
26593 automatic support for browsing
26596 \begin_layout Itemize
26597 typeset documentation, especially diagrams and mathematics
26601 \begin_layout Standard
26602 Now that I sparked your curiosity, take a look in the references.
26605 \begin_layout Subsubsection
26609 \begin_layout Standard
26610 The complete Literate Programming FAQ can be found at:
26613 \begin_layout Quote
26614 Literate Programming FAQ
26615 \begin_inset Flex URL
26618 \begin_layout Plain Layout
26620 http://www.literateprogramming.com/lpfaq.pdf
26628 \begin_layout Standard
26629 The FAQ lists 23 (twenty three!) different literate programming tools.
26630 Where some are specialized or
26631 \begin_inset Quotes eld
26635 \begin_inset Quotes erd
26638 for particular programming languages, while other have general scope.
26643 for my own use for several reasons:
26646 \begin_layout Itemize
26647 It can generate the documentation either in \SpecialChar LaTeX
26651 \begin_layout Itemize
26652 It has a open architecture, i.
26653 \begin_inset space \thinspace{}
26657 \begin_inset space \space{}
26660 it is easy to plug in new filters
26664 \begin_layout Plain Layout
26669 are programs that read a given data stream and output a manipulated data
26671 That way, a WEB file (consisting of literate code) can be turned into a
26672 file consisting only of C program code or \SpecialChar LaTeX
26678 and to perform special processing that you may need.
26682 \begin_layout Itemize
26683 There is a good selection of filters available already (the HTML is one
26687 \begin_layout Itemize
26691 \begin_layout Standard
26692 The Noweb web page can be found at:
26695 \begin_layout Quote
26697 \begin_inset Flex URL
26700 \begin_layout Plain Layout
26702 https://www.cs.tufts.edu/~nr/noweb/
26710 \begin_layout Standard
26711 Starting from there you can reach many other interesting links and even
26712 some literate program examples.
26715 \begin_layout Subsection
26717 and Literate Programming with Noweb
26720 \begin_layout Standard
26721 The \SpecialChar LyX
26722 support for Literate Programming is provided by using the generic \SpecialChar LyX
26724 converters mechanism.
26725 This support is provided in a
26726 \begin_inset Quotes eld
26730 \begin_inset Quotes erd
26734 \begin_inset space \thinspace{}
26738 \begin_inset space \space{}
26741 you will be able to use this new \SpecialChar LyX
26742 feature with some other literate programming
26743 tool of your choice by just changing your \SpecialChar LyX
26747 \begin_layout Subsubsection
26748 Generating documents and code (weaving and tangling)
26751 \begin_layout Paragraph
26752 Using the noweb module
26755 \begin_layout Standard
26756 If you have installed Noweb and \SpecialChar LyX
26757 successfully, whenever you open a new document,
26758 after you have chosen its document class, use the
26760 Document\SpecialChar menuseparator
26764 \begin_inset Quotes eld
26768 \begin_inset Quotes erd
26772 If Noweb is correctly installed, when you click on the
26773 \begin_inset Quotes eld
26777 \begin_inset Quotes erd
26780 link, you will see the
26781 \begin_inset Quotes eld
26785 \begin_inset Quotes erd
26788 module in the available list and you can add it to your document.
26791 \begin_layout Paragraph
26795 \begin_layout Standard
26797 enables you to write code with a custom inset named
26798 \begin_inset Flex Noun
26801 \begin_layout Plain Layout
26808 Noweb delimits chunks like this:
26811 \begin_layout LyX-Code
26815 \begin_layout LyX-Code
26819 \begin_layout LyX-Code
26823 \begin_layout LyX-Code
26827 \begin_layout LyX-Code
26831 \begin_layout Standard
26832 The problem is that whatever is written in between the << and the
26836 must be taken literally, i.
26837 \begin_inset space \thinspace{}
26841 \begin_inset space \space{}
26845 should be prevented from making any special interpretation of what has
26847 This is also handled by
26848 \begin_inset Flex Noun
26851 \begin_layout Plain Layout
26857 , that works like a normal text inset but has a free spacing capability.
26860 \begin_layout Standard
26861 As a special note, you can also use the
26862 \begin_inset Quotes eld
26866 \begin_inset Quotes erd
26869 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
26873 \begin_layout LyX-Code
26877 \begin_layout LyX-Code
26878 def some_function(args):
26881 \begin_layout LyX-Code
26882 "This is the doc string for this function."
26885 \begin_layout LyX-Code
26886 print "My args: ", args
26889 \begin_layout LyX-Code
26890 @ %def some_function
26893 \begin_layout Standard
26894 For an example of this usage and the resulting cross-reference output, look
26895 at the Literate python program in
26897 LIBDIR/examples/listerrors.lyx
26899 which should make this all clear.
26902 \begin_layout Paragraph
26903 Generating the documentation
26906 \begin_layout Standard
26907 At this point you already have a new document file with a proper document
26908 class, and with some code and text on it.
26909 How do I print it? The answer is simple, you select
26911 View\SpecialChar menuseparator
26915 Just like you would do for a plain document.
26916 No special procedure is required.
26919 \begin_layout Standard
26920 To help orientate you, I will now explain what happens inside \SpecialChar LyX
26924 \begin_layout Enumerate
26927 Update\SpecialChar menuseparator
26930 menu option is chosen, a \SpecialChar LaTeX
26936 \begin_layout Standard
26937 If the document is of any literate class the generated file will be named
26938 with an extension name defined by the
26939 \begin_inset Quotes eld
26943 \begin_inset Quotes erd
26946 format (defined in the Preferences panel), otherwise the file will have
26955 \begin_layout Enumerate
26956 Note that the only difference so far is in the name of the file, no special
26957 processing is required by \SpecialChar LyX
26959 Given that you formatted the code using the
26960 \begin_inset Flex Noun
26963 \begin_layout Plain Layout
26969 inset that, by itself, takes care of the business.
26972 \begin_layout Enumerate
26973 If the document is of any literate class \SpecialChar LyX
26974 will then use the internal \SpecialChar LyX
26976 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
26981 \begin_layout Plain Layout
26982 The converters are defined in the
26984 Tools\SpecialChar menuseparator
26988 \begin_inset Quotes eld
26992 \begin_inset Quotes erd
27004 manual for general information about converters.
27009 to generate the \SpecialChar LaTeX
27014 \begin_layout Standard
27015 Otherwise it will just skip this step.
27019 \begin_layout Enumerate
27020 Finally, \SpecialChar LaTeX
27021 is invoked and the regular post processing continues as in a plain
27025 \begin_layout Standard
27026 Independence from a particular
27027 \begin_inset Quotes eld
27031 \begin_inset Quotes erd
27034 is easily achieved by changing the commands that are run by the various
27038 \begin_layout Paragraph
27039 Generating the code
27042 \begin_layout Standard
27043 When the build menu option is chosen or the corresponding button in the
27044 toolbar is pressed, a \SpecialChar LaTeX
27045 file is generated just like step 1 above.
27046 Next, \SpecialChar LyX
27052 This converter needs to be defined by the user and is not installed by
27053 default, though the Program format is.
27054 This converter (like any other converter) will have two parts:
27057 \begin_layout Enumerate
27058 The converter program itself.
27059 This program performs the conversion from the one format to the other (in
27060 this case, from the Noweb format to the Program pseudo-format).
27063 \begin_layout Enumerate
27064 The error log parser.
27065 This is a program whose sole purpose is to rewrite error messages in a
27066 format that \SpecialChar LyX
27068 This makes it possible for \SpecialChar LyX
27069 to place error boxes in the right places in
27073 \begin_layout Standard
27074 The first part, the
27075 \begin_inset Quotes eld
27079 \begin_inset Quotes erd
27082 setting, should be set to
27085 \begin_layout LyX-Code
27093 \begin_layout Standard
27094 This basically means that \SpecialChar LyX
27096 \begin_inset Quotes eld
27100 \begin_inset Quotes erd
27103 (a program or script) with the name of the Noweb file (normally a file
27104 in the \SpecialChar LyX
27105 temp directory) and the directory path of the original \SpecialChar LyX
27110 \begin_layout Standard
27111 This is an implementation of
27112 \begin_inset Quotes eld
27116 \begin_inset Quotes erd
27119 that you can place in a directory on your path:
27122 \begin_layout LyX-Code
27128 \begin_layout LyX-Code
27134 \begin_layout LyX-Code
27137 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
27140 \begin_layout Standard
27141 The next part of the converter setting is the
27142 \begin_inset Quotes eld
27146 \begin_inset Quotes erd
27149 which is to be set to
27152 \begin_layout LyX-Code
27155 parselog=$$s/scripts/listerrors
27158 \begin_layout Standard
27159 This will run any errors that are generated by the
27160 \begin_inset Quotes eld
27164 \begin_inset Quotes erd
27167 process through the
27168 \begin_inset Quotes eld
27172 \begin_inset Quotes erd
27178 \begin_layout Standard
27179 The build will normally take place in \SpecialChar LyX
27180 's temporary directory, so the files
27181 produced by the conversion will be in that directory.
27183 will copy out what it regards as the `main' file, but the
27187 conversion may produce several files, and so most of these would then be
27188 deleted when \SpecialChar LyX
27190 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
27191 the build-script chunk can place the generated files in that location.
27194 \begin_layout Paragraph
27195 Build instructions in the document
27198 \begin_layout Standard
27199 The last piece of the integration between \SpecialChar LyX
27201 \begin_inset Quotes eld
27205 \begin_inset Quotes erd
27209 Generally, the instructions for building your program should be embedded
27210 in a chunk of its own.
27212 \begin_inset Quotes eld
27216 \begin_inset Quotes erd
27219 above uses the notangle command to look for this chunk (called
27220 \begin_inset Quotes eld
27224 \begin_inset Quotes erd
27227 ) and runs its contents through
27228 \begin_inset Quotes eld
27232 \begin_inset Quotes erd
27238 \begin_layout Standard
27239 Typically, such a chunk would look something like this:
27242 \begin_layout LyX-Code
27246 \begin_layout LyX-Code
27248 \begin_inset Newline newline
27251 if [ -z "${NOWEB_SOURCE}" ]
27252 \begin_inset Newline newline
27258 \begin_layout LyX-Code
27259 NOWEB_SOURCE=myfile.nw
27260 \begin_inset Newline newline
27264 \begin_inset Newline newline
27268 code to extract files ...
27269 use NOWEB_OUTPUT_DIR here ...]
27270 \begin_inset Newline newline
27274 code to compile files ...]
27275 \begin_inset Newline newline
27281 \begin_layout Standard
27284 LIBDIR/examples/listerrors.lyx
27288 LIBDIR/examples/Literate.lyx
27290 which implement two versions of the
27291 \begin_inset Quotes eld
27295 \begin_inset Quotes erd
27298 program for some illustrations of how all of these pieces go together or
27301 LIBDIR/examples/noweb2lyx.lyx.
27304 Interestingly, these three files show off the language-indepence of the
27306 literate programming support since they are written in Python, C and Perl
27310 \begin_layout Subsubsection
27311 Configuring \SpecialChar LyX
27315 \begin_layout Standard
27316 All the Literate Programming support is configured by the
27318 Tools\SpecialChar menuseparator
27322 \begin_inset Quotes eld
27326 \begin_inset Quotes erd
27330 The important parts are:
27333 \begin_layout Description
27335 \begin_inset space ~
27339 \begin_inset Quotes eld
27343 \begin_inset Quotes erd
27347 \begin_inset space ~
27350 format Set up via the File Formats tab, this is where the Noweb-specific
27360 , the file extension is set to
27365 This tells \SpecialChar LyX
27366 to create a file with a
27370 extension in the first step of the conversion process.
27373 \begin_layout Description
27375 \begin_inset space ~
27383 \begin_inset space ~
27386 format This is an empty format whose sole purpose is to be the endpoint
27387 of a conversion (which then allows us to set up a converter for it).
27390 \begin_layout Description
27400 This converter performs the
27401 \begin_inset Quotes eld
27405 \begin_inset Quotes erd
27408 of the literate document.
27409 For Noweb, it is set to
27410 \begin_inset Quotes eld
27415 noweave -delay -index $$i > $$o
27418 \begin_inset Quotes erd
27424 \begin_layout Description
27434 \begin_inset Quotes eld
27438 \begin_inset Quotes erd
27442 As stated above, the Converter is set to
27443 \begin_inset Quotes eld
27451 \begin_inset Quotes erd
27454 , with Flags set to
27455 \begin_inset Newline newline
27459 \begin_inset Quotes eld
27464 parselog=$$s/scripts/listerrors
27467 \begin_inset Quotes erd
27473 \begin_layout Subsubsection
27477 \begin_layout Standard
27478 There is also a new function implemented in the \SpecialChar LyX
27480 \begin_inset Quotes eld
27483 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
27487 \begin_layout Standard
27488 When debugging code with ddd/gdb, it is possible to invoke a text editor
27489 at the current execution position with a single key stroke.
27490 The default ddd configuration for that is shift-ctrl-V.
27491 It happens that you can define the editor command line invocation in ddd
27494 Edit\SpecialChar menuseparator
27495 Preferences\SpecialChar menuseparator
27498 dialog and changing the "Edit Sources" entry.
27501 \begin_layout Standard
27502 I take advantage of the newly created \SpecialChar LyX
27503 server function and this ddd feature,
27505 \begin_inset Quotes eld
27509 \begin_inset Quotes erd
27515 \begin_layout LyX-Code
27516 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
27519 \begin_layout Standard
27520 With this, whenever you are using ddd and find a point in the program that
27521 you want to edit, you just press shift-ctrl-V (in the ddd window), and
27522 ddd will forward this information to \SpecialChar LyX
27523 through the \SpecialChar LyX
27524 server and then the
27526 window will show the same file with the cursor at the same position ddd
27528 No more guessing or long scrolling to locate a point in the program back
27532 \begin_layout Standard
27533 Note however that you must enable the \SpecialChar LyX
27534 server to get this feature working
27535 (it is disabled by default).
27537 \begin_inset space ~
27541 \begin_inset CommandInset ref
27543 reference "sec:Starting-the-Server"
27547 explains how to do that.
27550 \begin_layout Subsubsection
27554 \begin_layout Standard
27555 There are six new buttons that can be added to your \SpecialChar LyX
27557 Four of these buttons are short cuts to layout styles:
27575 , one for the custom inset
27580 The last one is a short cut to the
27581 \begin_inset Quotes eld
27585 \begin_inset Quotes erd
27592 \begin_layout Standard
27594 has a range of buttons that are available for tool bar customization.
27595 In my toolbar I like to combine the six short cuts above with two more:
27600 \SpecialChar menuseparator
27605 \SpecialChar menuseparator
27612 Document\SpecialChar menuseparator
27613 View\SpecialChar menuseparator
27617 Here is how it looks like:
27620 \begin_layout LyX-Code
27624 \begin_layout LyX-Code
27628 \begin_layout LyX-Code
27629 Icon "layout Standard"
27632 \begin_layout LyX-Code
27633 Icon "layout Section"
27636 \begin_layout LyX-Code
27637 Icon "layout \SpecialChar LaTeX
27641 \begin_layout LyX-Code
27642 Icon "layout \SpecialChar LyX
27646 \begin_layout LyX-Code
27647 Icon "flex.insert Chunk"
27650 \begin_layout LyX-Code
27654 \begin_layout LyX-Code
27658 \begin_layout LyX-Code
27659 Icon "buffer-typeset"
27662 \begin_layout LyX-Code
27663 Icon "build-program"
27666 \begin_layout LyX-Code
27670 \begin_layout LyX-Code
27674 \begin_layout LyX-Code
27678 \begin_layout LyX-Code
27682 \begin_layout LyX-Code
27686 \begin_layout Subsubsection
27687 Colors customization
27690 \begin_layout Standard
27691 There are a number of colors in \SpecialChar LyX
27692 that can be customized in
27697 One of the things that bothers people is the \SpecialChar LaTeX
27699 The default color is red, since the chunks uses \SpecialChar LaTeX
27700 font, and there is a lot
27701 of chunks in literate documents, you may get tired of seeing everything
27703 You can change it by going to the tabs
27712 \begin_layout Standard
27713 The next thing is the visible presence of the newline character in the screen.
27714 You can choose the color of this particular character and make it blend
27716 I recommend you choosing a color that is close to the background but not
27717 equal, that way you still can see it is there, but it is not bothering
27721 \begin_layout Subsection
27726 \begin_layout Standard
27735 is documented in the
27739 example file and in the Sweave manual (menu
27741 Help\SpecialChar menuseparator
27747 \begin_layout Chapter
27751 \begin_layout Standard
27752 You can do everything with \SpecialChar LyX
27753 that you can do with \SpecialChar LaTeX
27755 However, \SpecialChar LyX
27756 cannot support every \SpecialChar LaTeX
27758 But you can always use \SpecialChar TeX
27760 This chapter shows you some more special things you might want to use.
27761 For other special things you can do with figures, tables, floats, boxes
27762 and notes, have a look at the
27765 \begin_inset space ~
27773 \begin_layout Section
27774 Non-standard Paragraph Shapes
27777 \begin_layout Standard
27780 as well as any other text processor uses by default rectangular paragraphs.
27781 For special cases like for example posters, invitation cards or poems you
27782 can modify the paragraph shape to one of your choice.
27783 This can be done by using the \SpecialChar LaTeX
27785 \begin_inset Flex Code
27788 \begin_layout Plain Layout
27794 which is loaded by using in the document settings the module
27796 Custom paragraph shapes
27801 \begin_layout Subsection
27805 \begin_layout Standard
27810 provides the following shapes:
27813 \begin_layout Standard
27814 \begin_inset Tabular
27815 <lyxtabular version="3" rows="13" columns="3">
27816 <features booktabs="true" islongtable="true" longtabularalignment="center">
27817 <column alignment="left" valignment="middle" width="16col%">
27818 <column alignment="left" valignment="middle" width="40col%">
27819 <column alignment="left" valignment="middle" width="35col%">
27820 <row endhead="true">
27821 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
27824 \begin_layout Plain Layout
27833 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
27836 \begin_layout Plain Layout
27845 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
27848 \begin_layout Plain Layout
27858 <row interlinespace="default">
27859 <cell alignment="left" valignment="top" usebox="none">
27862 \begin_layout Plain Layout
27870 <cell alignment="left" valignment="top" usebox="none">
27873 \begin_layout Plain Layout
27876 Circle with circular hole (in the size of a CD/DVD)
27881 <cell alignment="left" valignment="top" usebox="none">
27884 \begin_layout Plain Layout
27887 Cannot be scaled, take care there is not too much text
27893 <row interlinespace="default">
27894 <cell alignment="left" valignment="top" usebox="none">
27897 \begin_layout Plain Layout
27905 <cell alignment="left" valignment="top" usebox="none">
27908 \begin_layout Plain Layout
27916 <cell alignment="left" valignment="top" usebox="none">
27919 \begin_layout Plain Layout
27922 Fragile, calculation might fail
27928 <row interlinespace="default">
27929 <cell alignment="left" valignment="top" usebox="none">
27932 \begin_layout Plain Layout
27940 <cell alignment="left" valignment="top" usebox="none">
27943 \begin_layout Plain Layout
27946 Rhomboid (symbolizing a
27947 \begin_inset Quotes eld
27951 \begin_inset Quotes erd
27959 <cell alignment="left" valignment="top" usebox="none">
27962 \begin_layout Plain Layout
27971 <row interlinespace="default">
27972 <cell alignment="left" valignment="top" usebox="none">
27975 \begin_layout Plain Layout
27983 <cell alignment="left" valignment="top" usebox="none">
27986 \begin_layout Plain Layout
27994 <cell alignment="left" valignment="top" usebox="none">
27997 \begin_layout Plain Layout
28006 <row interlinespace="default">
28007 <cell alignment="left" valignment="top" usebox="none">
28010 \begin_layout Plain Layout
28018 <cell alignment="left" valignment="top" usebox="none">
28021 \begin_layout Plain Layout
28029 <cell alignment="left" valignment="top" usebox="none">
28032 \begin_layout Plain Layout
28041 <row interlinespace="default">
28042 <cell alignment="left" valignment="top" usebox="none">
28045 \begin_layout Plain Layout
28053 <cell alignment="left" valignment="top" usebox="none">
28056 \begin_layout Plain Layout
28059 Nut for bolt (hexagon with circular hole)
28064 <cell alignment="left" valignment="top" usebox="none">
28067 \begin_layout Plain Layout
28076 <row interlinespace="default">
28077 <cell alignment="left" valignment="top" usebox="none">
28080 \begin_layout Plain Layout
28088 <cell alignment="left" valignment="top" usebox="none">
28091 \begin_layout Plain Layout
28099 <cell alignment="left" valignment="top" usebox="none">
28102 \begin_layout Plain Layout
28111 <row interlinespace="default">
28112 <cell alignment="left" valignment="top" usebox="none">
28115 \begin_layout Plain Layout
28123 <cell alignment="left" valignment="top" usebox="none">
28126 \begin_layout Plain Layout
28134 <cell alignment="left" valignment="top" usebox="none">
28137 \begin_layout Plain Layout
28146 <row interlinespace="default">
28147 <cell alignment="left" valignment="top" usebox="none">
28150 \begin_layout Plain Layout
28158 <cell alignment="left" valignment="top" usebox="none">
28161 \begin_layout Plain Layout
28169 <cell alignment="left" valignment="top" usebox="none">
28172 \begin_layout Plain Layout
28181 <row interlinespace="default">
28182 <cell alignment="left" valignment="top" usebox="none">
28185 \begin_layout Plain Layout
28193 <cell alignment="left" valignment="top" usebox="none">
28196 \begin_layout Plain Layout
28199 Normal/reversed rain drop
28204 <cell alignment="left" valignment="top" usebox="none">
28207 \begin_layout Plain Layout
28210 Fragile, calculation might fail
28216 <row interlinespace="default">
28217 <cell alignment="left" valignment="top" usebox="none">
28220 \begin_layout Plain Layout
28229 <cell alignment="left" valignment="top" usebox="none">
28232 \begin_layout Plain Layout
28235 The \SpecialChar TeX
28241 <cell alignment="left" valignment="top" usebox="none">
28244 \begin_layout Plain Layout
28253 <row interlinespace="default">
28254 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
28257 \begin_layout Plain Layout
28261 \begin_inset Newline newline
28269 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
28272 \begin_layout Plain Layout
28275 Triangles in different orientations
28280 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
28283 \begin_layout Plain Layout
28299 \begin_layout Standard
28300 To use a shape for your paragraph, simply select it in \SpecialChar LyX
28302 for environments in the toolbar.
28305 \begin_layout Standard
28306 \begin_inset Newpage newpage
28312 \begin_layout Standard
28313 Here is an example paragraph in the shape of a nut:
28316 \begin_layout Standard
28317 \begin_inset VSpace bigskip
28326 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28327 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28329 At vero eos et accusam et justo duo dolores et ea rebum.
28330 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
28332 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28333 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28337 \begin_layout Standard
28338 \begin_inset VSpace bigskip
28344 \begin_layout Standard
28345 \begin_inset Note Greyedout
28348 \begin_layout Plain Layout
28357 paragraphs cannot run over a page break.
28365 \begin_layout Standard
28366 \begin_inset VSpace bigskip
28372 \begin_layout Standard
28374 \begin_inset Flex Code
28377 \begin_layout Plain Layout
28383 takes care that the shape will always be preserved, no matter how much
28384 text is in the paragraph.
28385 Therefore the paragraph size changes with the amount of contained text.
28386 This can lead to paragraph sizes exceeding the page margins.
28387 To demonstrate the size scaling, here is the same example paragraph but
28388 with twice as much text:
28391 \begin_layout Standard
28392 \begin_inset Newpage newpage
28401 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28402 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28404 At vero eos et accusam et justo duo dolores et ea rebum.
28405 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
28407 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28408 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28410 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28411 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28413 At vero eos et accusam et justo duo dolores et ea rebum.
28414 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
28416 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28417 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28421 \begin_layout Standard
28422 \begin_inset VSpace bigskip
28428 \begin_layout Standard
28429 An exception is the shape
28434 It cannot be scaled because it must fit the size of a CD/DVD.
28435 Therefore the amount of text that fits into the shape is limited.
28436 \begin_inset Newline newline
28447 shape are fragile, meaning that the calculation of their size can fail,
28448 depending on the amount of text.
28449 You will then get the \SpecialChar LaTeX
28451 \begin_inset Quotes eld
28454 Arithmetic overflow
28455 \begin_inset Quotes erd
28459 In this case one can try to remove or add some text; if nothing works one
28460 has to use another shape.
28463 \begin_layout Standard
28464 \begin_inset VSpace bigskip
28470 \begin_layout Standard
28471 For shapes with tips you will maybe see that \SpecialChar LaTeX
28472 's hyphenation routine fails
28473 for text in the tips.
28474 Therefore it is often necessary to add hyphenation points
28479 arg "specialchar-insert hyphenation"
28484 ) to the corresponding text parts.
28487 \begin_layout Standard
28488 \begin_inset VSpace bigskip
28494 \begin_layout Standard
28495 Shapepar paragraphs are either always centered or placed on the page so
28496 that their left border touches the left page margin.
28497 You can therefore not use the paragraph dialog to align such paragraphs.
28498 A solution is to put the paragraph into a minipage or parbox and align
28500 The problem is hereby to find the right width for the box.
28501 Because if it is too wide and you center the box, the paragraph is not
28502 centered too because it sticks at the left side of the box.
28503 So you might have to play a bit with the width until it fits.
28504 Here are two heart-shaped paragraphs, the first one is not aligned, the
28505 second one is right-aligned:
28508 \begin_layout Standard
28509 \begin_inset Newpage newpage
28515 \begin_layout Heart
28519 Lo\SpecialChar softhyphen
28520 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28521 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28523 At vero eos et accusam et justo duo dolores et ea rebum.
28524 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
28528 \begin_layout Standard
28529 \begin_inset VSpace bigskip
28535 \begin_layout Standard
28538 \begin_inset Box Frameless
28548 height_special "totalheight"
28553 backgroundcolor "none"
28556 \begin_layout Heart
28560 Lo\SpecialChar softhyphen
28561 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28562 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28564 At vero eos et accusam et justo duo dolores et ea rebum.
28565 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
28574 \begin_layout Subsection
28578 \begin_layout Standard
28579 You can define any shape you want.
28580 Doing this manually is a lot of work because every coordinate must be specified.
28581 But there is a way to let the computer calculate the coordinates:
28584 \begin_layout Enumerate
28585 Install the program
28586 \begin_inset CommandInset href
28589 target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
28597 \begin_layout Enumerate
28604 TeX/LaTeX\SpecialChar menuseparator
28605 Settings\SpecialChar menuseparator
28608 and select the font size you are using in your document.
28609 For example this document uses the size 12
28610 \begin_inset space \thinspace{}
28616 \begin_layout Enumerate
28620 \begin_layout Enumerate
28623 TeX/LaTeX\SpecialChar menuseparator
28626 to export the shape to coordinates.
28627 In the appearing dialog use either the outline of your shape for the coordinate
28628 s or the path itself.
28632 \begin_layout Plain Layout
28633 For more information see
28634 \begin_inset CommandInset href
28636 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
28649 \begin_layout Standard
28650 The coordinates are written into a \SpecialChar TeX
28652 To use it for your \SpecialChar LyX
28656 \begin_layout Enumerate
28657 Place the cursor before the first character of your paragraph (or into a
28661 \begin_layout Enumerate
28662 Open in \SpecialChar LyX
28665 Insert\SpecialChar menuseparator
28666 File\SpecialChar menuseparator
28668 \begin_inset space ~
28673 , select the file and use
28682 \begin_layout Standard
28683 \begin_inset VSpace defskip
28689 \begin_layout Standard
28690 \begin_inset Note Greyedout
28693 \begin_layout Plain Layout
28698 : The changed shape only applies to the current paragraph; everything is
28699 reset to normal for the next paragraph.
28700 Therefore the shape definition file must be input into every paragraph
28701 with the desired shape.
28709 \begin_layout Standard
28710 \begin_inset VSpace bigskip
28716 \begin_layout Standard
28717 Here is an example:
28720 \begin_layout Standard
28721 \begin_inset VSpace bigskip
28727 \begin_layout Standard
28728 \begin_inset CommandInset include
28730 filename "SpecialParagraphShape.tex"
28737 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28738 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28740 At vero eos et accusam et justo duo dolores et ea rebum.
28741 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
28743 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28744 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28748 \begin_layout Standard
28749 \begin_inset VSpace bigskip
28755 \begin_layout Standard
28760 to draw complexer shapes in
28764 you can draw the shape in a program of your choice and import the resulting
28770 Then you only need to draw a line or spline along the outline of the image.
28773 \begin_layout Standard
28774 \begin_inset VSpace bigskip
28780 \begin_layout Standard
28783 Custom paragraph shapes
28785 also provides the two commands
28793 which can be used to define custom shapes coordinate by coordinate.
28797 \begin_layout Plain Layout
28798 These commands are internally used for all shapes described here.
28803 For information how these styles are used and about further customization
28804 possibilities, have a look at the
28805 \begin_inset CommandInset href
28807 name "documentation"
28808 target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
28814 \begin_inset Flex Code
28817 \begin_layout Plain Layout