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
2872 \change_inserted 564990737 1671383236
2875 \begin_inset CommandInset label
2877 name "subsec:Extra-font-sizes"
2884 \begin_layout Standard
2886 \change_inserted 564990737 1671383236
2889 The “Extra font sizes” collection provides the document classes
2892 \begin_inset space \thinspace{}
2895 (with extra font sizes)
2900 \begin_inset space \thinspace{}
2903 (with extra font sizes)
2908 \begin_inset space \thinspace{}
2911 (with extra font sizes)
2916 \begin_inset space \thinspace{}
2919 (with extra font sizes)
2937 document classes respectively but offer the additional
2943 \begin_inset space ~
2948 options 8, 9, 14, 17 and 20 in the
2953 ocument\SpecialChar menuseparator
2958 ettings\SpecialChar menuseparator
2964 \begin_layout Subsection
2966 \change_inserted 564990737 1671383236
2972 \begin_layout Standard
2974 \change_inserted 564990737 1671383236
2977 The document classes
2980 \begin_inset space \thinspace{}
2988 \begin_inset space \thinspace{}
3003 document classes to facilitate the use of Hebrew in \SpecialChar LyX
3007 \begin_layout Subsection
3009 \change_inserted 564990737 1671383236
3012 \begin_inset CommandInset label
3014 name "subsec:Japanese"
3021 \begin_layout Standard
3023 \change_inserted 564990737 1671383236
3026 The document classes
3029 \begin_inset space \thinspace{}
3037 \begin_inset space \thinspace{}
3040 (Japanese Standard Class Vertical Writing)
3045 \begin_inset space \thinspace{}
3048 (Japanese Standard Class)
3053 \begin_inset space \thinspace{}
3061 \begin_inset space \thinspace{}
3064 (Japanese Standard Class Vertical Writing)
3069 \begin_inset space \thinspace{}
3072 (Japanese Standard Class)
3077 \begin_inset space \thinspace{}
3080 (Japanese Vertical Writing)
3085 \begin_inset space \thinspace{}
3088 (Japanese Standard Class)
3090 provide document classes for the Japanese language.
3093 \begin_layout Subsection
3097 \begin_layout Standard
3103 \begin_layout Subsubsection
3107 \begin_layout Standard
3108 The \SpecialChar LyX
3111 article (koma-script)
3115 report (koma-script)
3133 correspond to the \SpecialChar LaTeX
3151 \begin_inset space ~
3154 of the Koma-Script family.
3155 They are replacements for the standard document classes
3171 , resp., and fit better to European typography conventions in a number of
3175 \begin_layout Itemize
3176 Standard character size is 11pt in
3178 article (koma-script)
3182 report (koma-script)
3190 letter (koma-script)
3195 \begin_layout Itemize
3196 Headings, labels of the description environment, and a number of elements
3199 letter (koma-script)
3201 document class are set in a bold sans serif font.
3205 \begin_layout Plain Layout
3206 There is a big difference between the bold sans serif old cm fonts and new
3207 ec fonts, especially in the appearance of headings.
3208 In comparison, the ec bold sans serif fonts look a bit thin.
3209 Here the \SpecialChar LaTeX
3218 helps to produce the
3219 \begin_inset Quotes eld
3223 \begin_inset Quotes erd
3226 appearance when using the ec fonts.
3231 The numbering of chapter headings is made in the same way as the numbering
3232 of section headings, that is without the extra line
3233 \begin_inset Quotes eld
3236 Chapter\SpecialChar ldots
3238 \begin_inset Quotes erd
3242 In addition, the appearance of the headings can be modified by using a
3243 number of options (in \SpecialChar LyX
3244 to be entered in the field
3247 \begin_inset space ~
3254 Layout\SpecialChar menuseparator
3261 \begin_layout Itemize
3262 The main means in the Koma-Script document classes to design the type area
3271 (in \SpecialChar LyX
3272 to be entered in the extra class options field in the dialog
3274 Document\SpecialChar menuseparator
3278 They make a clearer modification of page margins possible as do the options
3281 Document\SpecialChar menuseparator
3288 \begin_layout Itemize
3289 The \SpecialChar LaTeX
3290 document classes of the Koma-Script family define a number of additional
3292 Those part of it which makes sense in \SpecialChar LyX
3293 is implemented in corresponding
3297 \begin_layout Standard
3298 Detailed descriptions of the \SpecialChar LaTeX
3299 document classes of the Koma-Script family
3300 can be found in the Koma-Script documentation
3311 \begin_layout Subsubsection
3312 article (koma-script), report (koma-script), and book (koma-script)
3315 \begin_layout Standard
3316 The document classes
3318 article (koma-script)
3322 report (koma-script)
3332 are implemented in the layout files
3345 They contain all the paragraph types of the corresponding standard document
3358 , resp., partly modified, with the exception of the \SpecialChar LyX
3363 -type, which is replaced by the new
3367 -type having the same functionality.
3372 -Type there is a number of new paragraph types added.
3379 letter (koma-script)
3384 \begin_layout Itemize
3393 : are equivalents to
3401 , resp., additionally inserting an entry in the table of contents.
3410 are not contained in
3412 article (koma-script)
3417 \begin_layout Itemize
3434 , resp., additionally clearing running heads.
3441 article (koma-script)
3447 \begin_layout Plain Layout
3460 report (koma-script)
3462 , but since this is identical to
3466 , is has not been implemented in \SpecialChar LyX
3475 \begin_layout Itemize
3480 : generates a heading directly above the following paragraph in the standard
3481 character size without affecting the structure of the document.
3484 \begin_layout Itemize
3493 are special captions which respect the different space settings needed
3494 for captions placed above or below an element (if you follow strict typographic
3495 rules, you might want to place table captions always above the table).
3496 You can also use the class option
3513 You need at least Koma-Script version 2.8q to use this.
3516 \begin_layout Itemize
3521 : can be used to set a bonmot, e.
3522 \begin_inset space \thinspace{}
3526 \begin_inset space \space{}
3529 at the beginning of a chapter.
3530 If you use the optional argument (
3532 Insert\SpecialChar menuseparator
3534 \begin_inset space ~
3539 ), you can insert the dictum's author there.
3540 Dictum and author are separated by a line.
3541 You need at least Koma-Script version 2.8q to use this.
3548 article (koma-script)
3553 \begin_layout Standard
3554 The following types, together with the standard types
3566 , form the title area of the document.
3567 They must be entered ahead of the first
3568 \begin_inset Quotes eld
3572 \begin_inset Quotes erd
3579 \begin_layout Plain Layout
3580 The corresponding \SpecialChar LaTeX
3581 commands must appear before the
3592 When such a type is used more than once, the latter usage overwrites the
3593 former one, that means, for every type only the latest usage is valid.
3594 The order of the different types however has, like
3606 , no effect on the appearance of the produced document.
3609 \begin_layout Itemize
3614 : produces a centered paragraph above the ordinary title (
3626 ) for the subject of the document.
3629 \begin_layout Itemize
3634 : produces a centered paragraph below the ordinary title (
3646 ) for the publishers' name.
3649 \begin_layout Itemize
3656 report (koma-script)
3662 produces a centered paragraph on its own page behind the title page, or
3665 article (koma-script)
3667 produces a centered paragraph below the ordinary title (
3686 \begin_layout Itemize
3691 : produces a left aligned paragraph above the ordinary title (
3707 ) for a document`s head.
3710 \begin_layout Itemize
3715 : produces in a double-sided print in
3717 report (koma-script)
3723 a left-aligned paragraph at the top of the title page`s back or has no
3724 effect in a single-sided print or in
3726 article (koma-script)
3731 \begin_layout Itemize
3736 : produces in a double-sided print in
3738 report (koma-script)
3744 a left-aligned paragraph at the bottom of the title page`s back or has
3745 no effect in a single-sided print or in
3747 article (koma-script)
3752 \begin_layout Itemize
3757 : produces a special
3758 \begin_inset Quotes eld
3762 \begin_inset Quotes erd
3765 page ahead of the actual document containing a paragraph without special
3769 \begin_layout Standard
3770 The layout files for the document classes
3772 article (koma-script)
3776 report (koma-script)
3787 This is thought of as a place to define your own types.
3792 in your personal layout directory and edit the file!
3795 \begin_layout Subsubsection
3796 letter (koma-script)
3799 \begin_layout Description
3800 Note: This section discusses the obsolete
3802 KOMA-Script-Letter (v.
3803 \begin_inset space ~
3808 , which is not even included anymore in recent KOMA releases.
3809 Please refer to the next section for the current KOMA-Script-Letter class
3811 \begin_inset space ~
3817 \begin_layout Standard
3821 letter (koma-script)
3823 is implemented in the layout file
3828 It contains all the paragraph types of the corresponding standard document
3833 , partly modified, with the exception of the \SpecialChar LyX
3847 type, which is replaced by the new
3852 In addition, it contains, in contrast to the standard document class, the
3871 Furthermore, there are a number of new letter specific types.
3874 \begin_layout Standard
3875 The appearance of the letter produced by this document class can be controlled
3876 by a number of \SpecialChar LaTeX
3877 commands, which you can put in the \SpecialChar LaTeX
3882 \begin_layout Plain Layout
3883 For example, the standard appearance of the letter`s heading, consisting
3884 of name and address, is quite self-willed.
3886 \begin_inset Quotes eld
3890 \begin_inset Quotes erd
3893 heading is produced by the following \SpecialChar LaTeX
3894 commands in the preamble:
3897 \begin_layout LyX-Code
3907 \begin_layout LyX-Code
3923 \begin_layout LyX-Code
3933 \begin_layout LyX-Code
3953 A detailed German description of such \SpecialChar LaTeX
3954 commands can be found in the Koma-Script
3960 With it, the letter's author can produce his personal letter layout.
3963 \begin_layout Standard
3972 define the beginning of the letter and must be used in every letter.
3973 To emphasize them in the \SpecialChar LyX
3974 document class, they are marked with the letter
3984 \begin_inset space ~
3988 It is possible to write any number of letters in one file.
3993 type produces a new letter using the same addressee and a
3997 type produces a new addressee.
4014 are ordinary paragraph types and can also be used several times in one
4015 and the same letter.
4018 \begin_layout Itemize
4023 : produces a paragraph for the addressee and implicitly defines the beginning
4027 \begin_layout Itemize
4032 : produces a paragraph for the form of address and implicitly produces a
4036 \begin_layout Itemize
4041 : produces a paragraph for a close.
4044 \begin_layout Itemize
4049 : produces a paragraph for a postscript.
4052 \begin_layout Itemize
4057 : produces a paragraph for a distribution list.
4060 \begin_layout Itemize
4065 : produces a paragraph for enclosures.
4068 \begin_layout Standard
4109 are input types provided with a label to enter information, which will
4110 be processed by the document class.
4114 \begin_layout Plain Layout
4115 It could be seen as a matter of inconsequence, that the types
4123 described above are not such input types as well.
4124 Because of the special meaning of those types, however, I have implemented
4125 them as ordinary paragraph types with a one letter mark in the left margin.
4126 Moreover, it would affect my feeling of symmetry, if the
4134 type had such a serious different appearance.
4139 The types must be used ahead of the corresponding
4146 \begin_layout Standard
4147 An implementation of these types in a WYSIWYG fashion does not seem to make
4148 sense, because the real appearance of the produced letter does not only
4149 depend on the usage of the particular type, but also on other factors.
4150 For example, a signature entered in the
4154 type will in the standard behavior appear in the produced letter only,
4155 when in the same letter also a
4160 The entered value of the
4164 type will in the standard behavior not appear in the produced letter at
4166 The possibility to design the letter`s heading freely is already indicated
4167 in a footnote above.
4170 \begin_layout Standard
4171 The input types can also be used as empty paragraphs.
4173 \begin_inset space \thinspace{}
4177 \begin_inset space \space{}
4189 type is not used at all, in the standard behavior the value of the
4193 type is used as signature, whereas if an empty
4197 type is used, no signature value is defined.
4200 \begin_layout Standard
4201 By using the input types it is possible to write a letter template, containing
4202 filled input types with your personal dates (name, address, etc.) and empty
4203 input types for other dates you want to enter.
4206 \begin_layout Itemize
4211 : sender's name, in the standard behavior appears as a centered paragraph
4212 in small caps in the letter`s heading.
4215 \begin_layout Itemize
4220 : sender's signature, in the standard behavior appears below the
4229 type is used, the value of the
4233 type appears instead.
4236 \begin_layout Itemize
4241 : sender's address, in the standard behavior appears in a centered paragraph
4242 in the letter`s heading below the sender's name.
4245 \begin_layout Itemize
4250 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
4261 \begin_layout Itemize
4266 : place of the letter`s making.
4269 \begin_layout Itemize
4274 : date of the letter`s making.
4283 , in the standard behavior, produce the place and the date in a right-aligned
4284 line below the addressee's field.
4289 type is used, neither place nor date appear, independent of the value of
4299 type is used, the date of the letter `s production is used.
4302 \begin_layout Itemize
4307 : sender`s back address, in the standard behavior appears above the addressee's
4308 field in a small sans serif font.
4311 \begin_layout Itemize
4316 : special mail information, in the standard behavior appears underlined
4317 above the addressee's field below the back address.
4320 \begin_layout Itemize
4325 : additional information, in the standard behavior appears on right side
4326 below the addressee`s field.
4329 \begin_layout Itemize
4334 : the letter's title, in the standard behavior appears in a big, bold, sans
4335 serif font above the subject.
4338 \begin_layout Itemize
4343 : the letter's subject, in the standard behavior appears in a bold font
4351 \begin_layout Standard
4372 produce a business letter like line above the
4376 line containing the fields
4377 \begin_inset Quotes eld
4381 \begin_inset Quotes erd
4385 \begin_inset Quotes eld
4389 \begin_inset Quotes erd
4393 \begin_inset Quotes eld
4397 \begin_inset Quotes erd
4401 \begin_inset Quotes eld
4405 \begin_inset Quotes erd
4409 \begin_inset Quotes eld
4413 \begin_inset Quotes erd
4417 \begin_inset Quotes eld
4421 \begin_inset Quotes erd
4425 For the date field, the value of the
4431 \begin_inset Quotes eld
4434 business letter types
4435 \begin_inset Quotes erd
4438 is used, the value of the
4442 type however does not appear, but only the \SpecialChar LaTeX
4450 The ordinary output of place and date in a right-aligned line below the
4451 addressee`s field is suppressed.
4452 The types are implemented as input types provided with a label and must
4453 be used ahead of the corresponding
4460 \begin_layout Itemize
4468 \begin_layout Itemize
4476 \begin_layout Itemize
4484 \begin_layout Itemize
4492 \begin_layout Itemize
4500 \begin_layout Subsubsection
4501 The new letter class: letter (koma-script v.2)
4504 \begin_layout Standard
4510 \begin_layout Standard
4511 \begin_inset VSpace medskip
4517 \begin_layout Standard
4519 Koma-Script version 2.8 has introduced a new letter class
4523 which supersedes the now unsupported
4528 It has — on the \SpecialChar LaTeX
4529 side — a completely new interface and is not compatible
4531 Therefore, \SpecialChar LyX
4532 supports both, though it is recommended you use the new class.
4535 \begin_layout Standard
4536 This class covers the same functionality as
4538 letter (koma-script),
4545 (receiver's address, same as
4562 will start a new letter (i.
4563 \begin_inset space \thinspace{}
4567 \begin_inset space \space{}
4570 you can write several letters per document).
4571 New elements are sender's
4587 and the possibility to use a
4593 Insert\SpecialChar menuseparator
4599 \begin_layout Standard
4600 The biggest improvement is, though, that the letter's layout is configurable
4601 to meet almost any needs.
4602 This can be done via the preamble or with a special style file (Letter
4603 Class Option, extension
4607 ), that will be read in as a class option.
4611 \begin_layout Plain Layout
4612 The KOMA package comes with some default
4617 There is, for instance, a
4621 file that follows german typesetting rules, or a
4625 that provides the default layout of the old
4630 The latter can be loaded with the class option
4636 Layout\SpecialChar menuseparator
4637 Document\SpecialChar menuseparator
4646 \change_deleted 564990737 1671617922
4654 \change_deleted 564990737 1671617938
4655 that is included in \SpecialChar LyX
4657 \change_inserted 564990737 1671617997
4664 ile\SpecialChar menuseparator
4666 \begin_inset space ~
4674 \begin_inset space ~
4677 Template\SpecialChar menuseparator
4680 \SpecialChar menuseparator
4681 KOMA-Script Letter (V.2)
4686 A detailed description is to be found in the Koma-Script documentation
4694 \begin_layout Subsubsection
4698 \begin_layout Standard
4699 Visualizing the Koma-Script document classes in \SpecialChar LyX
4700 , the \SpecialChar LyX
4701 internals cause some
4705 \begin_layout Itemize
4706 The chapter number of a
4710 type appears on a line of its own above the chapter heading instead of
4711 appearing in the same line ahead of it.
4712 The cause for that is the \SpecialChar LyX
4713 internal behavior for the labeltype
4720 \begin_layout Itemize
4721 The headings of the types
4730 \begin_inset Quotes eld
4734 \begin_inset Quotes erd
4738 table of contents, but not in the \SpecialChar LyX
4741 Document\SpecialChar menuseparator
4743 \begin_inset space ~
4747 \begin_inset space ~
4755 \begin_layout Itemize
4760 document class appear in a skip separation mode, not indented.
4761 This is the standard behavior, no special \SpecialChar LaTeX
4762 commands are needed for that.
4765 Document\SpecialChar menuseparator
4768 dialog the corresponding radio button indicates
4777 value always has the effect that extra \SpecialChar LaTeX
4778 commands are inserted in the document
4779 to produce the gap, which is not what is wanted in this case.
4782 \begin_layout Subsection
4784 \change_inserted 564990737 1670924924
4786 \begin_inset space \thinspace{}
4790 \begin_inset space \space{}
4794 \change_deleted 564990737 1670924933
4795 Article (mwart), book (mwbk) and report (mwrep)
4796 \begin_inset Argument status
4799 \begin_layout Plain Layout
4814 \begin_layout Standard
4820 \begin_layout Standard
4821 The \SpecialChar LyX
4838 correspond to the \SpecialChar LaTeX
4852 They are replacements for the standard document classes
4864 , resp., and fit better to Polish typography conventions in a number of points.
4868 \begin_layout Standard
4872 \begin_layout Itemize
4873 Unnumbered titles (with star, e.
4874 \begin_inset space \thinspace{}
4878 \begin_inset space \space{}
4885 ) are added into table of contents,
4888 \begin_layout Itemize
4889 Additional page styles:
4893 \begin_layout Description
4894 uheadings header with separated lines,
4897 \begin_layout Description
4898 myheadings custom header, contents headers via commands:
4913 \begin_layout Description
4914 myuheadings custom header with separated lines,
4917 \begin_layout Description
4918 outer page number is placed on outer side of page
4922 \begin_layout Itemize
4927 \begin_layout Description
4928 rmheadings serif titles — default,
4931 \begin_layout Description
4932 sfheadings sansserif titles,
4935 \begin_layout Description
4936 authortitle on title page first placed is author next title — default,
4939 \begin_layout Description
4940 titleauthor on title page first placed is title next author,
4943 \begin_layout Description
4944 withmarginpar reserve place on page for margins.
4948 \begin_layout Section
4950 \change_inserted 564990737 1670439534
4954 \begin_layout Standard
4956 \change_inserted 564990737 1670794710
4957 See also the document classes in the Collections (section
4958 \begin_inset space ~
4962 \begin_inset CommandInset ref
4964 reference "sec:Collections"
4971 \begin_layout Subsection
4973 \change_inserted 564990737 1670794716
4979 \begin_layout Standard
4981 \change_inserted 564990737 1670794716
4988 ; updated by the \SpecialChar LyX
4992 \begin_layout Subsubsection
4994 \change_inserted 564990737 1670794716
5000 \begin_layout Standard
5002 \change_inserted 564990737 1670794716
5005 This section describes how \SpecialChar LyX
5006 can be used to write articles for submission
5007 to the scientific journal
5009 Astronomy and Astrophysics
5012 \begin_inset CommandInset href
5015 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
5020 ) using Version 9.1 of the document class
5024 ; information about it is available at
5025 \begin_inset Flex URL
5028 \begin_layout Plain Layout
5030 \change_inserted 564990737 1670794716
5032 https://www.aanda.org/for-authors/latex-issues/texnical-background-information
5042 \begin_layout Standard
5044 \change_inserted 564990737 1670794716
5047 A manual comes together with the package and should be consulted before
5048 installing this document class as described in the
5050 Installing New Document Classe
5060 \begin_layout Standard
5062 \change_inserted 564990737 1670794716
5065 \begin_inset Note Greyedout
5068 \begin_layout Plain Layout
5070 \change_inserted 564990737 1670794716
5073 Please note that the publisher of the journal was changed from Springer
5074 to EDP Sciences starting January 1, 2001.
5075 That change also involved some slight changes to the style files, namely
5076 the removal of the thesaurus command.
5077 If you have an older version installed, please upgrade.
5078 For information about compatibility with the old (version 4) layout, please
5079 refer to the comments in
5082 Dir/layouts/aapaper.layout
5092 \begin_layout Subsubsection
5094 \change_inserted 564990737 1670794716
5100 \begin_layout Standard
5102 \change_inserted 564990737 1671617129
5105 It is recommended you start from the template in the menu
5110 ile\SpecialChar menuseparator
5112 \begin_inset space ~
5120 \begin_inset space ~
5125 \SpecialChar menuseparator
5126 Articles\SpecialChar menuseparator
5127 Astronomy & Astrophysics
5131 If you are not using the template, note the following settings:
5134 \begin_layout Itemize
5136 \change_inserted 564990737 1670794716
5148 ocument\SpecialChar menuseparator
5153 ettings\SpecialChar menuseparator
5155 \begin_inset space ~
5160 dialog (OK, that one was obvious).
5163 \begin_layout Itemize
5165 \change_inserted 564990737 1670794716
5171 \begin_inset space ~
5183 \begin_inset space ~
5188 dialog: leave it set to
5193 The whole layout is done by the macros, you shouldn't change anything.
5196 \begin_layout Subsubsection
5198 \change_inserted 564990737 1670794716
5204 \begin_layout Standard
5206 \change_inserted 564990737 1670794716
5209 First thing to enter is the header information.
5210 It consists of five entries, of which one is optional.
5214 \begin_layout Itemize
5216 \change_inserted 564990737 1670794716
5225 \begin_layout Itemize
5227 \change_inserted 564990737 1670794716
5236 \begin_layout Itemize
5238 \change_inserted 564990737 1670794716
5247 \begin_layout Itemize
5249 \change_inserted 564990737 1670794716
5258 \begin_layout Itemize
5260 \change_inserted 564990737 1670794716
5269 Received: <date>; Accepted <date>
5272 \begin_layout Standard
5274 \change_inserted 564990737 1670794716
5277 Although the order of the single header entries doesn't matter it is advised
5278 to keep the above sequence, just to get the best optics and meets the layout
5279 of the real document.
5282 \begin_layout Standard
5284 \change_inserted 564990737 1670794716
5287 If you want to place footnotes in the header block, e.
5288 \begin_inset space \thinspace{}
5292 \begin_inset space \space{}
5295 to state your present address, just use the standard footnote via the menu
5301 nsert\SpecialChar menuseparator
5310 will automagically use the term
5319 \begin_layout Standard
5321 \change_inserted 564990737 1670794716
5324 In addition to these topics, the macros use three additional \SpecialChar LaTeX
5326 have no counterpart in \SpecialChar LyX
5330 \begin_layout Itemize
5332 \change_inserted 564990737 1670794716
5340 to separate different names for more than one author and institute, respectivel
5344 \begin_layout Itemize
5346 \change_inserted 564990737 1670794716
5354 to mark corresponding author/institute pairs.
5355 The institutes are numbered sequentially as they appear in the
5359 field, so you have to put a marker to each author.
5362 \begin_layout Itemize
5364 \change_inserted 564990737 1670794716
5372 to supply an email address for fast contact.
5375 \begin_layout Standard
5377 \change_inserted 564990737 1671642374
5380 In all cases, the appropriate command has to be entered as \SpecialChar TeX
5381 code in \SpecialChar LyX
5383 See the examples in the template and in
5386 File\SpecialChar menuseparator
5387 Open Example\SpecialChar menuseparator
5388 Articles\SpecialChar menuseparator
5389 Astronomy & Astrophysics
5397 \begin_layout Subsubsection
5399 \change_inserted 564990737 1670794716
5405 \begin_layout Standard
5407 \change_inserted 564990737 1670794716
5410 The abstract should immediately follow the header block and must contain
5420 \begin_layout Enumerate
5422 \change_inserted 564990737 1670794716
5428 (optional) {} leave it empty if necessary
5431 \begin_layout Enumerate
5433 \change_inserted 564990737 1670794716
5442 \begin_layout Enumerate
5444 \change_inserted 564990737 1670794716
5453 \begin_layout Enumerate
5455 \change_inserted 564990737 1670794716
5464 \begin_layout Enumerate
5466 \change_inserted 564990737 1670794716
5472 (optional) {} leave it empty if necessary
5475 \begin_layout Standard
5477 \change_inserted 564990737 1670794716
5481 This structure not shown in
5488 \begin_layout Subsubsection
5490 \change_inserted 564990737 1670794716
5493 Supported environments
5496 \begin_layout Standard
5498 \change_inserted 564990737 1670794716
5501 The A&A paper layout supports the following environments for structuring
5505 \begin_layout Itemize
5507 \change_inserted 564990737 1670794716
5514 \begin_layout Itemize
5516 \change_inserted 564990737 1670794716
5523 \begin_layout Itemize
5525 \change_inserted 564990737 1670794716
5532 \begin_layout Itemize
5534 \change_inserted 564990737 1670794716
5541 \begin_layout Itemize
5543 \change_inserted 564990737 1670794716
5550 \begin_layout Itemize
5552 \change_inserted 564990737 1670794716
5559 \begin_layout Itemize
5561 \change_inserted 564990737 1670794716
5568 \begin_layout Itemize
5570 \change_inserted 564990737 1670794716
5577 \begin_layout Itemize
5579 \change_inserted 564990737 1670794716
5586 \begin_layout Itemize
5588 \change_inserted 564990737 1670794716
5595 \begin_layout Itemize
5597 \change_inserted 564990737 1670794716
5604 \begin_layout Itemize
5606 \change_inserted 564990737 1670794716
5614 \begin_layout Subsubsection
5616 \change_inserted 564990737 1670794716
5619 Commands not supported by \SpecialChar LyX
5623 \begin_layout Standard
5625 \change_inserted 564990737 1670794716
5628 Some commands are not yet supported by the
5632 layout for \SpecialChar LyX
5634 Some have already been mentioned.
5635 For the sake of completeness, they are listed all together here:
5638 \begin_layout Itemize
5640 \change_inserted 564990737 1670794716
5649 \begin_layout Itemize
5651 \change_inserted 564990737 1670794716
5660 \begin_layout Itemize
5662 \change_inserted 564990737 1670794716
5671 \begin_layout Itemize
5673 \change_inserted 564990737 1670794716
5682 \begin_layout Itemize
5684 \change_inserted 564990737 1670794716
5693 \begin_layout Standard
5695 \change_inserted 564990737 1670794716
5698 If you want to use any of these commands, you have to enter them yourself.
5701 Do not forget to use
5707 nsert\SpecialChar menuseparator
5710 \begin_inset space ~
5719 \begin_layout Subsubsection
5721 \change_inserted 564990737 1670794716
5724 Figure and Table Floats
5727 \begin_layout Standard
5729 \change_inserted 564990737 1670794716
5733 provides support for the necessary float environments
5735 figure, figure*, table
5741 , therefore we won't tell much about it here.
5745 \begin_inset space ~
5751 Just remember that tables should be left-aligned.
5752 For that, select the table and change the alignment in
5757 dit\SpecialChar menuseparator
5763 \begin_inset space ~
5769 \begin_layout Standard
5771 \change_inserted 564990737 1670794716
5774 There is only one special thing: the figures with a caption beside the figure.
5775 To create such a figure, you have to do the following:
5778 \begin_layout Enumerate
5780 \change_inserted 564990737 1670794716
5783 Create a wide figure float:
5788 nsert\SpecialChar menuseparator
5793 t\SpecialChar menuseparator
5796 , then, from within the float, use the menu
5801 dit\SpecialChar menuseparator
5807 \begin_inset space ~
5818 \begin_inset space ~
5830 \begin_layout Enumerate
5832 \change_inserted 564990737 1670794716
5835 Enter your caption text.
5838 \begin_layout Enumerate
5840 \change_inserted 564990737 1670794716
5847 to move the cursor above the caption.
5850 \begin_layout Enumerate
5852 \change_inserted 564990737 1670794716
5858 \begin_layout Enumerate
5860 \change_inserted 564990737 1670794716
5863 Position the cursor after the figure and insert a horizontal fill by using
5869 nsert\SpecialChar menuseparator
5874 rmatting\SpecialChar menuseparator
5880 \begin_inset space ~
5889 dialog and select the
5903 \begin_layout Enumerate
5905 \change_inserted 564990737 1670794716
5908 Switch to \SpecialChar LaTeX
5912 \begin_inset space ~
5920 \begin_layout Enumerate
5922 \change_inserted 564990737 1670794716
5933 Do not close the brace!
5936 \begin_layout Enumerate
5938 \change_inserted 564990737 1670794716
5941 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
5946 \begin_inset space ~
5958 \begin_layout Standard
5960 \change_inserted 564990737 1671642458
5963 Also, refer to the figures in the file in
5966 File\SpecialChar menuseparator
5967 Open Example\SpecialChar menuseparator
5968 Articles\SpecialChar menuseparator
5969 Astronomy & Astrophysics
5975 \begin_layout Subsubsection
5977 \change_inserted 564990737 1670794716
5983 \begin_layout Standard
5985 \change_inserted 564990737 1670794716
5988 For submission, the paper has to be formatted in a special double-spacing
5990 For this purpose, you have to add the option
6001 \begin_inset space ~
6011 ocument\SpecialChar menuseparator
6016 ettings\SpecialChar menuseparator
6018 \begin_inset space ~
6027 \begin_layout Subsubsection
6029 \change_inserted 564990737 1670794716
6035 \begin_layout Standard
6037 \change_inserted 564990737 1671642520
6043 File\SpecialChar menuseparator
6044 Open Example\SpecialChar menuseparator
6045 Articles\SpecialChar menuseparator
6046 Astronomy & Astrophysics
6049 was written with \SpecialChar LyX
6051 It is the example paper from the original macro package,
6056 \begin_inset CommandInset href
6059 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
6064 , but translated to \SpecialChar LyX
6065 using the older unstructured abstract type.
6066 Use it for inspiration, and compare the \SpecialChar LaTeX
6071 with the \SpecialChar LyX
6075 \begin_layout Subsection
6080 \begin_layout Standard
6086 \begin_layout Subsubsection
6090 \begin_layout Standard
6092 is a set of macros produced by the American Astronomical Society to
6093 facilitate electronic manuscript submission to the three journals they
6094 publish: the Astrophysical Journal (including the Letters and Supplement),
6095 the Astronomical Journal, and the Publications of the Astronomical Society
6098 has proven to be an excellent tool for generating these documents, especially
6099 given its equation, citation, and figure handling capabilities.
6101 requires version 5.0 (or higher) of these macros; preferably 6.0, which
6102 is the version described here, or higher.
6103 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
6104 2.09 and are fundamentally
6105 incompatible with \SpecialChar LyX
6107 The AAS\SpecialChar TeX
6108 package may be downloaded from the AAS\SpecialChar TeX
6112 \begin_layout Standard
6113 \begin_inset VSpace medskip
6119 \begin_layout Standard
6121 \begin_inset Flex URL
6124 \begin_layout Plain Layout
6126 https://aas.org/aastex/aastex-downloads
6134 \begin_layout Standard
6135 \begin_inset VSpace medskip
6141 \begin_layout Standard
6142 A complete user guide is contained in that package and you should familiarize
6143 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
6146 will not reduce the need to figure out all the AAS\SpecialChar TeX
6147 commands, it will only
6148 reduce the drudgery of typing everything in.
6149 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
6151 completely to the requirements of the journal to which you are submitting
6155 \begin_layout Subsubsection
6156 Starting a New Paper
6159 \begin_layout Standard
6160 I strongly suggest that you start with the AAS\SpecialChar TeX
6164 File\SpecialChar menuseparator
6170 \change_inserted 564990737 1671617265
6171 \SpecialChar menuseparator
6172 Articles\SpecialChar menuseparator
6173 American Astronomical Society
6174 \change_deleted 564990737 1671617310
6177 , enter the new file name, then choose the
6184 This will show the most common fields found in a manuscript.
6185 Simply overwrite the existing text (including the brackets,
6189 ) with the correct information.
6190 Many of the AAS\SpecialChar TeX
6191 commands and environments can be implemented directly in
6194 For commands such as these, the \SpecialChar LaTeX
6195 code must be entered directly and marked
6197 Such commands are referred to as \SpecialChar TeX
6198 code, or Evil Red Text.
6199 I tried to minimize the amount of \SpecialChar TeX
6200 code needed in an AAS\SpecialChar TeX
6204 \begin_layout Subsubsection
6205 Finishing Your Paper
6208 \begin_layout Standard
6209 When the paper is finished to your satisfaction and previews/prints correctly,
6211 \begin_inset Quotes eld
6215 \begin_inset Quotes erd
6218 actions which need to be done before you submit it to the journals.
6222 \begin_layout Enumerate
6223 Export your paper as a \SpecialChar LaTeX
6226 File\SpecialChar menuseparator
6227 Export\SpecialChar menuseparator
6235 \begin_layout Enumerate
6240 file with your favorite text editor
6244 \begin_layout Enumerate
6245 remove the comment lines before the
6254 \begin_layout Enumerate
6259 usepackage...{fontenc}
6261 line if it appears (usually just after
6276 \begin_layout Enumerate
6277 remove everything between (and including) the
6289 commands, except for any commands you specifically put into the \SpecialChar LaTeX
6291 (which should appear immediately after the
6292 \begin_inset Quotes eld
6295 User specified \SpecialChar LaTeX
6297 \begin_inset Quotes erd
6308 \begin_layout Enumerate
6309 Run the resulting file through \SpecialChar LaTeX
6310 to make sure it still processes correctly.
6313 \begin_layout Enumerate
6314 Reread the journal requirements to make sure your filenames and formats
6318 \begin_layout Enumerate
6322 \begin_layout Subsubsection
6323 Comments On Specific Commands
6326 \begin_layout Standard
6327 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
6334 ) gives a good description of each.
6335 Thus it's probably easiest for me to go down the list as found in the guide
6336 and offer comments where necessary.
6337 So let's begin \SpecialChar ldots
6341 \begin_layout Paragraph
6342 Things that work as expected
6345 \begin_layout Standard
6346 Because they work as you might expect, I simply list them and the section
6447 begin{thebibliography}
6455 (2.13.2), all the cite commands and their variations (2.13.2), the generic
6456 graphicx figure commands (2.14.1),
6480 (2.15.4, amongst other places),
6507 \begin_layout Standard
6508 The following style options also work correctly:
6529 Simply put them in the
6535 Layout\SpecialChar menuseparator
6541 \begin_layout Paragraph
6542 Things that work, but require more comment
6545 \begin_layout Standard
6546 The following items work, but require a little more discussion:
6549 \begin_layout Itemize
6550 These items are reserved for use by the journal editors, but you can put
6551 them into the \SpecialChar LaTeX
6552 preamble if you feel compelled to do so:
6585 \begin_layout Itemize
6586 These items may be placed in the \SpecialChar LaTeX
6587 preamble, and are included as blanks in
6609 \begin_layout Itemize
6616 (2.3) – can only be used
6617 \begin_inset Quotes eld
6621 \begin_inset Quotes erd
6624 , not in the middle of a paragraph.
6625 Use \SpecialChar TeX
6626 code if you need to embed it.
6629 \begin_layout Itemize
6636 (2.3) – will have extra {} after it.
6637 This should not cause an error.
6640 \begin_layout Itemize
6647 (2.6) – can only be used
6648 \begin_inset Quotes eld
6652 \begin_inset Quotes erd
6655 , not in the middle of a paragraph.
6656 Use \SpecialChar TeX
6657 code if you need to embed it.
6660 \begin_layout Itemize
6667 (2.8) – can't insert a cross-reference tag, you must type the tag name by
6671 \begin_layout Itemize
6685 \begin_layout Itemize
6692 (2.9) – will have extra {} after it.
6693 This should not cause an error.
6696 \begin_layout Itemize
6703 (2.11) – will have extra {} after it.
6704 This should not cause an error.
6707 \begin_layout Itemize
6714 (2.14.2) – you can insert an optional filename argument by placing the cursor
6715 at the beginning of the text and selecting
6717 Insert\SpecialChar menuseparator
6722 \begin_inset Quotes eld
6726 \begin_inset Quotes erd
6729 inserts an optional argument of the type needed by
6736 Hopefully it will be renamed someday.
6739 \begin_layout Itemize
6752 for the catalog ID optional parameter
6755 \begin_layout Itemize
6768 for the catalog ID optional parameter
6771 \begin_layout Paragraph
6772 Things not implemented, use \SpecialChar TeX
6776 \begin_layout Standard
6787 setcounter{equation}
6789 (2.12), Journal name abbreviations (2.13.4),
6825 (2.15.4, insert it as the first element in the lefthand cell after where
6827 Don't use any of \SpecialChar LyX
6828 's rules in the table),
6840 (2.15.5), much of Misc (2.17, except
6891 \begin_layout Paragraph
6892 Things that cannot be implemented
6895 \begin_layout Standard
6897 at least in any meaningful sort of way, so I suggest ignoring them.
6898 They are the references environment (2.13.3), and the deluxetable environment
6900 If you really, really need to use deluxetable, I suggest editing it in
6901 a separate file with a text editor, then using
6903 Insert\SpecialChar menuseparator
6905 \begin_inset space ~
6910 to include it in your \SpecialChar LyX
6913 \change_deleted 564990737 1671642564
6919 \change_inserted 564990737 1671642618
6923 File\SpecialChar menuseparator
6924 Open Example\SpecialChar menuseparator
6925 Articles\SpecialChar menuseparator
6926 American Astronomical Society
6932 \change_inserted 564990737 1671642621
6938 \begin_layout Subsubsection
6939 FAQs, Tips, Tricks, and Other Ruminations
6942 \begin_layout Paragraph
6943 Getting \SpecialChar LyX
6944 and AAS\SpecialChar TeX
6948 \begin_layout Standard
6949 It can be a bit tricky to get \SpecialChar LyX
6950 to recognize a new layout and document class.
6951 When all else fails, do this:
6954 \begin_layout Enumerate
6955 Make certain that \SpecialChar LaTeX
6956 can find AAS\SpecialChar TeX
6958 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
6960 directory completely unrelated to \SpecialChar LaTeX
6961 or AAS\SpecialChar TeX
6962 and run \SpecialChar LaTeX
6970 \begin_layout Enumerate
6975 appears in \SpecialChar LyX
6983 \begin_layout Enumerate
6986 Tools\SpecialChar menuseparator
6990 , then restart \SpecialChar LyX
6994 \begin_layout Enumerate
6995 Open a regular new file, not from a template.
6996 Does AAS\SpecialChar TeX
6997 appear in the class list in
6999 Document\SpecialChar menuseparator
7005 \begin_layout Standard
7006 If you get a warning from an existing AAS\SpecialChar TeX
7007 document about not being able
7008 to find the AAS\SpecialChar TeX
7009 layout or a message about
7010 \begin_inset Quotes eld
7013 You should not mix title layouts with normal ones
7014 \begin_inset Quotes erd
7017 , things haven't been installed correctly.
7020 \begin_layout Paragraph
7022 error processing a table
7025 \begin_layout Standard
7027 , by default, attempts to center the table caption/title.
7028 This seems to produce a bad interaction in AAS\SpecialChar TeX
7029 so you should click somewhere
7030 in the caption/title, then select
7032 Edit\SpecialChar menuseparator
7034 \begin_inset space ~
7048 This took care of it for me.
7051 \begin_layout Paragraph
7055 \begin_layout Standard
7056 A couple of things: 1) I have noticed some funny spacing in the reference
7057 entries in the text.
7058 When you enter the bibliography item data, make sure their is
7062 space between the last author and the parenthesis setting off the year;
7066 \begin_inset space \thinspace{}
7070 \begin_inset space \space{}
7084 2) Entering the references at all is not obvious.
7085 The easiest thing is to start typing your first reference at the end of
7086 the document, then mark it as type
7091 That will put a small gray box in front of what you just typed.
7092 Click on the box to fill in the rest of the information.
7093 For new references, go to the end of an existing reference and press return.
7094 That will create a new line with its own box, etc.
7097 \begin_layout Paragraph
7101 \begin_layout Standard
7102 Even though AAS\SpecialChar TeX
7103 provides its own figure commands (
7109 , for example), I much prefer \SpecialChar LaTeX
7110 's standard figure commands (with the default
7119 \begin_inset space ~
7122 commands as \SpecialChar TeX
7123 code into a Figure Float box if you desire, but I never have
7124 much luck getting the layout right.
7125 With the standard graphics, \SpecialChar LyX
7130 usepackage{graphicx}
7132 command into the \SpecialChar LaTeX
7133 preamble and handle the figures in the standard \SpecialChar LaTeX2e
7135 interspersing the figures in the text.
7136 I believe ApJ accepts figures exactly this way now; AJ might still use
7138 \begin_inset Quotes eld
7141 stack everything at the end
7142 \begin_inset Quotes erd
7148 \begin_layout Paragraph
7149 Things I could have done, but didn't
7152 \begin_layout Standard
7154 \begin_inset Quotes eld
7158 \begin_inset Quotes erd
7161 things I could have implemented, but chose not to.
7162 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
7164 even though it is double-spaced in the paper manuscript.
7165 Also, I chose not to make separate layouts for the preprint and preprint2
7167 Since I assume you will spend most of your time in the plain manuscript
7168 mode anyway, I decided not to chew up more disk space with this.
7172 \begin_layout Subsubsection
7176 \begin_layout Standard
7177 Your mileage may vary.
7178 I've now had papers published by both ApJ and AJ that have had 98% of the
7179 effort done in \SpecialChar LyX
7180 ; the last 2% was the \SpecialChar LaTeX
7181 post-processing and a few cleanups.
7182 I have had no trouble with the submission process, and I'm sure the journals
7183 were never aware that there might be a difference.
7184 So, go forth and publish!
7187 \begin_layout Subsection
7189 \change_inserted 564990737 1671442131
7195 \begin_layout Standard
7197 \change_inserted 564990737 1671642768
7203 \begin_inset space \thinspace{}
7212 document class together with the style
7216 to facilitate the description of chess games.
7220 File\SpecialChar menuseparator
7223 \SpecialChar menuseparator
7224 Articles\SpecialChar menuseparator
7243 \begin_layout Subsection
7245 \change_inserted 564990737 1671042028
7251 \begin_layout Standard
7253 \change_inserted 564990737 1671617396
7259 \begin_inset space \thinspace{}
7269 This provides the following additional environments:
7272 \begin_inset space ~
7280 \begin_inset space ~
7288 \begin_inset space ~
7306 A template is available in the menu
7311 ile\SpecialChar menuseparator
7313 \begin_inset space ~
7321 \begin_inset space ~
7326 \SpecialChar menuseparator
7327 Articles\SpecialChar menuseparator
7332 It has been customized with further environments and contains all the informati
7334 However, the documentation is also available from
7335 \begin_inset CommandInset href
7338 target "http://mirrors.ctan.org/macros/latex/contrib/elsarticle/doc/elsdoc.pdf"
7346 \begin_layout Subsection
7348 \change_inserted 564990737 1671042046
7354 \begin_layout Standard
7356 \change_inserted 564990737 1671042046
7362 \begin_inset space \thinspace{}
7367 provides an alternative to the
7372 It provides similar functionality, but you might prefer this layout with
7373 sans serif sections, headings, and more.
7376 \begin_layout Subsection
7381 \begin_layout Standard
7387 \begin_layout Standard
7388 \begin_inset VSpace bigskip
7394 \begin_layout Standard
7399 \begin_inset space ~
7404 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
7406 \begin_inset Formula $\beta$
7409 release of May, 1999) class.
7412 \begin_layout Standard
7418 textclass, which works with Rev\SpecialChar TeX
7420 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
7422 That means that it doesn't interact very well with \SpecialChar LyX
7423 , which requires \SpecialChar LaTeX2e
7425 it has been kludged to work.
7426 Since Rev\SpecialChar TeX
7427 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
7434 \begin_inset space ~
7439 textclass should also be pretty easy to use.
7442 \begin_layout Standard
7443 These documents are supposed to be used in
7447 to the Rev\SpecialChar TeX
7448 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
7450 and assume you'll know what to put in the preamble if necessary.
7453 \begin_layout Subsubsection
7457 \begin_layout Standard
7458 All you need to do is install Rev\SpecialChar TeX
7459 4, as described in the package's README
7461 The package can be found at The Rev\SpecialChar TeX
7463 \begin_inset Flex URL
7466 \begin_layout Plain Layout
7468 http://publish.aps.org/revtex4/
7474 Install it somewhere that \SpecialChar LaTeX
7476 Test it by trying to \SpecialChar LaTeX
7477 a short Rev\SpecialChar TeX
7478 4 document in some random directory (i.
7479 \begin_inset space \thinspace{}
7483 \begin_inset space \space{}
7486 not the directory where you installed the class file.) Then, if you reconfigure
7488 , it will find the class file and let you use the Rev\SpecialChar TeX
7492 \begin_layout Standard
7493 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
7502 \begin_inset space ~
7507 template, found in the templates directory.
7510 \begin_layout Subsubsection
7514 \begin_layout Standard
7515 Optional arguments to
7522 \begin_inset Quotes eld
7526 \begin_inset Quotes erd
7530 \begin_inset Quotes eld
7534 \begin_inset Quotes erd
7540 \begin_inset space ~
7548 \begin_inset space ~
7554 Remember that in Rev\SpecialChar TeX
7555 , at least one optional argument is required!
7558 \begin_layout Standard
7559 Other preamble matter, like
7566 \begin_inset space ~
7573 \begin_inset space ~
7578 dialog, also as usual.
7581 \begin_layout Subsubsection
7585 \begin_layout Standard
7586 The layouts basically correspond to the commands in Rev\SpecialChar TeX
7588 For example, the Email layout corresponds to
7595 Note that (at least as of Rev\SpecialChar TeX
7604 layouts are exactly equivalent, so you shouldn't need to use both.
7608 \begin_layout Plain Layout
7609 In case you're curious, both were included so that
7613 would be able to translate both
7633 \begin_layout Subsubsection
7637 \begin_layout Standard
7638 There are a couple of important unique aspects of Rev\SpecialChar TeX
7640 bugs that will be even more confusing in \SpecialChar LyX
7644 \begin_layout Standard
7645 In Rev\SpecialChar TeX
7663 The \SpecialChar LyX
7664 equivalent is that there is a separate Thanks layout.
7669 write footnotes in the
7673 layout, or weird things may happen.
7674 See the Rev\SpecialChar TeX
7675 4 documentation for more details.
7678 \begin_layout Standard
7682 \begin_inset space ~
7690 \begin_inset space ~
7699 layouts must be placed
7707 layout and the corresponding
7724 , the \SpecialChar LaTeX
7728 \begin_layout Subsection
7730 \change_inserted 564990737 1671042072
7736 \begin_layout Standard
7738 \change_inserted 564990737 1671042072
7745 classes were replaced in 2013 with a completely new
7750 This package provides a \SpecialChar LaTeX
7751 class and templates for books to be published
7752 at Springer Gabler Research, Springer Vieweg Research, Springer Spektrum
7753 Research, Springer VS Research, or Springer VS Forschung.
7754 The documentation is available in German from
7755 \begin_inset CommandInset href
7758 target "http://mirrors.ctan.org/macros/latex/contrib/springer/sr-vorl/sr-vorl.pdf"
7766 \begin_layout Section
7768 \change_inserted 564990737 1670439560
7772 \begin_layout Standard
7774 \change_inserted 564990737 1670439581
7775 See also the document classes in the Collections (section
7776 \begin_inset space ~
7780 \begin_inset CommandInset ref
7782 reference "sec:Collections"
7789 \begin_layout Subsection
7793 \begin_layout Standard
7799 \begin_layout Subsubsection
7803 \begin_layout Standard
7804 Memoir is a very powerful and constantly evolving class.
7805 It has been designed with regard to fictional and non-fictional literature.
7806 Its aim is to let the user have maximum control over the typesetting of
7808 Memoir is based on the standard book class, but it can also emulate the
7809 article class (see below).
7812 \begin_layout Standard
7813 Peter Wilson, the developer of Memoir, is known as the author of lots of
7814 useful packages in the \SpecialChar LaTeX
7816 Most of them have been merged with Memoir.
7817 Therefore, it is much easier to layout the table of contents, appendices,
7818 chapter designs and such.
7820 , though, does not support all of these goodies natively.
7821 Some of them might be added to forthcoming releases
7825 \begin_layout Plain Layout
7826 You are invited to send suggestions to
7827 \begin_inset Flex URL
7830 \begin_layout Plain Layout
7832 lyx-devel@lists.lyx.org
7842 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
7844 Of course you can still use all features with the help of some native \SpecialChar LaTeX
7846 commands (\SpecialChar TeX
7851 \begin_layout Plain Layout
7856 \begin_layout Plain Layout
7866 \begin_inset space ~
7870 \begin_inset CommandInset ref
7872 reference "sec:Inserting-TeX-Code"
7882 In this section, we can only list those features that are natively supported
7885 For detailed descriptions (and for the rest of features) we recommend you
7886 have a look at the detailed manual of the Memoir class
7890 \begin_layout Plain Layout
7895 \begin_layout Plain Layout
7905 \begin_inset Flex URL
7908 \begin_layout Plain Layout
7910 CTAN:/macros/latex/memoir/memman.pdf
7920 , which is not only a user guide for the class, but also both a comprehensive
7921 description on good typesetting and a superb example for good typesetting
7925 \begin_layout Subsubsection
7926 Basic features and restrictions
7929 \begin_layout Standard
7930 Memoir supports basically all features of the standard book classes.
7931 There are, however, some differences, as follows:
7934 \begin_layout Description
7936 \begin_inset space ~
7939 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
7942 \begin_layout Description
7944 \begin_inset space ~
7947 style: The fancy page style is not supported, due to a command clash between
7948 Memoir and the fancyhdr package (they both define a command with the same
7949 name, which confuses \SpecialChar LaTeX
7951 Instead, Memoir comes with a number of its own page styles (see
7953 Document\SpecialChar menuseparator
7954 Settings\SpecialChar menuseparator
7956 \begin_inset space ~
7962 If you want to use these for the chapter pages, you have to use the command
7969 in the main text or in preamble (e.
7970 \begin_inset space \thinspace{}
7974 \begin_inset space \space{}
7981 chapterstyle{companion}
7986 \begin_layout Description
7987 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
7988 optional argument in the standard classes.
7989 With this, you can specify an alternative version of the title for the
7990 table of contents and the headers (for instance, if the title is too long).
7992 , you can do this via
7994 Insert\SpecialChar menuseparator
7996 \begin_inset space ~
8001 at the beginning of a chapter/section.
8002 Memoir features a second optional argument and thus separates the table
8003 of contents from the header.
8004 You can define three variants of a title with this: one for the main text,
8005 one for the table of contents, and one for the headers.
8007 makes these available in form of specific
8018 \begin_layout Description
8019 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
8020 of contents, the list of figures and the list of table start a new page
8022 Memoir does not follow this route.
8023 You have to insert a page break yourself, if you want to have one.
8026 \begin_layout Description
8027 Titlepage: For some unknown reason, Memoir uses pagination on the title
8028 page (in the standard classes, title pages are
8029 \begin_inset Quotes eld
8033 \begin_inset Quotes erd
8037 If you want an empty title page, type
8041 aliaspagestyle{title}{empty}
8046 \begin_layout Description
8047 Article: With the class option
8053 Document\SpecialChar menuseparator
8054 Settings\SpecialChar menuseparator
8055 Class Settings\SpecialChar menuseparator
8057 \begin_inset space ~
8062 ), you can emulate article style.
8063 That is, counters (footnotes, figures, tables etc.) will not be reset on
8064 new chapters, chapters don't start a new page (but are—in contrary to
8065 \begin_inset Quotes eld
8069 \begin_inset Quotes erd
8072 article classes—still allowed), parts, though, use their own page, as in
8076 \begin_layout Description
8077 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
8078 font commands, which have been used in the old \SpecialChar LaTeX
8080 \begin_inset space \thinspace{}
8084 \begin_inset space \space{}
8100 It produces an error and stops \SpecialChar LaTeX
8101 whenever such a command appears.
8106 reallows the commands and spits out warnings instead (which does at least
8107 not stop \SpecialChar LaTeX
8109 Since a lot of packages and particularly Bib\SpecialChar TeX
8110 style files are still using
8111 those commands, we have decided to use this option by default.
8114 \begin_layout Subsubsection
8118 \begin_layout Standard
8119 We will only describe the features supported by \SpecialChar LyX
8120 (which is not much currently).
8121 Please consult the Memoir manual
8125 \begin_layout Plain Layout
8130 \begin_layout Plain Layout
8140 \begin_inset Flex URL
8143 \begin_layout Plain Layout
8145 CTAN:/macros/latex/memoir/memman.pdf
8158 \begin_layout Description
8159 Abstract: You may wonder why an abstract is an extra feature.
8160 Well, it is in book class.
8161 Usually books don't have abstracts.
8162 Memoir, however, has.
8163 You can use it wherever and how often you like.
8166 \begin_layout Description
8167 Chapterprecis: You may know this older typesetting style: The contents of
8168 a chapter are summarized below the title and also in the table of contents
8170 \begin_inset space \thinspace{}
8174 \begin_inset space \space{}
8179 Our hero arrives in Troia; he loses some friends; he finds others
8182 Chapterprecis does exactly this.
8183 It is therefore only sensible below a chapter.
8186 \begin_layout Description
8187 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
8188 The epigraph environment provides an elegant way of typesetting such a
8190 The motto itself (text) and its (optional) author (source) are divided
8192 The author (source) can be inserted via
8194 Insert\SpecialChar menuseparator
8201 \begin_layout Description
8202 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
8203 complex figurative poems).
8205 can only support a few of them.
8206 One is poemtitle, which is a centered title for poems, which will also
8207 be added to the table of contents (verse is the standard environment for
8209 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
8211 because they have to be nested inside regular verse environments, which
8212 is not possible with \SpecialChar LyX
8216 \begin_layout Description
8217 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
8220 \begin_layout Subsection
8222 \change_inserted 564990737 1671442175
8228 \begin_layout Standard
8230 \change_inserted 564990737 1671442175
8240 \begin_inset space \thinspace{}
8245 document class but adds two environments:
8248 \begin_layout Description
8250 \change_inserted 564990737 1671442175
8253 Recipe a numbered section environment at the
8257 level which generates a bold centered heading above a double horizontal
8261 \begin_layout Description
8263 \change_inserted 564990737 1671442175
8276 are what are being described and the environment ends with a horizontal
8280 \begin_layout Standard
8282 \change_inserted 564990737 1671642866
8286 File\SpecialChar menuseparator
8287 Open Example\SpecialChar menuseparator
8288 Books\SpecialChar menuseparator
8292 illustrates its use.
8295 \begin_layout Standard
8297 \change_inserted 564990737 1671442175
8300 It is designed for typesetting one or two recipes per page, with dimensions
8302 \begin_inset Quotes qrd
8306 \begin_inset Quotes qrd
8310 The hyperlinked table of contents (ToC) and page numbers make browsing
8311 recipes convenient, and the pages can be joined together or printed 2 per
8312 page to normal letterpaper easily.
8313 The size was chosen to work in half-page 3-ring binder cover sheets, because
8314 un-laminated paper just doesn't last in the kitchen.
8317 \begin_layout Standard
8319 \change_inserted 564990737 1671442175
8322 The half-letter pages can be printed two per page using your printer driver,
8323 or bound together using
8325 pdfjam --nup 2x1 --papersize '{11in,8.5in}'
8335 is the compiled version of your recipes.
8338 \begin_layout Section
8340 \change_inserted 564990737 1671442207
8344 \begin_layout Subsection
8346 \change_inserted 564990737 1671442208
8352 \begin_layout Standard
8354 \change_inserted 564990737 1671642942
8360 \begin_inset space \space{}
8364 \begin_inset space \thinspace{}
8373 document class, an unofficial implementation of the ‘Europass CV’ recommended
8374 by the European Commission in 2013.
8378 File\SpecialChar menuseparator
8379 Open Example\SpecialChar menuseparator
8380 Curricula Vitae\SpecialChar menuseparator
8384 offers guidance on its use.
8385 Its documentation is available from
8386 \begin_inset CommandInset href
8389 target "http://mirrors.ctan.org/macros/latex/contrib/europasscv/europasscv.pdf"
8397 \begin_layout Subsection
8399 \change_inserted 564990737 1671442208
8405 \begin_layout Standard
8407 \change_inserted 564990737 1671642984
8413 \begin_inset space \space{}
8417 \begin_inset space \thinspace{}
8426 document class, an unofficial implementation of the “Europass CV” recommended
8427 by the European Commission in 2002.
8431 File\SpecialChar menuseparator
8432 Open Example\SpecialChar menuseparator
8433 Curricula Vitae\SpecialChar menuseparator
8437 offers guidance on its use.
8438 Its documentation is available from
8439 \begin_inset CommandInset href
8442 target "http://mirrors.ctan.org/macros/latex/contrib/europecv/europecv.pdf"
8450 \begin_layout Subsection
8452 \change_inserted 564990737 1671442208
8458 \begin_layout Standard
8460 \change_inserted 564990737 1671643003
8466 \begin_inset space \space{}
8470 \begin_inset space \thinspace{}
8480 This allows the creation of customizable CVs.
8484 File\SpecialChar menuseparator
8485 Open Example\SpecialChar menuseparator
8486 Curricula Vitae\SpecialChar menuseparator
8490 offers guidance on its use.
8491 Its documentation is available from
8492 \begin_inset CommandInset href
8495 target "http://mirrors.ctan.org/macros/latex/contrib/moderncv/manual/moderncv_userguide.pdf"
8503 \begin_layout Subsection
8505 \change_inserted 564990737 1671442208
8511 \begin_layout Standard
8513 \change_inserted 564990737 1671643024
8519 \begin_inset space \space{}
8523 \begin_inset space \thinspace{}
8532 document class, originally developed for use with \SpecialChar LyX
8537 File\SpecialChar menuseparator
8538 Open Example\SpecialChar menuseparator
8539 Curricula Vitae\SpecialChar menuseparator
8543 offers guidance on its use.
8544 Its documentation is available from
8545 \begin_inset CommandInset href
8548 target "http://mirrors.ctan.org/macros/latex/contrib/simplecv/simplecv.pdf"
8556 \begin_layout Section
8558 \change_inserted 564990737 1671041968
8562 \begin_layout Subsection
8564 \change_inserted 564990737 1671041970
8570 \begin_layout Standard
8572 \change_inserted 564990737 1671617528
8583 document class for writing letters according to the
8585 Deutsches Institut für Normung
8588 The file in the menu
8593 ile\SpecialChar menuseparator
8595 \begin_inset space ~
8603 \begin_inset space ~
8606 Template\SpecialChar menuseparator
8607 Letters\SpecialChar menuseparator
8610 offers guidance on its use.
8611 The documentation is available from
8612 \begin_inset CommandInset href
8615 target "http://mirrors.ctan.org/macros/latex/contrib/dinbrief/liesmich"
8623 \begin_layout Subsection
8625 \change_inserted 564990737 1671458835
8631 \begin_layout Standard
8633 \change_inserted 564990737 1671617591
8644 document class for English letters and to create mailing labels.
8645 The file in the menu
8650 ile\SpecialChar menuseparator
8652 \begin_inset space ~
8660 \begin_inset space ~
8663 Template\SpecialChar menuseparator
8664 Letters\SpecialChar menuseparator
8665 Letter (Standard Class)
8667 offers guidance on its use.
8670 \begin_layout Section
8672 \change_inserted 564990737 1670439660
8676 \begin_layout Subsection
8678 \change_inserted 564990737 1671458922
8684 \begin_layout Standard
8686 \change_inserted 564990737 1671617655
8692 \begin_inset space \thinspace{}
8701 document class for creating presentations.
8702 The file in the menu
8707 ile\SpecialChar menuseparator
8709 \begin_inset space ~
8717 \begin_inset space ~
8720 Template\SpecialChar menuseparator
8721 Presentations\SpecialChar menuseparator
8724 offers guidance on its use.
8725 The documentation is available from
8726 \begin_inset CommandInset href
8729 target "http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf"
8737 \begin_layout Subsection
8740 Foil\SpecialChar TeX
8744 \begin_inset CommandInset label
8753 \begin_layout Standard
8759 \begin_layout Subsubsection
8763 \begin_layout Standard
8764 This section describes how to use \SpecialChar LyX
8765 to make slides for overhead projectors.
8766 There are two document classes that can do this: the default slides class
8769 Foil\SpecialChar TeX
8773 This section documents the latter.
8776 \begin_layout Standard
8777 I'm going to say this again, nice and clear, so that there's no misunderstanding
8781 \begin_layout Standard
8782 \begin_inset VSpace bigskip
8788 \begin_layout Standard
8792 This section documents the class
8793 \begin_inset Quotes eld
8801 \begin_inset Quotes erd
8809 \begin_layout Standard
8810 \begin_inset VSpace bigskip
8816 \begin_layout Standard
8817 If you're looking for the documentation for
8818 \begin_inset Quotes eld
8826 \begin_inset Quotes erd
8830 \begin_inset space ~
8834 \begin_inset CommandInset ref
8836 reference "sec:slitex"
8841 If your machine doesn't have the
8849 installed, you'll probably have to use the default
8853 class, which isn't quite as good as
8858 \begin_layout Standard
8863 class is designed for use with version
8864 \begin_inset space ~
8872 class file which is now an integral part of \SpecialChar LaTeX2e
8876 \begin_layout Subsubsection
8880 \begin_layout Standard
8881 Obviously, to use this document class, you need to select
8892 \begin_inset space ~
8898 There are some settings in the
8901 \begin_inset space ~
8906 dialog that you should know about that are specific to this class:
8909 \begin_layout Itemize
8910 Don't change the options
8921 \begin_inset space ~
8927 They're ignored by the
8934 \begin_layout Itemize
8935 The default font size is 20
8936 \begin_inset space \thinspace{}
8939 pt with the other options being 17
8940 \begin_inset space \thinspace{}
8944 \begin_inset space \thinspace{}
8948 \begin_inset space \thinspace{}
8954 \begin_layout Itemize
8963 but all math equations are still typeset in the usual roman font.
8966 \begin_layout Itemize
8969 Foil\SpecialChar TeX
8972 supports A4 and Letter paper sizes as well as a special size for working
8974 \begin_inset space \thinspace{}
8978 It doesn't support A5, B5, legal or executive paper sizes.
8981 \begin_layout Itemize
8982 Don't bother changing the
8986 settings because they are ignored anyway.
8987 All floats appear where they are defined in the text.
8990 \begin_layout Itemize
8995 setting behaves a bit differently for this class.
8998 Foil\SpecialChar TeX
9001 provides extensive footer and header capabilities including a user-defined
9004 \begin_inset space ~
9008 \begin_inset CommandInset ref
9010 reference "sec:foilfoot"
9015 The title page is treated differently to all other pages in the document
9024 has the logo centered at the bottom of the page (if one is defined).
9025 The possible page style choices and what they do are as follows:
9029 \begin_layout Labeling
9030 \labelwidthstring MMMMMMM
9037 The final output contains no page numbers, or other headers or footers
9038 (except footnotes of course).
9042 \begin_layout Labeling
9043 \labelwidthstring MMMMMMM
9050 The final output contains page numbers centered at the bottom of the page.
9051 No other headings or footers (other than footnotes).
9054 \begin_layout Labeling
9055 \labelwidthstring MMMMMMM
9060 Page numbers in lower right corner.
9061 Additional headers and footers are also shown.
9062 This is also the default.
9065 \begin_layout Labeling
9066 \labelwidthstring MMMMMMM
9071 Gives you access to the
9075 package although its use with
9077 Foil\SpecialChar TeX
9080 is discouraged by the writer of the
9082 Foil\SpecialChar TeX
9085 package because of some potential page layout clashes.
9089 \begin_layout Paragraph
9093 \begin_layout Standard
9094 The following options may be used in the extra class options in the
9096 Document\SpecialChar menuseparator
9102 \begin_layout Labeling
9103 \labelwidthstring MMMMMMx
9108 This sets up the page layout for 7.33
9109 \begin_inset space \thinspace{}
9113 \begin_inset space \thinspace{}
9116 in paper, which is about the same aspect ratio as a 35
9117 \begin_inset space \thinspace{}
9120 mm slide, making it a bit easier to work with this medium.
9123 \begin_layout Labeling
9124 \labelwidthstring MMMMMMx
9129 Places a rule across the page below the header on every page except the
9133 \begin_layout Labeling
9134 \labelwidthstring MMMMMMx
9139 Places a rule across the page above the footer on every page except the
9143 \begin_layout Labeling
9144 \labelwidthstring MMMMMMx
9149 This is automatically set each time you create a new
9156 Foil\SpecialChar TeX
9159 to use the dvips driver to rotate those pages that are set as landscape
9163 \begin_layout Labeling
9164 \labelwidthstring MMMMMMx
9169 Simply changes the page dimensions to those of a landscape page but doesn't
9171 Thus if you use this option you need to use an external program to rotate
9172 each page or feed your paper through your printer as landscape.
9173 Note that this option effectively reverses the roles of the
9181 environments (don't worry these are described in the next section).
9184 \begin_layout Labeling
9185 \labelwidthstring MMMMMMx
9190 Equation numbers on the left.
9193 \begin_layout Labeling
9194 \labelwidthstring MMMMMMx
9199 Flush-left equations.
9202 \begin_layout Subsubsection
9203 Supported Environments
9206 \begin_layout Standard
9207 Most of the environments commonly supported in other classes are also supported
9213 There are several additional environments provided by
9215 Foil\SpecialChar TeX
9218 as well as a couple added by \SpecialChar LyX
9220 The following environments are shared with other classes:
9223 \begin_layout Standard
9224 \begin_inset Flex Multiple Columns
9227 \begin_layout Itemize
9233 \begin_layout Itemize
9239 \begin_layout Itemize
9245 \begin_layout Itemize
9251 \begin_layout Itemize
9257 \begin_layout Itemize
9264 \begin_layout Itemize
9270 \begin_layout Itemize
9276 \begin_layout Itemize
9282 \begin_layout Itemize
9288 \begin_layout Itemize
9294 \begin_layout Itemize
9300 \begin_layout Itemize
9306 \begin_layout Itemize
9312 \begin_layout Itemize
9323 \begin_layout Standard
9324 That is, all the major environments apart from the sectioning environments.
9325 Since foils are essentially self-contained sections, with a title and body,
9328 Foil\SpecialChar TeX
9331 provides specific commands for starting new foils and these are:
9334 \begin_layout Itemize
9340 \begin_layout Itemize
9346 \begin_layout Standard
9348 also provides slightly modified versions of these two environments called:
9351 \begin_layout Itemize
9357 \begin_layout Itemize
9363 \begin_layout Standard
9364 and the differences will be explained in the next section.
9367 \begin_layout Standard
9368 Since foils are often used in presenting ideas or new theorems and such
9371 Foil\SpecialChar TeX
9374 also provides a comprehensive box of goodies for presenting them:
9377 \begin_layout Standard
9378 \begin_inset Flex Multiple Columns
9381 \begin_layout Itemize
9387 \begin_layout Itemize
9393 \begin_layout Itemize
9399 \begin_layout Itemize
9405 \begin_layout Itemize
9411 \begin_layout Itemize
9417 \begin_layout Itemize
9423 \begin_layout Itemize
9429 \begin_layout Itemize
9435 \begin_layout Itemize
9441 \begin_layout Itemize
9452 \begin_layout Standard
9453 The starred versions are unnumbered while the unstarred versions are numbered.
9454 There are also two list environments added by \SpecialChar LyX
9458 \begin_layout Itemize
9464 \begin_layout Itemize
9470 \begin_layout Standard
9473 Foil\SpecialChar TeX
9476 provides some powerful header and footer capabilities that are best set
9477 in the preamble although they may be set at any point in a document.
9478 If you want to change these settings in your document the best place to
9479 do so is at the very top of a foil, i.
9480 \begin_inset space \thinspace{}
9486 \begin_inset space \space{}
9491 straight after the foilhead.
9494 \begin_layout Standard
9495 For this purpose, the following command styles are provided [
9502 \begin_layout Standard
9503 \begin_inset Flex Multiple Columns
9506 \begin_layout Itemize
9510 \begin_inset space ~
9516 \begin_layout Itemize
9522 \begin_layout Itemize
9526 \begin_inset space ~
9532 \begin_layout Itemize
9536 \begin_inset space ~
9542 \begin_layout Itemize
9546 \begin_inset space ~
9553 \begin_layout Plain Layout
9554 \begin_inset space ~
9566 \begin_layout Standard
9567 There are also a few commands provided by
9569 Foil\SpecialChar TeX
9572 that aren't directly supported by \SpecialChar LyX
9573 but I'll tell you what they do and how
9574 to use them in section
9575 \begin_inset space ~
9579 \begin_inset CommandInset ref
9581 reference "sec:unsuppfoils"
9588 \begin_layout Subsubsection
9589 Building a Set of Foils
9592 \begin_layout Standard
9593 This section will give a simple introduction to using the different environments
9594 to build a set of foils.
9595 If you want to see an example set of foils, take a look at
9596 \change_deleted 564990737 1671643085
9601 file you find in \SpecialChar LyX
9607 \change_inserted 564990737 1671643099
9611 File\SpecialChar menuseparator
9614 \SpecialChar menuseparator
9615 Presentations\SpecialChar menuseparator
9623 \begin_layout Paragraph
9624 Give It a Title Page
9627 \begin_layout Standard
9628 Unlike other classes that provide
9648 creates the title on a page of its own.
9649 If you leave out the
9653 environment \SpecialChar LaTeX
9654 will substitute the current date (every time you regenerate
9658 \begin_layout Paragraph
9662 \begin_layout Standard
9663 As I mentioned earlier, there are four ways of starting a new foil.
9664 For portrait foils you should use
9673 The difference between these two environments is the amount of space between
9674 the title of the foil (the foilhead) and the body of the foil.
9677 \begin_layout Standard
9678 Landscape foils are generated using the
9687 Again the only difference is the spacing between foilhead and body.
9688 Both of the short versions have 0.5
9689 \begin_inset space ~
9692 inches less separation between the foilhead and the body.
9696 \begin_layout Standard
9697 One problem with the support for landscape foils is the requirement that
9702 driver to generate the PostScript output otherwise the foils won't be rotated.
9703 It is possible to get landscape foils even if you haven't got the
9707 driver provided you can feed your foils sideways through your printer ;-)
9710 \begin_layout Paragraph
9711 Theorems, Lemmas, Proofs and more
9714 \begin_layout Standard
9715 You can't have two of the same type of these environments directly following
9717 If you use a normal paragraph break, , you will just be extending the previous
9718 environment as if you had merged the two environments together.
9719 Rather than that, you need to insert a so-called separator.
9720 Please refer to the section entitled
9731 \begin_layout Paragraph
9735 \begin_layout Standard
9736 You get all the commonly supported list styles found in other classes as
9737 well as two new ones.
9738 I'll only describe the new ones here.
9739 If you want to find out more about the other list environments check out
9745 If you intend to use itemized lists you might also want to read about the
9749 \begin_inset space ~
9753 \begin_inset space ~
9758 dialog described above in section
9759 \begin_inset space ~
9763 \change_inserted 564990737 1671355684
9765 \begin_inset CommandInset ref
9767 reference "chap:bullets"
9772 \change_deleted 564990737 1671355684
9774 \begin_inset CommandInset ref
9776 reference "sec:bullet"
9785 \begin_layout Standard
9786 The two new list styles,
9794 , are designed to make it easier for you to create lists of do's and don'ts
9795 or right and wrong by providing dedicated environments that use a tick
9796 or a cross as the label of the list.
9797 These lists are in fact dedicated variants of the
9802 They do however require that you have the
9809 \begin_layout Paragraph
9813 \begin_layout Standard
9816 Foil\SpecialChar TeX
9819 redefines the floating tables and figures so that they appear exactly where
9820 they are in the text rather than pushing them to the top of the page or
9821 to some user specified location.
9822 In fact if you change the float placement settings they are simply ignored.
9825 \begin_layout Paragraph
9826 Page Headers and Footers
9827 \begin_inset CommandInset label
9836 \begin_layout Standard
9840 \begin_inset space ~
9849 are two commands used to control the left-footer text string.
9850 The first is meant to allow you to include a graphic logo on your foils
9852 \begin_inset Quotes eld
9857 Foil\SpecialChar TeX
9861 \begin_inset Quotes erd
9865 While the second is meant to provide a classification for the audience,
9869 \begin_inset space \thinspace{}
9875 \begin_inset space \space{}
9879 It is empty by default.
9882 \begin_layout Standard
9883 The remaining page corners can be filled by
9886 \begin_inset space ~
9891 (which defaults to page numbers),
9894 \begin_inset space ~
9902 \begin_inset space ~
9910 \begin_layout Subsubsection
9913 Foil\SpecialChar TeX
9917 \begin_inset CommandInset label
9919 name "sec:unsuppfoils"
9926 \begin_layout Standard
9927 All the commands mentioned below need to be set in a
9937 within another environment.
9940 \begin_layout Paragraph
9944 \begin_layout Standard
9945 All lengths are adjusted using the
9968 should be replaced by the name given to the length you want to change and
9973 is the length value.
9974 All lengths should be specified in units of length such as inches (
9986 ) or relative to some document or font-based length such as
9996 \begin_layout Standard
9997 It's possible to change the spacing between a foilhead and the body of the
9998 foil by adjusting the length specified by
10005 For example, to make
10010 \begin_inset space \space{}
10013 in closer to their bodies put the following in the preamble:
10019 foilheadskip}{-0.5in}
10022 \begin_layout Standard
10023 The spacings around floats can be adjusted by setting these lengths:
10026 \begin_layout Labeling
10027 \labelwidthstring MMMMMMMMMMM
10034 Separation between the text and the top of the float
10037 \begin_layout Labeling
10038 \labelwidthstring MMMMMMMMMMM
10045 Separation between the float and the caption
10048 \begin_layout Labeling
10049 \labelwidthstring MMMMMMMMMMM
10056 Separation between the caption and the following text
10059 \begin_layout Labeling
10060 \labelwidthstring MMMMMMMMMMM
10067 You can make the captions narrower than the surrounding text by adjusting
10069 Best done relative to
10078 \begin_layout Standard
10079 There are also several title page related lengths that you may find useful
10080 if you have a long title or several authors:
10083 \begin_layout Labeling
10084 \labelwidthstring MMMMMMMMMMM
10091 Separation from headers to
10096 \begin_layout Labeling
10097 \labelwidthstring MMMMMMMMMMM
10115 \begin_layout Labeling
10116 \labelwidthstring MMMMMMMMMMM
10130 \begin_layout Labeling
10131 \labelwidthstring MMMMMMMMMMM
10147 \begin_layout Labeling
10148 \labelwidthstring MMMMMMMMMMM
10164 \begin_layout Standard
10165 The last length related command affects all the list environments.
10176 a list environment then all the vertical spacing between the list items
10178 Note that this is a command not a length so it doesn't require
10184 like the stuff mentioned above.
10187 \begin_layout Paragraph
10188 Headers and Footers
10191 \begin_layout Standard
10204 commands control whether the logo in the
10208 definition appear on a given page.
10215 in the preamble then none of the foils will have the logo on them.
10216 If you don't want the logo on a particular page place the
10222 directly after the foilhead of that page and the
10228 directly after the next foilhead.
10231 \begin_layout Standard
10232 If you decide to use the
10236 page style setting in the
10239 \begin_inset space ~
10244 dialog you should probably add
10254 to your preamble so headers and footers on landscape pages are correctly
10255 placed when rotated.
10256 This is due to some clashes between the page layouts provided by the
10267 \begin_layout Subsection
10269 \change_inserted 564990737 1671459032
10275 \begin_layout Standard
10277 \change_inserted 564990737 1671643165
10283 \begin_inset space \thinspace{}
10292 document class for creating presentations.
10296 File\SpecialChar menuseparator
10297 Open Example\SpecialChar menuseparator
10298 Presentations\SpecialChar menuseparator
10302 offers guidance on its use.
10303 The documentation is available from
10304 \begin_inset CommandInset href
10307 target "http://mirrors.ctan.org/macros/latex/contrib/powerdot/doc/powerdot.pdf"
10315 \begin_layout Subsection
10317 \change_inserted 564990737 1671459032
10320 \begin_inset CommandInset label
10322 name "subsec:Seminar"
10331 \begin_layout Standard
10333 \change_inserted 564990737 1671643194
10339 \begin_inset space \thinspace{}
10348 document class for creating presentations.
10352 File\SpecialChar menuseparator
10353 Open Example\SpecialChar menuseparator
10354 Presentations\SpecialChar menuseparator
10358 offers guidance on its use.
10359 The documentation is available from
10360 \begin_inset CommandInset href
10363 target "http://mirrors.ctan.org/macros/latex/contrib/seminar/doc/seminar-doc.pdf"
10371 \begin_layout Subsection
10374 Sli\SpecialChar TeX
10378 \begin_inset CommandInset label
10387 \begin_layout Standard
10395 \begin_layout Subsubsection
10399 \begin_layout Standard
10400 This section describes how to use \SpecialChar LyX
10401 to make slides for overhead projectors.
10402 There are two document classes that can do this: the default slides class
10405 Foil\SpecialChar TeX
10409 This section documents the former.
10412 \begin_layout Standard
10413 I'm going to say this again, nice and clear, so that there's no misunderstanding
10417 \begin_layout Standard
10418 \begin_inset VSpace bigskip
10424 \begin_layout Standard
10428 This section documents the class
10429 \begin_inset Quotes eld
10437 \begin_inset Quotes erd
10445 \begin_layout Standard
10446 \begin_inset VSpace bigskip
10452 \begin_layout Standard
10453 If you're looking for the documentation for
10454 \begin_inset Quotes eld
10459 slides (Foil\SpecialChar TeX
10463 \begin_inset Quotes erd
10466 , check out section
10467 \begin_inset space ~
10471 \begin_inset CommandInset ref
10473 reference "sec:foiltex"
10483 \begin_inset Quotes eld
10488 slides (Foil\SpecialChar TeX
10492 \begin_inset Quotes erd
10495 ] is actually somewhat better than the default
10503 \begin_layout Plain Layout
10505 or so I've been told repeatedly by its advocates.
10506 Having never used it, I have no idea if this claim is true or not.
10511 which this section documents.
10514 \begin_layout Standard
10515 This class is the \SpecialChar LaTeX2e
10516 improvement of the old
10518 Sli\SpecialChar TeX
10522 Every \SpecialChar LaTeX2e
10523 distribution includes this class [which I'll just refer to as
10524 \begin_inset Quotes eld
10532 \begin_inset Quotes erd
10535 from now on], so you're bound to have it.
10536 As I noted earlier, there are other classes, such as
10540 , which also produce slides for overhead projectors and do a better job
10542 However, there are some things which
10546 can do which the others can't, such as generate overlays.
10547 Read on to learn more!
10550 \begin_layout Subsubsection
10552 \begin_inset CommandInset label
10554 name "sec:slidesetup"
10561 \begin_layout Standard
10562 Obviously, to use this document class, you need to select
10563 \begin_inset Quotes eld
10571 \begin_inset Quotes erd
10574 from the class list in the
10576 Document\SpecialChar menuseparator
10580 There are some other special things you should know about this class:
10583 \begin_layout Itemize
10584 Don't bother changing the options
10589 They're not supported by the
10596 \begin_layout Itemize
10600 \begin_inset space ~
10605 behaves a bit differently for this class.
10606 The possible choices and what they do are as follows:
10610 \begin_layout Description
10615 The final output contains page numbers in the lower right corner.
10618 \begin_layout Description
10627 , but also prints out any time markers you've put in.
10628 This is the default.
10631 \begin_layout Description
10636 The final output contains no page numbers, time markers, or alignment markers.
10640 \begin_layout Itemize
10645 class has an extra option:
10651 \begin_inset Quotes eld
10659 \begin_inset Quotes erd
10662 in the extra class options.
10666 \begin_layout Standard
10667 Using this options allows you to add time markers to
10673 \begin_inset space ~
10677 \begin_inset CommandInset ref
10679 reference "sec:slideNote"
10687 \begin_layout Standard
10688 You can also use the template file
10689 \change_deleted 564990737 1671617694
10691 \begin_inset Quotes eld
10699 \begin_inset Quotes erd
10704 to automatically set up a document to use the
10709 \change_deleted 564990737 1671617699
10714 File\SpecialChar menuseparator
10716 \begin_inset space ~
10720 \begin_inset space ~
10724 \change_inserted 564990737 1671617723
10725 \SpecialChar menuseparator
10726 Presentations\SpecialChar menuseparator
10731 to open your new document
10732 \change_deleted 564990737 1671617728
10736 The template file also contains some examples of the special paragraph
10737 environments used by this class.
10738 I'll describe those next.
10741 \begin_layout Subsubsection
10742 Paragraph Environments
10745 \begin_layout Paragraph
10746 Supported Environments
10749 \begin_layout Standard
10750 The first thing you'll notice when you start up a new
10754 document is the font size and type: it's the equivalent of the size
10755 \begin_inset Quotes eld
10763 \begin_inset Quotes erd
10769 \begin_inset space ~
10775 This is also what's used in the output.
10777 \begin_inset Quotes eld
10781 \begin_inset Quotes erd
10784 to remind you that this is a slide.
10785 Your final slides will use a larger font; ergo, you'll have less space.
10786 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
10789 \begin_layout Standard
10790 The next thing that becomes obvious is the changes to the paragraph environment
10791 pull-down box [at the far-left end of the toolbar].
10792 Most of the paragraph environments you're used to seeing are missing.
10793 There are also five new ones.
10798 class itself only supports certain paragraph environments:
10801 \begin_layout Itemize
10807 \begin_layout Itemize
10813 \begin_layout Itemize
10819 \begin_layout Itemize
10825 \begin_layout Itemize
10831 \begin_layout Itemize
10837 \begin_layout Itemize
10843 \begin_layout Itemize
10849 \begin_layout Itemize
10855 \begin_layout Itemize
10862 \begin_layout Standard
10863 All of the other standard environments, including the section-heading environmen
10864 ts, aren't used in the
10871 \begin_layout Standard
10872 On the other hand, you'll notice the following new environments:
10875 \begin_layout Itemize
10881 \begin_layout Itemize
10887 \begin_layout Itemize
10893 \begin_layout Itemize
10899 \begin_layout Itemize
10905 \begin_layout Standard
10906 These five are kind of quirky, due to a
10907 \begin_inset Quotes eld
10911 \begin_inset Quotes erd
10914 in \SpecialChar LyX
10916 You see, \SpecialChar LyX
10917 doesn't permit you to nest any other paragraph environment into
10918 an empty environment.
10919 Now, that's fine and dandy, but it means that you wouldn't be able to start
10920 a slide with anything except plain text.
10921 To deal with this, I've performed a little
10922 \begin_inset Quotes eld
10927 \begin_inset Quotes erd
10933 \begin_layout Paragraph
10934 Quirks of the New Environments
10935 \begin_inset CommandInset label
10937 name "sec:slideQuirk"
10944 \begin_layout Standard
10945 All five of the new paragraph environments are somewhat quirky due to inherent
10946 limitiations in the current version of \SpecialChar LyX
10948 As I just mentioned, \SpecialChar LyX
10949 forbids environments that begin with another environment.
10950 To get around this, the
10954 environment isn't a paragraph environment as described in the
10962 \begin_layout Standard
10963 You should consider
10976 \begin_inset Quotes eld
10979 pseudo-environments.
10980 \begin_inset Quotes erd
10983 They look like a section heading or a
10984 \begin_inset Quotes eld
10992 \begin_inset Quotes erd
10995 but really begin a [and, if necessary, end the previous] paragraph environment.
11005 \begin_inset Quotes eld
11009 \begin_inset Quotes erd
11012 These two perform some action.
11015 \begin_layout Standard
11016 A common feature of all five environments,
11036 , is a rather long-ish label.
11037 The text following this label — ordinarily the contents of the paragraph
11038 environment — is utterly irrelevant for
11060 completely ignores it.
11061 In fact, you can leave these five environments completely empty.
11065 \begin_layout Standard
11070 to put any text after the rather long-ish label, you might want to.
11071 This could be a short description of the contents of the
11076 In that case, enter your descriptive comment and hit
11080 as you normally would.
11083 \begin_layout Standard
11084 If, on the other hand, you don't want to enter any descriptive text, you'll
11085 hit another \SpecialChar LyX
11088 , like nature, abhors a vacuum, and will not let you start a new paragraph
11089 environment until you put something in the old one.
11093 \begin_layout Itemize
11094 Start entering the text that will
11122 \begin_layout Itemize
11123 Now move to the beginning of that paragraph.
11127 \begin_layout Itemize
11136 \begin_layout Itemize
11137 Finally, change this new, empty paragraph to a
11161 \begin_layout Standard
11162 Some future version of \SpecialChar LyX
11163 will, hopefully, resolve this quirkiness\SpecialChar ldots
11167 \begin_layout Subsubsection
11168 Making a Presentation with
11181 \begin_layout Paragraph
11189 \begin_layout Standard
11190 If you're expecting this section to teach you how to actually make a presentatio
11191 n, you'll be sorely disappointed.
11192 Naturally, I'll describe all of the ways the
11196 class can assist you in preparing the materials for a presentation.
11197 Filling in the contents, however, is up to you.
11202 the \SpecialChar LyX
11206 \begin_layout Standard
11211 environment [in the manner described in section
11212 \begin_inset space ~
11216 \begin_inset CommandInset ref
11218 reference "sec:slideQuirk"
11222 ] tells \SpecialChar LyX
11223 to begin a new slide [duh].
11224 The label for this environment/
11225 \begin_inset Quotes erd
11229 \begin_inset Quotes erd
11233 \begin_inset Quotes eld
11237 \begin_inset Quotes erd
11240 in cool blue, followed by the label,
11241 \begin_inset Quotes eld
11245 \begin_inset Quotes erd
11249 Any text or paragraph environments that follow this one go on the new slide.
11253 \begin_layout Standard
11254 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
11256 (this can be specified in the
11261 In fact, you'll want to, once you finish entering the contents of one slide.
11262 If you've entered more text than can physically fit on a slide, the extra
11263 overflows onto a new slide.
11264 I don't recommend doing this, however, since the overflow slide won't have
11265 any page number on it.
11266 Furthermore, it may interfere with any
11270 you've made to accompany the oversized
11277 \begin_layout Standard
11286 environments work the same way as the
11291 They both create an
11292 \begin_inset Quotes eld
11296 \begin_inset Quotes erd
11299 followed by a label [
11300 \begin_inset Quotes eld
11304 \begin_inset Quotes erd
11308 \begin_inset Quotes eld
11312 \begin_inset Quotes erd
11316 The color is a stunning magenta instead of blue, and the
11317 \begin_inset Quotes eld
11321 \begin_inset Quotes erd
11324 will look different, in style and in length.
11325 The label fonts of all three also differ from one another.
11328 \begin_layout Standard
11333 , if the contents of a
11341 exceed the physical size of a slide or sheet of paper, the extra will overflow
11343 Again, you should avoid this.
11344 It defeats the whole purpose of
11355 \begin_layout Paragraph
11365 \begin_layout Standard
11370 is a slide that sits atop another slide.
11371 Perhaps you wish to discuss a figure on the main
11375 before displaying the text associated with it.
11376 One way to accomplish this is tape a flap of dark paper over the part of
11381 you want to display later.
11382 This method fails, however, if you wish to overlap one graph with another,
11384 You would then have to fumble while speaking to align the two separate,
11389 s to align the two graphs.
11394 environment in both cases makes life much easier.
11397 \begin_layout Standard
11402 receives the page number of its
11403 \begin_inset Quotes eld
11407 \begin_inset Quotes erd
11415 \begin_inset Quotes eld
11423 \begin_inset Quotes erd
11430 \begin_layout Plain Layout
11431 Presumably, mutliple
11436 \begin_inset Quotes eld
11444 \begin_inset Quotes erd
11448 \begin_inset Quotes eld
11456 \begin_inset Quotes erd
11460 \begin_inset Quotes eld
11468 \begin_inset Quotes erd
11472 \begin_inset space ~
11475 appended to the page number of the parent
11485 Clearly, you want the contents of both the
11493 to each fit on a single physical slide! You should probably consider an
11499 \begin_inset Quotes eld
11503 \begin_inset Quotes erd
11511 Indeed, the \SpecialChar LyX
11516 class provides a visual cue for this: the label at the start of an
11520 is shorter than that at the start of a
11525 Lastly, when you generate printable output, you'll find alignment markers
11526 in all four corners of both the
11530 page and its parent
11535 These will assist you in lining up the two physical slides.
11538 \begin_layout Standard
11539 The major problem in overlaying two slides is aligning the contents of the
11540 two transparencies.
11541 How much space should you leave for that graph on the second slide? Worse
11542 still, what if you want a graph and a sentence on second slide, but there
11543 is text on the main transparency that goes in between them? You could try
11544 and insert vertical space of the right size.
11545 The better way is to use
11556 \begin_layout Standard
11557 As their names imply,
11565 are two command-like paragraph environments that make all subsequent text
11566 invisible and visible, respectively.
11568 \begin_inset space ~
11572 \begin_inset CommandInset ref
11574 reference "sec:slideQuirk"
11578 that you don't place anything
11582 these two environments, however.
11587 , it inserts a centered, sky-blue label into the page reading
11588 \begin_inset Quotes eld
11591 <Invisible Text Follows>
11592 \begin_inset Quotes erd
11596 For paragraphs following this label, the parts of the
11604 ; it doesn't matter which] where they would be contain instead blank space.
11608 \begin_layout Standard
11613 , the corresponding centered label is
11614 \begin_inset Quotes eld
11617 <Visible Text Follows>
11618 \begin_inset Quotes erd
11622 Paragraphs following this label behave normally.
11623 Note that the beginning of a new
11635 automatically shuts off an
11640 It's therefore not necessary to use
11651 \begin_layout Standard
11652 By now, it should be obvious how to create overlay transparencies using
11653 the proper combination of
11672 \begin_layout Enumerate
11677 , including everything that will appear on it, whether on the main slide
11685 \begin_layout Enumerate
11686 Before each figure or paragraph that will appear only on the
11695 If necessary, insert a
11699 environment after the
11706 \begin_layout Enumerate
11711 immediately following the
11718 \begin_layout Enumerate
11719 Copy the contents of this
11730 \begin_layout Enumerate
11735 , change all of the
11746 \begin_layout Standard
11748 You've just made an
11755 \begin_layout Standard
11756 There's one problem with the way I've designed the \SpecialChar LyX
11761 class: you can't make text in the middle of a paragraph invisible, nor
11762 make text in the middle of an invisible paragraph visible again.
11763 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
11768 \begin_layout Plain Layout
11769 The commands of interest are:
11772 \begin_layout Itemize
11777 invisible \SpecialChar ldots
11781 \begin_layout Itemize
11786 visible \SpecialChar ldots
11790 \begin_layout Plain Layout
11792 and need to be marked as \SpecialChar TeX
11795 \begin_inset Quotes eld
11799 \begin_inset Quotes erd
11802 you wish to change goes in between the brackets [and after the
11815 If you don't know how to mark text as \SpecialChar TeX
11816 , see the appropriate section of
11829 \begin_layout Paragraph
11839 \begin_inset CommandInset label
11841 name "sec:slideNote"
11848 \begin_layout Standard
11857 is associated with a
11858 \begin_inset Quotes eld
11862 \begin_inset Quotes erd
11870 Here, too, the \SpecialChar LyX
11875 class provides visual cues.
11880 is shorter than that of a
11884 [yet longer than that of an
11888 ] and, like the label of an
11892 is shockingly magenta.
11893 Additionally, the printed
11897 has the page number of its
11898 \begin_inset Quotes eld
11902 \begin_inset Quotes erd
11910 \begin_inset Quotes eld
11918 \begin_inset Quotes erd
11922 \begin_inset Quotes eld
11930 \begin_inset Quotes erd
11934 \begin_inset Quotes eld
11942 \begin_inset Quotes erd
11946 You can have multiple
11950 s associated with a single
11962 , you'll probably want to break up long
11966 s so that they fit on a single sheet of paper.
11969 \begin_layout Standard
11974 is obvious: it contains anything additional you might want to say about
11980 It could also be used as a sheet of reminders for a particular
11985 In the case of the latter, you might want to make use of time markers.
11986 Currently, the \SpecialChar LyX
11992 \begin_inset Quotes eld
11996 \begin_inset Quotes erd
11999 support for time markers, a
12001 Sli\SpecialChar TeX
12005 So, you'll have to resort to using the \SpecialChar LaTeX
12009 \begin_layout Standard
12010 To use time markers, you'll need to specify the extra class option
12011 \begin_inset Quotes eld
12019 \begin_inset Quotes erd
12023 \begin_inset space ~
12027 \begin_inset CommandInset ref
12029 reference "sec:slidesetup"
12034 This option turns on timing marks, which will appear in the lower-left-hand
12040 To set what appears in the time marker, you use the \SpecialChar LaTeX
12042 \begin_inset Quotes eld
12052 \begin_inset Quotes erd
12056 \begin_inset Quotes eld
12066 \begin_inset Quotes erd
12070 The arguments of both commands are time measured in seconds.
12072 \begin_inset Quotes eld
12082 \begin_inset Quotes erd
12085 sets the time marker to a given time.
12087 \begin_inset Quotes eld
12097 \begin_inset Quotes erd
12100 increments the time marker by the specified amount.
12101 Using time markers and
12105 s in this fashion, you can remind yourself how much time to spend on a particula
12113 \begin_layout Standard
12114 There's one last feature to describe.
12115 Clearly, you'd like to print out all of your
12123 s on transparencies while printing all of your
12140 with which it is associated.
12141 What's a person to do?
12144 \begin_layout Standard
12145 Luckily, there are two \SpecialChar LaTeX
12146 commands that allow you to select what to print
12148 Both must be placed into the preamble of your document.
12150 \begin_inset Quotes eld
12162 \begin_inset Quotes erd
12165 will cause the output to contain only the
12174 Correspondingly, the command
12175 \begin_inset Quotes eld
12187 \begin_inset Quotes erd
12190 prevents the output of anything but
12195 I'd advise placing both commands in the preamble and initially comment
12197 You can then preview your entire presentation as you write.
12198 When you're done writing, you can then uncomment one of the two to select
12199 what you want to print.
12200 I like to uncomment
12201 \begin_inset Quotes eld
12213 \begin_inset Quotes erd
12216 , print to a file with
12217 \begin_inset Quotes eld
12225 \begin_inset Quotes erd
12228 in its name, comment it back out, then uncomment
12229 \begin_inset Quotes eld
12241 \begin_inset Quotes erd
12245 \begin_inset Quotes eld
12253 \begin_inset Quotes erd
12257 I can then send either file to a printer, loading transparencies or plain
12258 paper as appropriate.
12261 \begin_layout Standard
12262 You can also provide other arguments to the
12263 \begin_inset Quotes eld
12273 \begin_inset Quotes erd
12277 \begin_inset Quotes eld
12287 \begin_inset Quotes erd
12291 See a good \SpecialChar LaTeX
12295 \begin_layout Subsubsection
12300 Class Template File
12303 \begin_layout Standard
12304 I have also provided a template file
12305 \change_deleted 564990737 1671617750
12307 \begin_inset Quotes eld
12315 \begin_inset Quotes erd
12325 To use it, begin your new presentation with
12327 File\SpecialChar menuseparator
12329 \begin_inset space ~
12333 \begin_inset space ~
12337 \change_inserted 564990737 1671616988
12338 \SpecialChar menuseparator
12339 Presentations\SpecialChar menuseparator
12345 Your new \SpecialChar LyX
12346 presentation file will contain an example
12367 additionally contain an example of the use of
12376 Lastly, the preamble will contain:
12379 \begin_layout LyX-Code
12380 % Uncomment to print out only slides and overlays
12383 \begin_layout LyX-Code
12387 \begin_layout LyX-Code
12393 \begin_inset Newline newline
12399 \begin_layout LyX-Code
12400 % Uncomment to print out only notes
12403 \begin_layout LyX-Code
12407 \begin_layout LyX-Code
12415 \begin_layout Standard
12416 One final thing: I created this class to support the \SpecialChar LaTeX2e
12418 \begin_inset Quotes eld
12423 Sli\SpecialChar TeX
12427 \begin_inset Quotes erd
12430 class, one of the built-in \SpecialChar LaTeX2e
12432 Neither I nor the rest of the \SpecialChar LyX
12433 Team endorse or oppose the use of this built-in
12435 It's here if you want it or need it.
12436 There exist other \SpecialChar LaTeX2e
12437 classes for creating presentations, such as the
12442 \begin_inset space ~
12446 \begin_inset CommandInset ref
12448 reference "sec:foiltex"
12453 \begin_inset Quotes eld
12461 \begin_inset Quotes erd
12464 package [present on some \SpecialChar TeX
12466 The latter is not yet supported under \SpecialChar LyX
12471 \begin_layout Plain Layout
12472 Perhaps you can take on the task\SpecialChar ldots
12478 I know nothing about these other classes.
12479 Try them out to see what sort of alternative they provide.
12482 \begin_layout Section
12484 \change_inserted 564990737 1670439661
12488 \begin_layout Subsection
12490 \change_inserted 564990737 1670439661
12494 \begin_layout Standard
12496 \change_inserted 564990737 1670439661
12505 document class for preparing reports.
12510 document class, this provides parts, chapters and sections but does not
12511 provide the paragraph styles needed for a book; like the
12515 document class, it provides the abstract paragraph style.
12516 In two-sided mode, it does not start a new chapter on the right hand page.
12519 \begin_layout Standard
12521 \change_inserted 564990737 1670439674
12526 document classes are described in the Collections (section
12527 \begin_inset space ~
12531 \begin_inset CommandInset ref
12533 reference "sec:Collections"
12540 \begin_layout Section
12542 \change_inserted 564990737 1670439674
12546 \begin_layout Subsection
12550 \begin_layout Standard
12556 \begin_layout Subsubsection
12560 \begin_layout Standard
12561 Broadway is for writing plays.
12562 The format is more decorative than Hollywood, and much less standardized.
12563 This format should be suitable for workshops.
12566 \begin_layout Subsubsection
12570 \begin_layout Standard
12571 The same as in Hollywood.
12574 \begin_layout Subsubsection
12578 \begin_layout Standard
12583 names as labels then cross-reference the label to insert the name.
12584 The cross-reference dialog will show the current cast of characters.
12587 \begin_layout Subsubsection
12588 Paper size and Margins
12591 \begin_layout Standard
12592 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12595 \begin_layout Subsubsection
12599 \begin_layout Standard
12600 The following environments are available.
12601 You can use broadway.bind to get the bind keys shown at the right.
12604 \begin_layout Itemize
12608 \begin_inset Newline newline
12613 You should not have to use this, but it is here for anything that does not
12617 \begin_layout Itemize
12621 \begin_inset space \hfill{}
12625 \begin_inset Newline newline
12630 Used to describe stage setting and the action.
12631 First use of speaker names in all CAPs.
12634 \begin_layout Itemize
12638 \begin_inset space \hfill{}
12642 \begin_inset Newline newline
12647 Automatically numbered.
12648 On screen it will be arabic, but will print as Roman.
12651 \begin_layout Itemize
12655 \begin_inset space \hfill{}
12659 \begin_inset Newline newline
12669 It is just centered text.
12672 \begin_layout Itemize
12676 \begin_inset space \hfill{}
12680 \begin_inset Newline newline
12685 Not automatically numbered.
12686 You supply the number.
12687 This is because I couldn't figure out how.
12690 \begin_layout Itemize
12694 \begin_inset space \hfill{}
12698 \begin_inset Newline newline
12703 A special case of Narrative to describe the setting and action as the curtain
12707 \begin_layout Itemize
12711 \begin_inset space \hfill{}
12715 \begin_inset Newline newline
12720 The speaker's (actor's) title, centered in all CAPS.
12723 \begin_layout Itemize
12727 \begin_inset space \hfill{}
12731 \begin_inset Newline newline
12736 Instructions to the speaker.
12737 The parentheses are automatically inserted.
12738 The ( will appear on screen, but both will be in the printed play.
12739 This environment is only used within
12746 \begin_layout Itemize
12750 \begin_inset space \hfill{}
12754 \begin_inset Newline newline
12759 What the Speaker says.
12762 \begin_layout Itemize
12766 \begin_inset space \hfill{}
12770 \begin_inset Newline newline
12775 The curtain comes down.
12778 \begin_layout Itemize
12782 \begin_inset space \hfill{}
12788 \begin_layout Itemize
12792 \begin_inset space \hfill{}
12798 \begin_layout Itemize
12802 \begin_inset space \hfill{}
12808 \begin_layout Standard
12812 \begin_layout Subsection
12813 Hollywood (Hollywood spec scripts)
12816 \begin_layout Standard
12822 \begin_layout Subsubsection
12826 \begin_layout Standard
12827 Getting the format of a Hollywood script right is a
12828 \begin_inset Quotes eld
12832 \begin_inset Quotes erd
12835 It is designed to make the readers focus on content and to be easy and
12836 familiar for the actors to read.
12837 Each page of a script should be one minute of film.
12838 Nothing goes in a script that you cannot see or hear on screen.
12839 The courier 12 pt font should be used throughout.
12843 \begin_layout Subsubsection
12847 \begin_layout Standard
12848 Speakers' lines should NEVER break in mid-sentence.
12849 If a speaker's lines continue over a page break, repeat the
12853 title followed by (Cont'd).
12856 \begin_layout Subsubsection
12860 \begin_layout Standard
12865 names as labels then cross-reference the label to insert the name.
12866 The cross-reference dialog will show the current cast of characters.
12867 You can use this to insert the speaker name in narratives also.
12870 \begin_layout Subsubsection
12871 Paper size and Margins
12874 \begin_layout Standard
12875 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12878 \begin_layout Subsubsection
12882 \begin_layout Standard
12883 The following environments are available.
12884 You can use hollywood.bind to get the bind keys shown at the right.
12887 \begin_layout Itemize
12891 \begin_inset Newline newline
12896 Used where nothing else works.
12900 \begin_layout Itemize
12906 \begin_inset space \hfill{}
12914 \begin_inset Newline newline
12917 Usually followed by something like
12918 \begin_inset Quotes eld
12921 on Sally waking up.
12922 \begin_inset Quotes erd
12928 \begin_layout Itemize
12932 \begin_inset space \hfill{}
12936 \begin_inset Newline newline
12941 Introduces a new INTERIOR camera set-up.
12942 Always followed by DAY or NIGHT, or something similar to define the lighting
12944 Everthing on this line in CAPS.
12947 \begin_layout Itemize
12951 \begin_inset space \hfill{}
12955 \begin_inset Newline newline
12960 Introduces a new EXTERIOR camera set-up.
12961 Everthing on this line in CAPS.
12964 \begin_layout Itemize
12968 \begin_inset space \hfill{}
12972 \begin_inset Newline newline
12977 The character speaking.
12980 \begin_layout Itemize
12984 \begin_inset space \hfill{}
12988 \begin_inset Newline newline
12993 Instructions to the speaker.
12994 The () are automatically inserted.
12997 \begin_layout Itemize
13001 \begin_inset space \hfill{}
13005 \begin_inset Newline newline
13017 \begin_layout Itemize
13021 \begin_inset space \hfill{}
13025 \begin_inset Newline newline
13030 Camera movement instruction.
13032 \begin_inset space \thinspace{}
13036 \begin_inset space \space{}
13042 \begin_layout Itemize
13046 \begin_inset space \hfill{}
13052 \begin_layout Itemize
13056 \begin_inset space \hfill{}
13062 \begin_layout Itemize
13066 \begin_inset space \hfill{}
13072 \begin_layout Itemize
13076 \begin_inset space \hfill{}
13082 \begin_layout Subsubsection
13086 \begin_layout Itemize
13090 \begin_layout Itemize
13094 \begin_layout Itemize
13096 \begin_inset space \thinspace{}
13103 \begin_layout Itemize
13108 \begin_layout Itemize
13109 PAN — camera movement
13112 \begin_layout Itemize
13113 INSERT — cut to close-up of
13116 \begin_layout Chapter
13118 \change_inserted 564990737 1671185876
13122 \begin_layout Section
13124 \change_inserted 564990737 1671716212
13127 Academic Field Specifics
13130 \begin_layout Subsection
13132 \change_inserted 564990737 1671716212
13135 Chemistry: Hazard and Precautionary Statements
13138 \begin_layout Standard
13140 \change_inserted 564990737 1671716212
13143 This module provides two insets to typeset numbers and phrases of chemical
13144 hazard and precautionary statements.
13145 For a description see
13148 File\SpecialChar menuseparator
13149 Open Example\SpecialChar menuseparator
13150 Modules\SpecialChar menuseparator
13151 Hazard and Precautionary Statements
13155 Help\SpecialChar menuseparator
13156 Specific Manuals\SpecialChar menuseparator
13157 Hazard and Precautionary Statements
13163 \begin_layout Subsection
13165 \change_inserted 564990737 1671716212
13169 Chemistry: Risk and Safety Statements
13172 \begin_layout Standard
13174 \change_inserted 564990737 1671716212
13177 This module provides two insets,
13185 , accessible via the menu
13190 nsert\SpecialChar menuseparator
13192 \begin_inset space ~
13197 and an environment to typeset numbers and phrases of chemical risk and
13201 \begin_layout Subsection
13203 \change_inserted 564990737 1671716212
13209 \begin_layout Standard
13211 \change_inserted 564990737 1671716212
13214 This module uses the
13218 package to add environments useful for linguistics (numbered examples,
13219 glosses, semantic markup, tableau floats).
13220 You can obtain information about this module in
13225 elp\SpecialChar menuseparator
13231 \begin_inset space ~
13234 Manuals\SpecialChar menuseparator
13244 File\SpecialChar menuseparator
13245 Open Example\SpecialChar menuseparator
13248 Modules\SpecialChar menuseparator
13254 \begin_layout Section
13256 \change_inserted 564990737 1671788778
13262 \begin_layout Subsection
13264 \change_inserted 564990737 1671788778
13270 \begin_layout Standard
13272 \change_inserted 564990737 1671788778
13275 This module supports the Braille writing system.
13276 It requires the \SpecialChar LaTeX
13282 This and its documentation can be obtained from
13283 \begin_inset CommandInset href
13286 target "https://www.ctan.org/pkg/braille"
13292 You do not have to reconfigure your system after installing it.
13298 elp\SpecialChar menuseparator
13304 \begin_inset space ~
13307 Manuals\SpecialChar menuseparator
13316 File\SpecialChar menuseparator
13317 Open Example\SpecialChar menuseparator
13318 Modules\SpecialChar menuseparator
13324 \begin_layout Section
13326 \change_inserted 564990737 1671788778
13329 Annotation & Revision
13332 \begin_layout Subsection
13334 \change_inserted 564990737 1671788778
13340 \begin_layout Standard
13342 \change_inserted 564990737 1671788778
13345 This module provides “FiXme” (marginal) annotations for document revision
13347 A list of annotations can be produced by using the “List of FIXMEs” paragraph
13349 The annotations are customizable via the LaTeX preamble.
13350 See the FiXme documentation which can be obtained from
13351 \begin_inset CommandInset href
13354 target "http://mirrors.ctan.org/macros/latex/contrib/fixme/fixme.pdf"
13363 \begin_layout Paragraph
13365 \change_inserted 564990737 1671788778
13371 \begin_layout Standard
13373 \change_inserted 564990737 1671788778
13376 by default, the notes are only displayed in “draft” mode (if the option
13377 “draft” has been inserted in
13379 Document\SpecialChar menuseparator
13380 Settings\SpecialChar menuseparator
13381 Document Class\SpecialChar menuseparator
13382 Class Options\SpecialChar menuseparator
13386 To display them always, insert
13394 Document\SpecialChar menuseparator
13395 Settings\SpecialChar menuseparator
13403 \begin_layout Subsection
13405 \change_inserted 564990737 1671788778
13411 \begin_layout Standard
13413 \change_inserted 564990737 1671788778
13416 This module provides various kinds of annotations for PDF output.
13419 Help\SpecialChar menuseparator
13420 Specific Manuals\SpecialChar menuseparator
13421 PDF comments and File\SpecialChar menuseparator
13422 Open Example\SpecialChar menuseparator
13423 Modules\SpecialChar menuseparator
13429 \begin_layout Subsection
13431 \change_inserted 564990737 1671788778
13438 \begin_layout Standard
13440 \change_inserted 564990737 1671788778
13443 This module provides fields and buttons for PDF forms.
13445 \begin_inset CommandInset href
13447 name "hyperref documentation"
13448 target "http://mirrors.ctan.org/macros/latex/contrib/hyperref/doc/hyperref-doc.pdf"
13455 Help\SpecialChar menuseparator
13456 Specific Manuals\SpecialChar menuseparator
13457 PDF forms and File\SpecialChar menuseparator
13458 Open Example\SpecialChar menuseparator
13459 Modules\SpecialChar menuseparator
13465 \begin_layout Subsection
13467 \change_inserted 564990737 1671788778
13474 \begin_layout Standard
13476 \change_inserted 564990737 1671788778
13479 This module defines an inset to typeset reading aids (ruby, furigana) to
13480 Chinese characters.
13481 It uses the “okumakro,” “luatexja-ruby” or “ruby” package (depending on
13482 the TeX engine) or a fallback definition.
13486 \begin_layout Subsection
13488 \change_inserted 564990737 1671788778
13495 \begin_layout Standard
13497 \change_inserted 564990737 1671788778
13500 This module provides custom insets to insert TODO items in your document.
13501 In order to generate a “List of TODOs,” the module provides a paragraph
13503 Inserting “final” in
13505 Document\SpecialChar menuseparator
13506 Settings\SpecialChar menuseparator
13507 Document Class\SpecialChar menuseparator
13508 Class Options\SpecialChar menuseparator
13511 ) suppresses the output of TODO notes.
13513 \begin_inset CommandInset href
13515 name "todonotes documentation"
13516 target "http://mirrors.ctan.org/macros/latex/contrib/todonotes/todonotes.pdf"
13524 \begin_layout Section
13525 Multiple Text Columns
13528 \begin_layout Standard
13529 This feature is independent of the option
13531 Two-column document
13533 in the document settings under
13538 If you want to have 2
13539 \begin_inset space ~
13542 columns for the whole document, it is recommended to use the
13544 Two-column document
13547 For all other cases use this feature.
13550 \begin_layout Standard
13551 To use multiple text columns in your document, you have to load the module
13558 Document\SpecialChar menuseparator
13559 Settings\SpecialChar menuseparator
13562 ) and must have the \SpecialChar LaTeX
13564 \begin_inset Flex Code
13567 \begin_layout Plain Layout
13576 \begin_layout Standard
13577 Footnotes within multiple columns will be placed at the bottom of the page
13578 and not under each column.
13579 Within the different columns you can use everything, with the limitation
13580 that for floats you need to use the float option
13587 \begin_layout Subsection
13591 \begin_layout Standard
13592 If you want to have 2
13593 \begin_inset space ~
13596 columns in your text, insert a multicolumn inset via the menu
13598 Insert\SpecialChar menuseparator
13600 \begin_inset space ~
13603 Insets\SpecialChar menuseparator
13605 \begin_inset space ~
13610 where the columns should start.
13611 Write all text that should be printed in 2
13612 \begin_inset space ~
13615 columns into this inset.
13618 \begin_layout Standard
13619 Here is an example:
13622 \begin_layout Standard
13624 \begin_inset Flex Multiple Columns
13627 \begin_layout Plain Layout
13632 The Adventure of the Empty House
13635 \begin_inset Newline newline
13638 by Sir Arthur Conan Doyle
13641 \begin_layout Plain Layout
13644 It was in the spring of the year 1894 that all London was interested, and
13645 the fashionable world dismayed, by the murder of the Honourable Ronald
13646 Adair under most unusual and inexplicable circumstances.
13647 The public has already learned those particulars of the crime which came
13648 out in the police investigation, but a good deal was suppressed upon that
13649 occasion, since the case for the prosecution was so overwhelmingly strong
13650 that it was not necessary to bring forward all the facts.
13651 Only now, at the end of nearly ten years, am I allowed to supply those
13652 missing links which make up the whole of that remarkable chain.
13653 The crime was of interest in itself, but that interest was as nothing to
13654 me compared to the inconceivable sequel, which afforded me the greatest
13655 shock and surprise of any event in my adventurous life.
13656 Even now, after this long interval, I find myself thrilling as I think
13657 of it, and feeling once more that sudden flood of joy, amazement, and increduli
13658 ty which utterly submerged my mind.
13659 Let me say to that public, which has shown some interest in those glimpses
13660 which I have occasionally given them of the thoughts and actions of a very
13661 remarkable man, that they are not to blame me if I have not shared my knowledge
13662 with them, for I should have considered it my first duty to do so, had
13663 I not been barred by a positive prohibition from his own lips, which was
13664 only withdrawn upon the third of last month.
13672 \begin_layout Standard
13673 To get 3 or more columns, set the cursor into the multicolumn inset and
13676 Insert\SpecialChar menuseparator
13678 \begin_inset space ~
13682 \begin_inset space ~
13688 The number of the desired columns is written into that inset (for 3
13689 \begin_inset space ~
13693 \begin_inset Quotes eld
13697 \begin_inset Quotes erd
13701 \begin_inset Newline newline
13704 Here is an example with 3
13705 \begin_inset space ~
13711 \begin_layout Standard
13712 \begin_inset Flex Multiple Columns
13715 \begin_layout Plain Layout
13718 \begin_inset Argument 1
13721 \begin_layout Plain Layout
13728 It can be imagined that my close intimacy with Sherlock Holmes had interested
13729 me deeply in crime, and that after his disappearance I never failed to
13730 read with care the various problems which came before the public.
13731 And I even attempted, more than once, for my own private satisfaction,
13732 to employ his methods in their solution, though with indifferent success.
13733 There was none, however, which appealed to me like this tragedy of Ronald
13735 As I read the evidence at the inquest, which led up to a verdict of willful
13736 murder against some person or persons unknown, I realized more clearly
13737 than I had ever done the loss which the community had sustained by the
13738 death of Sherlock Holmes.
13739 There were points about this strange business which would, I was sure,
13740 have specially appealed to him, and the efforts of the police would have
13741 been supplemented, or more probably anticipated, by the trained observation
13742 and the alert mind of the first criminal agent in Europe.
13743 All day, as I drove upon my round, I turned over the case in my mind and
13744 found no explanation which appeared to me to be adequate.
13745 At the risk of telling a twice-told tale, I will recapitulate the facts
13746 as they were known to the public at the conclusion of the inquest.
13754 \begin_layout Standard
13755 You can have up to 10
13756 \begin_inset space ~
13759 columns if you want to, but that might not be very pleasant for the readers
13763 \begin_layout Standard
13764 \begin_inset Newpage newpage
13770 \begin_layout Subsection
13771 Columns inside Columns
13774 \begin_layout Standard
13775 You can also have columns inside columns:
13778 \begin_layout Standard
13779 \begin_inset Flex Multiple Columns
13782 \begin_layout Plain Layout
13785 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
13786 at that time governor of one of the Australian colonies.
13787 Adair's mother had returned from Australia to undergo the operation for
13788 cataract, and she, her son Ronald, and her daughter Hilda were living together
13792 \begin_layout Plain Layout
13793 \begin_inset Flex Multiple Columns
13796 \begin_layout Plain Layout
13799 The youth moved in the best society
13800 \begin_inset space ~
13803 – had, so far as was known, no enemies and no particular vices.
13804 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
13805 had been broken off by mutual consent some months before, and there was
13806 no sign that it had left any very profound feeling behind it.
13807 For the rest {sic} the man's life moved in a narrow and conventional circle,
13808 for his habits were quiet and his nature unemotional.
13809 Yet it was upon this easy-going young aristocrat that death came, in most
13810 strange and unexpected form, between the hours of ten and eleven-twenty
13811 on the night of March 30, 1894.
13819 \begin_layout Plain Layout
13822 Ronald Adair was fond of cards
13823 \begin_inset space ~
13826 – playing continually, but never for such stakes as would hurt him.
13827 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
13828 It was shown that, after dinner on the day of his death, he had played
13829 a rubber of whist at the latter club.
13830 He had also played there in the afternoon.
13835 The evidence of those who had played with him
13836 \begin_inset space ~
13840 Murray, Sir John Hardy, and Colonel Moran
13841 \begin_inset space ~
13844 – showed that the game was whist, and that there was a fairly equal fall
13846 Adair might have lost five pounds, but not more.
13847 His fortune was a considerable one, and such a loss could not in any way
13849 He had played nearly every day at one club or other, but he was a cautious
13850 player, and usually rose a winner.
13851 It came out in evidence that, in partnership with Colonel Moran, he had
13852 actually won as much as four hundred and twenty pounds in a sitting, some
13853 weeks before, from Godfrey Milner and Lord Balmoral.
13854 So much for his recent history as it came out at the inquest.
13862 \begin_layout Subsection
13866 \begin_layout Standard
13867 The examples in this section show some more special features of multiple
13871 \begin_layout Standard
13872 For more features of multiple columns, have a look at the
13873 \begin_inset CommandInset href
13875 name "documentation"
13876 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
13881 of the \SpecialChar LaTeX
13883 \begin_inset Flex Code
13886 \begin_layout Plain Layout
13895 \begin_layout Subsubsection
13899 \begin_layout Standard
13900 To add a preface text for multiple columns, set the cursor into the multicolumn
13901 inset and use the menu
13903 Insert\SpecialChar menuseparator
13907 Write your preface text into that inset.
13908 \begin_inset Newline newline
13911 This is an example with some preface text:
13914 \begin_layout Standard
13915 \begin_inset VSpace bigskip
13921 \begin_layout Standard
13922 \begin_inset Flex Multiple Columns
13925 \begin_layout Plain Layout
13926 \begin_inset Argument 2
13929 \begin_layout Plain Layout
13930 And the story continues and continues and continues and continues\SpecialChar ldots
13938 On the evening of the crime, he returned from the club exactly at ten.
13939 His mother and sister were out spending the evening with a relation.
13940 The servant deposed that she heard him enter the front room on the second
13941 floor, generally used as his sitting-room.
13942 She had lit a fire there, and as it smoked she had opened the window.
13943 No sound was heard from the room until eleven-twenty, the hour of the return
13944 of Lady Maynooth and her daughter.
13945 Desiring to say good-night, she attempted to enter her son's room.
13946 The door was locked on the inside, and no answer could be got to their
13947 cries and knocking.
13948 Help was obtained, and the door forced.
13949 The unfortunate young man was found lying near the table.
13950 His head had been horribly mutilated by an expanding revolver bullet, but
13951 no weapon of any sort was to be found in the room.
13959 \begin_layout Standard
13960 You can also use a section heading as the preface if you use a section command
13961 as \SpecialChar TeX
13963 For example the command
13966 \begin_layout LyX-Code
13969 subsection{subsection title}
13972 \begin_layout Standard
13973 creates a subsection.
13974 In this example the preface is a subsubsection:
13977 \begin_layout Standard
13978 \begin_inset Flex Multiple Columns
13981 \begin_layout Plain Layout
13982 \begin_inset Argument 2
13985 \begin_layout Plain Layout
13989 \begin_layout Plain Layout
13998 This is a subsubsection heading as a preface
14002 \begin_layout Plain Layout
14016 A minute examination of the circumstances served only to make the case more
14018 In the first place, no reason could be given why the young man should have
14019 fastened the door upon the inside.
14020 There was the possibility that the murderer had done this, and had afterwards
14021 escaped by the window.
14022 The drop was at least twenty feet, however, and a bed of crocuses in full
14024 Neither the flowers nor the earth showed any sign of having been disturbed,
14025 nor were there any marks upon the narrow strip of grass which separated
14026 the house from the road.
14027 Apparently, therefore, it was the young man himself who had fastened the
14029 But how did he come by his death? No one could have climbed up to the window
14030 without leaving traces.
14031 Suppose a man had fired through the window, he would indeed be a remarkable
14032 shot who could with a revolver inflict so deadly a wound.
14033 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
14034 a hundred yards of the house.
14035 No one had heard a shot.
14043 \begin_layout Standard
14044 If there is less vertical space than 6
14045 \begin_inset space ~
14048 text lines is left on the page at the beginning of the multiple columns,
14049 a page break will be inserted before the multiple columns.
14050 Depending on the number of lines of the preface text, you might want to
14052 This is done by setting the cursor into the mulitcolumn inset behind the
14053 preface (if there is any) and using the menu
14055 Insert\SpecialChar menuseparator
14057 \begin_inset space ~
14061 \begin_inset space ~
14065 \begin_inset space ~
14071 Insert into that inset the amount of space like e.
14072 \begin_inset space \thinspace{}
14076 \begin_inset space \space{}
14080 \begin_inset Quotes eld
14084 \begin_inset Quotes erd
14088 \begin_inset Newline newline
14091 In this example the space is set to 7
14092 \begin_inset space ~
14095 text lines by using
14096 \begin_inset Flex Code
14099 \begin_layout Plain Layout
14108 \begin_inset Flex Code
14111 \begin_layout Plain Layout
14119 needs to be inserted as \SpecialChar TeX
14123 \begin_layout Standard
14124 \begin_inset Flex Multiple Columns
14127 \begin_layout Plain Layout
14128 \begin_inset Argument 3
14131 \begin_layout Plain Layout
14136 \begin_layout Plain Layout
14152 On the evening of the crime, he returned from the club exactly at ten.
14153 His mother and sister were out spending the evening with a relation.
14154 The servant deposed that she heard him enter the front room on the second
14155 floor, generally used as his sitting-room.
14156 She had lit a fire there, and as it smoked she had opened the window.
14157 No sound was heard from the room until eleven-twenty, the hour of the return
14158 of Lady Maynooth and her daughter.
14159 Desiring to say good-night, she attempted to enter her son's room.
14160 The door was locked on the inside, and no answer could be got to their
14161 cries and knocking.
14162 Help was obtained, and the door forced.
14163 The unfortunate young man was found lying near the table.
14164 His head had been horribly mutilated by an expanding revolver bullet, but
14165 no weapon of any sort was to be found in the room.
14173 \begin_layout Subsubsection
14177 \begin_layout Standard
14178 The amount of space before and after multiple columns can be changed by
14179 changing the length
14180 \begin_inset Flex Code
14183 \begin_layout Plain Layout
14192 For example the command
14195 \begin_layout LyX-Code
14203 \begin_layout Standard
14204 in \SpecialChar TeX
14205 Code changes its value to 3
14206 \begin_inset space \thinspace{}
14210 The change must be made before the multiple columns' start.
14211 The predefined value is 13
14212 \begin_inset space \thinspace{}
14218 \begin_layout Standard
14220 \begin_inset Flex Code
14223 \begin_layout Plain Layout
14232 \begin_inset space \thinspace{}
14238 \begin_layout Standard
14242 \begin_layout Plain Layout
14248 multicolsep}{2.5cm}
14256 \begin_layout Standard
14257 \begin_inset Flex Multiple Columns
14260 \begin_layout Plain Layout
14263 All day I turned these facts over in my mind, endeavouring to hit upon some
14264 theory which could reconcile them all, and to find that line of least resistanc
14265 e which my poor friend had declared to be the starting-point of every investigat
14267 I confess that I made little progress.
14268 In the evening I strolled across the Park, and found myself about six o'clock
14269 at the Oxford Street end of Park Lane.
14270 A group of loafers upon the pavements, all staring up at a particular window,
14271 directed me to the house which I had come to see.
14272 A tall, thin man with coloured glasses, whom I strongly suspected of being
14273 a plain-clothes detective, was pointing out some theory of his own, while
14274 the others crowded round to listen to what he said.
14275 I got as near him as I could, but his observations seemed to me to be absurd,
14276 so I withdrew again in some disgust.
14277 As I did so I struck against an elderly, deformed man, who had been behind
14278 me, and I knocked down several books which he was carrying.
14286 \begin_layout Standard
14287 \begin_inset Note Greyedout
14290 \begin_layout Plain Layout
14295 The values you set with
14296 \begin_inset Flex Code
14299 \begin_layout Plain Layout
14307 will be used for all following multiple columns until you change them again.
14315 \begin_layout Standard
14319 \begin_layout Plain Layout
14331 \begin_inset Note Note
14334 \begin_layout Plain Layout
14335 go back to the default
14343 \begin_layout Standard
14344 \begin_inset Newpage newpage
14350 \begin_layout Subsubsection
14354 \begin_layout Standard
14355 A column break can be forced by inserting the command
14356 \begin_inset Flex Code
14359 \begin_layout Plain Layout
14367 as \SpecialChar TeX
14368 Code to that position in the text where the column should be broken.
14369 Note that this leads in most cases to whitespace in the text.
14370 \begin_inset Newline newline
14373 Here is an example:
14376 \begin_layout Standard
14377 \begin_inset Flex Multiple Columns
14380 \begin_layout Plain Layout
14383 \begin_inset Quotes eld
14386 You're surprised to see me, sir,
14387 \begin_inset Quotes erd
14390 said he, in a strange, croaking voice.
14393 \begin_layout Plain Layout
14396 I acknowledged that I was.
14399 \begin_layout Plain Layout
14402 \begin_inset Quotes eld
14405 Well, I've a conscience, sir, and when I chanced to see you go into this
14406 house, as I came hobbling after you, I thought to myself, I'll just step
14407 in and see that kind gentleman, and tell him that if I was a bit gruff
14408 in my manner there was not any harm meant, and that I am much obliged to
14409 him for picking up my books.
14410 \begin_inset Quotes erd
14416 \begin_layout Plain Layout
14419 \begin_inset Quotes eld
14422 You make too much of a trifle,
14423 \begin_inset Quotes erd
14428 \begin_inset Quotes eld
14431 May I ask how you knew who I was?
14432 \begin_inset Quotes erd
14435 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
14439 \begin_layout Plain Layout
14451 \begin_layout Plain Layout
14454 \begin_inset Quotes eld
14457 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
14458 you'll find my little bookshop at the corner of Church Street, and very
14459 happy to see you, I am sure.
14460 Maybe you collect yourself, sir.
14464 \begin_inset space ~
14478 \begin_inset space ~
14481 – a bargain, every one of them.
14482 With five volumes you could just fill that gap on that second shelf.
14483 It looks untidy, does it not, sir?
14484 \begin_inset Quotes erd
14495 \begin_layout Subsubsection
14499 \begin_layout Standard
14500 The width of the columns is automatically calculated, but you can modify
14501 the space between the columns.
14502 This is done by changing the length
14503 \begin_inset Flex Code
14506 \begin_layout Plain Layout
14515 Its predefined value is 10
14516 \begin_inset space \thinspace{}
14520 Here is an example where
14521 \begin_inset Flex Code
14524 \begin_layout Plain Layout
14533 \begin_inset space \thinspace{}
14539 \begin_layout Standard
14543 \begin_layout Plain Layout
14557 \begin_layout Standard
14558 \begin_inset Flex Multiple Columns
14561 \begin_layout Plain Layout
14564 My observations of No.
14565 \begin_inset space \space{}
14568 427 Park Lane did little to clear up the problem in which I was interested.
14569 The house was separated from the street by a low wall and railing, the
14570 whole not more than five feet high.
14571 It was perfectly easy, therefore, for anyone to get into the garden, but
14572 the window was entirely inaccessible, since there was no water pipe or
14573 anything which could help the most active man to climb it.
14574 More puzzled than ever, I retraced my steps to Kensington.
14575 I had not been in my study five minutes when the maid entered to say that
14576 a person desired to see me.
14577 To my astonishment it was none other than my strange old book collector,
14578 his sharp, wizened face peering out from a frame of white hair, and his
14579 precious volumes, a dozen of them at least, wedged under his right arm.
14587 \begin_layout Standard
14591 \begin_layout Plain Layout
14603 \begin_inset Note Note
14606 \begin_layout Plain Layout
14607 go back to the default
14615 \begin_layout Subsubsection
14619 \begin_layout Standard
14620 Between the columns a rule with a width of the length
14621 \begin_inset Flex Code
14624 \begin_layout Plain Layout
14633 If this rule width is set to 0
14634 \begin_inset space \thinspace{}
14637 pt (this is the default), the rule is suppressed.
14638 In the following example the rule is 2
14639 \begin_inset space \thinspace{}
14645 \begin_layout Standard
14649 \begin_layout Plain Layout
14655 columnseprule}{2pt}
14663 \begin_layout Standard
14664 \begin_inset Flex Multiple Columns
14667 \begin_layout Plain Layout
14670 \begin_inset Quotes eld
14673 You're surprised to see me, sir,
14674 \begin_inset Quotes erd
14677 said he, in a strange, croaking voice.
14680 \begin_layout Plain Layout
14683 I acknowledged that I was.
14686 \begin_layout Plain Layout
14689 \begin_inset Quotes eld
14692 Well, I've a conscience, sir, and when I chanced to see you go into this
14693 house, as I came hobbling after you, I thought to myself, I'll just step
14694 in and see that kind gentleman, and tell him that if I was a bit gruff
14695 in my manner there was not any harm meant, and that I am much obliged to
14696 him for picking up my books.
14697 \begin_inset Quotes erd
14703 \begin_layout Plain Layout
14706 \begin_inset Quotes eld
14709 You make too much of a trifle,
14710 \begin_inset Quotes erd
14715 \begin_inset Quotes eld
14718 May I ask how you knew who I was?
14719 \begin_inset Quotes erd
14725 \begin_layout Plain Layout
14728 \begin_inset Quotes eld
14731 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
14732 you'll find my little bookshop at the corner of Church Street, and very
14733 happy to see you, I am sure.
14734 Maybe you collect yourself, sir.
14738 \begin_inset space ~
14752 \begin_inset space ~
14755 – a bargain, every one of them.
14756 With five volumes you could just fill that gap on that second shelf.
14757 It looks untidy, does it not, sir?
14758 \begin_inset Quotes erd
14769 \begin_layout Standard
14770 \begin_inset VSpace defskip
14776 \begin_layout Standard
14777 The rule can be colored by redefining the command
14778 \begin_inset Flex Code
14781 \begin_layout Plain Layout
14790 This is done by inserting the command
14793 \begin_layout LyX-Code
14798 columnseprulecolor}{
14803 \begin_layout Standard
14804 as \SpecialChar TeX
14805 Code before the multicolumn inset.
14807 \begin_inset Flex Code
14810 \begin_layout Plain Layout
14816 in this command by a color of your choice.
14817 You can use all pre- and self-defined colors.
14825 \begin_inset space ~
14830 for more information about pre- and self-defined colors.
14831 To go back to the default color insert the command
14834 \begin_layout LyX-Code
14839 columnseprulecolor}{
14844 \begin_layout Standard
14845 Here is the example with a cyan rule and 1
14846 \begin_inset space \thinspace{}
14849 cm column separation:
14852 \begin_layout Standard
14856 \begin_layout Plain Layout
14865 \begin_layout Plain Layout
14871 columnseprulecolor}{
14881 \begin_layout Standard
14882 \begin_inset Flex Multiple Columns
14885 \begin_layout Plain Layout
14888 \begin_inset Quotes eld
14891 You're surprised to see me, sir,
14892 \begin_inset Quotes erd
14895 said he, in a strange, croaking voice.
14898 \begin_layout Plain Layout
14901 I acknowledged that I was.
14904 \begin_layout Plain Layout
14907 \begin_inset Quotes eld
14910 Well, I've a conscience, sir, and when I chanced to see you go into this
14911 house, as I came hobbling after you, I thought to myself, I'll just step
14912 in and see that kind gentleman, and tell him that if I was a bit gruff
14913 in my manner there was not any harm meant, and that I am much obliged to
14914 him for picking up my books.
14915 \begin_inset Quotes erd
14921 \begin_layout Plain Layout
14924 \begin_inset Quotes eld
14927 You make too much of a trifle,
14928 \begin_inset Quotes erd
14933 \begin_inset Quotes eld
14936 May I ask how you knew who I was?
14937 \begin_inset Quotes erd
14943 \begin_layout Plain Layout
14946 \begin_inset Quotes eld
14949 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
14950 you'll find my little bookshop at the corner of Church Street, and very
14951 happy to see you, I am sure.
14952 Maybe you collect yourself, sir.
14956 \begin_inset space ~
14970 \begin_inset space ~
14973 – a bargain, every one of them.
14974 With five volumes you could just fill that gap on that second shelf.
14975 It looks untidy, does it not, sir?
14976 \begin_inset Quotes erd
14987 \begin_layout Standard
14991 \begin_layout Plain Layout
14997 columnseprule}{0pt}
15000 \begin_layout Plain Layout
15006 columnseprulecolor}{
15014 \begin_inset Note Note
15017 \begin_layout Plain Layout
15018 go back to the default
15026 \begin_layout Section
15028 \change_inserted 564990737 1671270380
15032 \begin_layout Subsection
15034 \change_inserted 564990737 1671270398
15036 \change_deleted 564990737 1671270396
15042 \begin_layout Standard
15045 as well as any other text processor uses by default rectangular paragraphs.
15046 For special cases like for example posters, invitation cards or poems you
15047 can modify the paragraph shape to one of your choice.
15048 This can be done by using the \SpecialChar LaTeX
15050 \begin_inset Flex Code
15053 \begin_layout Plain Layout
15059 which is loaded by using in the document settings the module
15061 Custom paragraph shapes
15066 \begin_layout Subsubsection
15070 \begin_layout Standard
15075 provides the following shapes:
15078 \begin_layout Standard
15079 \begin_inset Tabular
15080 <lyxtabular version="3" rows="13" columns="3">
15081 <features booktabs="true" islongtable="true" longtabularalignment="center">
15082 <column alignment="left" valignment="middle" width="16col%">
15083 <column alignment="left" valignment="middle" width="40col%">
15084 <column alignment="left" valignment="middle" width="35col%">
15085 <row endhead="true">
15086 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
15089 \begin_layout Plain Layout
15098 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
15101 \begin_layout Plain Layout
15110 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
15113 \begin_layout Plain Layout
15123 <row interlinespace="default">
15124 <cell alignment="left" valignment="top" usebox="none">
15127 \begin_layout Plain Layout
15135 <cell alignment="left" valignment="top" usebox="none">
15138 \begin_layout Plain Layout
15141 Circle with circular hole (in the size of a CD/DVD)
15146 <cell alignment="left" valignment="top" usebox="none">
15149 \begin_layout Plain Layout
15152 Cannot be scaled, take care there is not too much text
15158 <row interlinespace="default">
15159 <cell alignment="left" valignment="top" usebox="none">
15162 \begin_layout Plain Layout
15170 <cell alignment="left" valignment="top" usebox="none">
15173 \begin_layout Plain Layout
15181 <cell alignment="left" valignment="top" usebox="none">
15184 \begin_layout Plain Layout
15187 Fragile, calculation might fail
15193 <row interlinespace="default">
15194 <cell alignment="left" valignment="top" usebox="none">
15197 \begin_layout Plain Layout
15205 <cell alignment="left" valignment="top" usebox="none">
15208 \begin_layout Plain Layout
15211 Rhomboid (symbolizing a
15212 \begin_inset Quotes eld
15216 \begin_inset Quotes erd
15224 <cell alignment="left" valignment="top" usebox="none">
15227 \begin_layout Plain Layout
15236 <row interlinespace="default">
15237 <cell alignment="left" valignment="top" usebox="none">
15240 \begin_layout Plain Layout
15248 <cell alignment="left" valignment="top" usebox="none">
15251 \begin_layout Plain Layout
15259 <cell alignment="left" valignment="top" usebox="none">
15262 \begin_layout Plain Layout
15271 <row interlinespace="default">
15272 <cell alignment="left" valignment="top" usebox="none">
15275 \begin_layout Plain Layout
15283 <cell alignment="left" valignment="top" usebox="none">
15286 \begin_layout Plain Layout
15294 <cell alignment="left" valignment="top" usebox="none">
15297 \begin_layout Plain Layout
15306 <row interlinespace="default">
15307 <cell alignment="left" valignment="top" usebox="none">
15310 \begin_layout Plain Layout
15318 <cell alignment="left" valignment="top" usebox="none">
15321 \begin_layout Plain Layout
15324 Nut for bolt (hexagon with circular hole)
15329 <cell alignment="left" valignment="top" usebox="none">
15332 \begin_layout Plain Layout
15341 <row interlinespace="default">
15342 <cell alignment="left" valignment="top" usebox="none">
15345 \begin_layout Plain Layout
15353 <cell alignment="left" valignment="top" usebox="none">
15356 \begin_layout Plain Layout
15364 <cell alignment="left" valignment="top" usebox="none">
15367 \begin_layout Plain Layout
15376 <row interlinespace="default">
15377 <cell alignment="left" valignment="top" usebox="none">
15380 \begin_layout Plain Layout
15388 <cell alignment="left" valignment="top" usebox="none">
15391 \begin_layout Plain Layout
15399 <cell alignment="left" valignment="top" usebox="none">
15402 \begin_layout Plain Layout
15411 <row interlinespace="default">
15412 <cell alignment="left" valignment="top" usebox="none">
15415 \begin_layout Plain Layout
15423 <cell alignment="left" valignment="top" usebox="none">
15426 \begin_layout Plain Layout
15434 <cell alignment="left" valignment="top" usebox="none">
15437 \begin_layout Plain Layout
15446 <row interlinespace="default">
15447 <cell alignment="left" valignment="top" usebox="none">
15450 \begin_layout Plain Layout
15458 <cell alignment="left" valignment="top" usebox="none">
15461 \begin_layout Plain Layout
15464 Normal/reversed rain drop
15469 <cell alignment="left" valignment="top" usebox="none">
15472 \begin_layout Plain Layout
15475 Fragile, calculation might fail
15481 <row interlinespace="default">
15482 <cell alignment="left" valignment="top" usebox="none">
15485 \begin_layout Plain Layout
15494 <cell alignment="left" valignment="top" usebox="none">
15497 \begin_layout Plain Layout
15500 The \SpecialChar TeX
15506 <cell alignment="left" valignment="top" usebox="none">
15509 \begin_layout Plain Layout
15518 <row interlinespace="default">
15519 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
15522 \begin_layout Plain Layout
15526 \begin_inset Newline newline
15534 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
15537 \begin_layout Plain Layout
15540 Triangles in different orientations
15545 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
15548 \begin_layout Plain Layout
15564 \begin_layout Standard
15565 To use a shape for your paragraph, simply select it in \SpecialChar LyX
15567 for environments in the toolbar.
15570 \begin_layout Standard
15571 \begin_inset Newpage newpage
15577 \begin_layout Standard
15578 Here is an example paragraph in the shape of a nut:
15581 \begin_layout Standard
15582 \begin_inset VSpace bigskip
15591 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
15592 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
15594 At vero eos et accusam et justo duo dolores et ea rebum.
15595 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
15597 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
15598 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
15602 \begin_layout Standard
15603 \begin_inset VSpace bigskip
15609 \begin_layout Standard
15610 \begin_inset Note Greyedout
15613 \begin_layout Plain Layout
15622 paragraphs cannot run over a page break.
15630 \begin_layout Standard
15631 \begin_inset VSpace bigskip
15637 \begin_layout Standard
15639 \begin_inset Flex Code
15642 \begin_layout Plain Layout
15648 takes care that the shape will always be preserved, no matter how much
15649 text is in the paragraph.
15650 Therefore the paragraph size changes with the amount of contained text.
15651 This can lead to paragraph sizes exceeding the page margins.
15652 To demonstrate the size scaling, here is the same example paragraph but
15653 with twice as much text:
15656 \begin_layout Standard
15657 \begin_inset Newpage newpage
15666 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
15667 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
15669 At vero eos et accusam et justo duo dolores et ea rebum.
15670 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
15672 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
15673 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
15675 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
15676 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
15678 At vero eos et accusam et justo duo dolores et ea rebum.
15679 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
15681 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
15682 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
15686 \begin_layout Standard
15687 \begin_inset VSpace bigskip
15693 \begin_layout Standard
15694 An exception is the shape
15699 It cannot be scaled because it must fit the size of a CD/DVD.
15700 Therefore the amount of text that fits into the shape is limited.
15701 \begin_inset Newline newline
15712 shape are fragile, meaning that the calculation of their size can fail,
15713 depending on the amount of text.
15714 You will then get the \SpecialChar LaTeX
15716 \begin_inset Quotes eld
15719 Arithmetic overflow
15720 \begin_inset Quotes erd
15724 In this case one can try to remove or add some text; if nothing works one
15725 has to use another shape.
15728 \begin_layout Standard
15729 \begin_inset VSpace bigskip
15735 \begin_layout Standard
15736 For shapes with tips you will maybe see that \SpecialChar LaTeX
15737 's hyphenation routine fails
15738 for text in the tips.
15739 Therefore it is often necessary to add hyphenation points
15744 arg "specialchar-insert hyphenation"
15749 ) to the corresponding text parts.
15752 \begin_layout Standard
15753 \begin_inset VSpace bigskip
15759 \begin_layout Standard
15760 Shapepar paragraphs are either always centered or placed on the page so
15761 that their left border touches the left page margin.
15762 You can therefore not use the paragraph dialog to align such paragraphs.
15763 A solution is to put the paragraph into a minipage or parbox and align
15765 The problem is hereby to find the right width for the box.
15766 Because if it is too wide and you center the box, the paragraph is not
15767 centered too because it sticks at the left side of the box.
15768 So you might have to play a bit with the width until it fits.
15769 Here are two heart-shaped paragraphs, the first one is not aligned, the
15770 second one is right-aligned:
15773 \begin_layout Standard
15774 \begin_inset Newpage newpage
15780 \begin_layout Heart
15784 Lo\SpecialChar softhyphen
15785 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
15786 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
15788 At vero eos et accusam et justo duo dolores et ea rebum.
15789 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
15793 \begin_layout Standard
15794 \begin_inset VSpace bigskip
15800 \begin_layout Standard
15803 \begin_inset Box Frameless
15813 height_special "totalheight"
15818 backgroundcolor "none"
15821 \begin_layout Heart
15825 Lo\SpecialChar softhyphen
15826 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
15827 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
15829 At vero eos et accusam et justo duo dolores et ea rebum.
15830 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
15839 \begin_layout Subsubsection
15843 \begin_layout Standard
15844 You can define any shape you want.
15845 Doing this manually is a lot of work because every coordinate must be specified.
15846 But there is a way to let the computer calculate the coordinates:
15849 \begin_layout Enumerate
15850 Install the program
15851 \begin_inset CommandInset href
15854 target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
15862 \begin_layout Enumerate
15869 TeX/LaTeX\SpecialChar menuseparator
15870 Settings\SpecialChar menuseparator
15873 and select the font size you are using in your document.
15874 For example this document uses the size 12
15875 \begin_inset space \thinspace{}
15881 \begin_layout Enumerate
15885 \begin_layout Enumerate
15888 TeX/LaTeX\SpecialChar menuseparator
15891 to export the shape to coordinates.
15892 In the appearing dialog use either the outline of your shape for the coordinate
15893 s or the path itself.
15897 \begin_layout Plain Layout
15898 For more information see
15899 \begin_inset CommandInset href
15901 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
15914 \begin_layout Standard
15915 The coordinates are written into a \SpecialChar TeX
15917 To use it for your \SpecialChar LyX
15921 \begin_layout Enumerate
15922 Place the cursor before the first character of your paragraph (or into a
15926 \begin_layout Enumerate
15927 Open in \SpecialChar LyX
15930 Insert\SpecialChar menuseparator
15931 File\SpecialChar menuseparator
15933 \begin_inset space ~
15938 , select the file and use
15947 \begin_layout Standard
15948 \begin_inset VSpace defskip
15954 \begin_layout Standard
15955 \begin_inset Note Greyedout
15958 \begin_layout Plain Layout
15963 : The changed shape only applies to the current paragraph; everything is
15964 reset to normal for the next paragraph.
15965 Therefore the shape definition file must be input into every paragraph
15966 with the desired shape.
15974 \begin_layout Standard
15975 \begin_inset VSpace bigskip
15981 \begin_layout Standard
15982 Here is an example:
15985 \begin_layout Standard
15986 \begin_inset VSpace bigskip
15992 \begin_layout Standard
15993 \begin_inset CommandInset include
15995 filename "SpecialParagraphShape.tex"
16002 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
16003 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
16005 At vero eos et accusam et justo duo dolores et ea rebum.
16006 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
16008 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
16009 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
16013 \begin_layout Standard
16014 \begin_inset VSpace bigskip
16020 \begin_layout Standard
16025 to draw complexer shapes in
16029 you can draw the shape in a program of your choice and import the resulting
16035 Then you only need to draw a line or spline along the outline of the image.
16038 \begin_layout Standard
16039 \begin_inset VSpace bigskip
16045 \begin_layout Standard
16048 Custom paragraph shapes
16050 also provides the two commands
16058 which can be used to define custom shapes coordinate by coordinate.
16062 \begin_layout Plain Layout
16063 These commands are internally used for all shapes described here.
16068 For information how these styles are used and about further customization
16069 possibilities, have a look at the
16070 \begin_inset CommandInset href
16072 name "documentation"
16073 target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
16079 \begin_inset Flex Code
16082 \begin_layout Plain Layout
16091 \begin_layout Chapter
16093 \change_deleted 564990737 1671304317
16097 \change_inserted 564990737 1671304322
16099 \change_deleted 564990737 1671304331
16100 ies with Bib\SpecialChar TeX
16106 \begin_layout Standard
16107 The most basic information about how to use Bib\SpecialChar TeX
16112 with \SpecialChar LyX
16113 is contained in the section
16115 Bibliography databases
16122 The following subsections explain special bibliography features supported
16123 by \SpecialChar LyX
16127 \begin_layout Section
16128 Alternative Citation Styles
16131 \begin_layout Standard
16132 Standard Bib\SpecialChar TeX
16134 \begin_inset space \thinspace{}
16138 \begin_inset space \space{}
16142 \begin_inset Quotes eld
16146 \begin_inset Quotes erd
16149 ) to refer to a cited work.
16150 However, in many scientific disciplines, other citation styles are in use.
16151 The most common one is the author-year style (e.
16152 \begin_inset space \thinspace{}
16156 \begin_inset space \space{}
16160 \begin_inset Quotes eld
16164 \begin_inset Quotes erd
16169 supports three packages that provide this style,
16170 \begin_inset Flex Code
16173 \begin_layout Plain Layout
16180 \begin_inset Flex Code
16183 \begin_layout Plain Layout
16190 \begin_inset Flex Code
16193 \begin_layout Plain Layout
16200 Each of these packages has their pros and cons, which cannot be listed
16202 If you only want to have simple author-year (or author-numerical) style,
16203 or if you want to use one of the countless style files for
16204 \begin_inset Flex Code
16207 \begin_layout Plain Layout
16213 , then the established
16214 \begin_inset Flex Code
16217 \begin_layout Plain Layout
16223 package is probably your choice.
16224 If you look for specific citation styles common in law studies, you might
16226 \begin_inset Flex Code
16229 \begin_layout Plain Layout
16236 If you want to have full control over the formatting or look for advanced
16237 features such as ibidem, footnote citations, full title citations, advanced
16238 date formats (such as 400 BC) or full localization to other languages than
16239 English, you should definitely consider
16240 \begin_inset Flex Code
16243 \begin_layout Plain Layout
16249 , which exceeds all other packages in terms of features, but is also quite
16250 heavy and more resource-hungry.
16253 \begin_layout Standard
16254 The handling of these packages in \SpecialChar LyX
16255 is basically the same.
16257 \begin_inset Flex Noun
16260 \begin_layout Plain Layout
16261 Document\SpecialChar menuseparator
16268 \begin_inset Flex Noun
16271 \begin_layout Plain Layout
16278 \begin_inset Flex Noun
16281 \begin_layout Plain Layout
16288 \begin_inset Flex Noun
16291 \begin_layout Plain Layout
16298 \begin_inset Flex Noun
16301 \begin_layout Plain Layout
16308 \begin_inset Flex Noun
16311 \begin_layout Plain Layout
16312 Biblatex (Natbib mode)
16318 \begin_inset Flex Noun
16321 \begin_layout Plain Layout
16328 \begin_inset Flex Noun
16331 \begin_layout Plain Layout
16338 \begin_inset space ~
16341 6.5.3 in the User's Guide for more information on these choices).
16342 With all these packages, you will get some extra features in the citation
16343 dialog and you can select the style of the reference (
16344 \begin_inset Quotes eld
16348 \begin_inset Quotes erd
16352 \begin_inset Quotes eld
16356 \begin_inset Quotes erd
16360 \begin_inset Quotes eld
16364 \begin_inset Quotes erd
16368 \begin_inset Quotes eld
16372 \begin_inset Quotes erd
16376 Note that either package needs specifically designed style files.
16377 They all ship their own, but there are lots of additional style files,
16378 and there is even an interactive style file builder
16382 \begin_layout Plain Layout
16384 \begin_inset Flex URL
16387 \begin_layout Plain Layout
16389 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
16400 \begin_inset Flex Code
16403 \begin_layout Plain Layout
16412 \begin_layout Section
16413 Subdivided Bibliographies
16416 \begin_layout Standard
16417 Sometimes you might need to divide your bibliography into several sections.
16418 If you are for instance a historian, the possibility to separate sources
16419 and scientific works is most likely a
16420 \begin_inset Quotes eld
16424 \begin_inset Quotes erd
16428 Unfortunately, Bib\SpecialChar TeX
16429 itself does not allow you to do this.
16430 But with the help of some \SpecialChar LaTeX
16431 packages, Bib\SpecialChar TeX
16432 can be extended to fit your needs.
16435 \begin_layout Standard
16437 provides native support for one of these packages,
16445 \begin_layout Plain Layout
16447 \begin_inset Flex URL
16450 \begin_layout Plain Layout
16452 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
16462 The advantage of this package (compared to other packages such as
16466 ) is that you don't need to define new citation commands.
16467 Instead, you need to prepare different bibliographic databases which include
16468 the entries for the different sections of the bibliography.
16469 For example: If you want to divide your bibliography into the sections
16471 \begin_inset Quotes eld
16475 \begin_inset Quotes erd
16479 \begin_inset Quotes eld
16483 \begin_inset Quotes erd
16486 , you first need to create two bibliographic databases, e.
16487 \begin_inset space \thinspace{}
16491 \begin_inset space \space{}
16495 \begin_inset Flex Code
16498 \begin_layout Plain Layout
16505 \begin_inset Flex Code
16508 \begin_layout Plain Layout
16518 \begin_layout Standard
16520 \begin_inset Flex Noun
16523 \begin_layout Plain Layout
16524 Document\SpecialChar menuseparator
16531 \begin_inset Flex Noun
16534 \begin_layout Plain Layout
16541 \begin_inset Flex Noun
16544 \begin_layout Plain Layout
16545 Subdivided bibliography
16551 Now you can insert multiple Bib\SpecialChar TeX
16552 bibliographies, one for each section of
16554 Returning to our example: Insert the Bib\SpecialChar TeX
16556 \begin_inset Flex Code
16559 \begin_layout Plain Layout
16565 and a second one for the database
16566 \begin_inset Flex Code
16569 \begin_layout Plain Layout
16576 You are free to use the same or different styles for each section.
16577 Additionally, you can choose if the bibliography section should contain
16579 \begin_inset Quotes eld
16582 all cited references
16583 \begin_inset Quotes erd
16586 of the specified database(s) (which is the default),
16587 \begin_inset Quotes eld
16590 all uncited references
16591 \begin_inset Quotes erd
16595 \begin_inset Quotes eld
16599 \begin_inset Quotes erd
16603 This might be useful if you would like to separate your bibliography into
16605 \begin_inset Quotes eld
16609 \begin_inset Quotes erd
16613 \begin_inset Quotes eld
16617 \begin_inset Quotes erd
16621 \begin_inset Quotes eld
16625 \begin_inset Quotes erd
16629 The titles for the sections can be added as ordinary sections or subsections.
16631 \begin_inset Flex Code
16634 \begin_layout Plain Layout
16640 removes the bibliography title, you have to manually re-add that, too (as
16641 a chapter* or section*, for instance).
16644 \begin_layout Standard
16649 , the procedure is a bit different.
16658 , the aforementioned
16659 \begin_inset Flex Noun
16662 \begin_layout Plain Layout
16663 Subdivided bibliography
16668 option is disabled if you use
16677 provides its own means to generate subdivided bibliographies.
16678 You can either add keywords to bibliography entries via the
16679 \begin_inset Flex Code
16682 \begin_layout Plain Layout
16688 entry option and then filter bibliography sections by keyword (by adding
16690 \begin_inset Flex Code
16693 \begin_layout Plain Layout
16700 \begin_inset Flex Noun
16703 \begin_layout Plain Layout
16709 field of the dialog that opens if you left-click on the
16710 \begin_inset Flex Noun
16713 \begin_layout Plain Layout
16714 Biblatex Generated Bibliography
16719 button), or you can filter by entry types (such as
16728 \begin_inset space \thinspace{}
16733 \begin_inset Flex Code
16736 \begin_layout Plain Layout
16743 \begin_inset Flex Code
16746 \begin_layout Plain Layout
16753 \begin_inset Flex Noun
16756 \begin_layout Plain Layout
16762 field, or you can create so-called
16763 \begin_inset Quotes eld
16766 Bibliography Categories
16767 \begin_inset Quotes erd
16770 to which you can assign individual entries.
16771 Please refer to the Biblatex manual, section
16773 Subdivided Bibliographies
16778 \begin_layout Section
16779 Multiple Bibliographies
16780 \begin_inset CommandInset label
16782 name "subsec:Multiple-Bibliographies"
16789 \begin_layout Standard
16790 Multiple bibliographies, e.
16791 \begin_inset space \thinspace{}
16795 \begin_inset space \space{}
16798 a bibliography for each part, chapter, section, subsection or child (sub-documen
16799 t) of the document, are also supported by \SpecialChar LyX
16801 In order to enable it, go to
16802 \begin_inset Flex Noun
16805 \begin_layout Plain Layout
16806 Document\SpecialChar menuseparator
16807 Settings\SpecialChar menuseparator
16813 and select the relevant unit (e.
16814 \begin_inset space \thinspace{}
16818 \begin_inset Quotes eld
16822 \begin_inset Quotes erd
16826 \begin_inset Flex Noun
16829 \begin_layout Plain Layout
16830 Multiple Bibliographies
16836 Then add a Bib(la)\SpecialChar TeX
16837 bibliography to each unit (e.
16838 \begin_inset space \thinspace{}
16841 g., section) of your document.
16842 In the output, a separate bibliography, containing only the references
16843 done in the current unit is generated.
16846 \begin_layout Standard
16847 If you use Bib\SpecialChar TeX
16849 \begin_inset Flex Code
16852 \begin_layout Plain Layout
16859 \begin_inset Flex Code
16862 \begin_layout Plain Layout
16868 package is used to create multiple bibliographies.
16869 The former package is used if you select
16870 \begin_inset Quotes eld
16874 \begin_inset Quotes erd
16882 \begin_inset Flex Noun
16885 \begin_layout Plain Layout
16886 Sectioned Bibliography
16892 In all other cases,
16893 \begin_inset Flex Code
16896 \begin_layout Plain Layout
16906 \begin_layout Plain Layout
16907 An alternative approach, if you are willing to use some
16908 \begin_inset Flex Noun
16911 \begin_layout Plain Layout
16919 \begin_inset space ~
16923 \begin_inset CommandInset ref
16925 reference "sec:Inserting-TeX-Code"
16930 \begin_inset Flex Code
16933 \begin_layout Plain Layout
16945 \begin_inset Flex Code
16948 \begin_layout Plain Layout
16954 is used, \SpecialChar LyX
16955 encloses the specified units in
16956 \begin_inset Flex Code
16959 \begin_layout Plain Layout
16966 \begin_inset Flex Code
16969 \begin_layout Plain Layout
16978 \begin_inset Flex Code
16981 \begin_layout Plain Layout
16989 in order to create the units.
16990 Note that this approach has some limitations.
16991 First, every citation reference has to be inside some
16992 \begin_inset Flex Code
16995 \begin_layout Plain Layout
17002 So citations outside a defined unit (e.
17003 \begin_inset space \thinspace{}
17006 g., before the first section if you use
17007 \begin_inset Quotes eld
17011 \begin_inset Quotes erd
17015 \begin_inset Quotes eld
17019 \begin_inset Quotes erd
17023 You can also create your own units by entering
17024 \begin_inset Flex Code
17027 \begin_layout Plain Layout
17036 \begin_inset Flex Code
17039 \begin_layout Plain Layout
17047 as \SpecialChar TeX
17048 code (for instance to work around the mentioned limitation).
17050 \begin_inset Flex Code
17053 \begin_layout Plain Layout
17059 s cannot be nested.
17060 A second limitation is that
17061 \begin_inset Flex Code
17064 \begin_layout Plain Layout
17070 always processes all references of a bibliography database, even if they
17072 This can result in odd labels (e.
17073 \begin_inset space \thinspace{}
17078 \begin_inset Quotes eld
17082 \begin_inset Quotes erd
17085 if two works of this author from 2014 are in the database, even if only
17089 \begin_layout Standard
17095 \begin_inset Flex Code
17098 \begin_layout Plain Layout
17104 option is used instead.
17105 If you need specific units, you can start them with the \SpecialChar TeX
17107 \begin_inset Flex Code
17110 \begin_layout Plain Layout
17119 \begin_inset Flex Code
17122 \begin_layout Plain Layout
17131 If you also want to control the end of the unit, use the environment
17132 \begin_inset Flex Code
17135 \begin_layout Plain Layout
17145 \begin_inset Flex Code
17148 \begin_layout Plain Layout
17158 \begin_inset Flex Code
17161 \begin_layout Plain Layout
17167 s cannot be nested.
17168 In addition to the individual bibliography of the current unit,
17172 also provides an easy way to output all bibliographies, subsequently, at
17174 \begin_inset space \thinspace{}
17177 g., at the end of the document).
17179 \begin_inset Quotes eld
17182 all reference units
17183 \begin_inset Quotes erd
17186 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve
17188 Please refer to the
17192 manual for more information on this topic.
17195 \begin_layout Chapter
17197 \change_deleted 564990737 1671355654
17201 \change_inserted 564990737 1671355667
17203 \change_deleted 564990737 1671355661
17205 \change_inserted 564990737 1671355684
17207 \begin_inset CommandInset label
17209 name "chap:bullets"
17214 \change_deleted 564990737 1671355684
17216 \begin_inset CommandInset label
17227 \begin_layout Standard
17233 \begin_layout Section
17237 \begin_layout Standard
17239 provides 216 bullet shapes that can be accessed from a simple dialog.
17240 Using this dialog you can easily specify what bullet shape to use at each
17241 level of an itemized list.
17242 These settings are document-wide so you won't be able to specify different
17243 sets of bullets for different paragraphs.
17247 \begin_layout Plain Layout
17248 Well, actually you can but you'll have to do it by hand.
17256 \begin_layout Section
17260 \begin_layout Standard
17261 Open the dialog by selecting the
17262 \begin_inset Flex Noun
17265 \begin_layout Plain Layout
17266 Document\SpecialChar menuseparator
17272 menu item and then select the
17273 \begin_inset Flex Noun
17276 \begin_layout Plain Layout
17285 \begin_layout Standard
17286 The dialog provides you with a table of bullet shapes.
17287 A column of buttons on the left of the table provides access to the six
17288 different panels of bullet shapes.
17289 The row of buttons across the top is used to select which bullet depth
17292 \change_deleted 244031559 1603875981
17293 A text entry under the table shows the currently selected bullet shape's
17295 equivalent and this can be edited if desired.
17296 If you do modify the text you will also need to specify any needed packages
17297 in the \SpecialChar LaTeX
17303 \begin_layout Standard
17304 The six panels are divided up by the packages they require.
17305 The following table shows the mappings from button name to \SpecialChar LaTeX
17309 \begin_layout Standard
17311 \begin_inset Tabular
17312 <lyxtabular version="3" rows="7" columns="2">
17313 <features tabularvalignment="middle">
17314 <column alignment="center" valignment="top" width="0pt">
17315 <column alignment="center" valignment="top" width="0pt">
17317 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
17320 \begin_layout Plain Layout
17335 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
17338 \begin_layout Plain Layout
17355 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
17358 \begin_layout Plain Layout
17373 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
17376 \begin_layout Plain Layout
17385 base \SpecialChar LaTeX
17393 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
17396 \begin_layout Plain Layout
17411 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
17414 \begin_layout Plain Layout
17431 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
17434 \begin_layout Plain Layout
17449 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
17452 \begin_layout Plain Layout
17469 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
17472 \begin_layout Plain Layout
17487 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
17490 \begin_layout Plain Layout
17507 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
17510 \begin_layout Plain Layout
17525 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
17528 \begin_layout Plain Layout
17545 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
17548 \begin_layout Plain Layout
17563 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
17566 \begin_layout Plain Layout
17589 \begin_layout Standard
17591 doesn't stop you using bullets from packages you don't have.
17592 If you get errors from \SpecialChar LaTeX
17593 when you try to view or print the file, then it
17594 is likely you are missing a package.
17598 \begin_layout Plain Layout
17600 doesn't restrict your use since you may be editing locally and exporting
17609 \begin_layout Section
17613 \begin_layout Standard
17614 Select which bullet depth you want to change then select the bullet shape
17616 Any changes will not be visible in \SpecialChar LyX
17617 , but are visible when viewing the document.
17620 \begin_layout Standard
17621 You can reset a bullet shape to the default simply by clicking your right
17622 mouse button on the appropriate bullet depth button.
17626 \begin_layout Plain Layout
17631 want to have multiple sets of paragraphs with different sets of bullets
17632 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
17634 The bullet selection dialog can help though because it provides you with
17635 the \SpecialChar LaTeX
17636 code for a wide range of bullet shapes.
17637 To make your own custom paragraphs you have the following options:
17640 \begin_layout Plain Layout
17644 \begin_layout Plain Layout
17660 \begin_layout Plain Layout
17664 \begin_layout Plain Layout
17686 \begin_layout Itemize
17687 Use the \SpecialChar LaTeX
17689 \begin_inset Flex Code
17692 \begin_layout Plain Layout
17700 to specify a new bullet shape for a given depth.
17701 You'll also need to save the current bullet shape so you can restore it
17703 In this itemized list the following \SpecialChar LaTeX
17704 code was used to change the bullet
17705 used for the first depth.
17709 \begin_layout LyX-Code
17719 \begin_layout LyX-Code
17736 \begin_layout Itemize
17737 Note that the itemize depth is specified in Roman numerals as part of the
17747 \begin_layout Itemize
17748 \begin_inset Argument item:1
17751 \begin_layout Plain Layout
17755 \begin_layout Plain Layout
17773 Specify each individual entry by starting each item with the bullet shape
17775 \begin_inset Quotes eld
17779 \begin_inset Quotes erd
17782 inset (available at
17784 Insert\SpecialChar menuseparator
17788 \begin_inset Flex Noun
17791 \begin_layout Plain Layout
17799 For example, this item was started with
17800 \begin_inset Flex Code
17803 \begin_layout Plain Layout
17818 \begin_layout Plain Layout
17822 \begin_layout Plain Layout
17838 \begin_layout Plain Layout
17839 You'll also need to revert the labelitem back to its previous setting for
17840 the global bullet shape settings to remain in effect.
17841 The way used here was:
17844 \begin_layout LyX-Code
17859 \begin_layout Chapter
17863 \begin_layout Section
17864 Multipart Documents
17867 \begin_layout Subsection
17871 \begin_layout Standard
17872 When you are working on a large file with many sections, it is often convenient
17873 to break up the document into several files, or perhaps you have something
17874 where a table may change from time to time, but the preceding text does
17876 In these cases, you should seriously consider using multipart documents.
17877 For example, scientific papers often have five major sections: the introduction
17878 , observations, results, discussion, and conclusion.
17879 Each of these could be its own separate \SpecialChar LyX
17881 \begin_inset Quotes eld
17885 \begin_inset Quotes erd
17888 file which contains the title, authors, abstract, references, etc., plus
17889 the five included files.
17890 It is important to note that each of these files is a full \SpecialChar LyX
17892 can be formatted and printed on its own, as well as included in a master
17894 Each of these files must have the same document class, however—don't attempt
17895 to mix book classes with article classes.
17896 You may also include \SpecialChar LaTeX
17897 files; however, these files must not have their own
17899 \begin_inset space \thinspace{}
17903 \begin_inset space \space{}
17906 everything up to and including the
17907 \begin_inset Flex Code
17910 \begin_layout Plain Layout
17918 line as well as the
17919 \begin_inset Flex Code
17922 \begin_layout Plain Layout
17930 line must be deleted) or else errors will be generated when you try to
17934 \begin_layout Standard
17936 allows you to include files quite easily with
17937 \begin_inset Flex Noun
17940 \begin_layout Plain Layout
17941 Insert\SpecialChar menuseparator
17943 \begin_inset space ~
17952 When you click on this selection a small box is inserted into the file
17953 at the current cursor location.
17954 Clicking on the box raises a dialog which allows you to select the file
17955 to be included, and the method of its inclusion.
17959 \begin_layout Standard
17960 The file selection box should by now be obvious.
17961 The three inclusion methods are
17962 \begin_inset Quotes eld
17966 \begin_inset Quotes erd
17970 \begin_inset Quotes eld
17974 \begin_inset Quotes erd
17978 \begin_inset Quotes eld
17982 \begin_inset Quotes erd
17987 \begin_inset Quotes eld
17991 \begin_inset Quotes erd
17995 \begin_inset Quotes eld
17999 \begin_inset Quotes erd
18002 are similar in many ways, but there are also some notable differences:
18005 \begin_layout Enumerate
18007 \begin_inset Quotes eld
18011 \begin_inset Quotes erd
18014 are typeset beginning on a new page, while files that are
18015 \begin_inset Quotes eld
18019 \begin_inset Quotes erd
18022 are typeset starting on the current page.
18025 \begin_layout Enumerate
18026 \begin_inset Quotes eld
18030 \begin_inset Quotes erd
18033 files cannot themselves
18034 \begin_inset Quotes eld
18038 \begin_inset Quotes erd
18042 \begin_inset Quotes eld
18046 \begin_inset Quotes erd
18051 \begin_inset Quotes eld
18055 \begin_inset Quotes erd
18058 , on the other hand, infinite sub-inputting is possible.
18061 \begin_layout Enumerate
18062 \begin_inset Quotes eld
18066 \begin_inset Quotes erd
18069 allow for the output of only selected
18070 \begin_inset Quotes eld
18074 \begin_inset Quotes erd
18077 files, while maintaining the actual counters (pagination etc.) and references
18078 (please refer to the section
18081 \begin_inset space ~
18089 \begin_inset space ~
18094 manual for details).
18097 \begin_layout Standard
18099 \begin_inset Quotes eld
18103 \begin_inset Quotes erd
18106 is the preferred method for chapters that are outsourced to child documents,
18108 \begin_inset Quotes eld
18112 \begin_inset Quotes erd
18115 is more suitable for arbitrary file inheritance.
18118 \begin_layout Standard
18120 \begin_inset Quotes eld
18124 \begin_inset Quotes erd
18127 included file allows you to include a file typeset exactly as it appears
18129 \begin_inset space \thinspace{}
18133 \begin_inset space \space{}
18137 \begin_inset Flex Code
18140 \begin_layout Plain Layout
18146 mode, with the characters set in a fixed-width typewriter font.
18147 Normally, spaces in this file are invisible, though two consecutive spaces
18148 are conserved, unlike \SpecialChar LyX
18149 's normal treatment of spaces.
18150 However, setting the
18151 \begin_inset Flex Noun
18154 \begin_layout Plain Layout
18156 \begin_inset space ~
18160 \begin_inset space ~
18164 \begin_inset space ~
18172 checkbox typesets a mark to unambiguously define the presence of a space.
18176 \begin_layout Standard
18177 Generally, the master file is converted into a full \SpecialChar LaTeX
18178 file before typesetting,
18179 while the included files are converted to \SpecialChar LaTeX
18180 files that do not have all the
18181 preamble information.
18184 \begin_layout Subsection
18185 Cross-References Between Files
18188 \begin_layout Standard
18189 \begin_inset Box Shadowbox
18199 height_special "totalheight"
18204 backgroundcolor "none"
18207 \begin_layout Plain Layout
18208 This section is somewhat out of date.
18209 Need to describe default master documents and how children are opened when
18219 \begin_layout Standard
18220 It is possible to set up cross-references between the different files.
18221 First, open all the files in question: let's call them A and B in a two
18222 file example, where B is included in A.
18223 Let's say you insert a label in A, then want to reference it in B.
18224 Open the cross-reference dialog whilst in document B, and you can select
18226 \begin_inset Quotes eld
18230 \begin_inset Quotes erd
18236 \begin_layout Subsection
18237 Bibliography Lists in all Subdocuments
18240 \begin_layout Standard
18241 If you work with child documents, you might want to have only one main bibliogra
18242 phy at the end, but still be able to have a selected bibliography for the
18243 child if you output it on its own.
18244 Here is how to achieve this.
18247 \begin_layout Standard
18248 For the main document, you just insert a bibliography inset at the place
18249 where the main bibliography has to appear (within the master file or within
18251 If the bibliography inset is in the master file, the references will be
18252 inherited by all children, so they are available in the citation dialog
18256 \begin_layout Standard
18257 For child-specific bibliographies, insert bibliography insets within the
18258 child documents, at the place where the bibliography should appear when
18259 the child is compiled separately.
18260 However, the trick is to insert them into a branch (
18262 Insert\SpecialChar menuseparator
18263 Branch\SpecialChar menuseparator
18264 Insert New Branch...
18267 \begin_inset space \thinspace{}
18272 \begin_inset Quotes eld
18276 \begin_inset Quotes erd
18280 Within the children, activate the branch (
18282 Document\SpecialChar menuseparator
18283 Settings...\SpecialChar menuseparator
18287 Within the master, deactivate the branch (
18289 Document\SpecialChar menuseparator
18290 Settings...\SpecialChar menuseparator
18294 Now the child's bibliography will be ignored by the master, but considered
18298 \begin_layout Standard
18299 If you need multiple bibliographies (e.
18300 \begin_inset space \thinspace{}
18303 g., one per child in the
18307 ), please refer to sec.
18308 \begin_inset space ~
18312 \begin_inset CommandInset ref
18314 reference "subsec:Multiple-Bibliographies"
18321 \begin_layout Section
18326 \begin_layout Standard
18327 Users sometimes need to be able to
18328 \begin_inset Quotes eld
18332 \begin_inset Quotes erd
18336 file together with all the images (and other files) on which it depends,
18337 either for sending to a publisher or for sharing with a co-author.
18339 includes a Python script (
18340 \begin_inset Flex Code
18343 \begin_layout Plain Layout
18349 ) that automates this process.
18350 To use it, you must have either the
18351 \begin_inset Flex Code
18354 \begin_layout Plain Layout
18361 \begin_inset Flex Code
18364 \begin_layout Plain Layout
18370 python modules installed on your system.
18371 By default, the script prefers the
18372 \begin_inset Flex Code
18375 \begin_layout Plain Layout
18382 \begin_inset Flex Code
18385 \begin_layout Plain Layout
18391 format on Unix-like systems and the
18392 \begin_inset Flex Code
18395 \begin_layout Plain Layout
18404 \begin_layout Standard
18406 's configuration process will set the script up to export a `\SpecialChar LyX
18408 and this format will then be available under
18409 \begin_inset Flex Code
18412 \begin_layout Plain Layout
18413 File\SpecialChar menuseparator
18422 \begin_layout Standard
18423 Independently of the platform, the generation of a particular archive format
18424 can be forced by adding either the
18425 \begin_inset Flex Code
18428 \begin_layout Plain Layout
18435 \begin_inset Flex Code
18438 \begin_layout Plain Layout
18445 \begin_inset Flex Code
18448 \begin_layout Plain Layout
18455 \begin_inset Flex Code
18458 \begin_layout Plain Layout
18464 format) switch to the
18465 \begin_inset Flex Code
18468 \begin_layout Plain Layout
18470 \SpecialChar menuseparator
18478 \begin_inset Flex Code
18481 \begin_layout Plain Layout
18482 Tools\SpecialChar menuseparator
18483 Preferences\SpecialChar menuseparator
18484 File Handling\SpecialChar menuseparator
18491 (Make sure you add the switch after the script name, not before it.)
18494 \begin_layout Section
18495 Fancy Headers and Footers
18498 \begin_layout Standard
18499 The default page layout is rather plain; for an
18500 \begin_inset Flex Code
18503 \begin_layout Plain Layout
18509 document class, all you get is a centered page number at the bottom of
18511 This document uses KOMA-script's book class, so it appears to be a bit
18513 But to really put on a show, you need to set the document page style to
18515 \begin_inset Quotes eld
18519 \begin_inset Quotes erd
18522 , as mentioned in the
18527 This section describes the \SpecialChar LaTeX
18528 code you need to insert in your \SpecialChar LaTeX
18530 order to get the desired effects.
18533 \begin_layout Standard
18534 For more information on fancy headers, see the
18535 \begin_inset Flex Code
18538 \begin_layout Plain Layout
18544 package documentation.
18546 \begin_inset Flex URL
18549 \begin_layout Plain Layout
18551 https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
18559 \begin_layout Standard
18560 The page header is divided into three fields, not surprisingly labeled
18561 \begin_inset Quotes eld
18565 \begin_inset Quotes erd
18569 \begin_inset Quotes eld
18573 \begin_inset Quotes erd
18577 \begin_inset Quotes eld
18581 \begin_inset Quotes erd
18585 The footer is also divided into these three fields.
18586 The \SpecialChar LaTeX
18587 commands to set these fields in the simplest manner are
18588 \begin_inset Flex Code
18591 \begin_layout Plain Layout
18600 \begin_inset Flex Code
18603 \begin_layout Plain Layout
18612 \begin_inset Flex Code
18615 \begin_layout Plain Layout
18624 \begin_inset Flex Code
18627 \begin_layout Plain Layout
18636 Suppose you wish to put your name in the upper left hand corner of each
18638 Simply insert the following command in the preamble:
18641 \begin_layout Standard
18650 \begin_layout Standard
18651 You will now see your name in the upper left.
18652 If a field has a default entry that you would like to get rid of (often
18653 the page number appears in the central footer) simply include a command
18654 with a blank argument, e.
18655 \begin_inset space \thinspace{}
18661 \begin_layout Standard
18669 \begin_layout Standard
18670 Let's get really fancy: lets put the section number with the word
18671 \begin_inset Quotes eld
18675 \begin_inset Quotes erd
18679 \begin_inset space \thinspace{}
18683 \begin_inset space \space{}
18686 Section 3) in the upper left, the page number (e.
18687 \begin_inset space \thinspace{}
18691 \begin_inset space \space{}
18694 Page 4) in the upper right, your name in the lower left, and the date in
18696 The following commands should now appear in the preamble:
18699 \begin_layout Standard
18709 \begin_layout Standard
18717 \begin_layout Standard
18727 \begin_layout Standard
18736 \begin_layout Standard
18744 \begin_layout Standard
18754 \begin_layout Standard
18756 \begin_inset Flex Code
18759 \begin_layout Plain Layout
18768 \begin_inset Flex Code
18771 \begin_layout Plain Layout
18779 access \SpecialChar LaTeX
18780 's section and page counters, and so print out the current section
18783 \begin_inset Flex Code
18786 \begin_layout Plain Layout
18794 simply prints out today's date.
18797 \begin_layout Standard
18798 The thicknesses of the horizontal rules drawn beneath the header and above
18799 the footer can also be modified.
18800 If you don't want one of the rules, set its thickness to 0.
18801 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
18807 \begin_inset Flex Code
18810 \begin_layout Plain Layout
18815 headrulewidth}{0.4pt}
18821 \begin_inset Flex Code
18824 \begin_layout Plain Layout
18829 footrulewidth}{0.4pt}
18834 to set the thicknesses.
18837 \begin_layout Standard
18838 You can switch the header/footer settings on and off for individual pages
18839 using commands like
18840 \begin_inset Flex Code
18843 \begin_layout Plain Layout
18846 thispagestyle{empty}
18852 \begin_inset Flex Code
18855 \begin_layout Plain Layout
18858 thispagestyle{plain}
18864 \begin_inset Flex Code
18867 \begin_layout Plain Layout
18870 thispagestyle{fancy}
18876 Simply insert them in the text on the page you want changed and mark them
18877 as \SpecialChar TeX
18879 In fact, title pages are marked as plain by default, while following pages
18880 are marked fancy when using the global fancy setting.
18883 \begin_layout Standard
18884 As a final example, it is possible to include an image in the header or
18886 Suppose you want to put a company logo in the upper lefthand corner.
18887 You might try something like
18890 \begin_layout Standard
18899 includegraphics{logo.eps}}}
18902 \begin_layout Standard
18904 (you may need to preface this with
18905 \begin_inset Flex Code
18908 \begin_layout Plain Layout
18911 usepackage{graphics}
18916 if you don't include graphics elsewhere in your document).
18919 \begin_layout Chapter
18921 and the World Wide Web
18924 \begin_layout Standard
18926 has long supported the export of documents to various web-friendly formats,
18928 Before version 2.0, however, HTML export was always accomplished by the
18929 use of external converters.
18933 \begin_layout Plain Layout
18934 For details on the use of external converters with \SpecialChar LyX
18939 section of the Customization manual.
18944 These fall into two large groups: there are converters that use \SpecialChar LaTeX
18946 intermediate format, such as
18947 \begin_inset Flex Code
18950 \begin_layout Plain Layout
18957 \begin_inset Flex Code
18960 \begin_layout Plain Layout
18967 \begin_inset Flex Code
18970 \begin_layout Plain Layout
18976 , relying upon \SpecialChar LyX
18977 to produce the \SpecialChar LaTeX
18978 ; and there is a converter that works directly
18979 on \SpecialChar LyX
18981 \begin_inset Flex Code
18984 \begin_layout Plain Layout
18992 All of these have different advantages and disadvantages.
18996 \begin_layout Standard
18997 The \SpecialChar LaTeX
18998 -based converters have the advantage that, in principle, they know everythin
18999 g about the exported document that \SpecialChar LaTeX
19001 Such converters do not care, for example, if a certain block of code was
19002 produced by \SpecialChar LyX
19003 or was Evil Red Text.
19004 These converters know about
19005 \begin_inset Flex Code
19008 \begin_layout Plain Layout
19014 files, counters, and references, and can often make use of the
19015 \begin_inset Flex Code
19018 \begin_layout Plain Layout
19024 files generated by Bib\SpecialChar TeX
19026 On the other hand, \SpecialChar LaTeX
19027 is a very hard language to parse—it is sometimes said
19028 that only \SpecialChar TeX
19029 itself understands \SpecialChar TeX
19030 —and \SpecialChar LaTeX
19031 -based converters will often choke on
19032 what seem to be quite simple constructs; complex ones can throw them completely
19033 , and as of this writing, for example, the
19037 manual will not export with
19038 \begin_inset Flex Code
19041 \begin_layout Plain Layout
19047 , though the others will.
19048 The other issue concerns how math is handled.
19049 These converters typically convert the formulae into little pictures that
19050 are then linked from the HTML document.
19051 Since these are actually generated by \SpecialChar LaTeX
19052 , they are accurate.
19053 But they do not scale well, and just getting them to look as if they are
19054 actually meant to be in your document—so that the font sizes seem to be
19055 roughly the same—can be a challenge.
19058 \begin_layout Standard
19060 \begin_inset Flex Code
19063 \begin_layout Plain Layout
19071 \begin_inset CommandInset href
19073 name "http://pinchito.es/elyxer/"
19074 target "http://pinchito.es/elyxer/"
19079 ) solves some of these problems.
19080 In particular, the formulae it produces scale perfectly, since it renders
19081 math using a combination of HTML and CSS rather than converting the formulae
19083 But even moderately complex formula are rendered less well than with
19084 \begin_inset Flex Code
19087 \begin_layout Plain Layout
19093 ; this reflects the limitations of HTML.
19097 \begin_layout Plain Layout
19099 \begin_inset Flex Code
19102 \begin_layout Plain Layout
19109 can also use jsMath and MathJax for equations, but this setting is only
19110 available globally and requires one to have access to a server that runs
19116 More importantly (as of version 1.1.1, at least),
19117 \begin_inset Flex Code
19120 \begin_layout Plain Layout
19127 has limited support for math macros and no support for user-defined paragraph
19128 or character styles.
19129 These limitations make
19130 \begin_inset Flex Code
19133 \begin_layout Plain Layout
19140 unsuitable for many of the documents \SpecialChar LyX
19142 In principle, of course, these problems could be solved, but the \SpecialChar LyX
19144 have decided to follow a different path and have made \SpecialChar LyX
19146 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
19147 , DocBook, and plaintext.
19150 \begin_layout Standard
19151 As of this writing, XHTML output remains under development and should probably
19153 \begin_inset Quotes eld
19157 \begin_inset Quotes erd
19164 \begin_layout Plain Layout
19166 \begin_inset Flex Code
19169 \begin_layout Plain Layout
19170 development/HTML/HTML.notes
19175 , which can be found in the \SpecialChar LyX
19177 \begin_inset CommandInset href
19179 name "accessed online"
19180 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
19185 , usually contains up-to-date information about the state of XHTML output.
19186 See also the list of XHTML bugs on
19187 \begin_inset CommandInset href
19189 name "the bug tracker"
19190 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"
19200 Still, the developers have chosen this approach because it has several
19201 potential advantages over the other two.
19204 \begin_layout Standard
19205 These advantages are primarily due to the fact that the XHTML output routines,
19206 since they are part of \SpecialChar LyX
19207 , know everything \SpecialChar LyX
19208 knows about the document being
19213 \begin_layout Plain Layout
19214 Another advantage is that, since these routines are internal to \SpecialChar LyX
19216 immune to changes in \SpecialChar LyX
19217 's file format, or to changes in the semantics of
19223 So they know about the table of contents (as displayed in the outline),
19224 about the counters associated with different paragraph styles, and about
19225 user-defined styles.
19226 The XHTML output routines know what \SpecialChar LyX
19227 knows about internationalization,
19228 too, so they will output
19229 \begin_inset Quotes eld
19233 \begin_inset Quotes erd
19237 \begin_inset Quotes eld
19245 \begin_inset Quotes erd
19248 , depending upon the language in effect at the time.
19252 \begin_layout Standard
19253 Quite generally, the output routines know what \SpecialChar LyX
19254 knows about document layout,
19255 that is, about how the document is to be rendered on screen.
19256 We use this information when we output the document as XHTML.
19257 In particular, \SpecialChar LyX
19262 generates CSS style information corresponding to the layout information
19263 it uses to render the document on screen: if section headings are supposed
19264 to be sans-serif and bold as seen in \SpecialChar LyX
19265 , then (by default) they will be sans-seri
19266 f and bold when viewed in a web browser, too.
19267 And this is true not just for pre-defined styles, like Section, but for
19268 any style, including user-defined styles.
19269 Indeed, the XHTML output routines make no distinction between user-defined
19271 \change_deleted 244031559 1603876931
19273 \change_inserted 244031559 1603876940
19276 styles and \SpecialChar LyX
19277 's own pre-defined styles: in each case, everything \SpecialChar LyX
19279 the styles is contained in the layout files.
19280 And much the same is true as regards pre-defined textual insets, such as
19281 footnotes, and various custom insets.
19285 \begin_layout Standard
19286 The result is that XHTML output can be customized and extended in exactly
19287 the same way \SpecialChar LaTeX
19288 output can be customized and extended: through layout files
19290 See chapter five of the
19294 manual for the details.
19297 \begin_layout Standard
19298 The remainder of this chapter contains more detailed information on XHTML
19299 output, its limitations, and ways to work around those limitations.
19302 \begin_layout Section
19303 Math Output in XHTML
19306 \begin_layout Standard
19308 offers four choices for how math is rendered.
19309 These have various advantages and disadvantages:
19312 \begin_layout Itemize
19314 \begin_inset Newline newline
19317 MathML is a dialect of XML designed specifically for mathematics on the
19318 web, and it typically renders very well in browsers that support it.
19319 The disadvantage is that not all browsers support MathML, and support is
19320 not complete even in the Gecko-based browsers, such as Firefox.
19321 \begin_inset Newline newline
19324 If \SpecialChar LyX
19325 is unable to render a formula as MathML—for example, if the formula
19327 \begin_inset Flex Code
19330 \begin_layout Plain Layout
19336 package or ERT—then it will instead output the formula as an image.
19340 \begin_layout Itemize
19342 \begin_inset Newline newline
19345 As mentioned above,
19346 \begin_inset Flex Code
19349 \begin_layout Plain Layout
19355 outputs math as HTML, styled by CSS.
19359 \begin_layout Plain Layout
19361 has borrowed some of the CSS for its HTML output from
19362 \begin_inset Flex Code
19365 \begin_layout Plain Layout
19376 For simple formulae, this can work quite well, though with more complicated
19377 formulae it tends to break down.
19378 Still, this method has the advantage that it is very widely supported and
19379 so it may be appropriate for documents that contain only a little, fairly
19381 \begin_inset Newline newline
19384 If Lyx is unable to render a formula as HTML—for example, if the formula
19386 \begin_inset Flex Code
19389 \begin_layout Plain Layout
19395 package or ERT—then it will instead output the formula as an image.
19399 \begin_layout Itemize
19401 \begin_inset Newline newline
19405 \begin_inset Flex Code
19408 \begin_layout Plain Layout
19415 will output formulae as images, the very same images, in fact, that are
19416 used for instant preview.
19420 \begin_layout Plain Layout
19421 Instant preview does
19425 have to be on for images to be output, however.
19430 The advantage to this method is that the images are simply generated by
19432 , so they are very accurate.
19433 The disadvantage, as mentioned earlier, is that these are bitmapped images,
19434 so they do not scale terribly well, and one cannot copy them, etc.
19435 \begin_inset Newline newline
19438 The size of the images can be controlled by setting the
19439 \begin_inset Quotes eld
19442 Math Images Scaling
19443 \begin_inset Quotes erd
19447 \begin_inset Flex Noun
19450 \begin_layout Plain Layout
19451 Document\SpecialChar menuseparator
19452 Settings\SpecialChar menuseparator
19462 \begin_layout Plain Layout
19463 For those who want to know, this controls the resolution of the image in
19464 dots per inch and is based upon a default of 75 dpi.
19470 \begin_inset Newline newline
19473 If \SpecialChar LyX
19474 for some reason fails to create an image for a formula (e.g., if a required
19476 package is not installed), then it will fall back to outputing the raw
19481 \begin_layout Itemize
19484 \begin_inset Newline newline
19487 Finally, \SpecialChar LyX
19488 will happily output math as \SpecialChar LaTeX
19490 As well as being the output of last resort, this method can be used with
19492 \begin_inset CommandInset href
19495 target "http://www.math.union.edu/~dpvc/jsMath/"
19500 , which uses JavaScript to render \SpecialChar LaTeX
19501 embedded in HTML documents.
19503 wraps the \SpecialChar LaTeX
19505 \begin_inset Flex Code
19508 \begin_layout Plain Layout
19514 (for inline formulas) or
19515 \begin_inset Flex Code
19518 \begin_layout Plain Layout
19524 (for displayed formulas) with
19525 \begin_inset Flex Code
19528 \begin_layout Plain Layout
19534 , as is required for jsMath.
19537 \begin_layout Standard
19538 One of these output methods must be selected under
19539 \begin_inset Flex Noun
19542 \begin_layout Plain Layout
19543 Document\SpecialChar menuseparator
19544 Settings\SpecialChar menuseparator
19551 By default, \SpecialChar LyX
19553 This is a document-wide setting, therefore.
19556 \begin_layout Standard
19557 Eventually, \SpecialChar LyX
19558 will offer the user the option to select an alternate output
19559 method for a particular inset, say, one that isn't being rendered very
19564 \begin_layout Plain Layout
19565 That said, since \SpecialChar LyX
19566 falls back to images if the inset contains ERT, then one
19567 can force output as an image by putting some harmless ERT into the math,
19569 \begin_inset Formula $a=b\relax$
19580 \begin_layout Section
19581 Bibliography and Citations
19584 \begin_layout Standard
19585 XHTML output fully supports bibliographies and citations.
19589 \begin_layout Standard
19590 Citation labels are generated by the same machinery that generates \SpecialChar LyX
19592 labels, so the labels will look in the output much as they do in \SpecialChar LyX
19595 If you are using numerical citations, then \SpecialChar LyX
19596 will output numerical labels,
19597 such as [1] or [17], rather than simply showing the citation key in square
19598 brackets, as it does on-screen.
19599 If you are using author-year citations, then \SpecialChar LyX
19600 will add lowercase letters
19601 to the years, just as Bib\SpecialChar TeX
19602 does, if it finds more than one citation for
19603 a given author-year combination.
19604 The labels will be printed with the bibliography entries.
19605 Note that there is, at present, no way to customize the appearance of the
19606 labels, for example, to choose between square brackets and parentheses.
19609 \begin_layout Standard
19610 Bibliography output is handled by the same machinery that handles the presentati
19611 on of reference information in the citation dialog, so you will see in the
19612 XHTML output pretty much what you would see if you were to look at a given
19613 entry in the citation dialog.
19614 The formatting can be customized in your layout file or, preferably, in
19620 manual for the details.
19623 \begin_layout Standard
19624 The main defect at present is that cross-referenced information is printed
19625 with every entry with which it is associated.
19626 So you can see things like this:
19629 \begin_layout Quote
19631 \begin_inset Quotes eld
19634 Context and Logical Form
19635 \begin_inset Quotes erd
19640 Language in Context: Selected Essays
19642 (Oxford: Oxford University Press, 2007), pp.
19646 \begin_layout Quote
19648 \begin_inset Quotes eld
19651 Semantics in Context
19652 \begin_inset Quotes erd
19657 Language in Context: Selected Essays
19659 (Oxford: Oxford University Press, 2007), pp.
19663 \begin_layout Standard
19664 This should be fixed before long.
19667 \begin_layout Standard
19668 There is no support at present for sectioned bibliographies.
19669 If you have multiple bibliographies, then \SpecialChar LyX
19670 will print the same bibliography
19674 \begin_layout Section
19678 \begin_layout Standard
19680 will happily export indexes as XHTML, but with certain limitations at the
19684 \begin_layout Standard
19685 Index export will be most reliable when you do not attempt to use the fancy
19686 constructs that are described in the section on indexes in the
19694 \begin_layout Plain Layout
19695 The main issue here is that \SpecialChar LyX
19696 itself does not really handle these.
19697 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
19703 We'll describe how they are handled using the subsection headings from
19707 \begin_layout Itemize
19708 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
19709 makes an effort to support these,
19710 but the entries must be separated by
19711 \begin_inset Quotes eld
19715 \begin_inset Quotes erd
19718 , that is, there must be spaces around the exclamation point.
19719 This is because it is otherwise too difficult to check for escaped exclamation
19720 points, ones in math, and so forth.
19723 \begin_layout Itemize
19724 Page Ranges: There is no support at all for page ranges, since these make
19725 no sense with XHMTL.
19726 Instead, you will just get two index entries, one at either end.
19729 \begin_layout Itemize
19730 Cross-referencing: There is no support for cross-referencing.
19731 If \SpecialChar LyX
19732 finds an entry containing the
19733 \begin_inset Quotes eld
19736 |see\SpecialChar ldots
19738 \begin_inset Quotes erd
19741 construct, it is just dropped, and the rest is treated as an ordinary index
19745 \begin_layout Itemize
19746 Index Entry Order: \SpecialChar LyX
19747 does support attempts to fix the sorting order.
19748 It will take what is before the first `@' it finds and use that for sorting,
19749 taking what follows the first `@' to be the actual entry.
19750 At present, \SpecialChar LyX
19751 does not check for escaped `@', so do not try to index email
19755 \begin_layout Itemize
19756 Index Entry Layout: You can format entries by using the text style dialog,
19757 or by using any other method available within \SpecialChar LyX
19759 There is no support for constructs like:
19760 \begin_inset Quotes eld
19764 \begin_inset Quotes erd
19768 Indeed, if \SpecialChar LyX
19769 finds a pipe symbol, `|', in an entry, it will delete it and
19770 everything that follows it.
19773 \begin_layout Itemize
19774 Multiple Indexes: There is no support for multiple indexes.
19775 Rather, all index entries will be printed as one large index.
19776 To avoid our printing several versions of the index, we print only the
19777 main index, so make sure you have one.
19780 \begin_layout Section
19781 Nomenclature and Glossary
19784 \begin_layout Standard
19785 There is at present no support for glossaries.
19786 Adding it would be fairly trivial, and welcome.
19789 \begin_layout Chapter
19791 \change_inserted 1075283030 1616534180
19795 \begin_layout Standard
19797 \change_inserted 1075283030 1616534386
19798 Apart from HTML, \SpecialChar LyX
19799 can generate documents in the DocBook XML vocabulary.
19800 With versions 2.3 and before, only select templates could be used to generate
19801 DocBook documents (only version 4).
19802 Starting with \SpecialChar LyX
19803 2.4, most \SpecialChar LyX
19804 layouts can generate valid DocBook documents (only
19806 This feature is built into \SpecialChar LyX
19807 and does not require the use of external tools.
19810 \begin_layout Standard
19812 \change_inserted 1075283030 1616534437
19813 The result is that the DocBook output can be customized and extended in
19814 exactly the same way \SpecialChar LaTeX
19815 output can be customized and extended: through layout
19817 See chapter five of the
19821 manual for the details.
19824 \begin_layout Standard
19826 \change_inserted 1075283030 1616534475
19827 Most \SpecialChar LyX
19828 features are supported with DocBook, like math output.
19831 \begin_layout Itemize
19833 \change_inserted 1075283030 1616534741
19834 Math output is performed mostly in MathML (the major exception being constructio
19835 ns not supported by \SpecialChar LyX
19838 All formulae are also available in raw \SpecialChar TeX
19839 in the DocBook output for further
19843 \begin_layout Itemize
19845 \change_inserted 1075283030 1616534852
19846 Bibliographies and citations are implemented, including with an external
19848 Bibliography entries are not prerendered when the detailed information
19849 are available, but rather output with the standard DocBook constructs.
19850 The external DocBook processor is expected to handle the rendering of entries.
19853 \begin_layout Itemize
19855 \change_inserted 1075283030 1616534863
19856 Indexes are supported, including multiple indices.
19861 ), page ranges, and cross-references (
19865 ) are supported, with the exception of the same symbols escaped.
19874 ) are not supported.
19875 There is no support for escaping of index entries.
19878 \begin_layout Itemize
19880 \change_inserted 1075283030 1616534884
19881 Glossaries are implemented.
19884 \begin_layout Standard
19886 \change_inserted 1075283030 1616534894
19887 Two major parameters can be set at the document level.
19890 \begin_layout Itemize
19892 \change_inserted 1075283030 1616534948
19893 Format for tables: \SpecialChar LyX
19894 can generate tables either as HTML (default value) or
19895 CALS, depending on the user's requirements.
19896 Most DocBook processors accept both formats.
19899 \begin_layout Itemize
19901 \change_inserted 1075283030 1616535006
19902 MathML prefix: in DocBook, MathML is included within its own name space,
19904 The implication is that there must be an indication of the tags belonging
19905 to the MathML standard.
19906 Three choices are offered:
19910 \begin_layout Itemize
19912 \change_inserted 1075283030 1616535044
19913 Inline: the MathML name space is defined for each formula (using the
19917 attribute on each formula)
19920 \begin_layout Itemize
19922 \change_inserted 1075283030 1616535090
19927 prefix (default): the MathML name space is defined at the document level
19932 attribute on the root element).
19933 Each MathML is prefixed with
19942 \begin_layout Itemize
19944 \change_inserted 1075283030 1616620405
19949 prefix: similar to the
19958 \begin_layout Standard
19960 \change_inserted 1075283030 1616620470
19961 This option is especially useful if you want \SpecialChar LyX
19962 to match your personal style
19963 or to work with buggy software that only accepts one prefix for MathML.
19969 \begin_layout Chapter
19970 The \SpecialChar LyX
19974 \begin_layout Section
19978 \begin_layout Standard
19979 The `\SpecialChar LyX
19980 server' allows other programs to talk to \SpecialChar LyX
19981 , invoke \SpecialChar LyX
19982 commands, and retrieve
19983 information about the \SpecialChar LyX
19985 This is only intended for advanced users, but they should find it useful.
19986 It is by writing to the \SpecialChar LyX
19987 server, for example, that bibliography managers,
19988 such as JabRef, are able to
19989 \begin_inset Quotes eld
19993 \begin_inset Quotes erd
19996 citations to \SpecialChar LyX
20000 \begin_layout Section
20001 Starting the \SpecialChar LyX
20003 \begin_inset CommandInset label
20005 name "sec:Starting-the-Server"
20012 \begin_layout Standard
20013 The \SpecialChar LyX
20014 server works through the use of a pair of named pipes.
20015 These are usually located in
20016 \begin_inset Flex Code
20019 \begin_layout Plain Layout
20025 , (except on Windows, where
20029 named pipes are special objects located in
20030 \begin_inset Flex Code
20033 \begin_layout Plain Layout
20045 ) and have the names
20046 \begin_inset Quotes eld
20050 \begin_inset Flex Code
20053 \begin_layout Plain Layout
20060 \begin_inset Quotes erd
20064 \begin_inset Quotes eld
20068 \begin_inset Flex Code
20071 \begin_layout Plain Layout
20078 \begin_inset Quotes erd
20082 External programs write into
20083 \begin_inset Flex Code
20086 \begin_layout Plain Layout
20092 and read back data from
20093 \begin_inset Flex Code
20096 \begin_layout Plain Layout
20103 The stem of the pipe names can be defined in the
20104 \begin_inset Flex Noun
20107 \begin_layout Plain Layout
20108 Tools\SpecialChar menuseparator
20114 dialog, for example
20115 \begin_inset Flex Code
20118 \begin_layout Plain Layout
20119 "/home/myhome/lyxpipe"
20125 \begin_inset Flex Code
20128 \begin_layout Plain Layout
20142 on Windows (where any working path instead of lyxpipe can be used, for
20144 \begin_inset Flex Code
20147 \begin_layout Plain Layout
20170 configure this manually in order for the server to start.
20173 \begin_layout Standard
20176 \begin_inset Flex Code
20179 \begin_layout Plain Layout
20186 \begin_inset Flex Code
20189 \begin_layout Plain Layout
20195 ' to create the pipes.
20196 If one of the pipes already exists, \SpecialChar LyX
20197 will assume that another \SpecialChar LyX
20199 is already running and will not start the server.
20200 On POSIX (Unix like) systems, if for some other reason, an unused
20201 \begin_inset Quotes eld
20205 \begin_inset Quotes erd
20208 pipe is left in existence when \SpecialChar LyX
20209 closes, then \SpecialChar LyX
20210 will try to delete it.
20211 If this fails for some reason, you will need to delete the pipes manually
20212 and then restart \SpecialChar LyX
20214 On Windows, pipes are deleted by the OS on program termination or crash,
20216 \begin_inset Quotes eld
20220 \begin_inset Quotes erd
20223 pipes should not be possible.
20226 \begin_layout Standard
20227 To have several \SpecialChar LyX
20228 processes with servers at the same time, you have to use
20229 different configurations, perhaps by using separate user directories, each
20231 \begin_inset Flex Code
20234 \begin_layout Plain Layout
20240 file, for each process.
20243 \begin_layout Standard
20244 If you are developing a client program, you might find it useful to enable
20245 debugging information from the \SpecialChar LyX
20247 Do this by starting \SpecialChar LyX
20249 \begin_inset Flex Code
20252 \begin_layout Plain Layout
20261 \begin_layout Standard
20262 You can find a complete example client written in C++ in the source distribution
20264 \begin_inset Flex Code
20267 \begin_layout Plain Layout
20268 development/lyxserver/server_monitor.cpp
20276 \begin_layout Standard
20277 Another useful tool is the command-line based client found in
20278 \begin_inset Flex Code
20281 \begin_layout Plain Layout
20282 src/client/lyxclient
20290 \begin_layout Section
20291 Normal communication
20294 \begin_layout Standard
20295 To issue a \SpecialChar LyX
20296 call, the client writes a line of ASCII text into the input
20298 This line has the following format:
20301 \begin_layout Quote
20315 \begin_layout Description
20316 clientname is a name that the client can choose arbitrarily.
20317 Its only use is that \SpecialChar LyX
20318 will echo it if it sends an answer—so a client can
20319 dispatch results from different requesters.
20322 \begin_layout Description
20323 function is the function you want \SpecialChar LyX
20325 It is the same as the commands you'd use in the minibuffer.
20328 \begin_layout Description
20329 argument is an optional argument which is meaningful only to some functions
20331 \begin_inset Quotes eld
20335 \begin_inset Quotes erd
20338 LFUN will insert the argument as text at the cursor position).
20341 \begin_layout Standard
20342 The answer from \SpecialChar LyX
20343 will arrive in the output pipe and be of the form
20346 \begin_layout Quote
20360 \begin_layout Standard
20369 are just echoed from the command request, while
20373 is more or less useful information filled according to how the command
20374 execution worked out.
20375 Some commands, such as
20376 \begin_inset Quotes eld
20380 \begin_inset Quotes erd
20383 , will return information about the internal state of \SpecialChar LyX
20385 return an empty data-response.
20386 This means that the command execution went fine.
20389 \begin_layout Standard
20390 In case of errors, the response from \SpecialChar LyX
20391 will have this form
20394 \begin_layout Quote
20408 \begin_layout Standard
20413 should contain an explanation of why the command failed.
20416 \begin_layout Standard
20420 \begin_layout LyX-Code
20421 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
20422 \begin_inset Newline newline
20425 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
20426 \begin_inset Newline newline
20429 read a <~/.lyxpipe.out
20430 \begin_inset Newline newline
20436 \begin_layout Subsection
20437 AppleScript (Mac OS X)
20440 \begin_layout Standard
20441 Since \SpecialChar LyX
20442 2.1, \SpecialChar LyX
20443 supports basic interactions with AppleScript for normal communicatio
20444 n through the command run.
20445 This command takes a direct argument (the
20449 to perform) and an optional argument.
20450 It either returns the output of the function or triggers an error with
20451 the error message and code.
20454 \begin_layout Standard
20458 \begin_layout LyX-Code
20459 tell application "\SpecialChar LyX
20463 \begin_layout LyX-Code
20467 \begin_layout LyX-Code
20468 -- Stores the current file name into f
20471 \begin_layout LyX-Code
20472 set f to (run "server-get-filename" with argument "")
20475 \begin_layout LyX-Code
20476 on error the error_message number the error_number
20479 \begin_layout LyX-Code
20480 display dialog "Error: " & the error_number & ".
20484 \begin_layout LyX-Code
20485 & the error_message buttons {"OK"} default button 1
20488 \begin_layout LyX-Code
20492 \begin_layout LyX-Code
20496 \begin_layout Section
20500 \begin_layout Standard
20502 can notify clients of events going on asynchronously.
20503 Currently it will only do this if the user binds a key sequence with the
20505 \begin_inset Quotes eld
20509 \begin_inset Quotes erd
20513 The format of the string \SpecialChar LyX
20514 sends is as follows:
20517 \begin_layout Quote
20518 \begin_inset Flex Code
20521 \begin_layout Plain Layout
20532 \begin_layout Standard
20537 is the printed representation of the key sequence that was actually typed
20541 \begin_layout Standard
20542 This mechanism can be used to extend \SpecialChar LyX
20543 's command set and implement macros.
20544 Bind some key sequence to
20545 \begin_inset Quotes eld
20549 \begin_inset Quotes erd
20553 Then start a client that listens on the output pipe, dispatches the command
20554 according to the sequence, and starts a function that may use \SpecialChar LyX
20557 requests to issue a command or a series of commands to \SpecialChar LyX
20561 \begin_layout Section
20562 The simple \SpecialChar LyX
20566 \begin_layout Standard
20568 implements a simple protocol that can be used for session management.
20569 All messages are of the form
20572 \begin_layout Quote
20582 \begin_layout Standard
20588 \begin_inset Quotes eld
20592 \begin_inset Quotes erd
20596 \begin_inset Quotes eld
20600 \begin_inset Quotes erd
20605 \begin_inset Quotes eld
20609 \begin_inset Quotes erd
20612 is received from a client, \SpecialChar LyX
20613 will report back to inform the client that
20614 it's listening to it's messages, while
20615 \begin_inset Quotes eld
20619 \begin_inset Quotes erd
20622 sent from \SpecialChar LyX
20623 will inform clients that \SpecialChar LyX
20627 \begin_layout Section
20628 Reverse DVI/PDF search
20631 \begin_layout Standard
20632 Some DVI/PDF viewers
20636 \begin_layout Plain Layout
20637 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
20638 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
20647 facility (also called
20652 This means that you can tell \SpecialChar LyX
20653 to put the cursor to a specific line in the
20654 document by clicking at the respective position in the DVI/PDF output.
20655 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
20657 This is done via the \SpecialChar LyX
20658 server either by using the named pipe (
20662 ), or the UNIX domain socket (
20666 ) that \SpecialChar LyX
20667 creates in its temporary directory (this is the way the
20668 \begin_inset Flex Code
20671 \begin_layout Plain Layout
20677 program communicates with \SpecialChar LyX
20679 In some cases, you need a helper script that mediates between the viewer
20680 and \SpecialChar LyX
20681 , in others, the viewer can communicate with \SpecialChar LyX
20683 This depends on the selected viewer and on your operating system.
20684 The same applies to the way viewers need to be configured and the way the
20685 reverse search is actually performed.
20686 In what follows, we will thus describe how to setup reverse search for
20688 Before we turn to this, though, we will explain what needs to be done generally
20689 to enable reverse search in the DVI/PDF output.
20692 \begin_layout Subsection
20694 \begin_inset CommandInset label
20696 name "subsec:rev-search"
20703 \begin_layout Standard
20704 In most cases \SpecialChar LyX
20705 will do the work for you by pressing the following button
20709 arg "buffer-toggle-output-sync"
20713 Alternatively, you can also enable the feature by checking
20715 Synchronize with Output
20718 \begin_inset Flex Noun
20721 \begin_layout Plain Layout
20722 Document\SpecialChar menuseparator
20723 Settings\SpecialChar menuseparator
20730 In such a case \SpecialChar LyX
20731 will automatically insert the necessary Sync\SpecialChar TeX
20733 PDF) or load the srcltx package (for DVI) respectively.
20734 This option can be easily reached also on
20735 \begin_inset Flex Code
20738 \begin_layout Plain Layout
20747 \begin_layout Standard
20748 If you need a different setting, you can select or input a custom macro
20749 from the drop down box just below
20750 \begin_inset Flex Noun
20753 \begin_layout Plain Layout
20754 Document\SpecialChar menuseparator
20755 Settings\SpecialChar menuseparator
20756 Output\SpecialChar menuseparator
20757 Synchronize with Output
20765 \begin_layout Standard
20766 Note that the method
20767 \begin_inset Flex Code
20770 \begin_layout Plain Layout
20778 enables gzip compression.
20779 If your viewer does not support it, you should instead use
20780 \begin_inset Flex Code
20783 \begin_layout Plain Layout
20794 \begin_layout Standard
20795 Please also note that including the
20796 \begin_inset Flex Code
20799 \begin_layout Plain Layout
20806 \begin_inset Flex Code
20809 \begin_layout Plain Layout
20815 sometimes has an undesired impact on the typesetting.
20816 Thus, you should switch output synchronization off for the final typesetting
20818 \begin_inset Flex Code
20821 \begin_layout Plain Layout
20828 \begin_inset Flex Code
20831 \begin_layout Plain Layout
20841 \begin_layout Standard
20842 In case you need some more special settings that are not covered by the
20843 automatic settings, read the next section about how to set up output synchroniz
20845 If the automatic setup suits your needs, you can readily jump to section
20846 \begin_inset space ~
20850 \begin_inset CommandInset ref
20852 reference "subsec:configuring-viewers"
20856 , where the necessary configuration steps in your viewer – needed both with
20857 the automatic and the manual setup – are described.
20860 \begin_layout Subsection
20864 \begin_layout Standard
20866 provides several different methods for reverse search.
20867 Some are built-in in the
20868 \begin_inset Flex Code
20871 \begin_layout Plain Layout
20877 program, some are provided by external packages.
20878 Your choice depends on whether your \SpecialChar LaTeX
20879 distribution already provides a given
20880 method (the built-in methods are rather new) and whether your viewer can
20882 The available methods are described in the following.
20885 \begin_layout Subsubsection*
20886 Built-in DVI-search via src-specials (DVI only)
20889 \begin_layout Standard
20890 This method provides the DVI file with the necessary information for reverse
20892 It is available in \SpecialChar LaTeX
20893 since quite some time (any somewhat recent \SpecialChar LaTeX
20895 should include it), and it works reliably.
20896 To enable it, change the
20897 \begin_inset Flex Noun
20900 \begin_layout Plain Layout
20911 \begin_inset Flex Noun
20914 \begin_layout Plain Layout
20925 \begin_inset Flex Noun
20928 \begin_layout Plain Layout
20929 Preferences\SpecialChar menuseparator
20930 File Handling\SpecialChar menuseparator
20937 \begin_inset Flex Code
20940 \begin_layout Plain Layout
20941 latex -src-specials $$i
20947 If this doesn't work, check if your \SpecialChar TeX
20948 engine needs different options (the
20949 syntax might differ in some distributions).
20952 \begin_layout Subsubsection*
20953 External Packages (PDFSync and scrltx)
20956 \begin_layout Standard
20965 provide reverse search facility for PDF output (via pdflatex) and DVI output,
20967 In order to enable it, load the packages in the \SpecialChar LyX
20971 \begin_layout Itemize
20972 \begin_inset Flex Code
20975 \begin_layout Plain Layout
20978 usepackage{pdfsync}
20983 for reverse PDF search,
20986 \begin_layout Itemize
20987 \begin_inset Flex Code
20990 \begin_layout Plain Layout
20993 usepackage[active]{srcltx}
20998 for reverse DVI search.
21001 \begin_layout Standard
21002 If you want to be able to perform both DVI and PDF reverse searches, you
21003 can also insert in the preamble the following lines
21006 \begin_layout LyX-Code
21010 \begin_inset Newline newline
21016 \begin_inset Newline newline
21021 usepackage{pdfsync}
21022 \begin_inset Newline newline
21028 \begin_inset Newline newline
21033 usepackage[active]{srcltx}
21034 \begin_inset Newline newline
21042 \begin_layout Standard
21043 This way, you can preview the file as either DVI or PDF (pdflatex) and the
21044 right package will be used.
21047 \begin_layout Standard
21048 Note that PDFSync might affect the output layout of your document.
21049 It is therefore advised to disable PDFsync for final documents.
21052 \begin_layout Subsubsection*
21053 Built-in reverse search via Sync\SpecialChar TeX
21057 \begin_layout Standard
21059 \begin_inset Flex Code
21062 \begin_layout Plain Layout
21068 have built-in support for both PDF and DVI reverse search.
21071 Sync\SpecialChar TeX
21074 facility is basically the result of the integration of the PDFSync package
21075 to the pdftex program and its merge with the
21080 You need at least \SpecialChar TeX
21081 Live 2008 or a recent Mik\SpecialChar TeX
21082 distribution in order to use
21087 \begin_layout Plain Layout
21088 For some reason, Mik\SpecialChar TeX
21089 does not understand/obey the command \SpecialChar LyX
21091 the preamble when you check the "Enable Forward/Reverse Search" button
21092 in the toolbar and does not generate the necessary info.
21095 \begin_layout Plain Layout
21096 The generation of the required info can be forced by changing the converter
21097 "\SpecialChar LaTeX
21098 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
21099 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
21100 the -synctex=1 switch).
21105 Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
21106 Skim on the Mac, SumatraPDF on Windows; see the next section for details)
21107 already provide Sync\SpecialChar TeX
21111 \begin_layout Standard
21112 To enable Sync\SpecialChar TeX
21113 for DVI output, change the
21114 \begin_inset Flex Noun
21117 \begin_layout Plain Layout
21128 \begin_inset Flex Noun
21131 \begin_layout Plain Layout
21136 (plain) -> DraftDVI
21142 \begin_inset Flex Noun
21145 \begin_layout Plain Layout
21146 Preferences\SpecialChar menuseparator
21147 File Handling\SpecialChar menuseparator
21154 \begin_inset Flex Code
21157 \begin_layout Plain Layout
21158 latex -synctex=1 $$i
21163 , and for PDF output, change the
21164 \begin_inset Flex Noun
21167 \begin_layout Plain Layout
21172 (pdflatex) -> PDF (pdflatex)
21178 \begin_inset Flex Code
21181 \begin_layout Plain Layout
21182 pdflatex -synctex=1 $$i
21188 Should your viewer not be considered in the following description, or in
21189 case of missing success, please check the documentation of your viewer
21190 whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
21195 \begin_layout Plain Layout
21196 Note that the option
21197 \begin_inset Flex Code
21200 \begin_layout Plain Layout
21206 option enables gzip compression.
21207 If your viewer does not support it, you should instead use
21208 \begin_inset Flex Code
21211 \begin_layout Plain Layout
21225 \begin_layout Subsection
21226 Configuring and using specific viewers
21227 \begin_inset CommandInset label
21229 name "subsec:configuring-viewers"
21236 \begin_layout Subsubsection*
21237 Xdvi (all platforms)
21240 \begin_layout Standard
21242 \begin_inset Flex Code
21245 \begin_layout Plain Layout
21251 , you don't need to do anything else for performing a reverse DVI search,
21252 as \SpecialChar LyX
21253 already provides the necessary hooks for automatically using the
21254 \begin_inset Flex Code
21257 \begin_layout Plain Layout
21264 Just setup your document as described above (reverse search is triggered
21265 by Ctrl-click or Alt-click on Mac OSX, respectively).
21268 \begin_layout Standard
21269 However, if for whatever reason you want to use the named pipe instead of
21270 the socket for communicating with \SpecialChar LyX
21271 , simply change the DVI viewer in
21272 \begin_inset Flex Noun
21275 \begin_layout Plain Layout
21276 Preferences\SpecialChar menuseparator
21277 File Handling\SpecialChar menuseparator
21287 \begin_layout Plain Layout
21288 On Mac OSX you have to use
21289 \begin_inset Flex Code
21292 \begin_layout Plain Layout
21293 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
21304 \begin_inset Flex Code
21307 \begin_layout Plain Layout
21308 xdvi -editor "lyxeditor.sh %f %l"
21314 \begin_inset Flex Code
21317 \begin_layout Plain Layout
21323 is a suitable script.
21324 For example, a minimal shell script is the following one:
21327 \begin_layout LyX-Code
21329 \begin_inset Newline newline
21332 LYXPIPE="/path/to/lyxpipe"
21333 \begin_inset Newline newline
21336 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
21337 \begin_inset Newline newline
21340 echo "$COMMAND" > "${LYXPIPE}".in || exit
21341 \begin_inset Newline newline
21344 read TMP < "${LYXPIPE}".out || exit
21347 \begin_layout Standard
21349 \begin_inset Flex Code
21352 \begin_layout Plain Layout
21358 is the LyXServer pipe path specified in
21359 \begin_inset Flex Noun
21362 \begin_layout Plain Layout
21363 Preferences\SpecialChar menuseparator
21373 \begin_layout Plain Layout
21375 \begin_inset Flex Code
21378 \begin_layout Plain Layout
21384 folder of a source distribution you can find a
21385 \begin_inset Flex Code
21388 \begin_layout Plain Layout
21394 script which is able to locate the
21398 based on your preferences.
21406 \begin_layout Subsubsection*
21410 \begin_layout Standard
21412 \begin_inset Flex Code
21415 \begin_layout Plain Layout
21416 /Applications/MacDviX_Folder/calleditor.script
21421 , add the following lines:
21424 \begin_layout LyX-Code
21425 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
21426 \begin_inset Newline newline
21432 \begin_layout Standard
21433 Modify the lines accordingly if you install \SpecialChar LyX
21434 somewhere else than in the
21435 Applications folder.
21438 \begin_layout Standard
21439 Reverse search is triggered by Alt-click (OPTION-click).
21442 \begin_layout Subsubsection*
21446 \begin_layout Standard
21448 \begin_inset Flex Code
21451 \begin_layout Plain Layout
21452 open -a Skim.app $$i
21457 to the viewer setting in
21458 \begin_inset Flex Noun
21461 \begin_layout Plain Layout
21462 Preferences\SpecialChar menuseparator
21463 File Handling\SpecialChar menuseparator
21464 File formats\SpecialChar menuseparator
21471 \begin_inset Flex Noun
21474 \begin_layout Plain Layout
21475 Skim\SpecialChar menuseparator
21476 Preferences\SpecialChar menuseparator
21483 \begin_inset Flex Noun
21486 \begin_layout Plain Layout
21492 preset and enter command
21493 \begin_inset Flex Noun
21496 \begin_layout Plain Layout
21497 /Applications/\SpecialChar LyX
21498 .app/Contents/MacOS/lyxeditor
21506 \begin_layout Standard
21507 Reverse search is triggered by COMMAND-SHIFT-click
21510 \begin_layout Subsubsection*
21514 \begin_layout Standard
21515 Reverse search with evince does not work out of the box, but it can be achieved
21516 by means of some third party helper scripts.
21518 \begin_inset CommandInset href
21520 target "https://wiki.lyx.org/LyX/SyncTeX"
21528 \begin_layout Subsubsection*
21532 \begin_layout Standard
21534 \begin_inset Flex Noun
21537 \begin_layout Plain Layout
21538 Settings\SpecialChar menuseparator
21539 Configure Okular\SpecialChar menuseparator
21546 \begin_inset Quotes erd
21550 This inserts the appropriate command (
21551 \begin_inset Flex Code
21554 \begin_layout Plain Layout
21563 \begin_layout Standard
21564 Reverse search is triggered by SHIFT-click.
21566 \change_inserted -712698321 1578211026
21567 Note that this only works if Okular is in
21568 \begin_inset Quotes eld
21572 \begin_inset Quotes erd
21576 \begin_inset space \thinspace{}
21579 e., the hand symbol is clicked).
21584 \begin_layout Subsubsection*
21588 \begin_layout Standard
21589 Qpdfview supports Sync\SpecialChar TeX
21590 since version 0.3.5.
21592 \begin_inset Flex Noun
21595 \begin_layout Plain Layout
21596 Edit\SpecialChar menuseparator
21597 Settings\SpecialChar menuseparator
21603 , click on the input field of the
21604 \begin_inset Quotes eld
21608 \begin_inset Quotes erd
21611 item and add the command
21612 \begin_inset Flex Code
21615 \begin_layout Plain Layout
21624 \begin_layout Standard
21625 Reverse search is triggered by double-click or, in more recent versions,
21629 \begin_layout Subsubsection*
21633 \begin_layout Standard
21634 Launch yap, choose its
21635 \begin_inset Flex Noun
21638 \begin_layout Plain Layout
21639 View\SpecialChar menuseparator
21645 menu and select the
21646 \begin_inset Quotes eld
21650 \begin_inset Quotes erd
21655 \begin_inset Quotes eld
21658 New\SpecialChar ldots
21660 \begin_inset Quotes erd
21663 button and, in the window that opens, enter
21664 \begin_inset Quotes eld
21669 \begin_inset Quotes erd
21672 (or any other name you like) in the
21673 \begin_inset Quotes eld
21677 \begin_inset Quotes erd
21681 Now click on the button labeled
21682 \begin_inset Quotes eld
21687 \begin_inset Quotes erd
21690 to open a file dialog and navigate to the directory containing the batch
21692 \begin_inset Flex Code
21695 \begin_layout Plain Layout
21703 \begin_inset Flex Code
21706 \begin_layout Plain Layout
21712 and then specify the program arguments as
21713 \begin_inset Flex Code
21716 \begin_layout Plain Layout
21724 \begin_inset Flex Code
21727 \begin_layout Plain Layout
21733 wrapper is used for communicating with \SpecialChar LyX
21741 \begin_layout LyX-Code
21743 \begin_inset Newline newline
21746 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
21755 \begin_inset Newline newline
21769 \begin_layout Standard
21770 Make sure that the \SpecialChar LyX
21771 Server pipe path you specified in \SpecialChar LyX
21773 \begin_inset Flex Code
21776 \begin_layout Plain Layout
21790 , otherwise change the
21791 \begin_inset Flex Code
21794 \begin_layout Plain Layout
21800 wrapper accordingly.
21803 \begin_layout Standard
21804 In yap, reverse search is triggered by double-click.
21807 \begin_layout Subsubsection*
21808 SumatraPDF (Windows)
21811 \begin_layout Standard
21812 In order to use SumatraPDF for inverse search, enter
21813 \begin_inset Flex Code
21816 \begin_layout Plain Layout
21817 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
21822 in the viewer setting in
21823 \begin_inset Flex Noun
21826 \begin_layout Plain Layout
21827 Preferences\SpecialChar menuseparator
21828 File Handling\SpecialChar menuseparator
21829 File formats\SpecialChar menuseparator
21836 \begin_inset Flex Code
21839 \begin_layout Plain Layout
21845 is the previous wrapper.
21846 If SumatraPDF.exe is not in your command PATH, use its full file name.
21849 \begin_layout Standard
21850 Reverse search is triggered by double-click.
21853 \begin_layout Subsubsection*
21857 \begin_layout Standard
21858 First of all, make sure that yap is your default DVI viewer in the Windows
21859 environment, then launch it, choose its
21860 \begin_inset Flex Noun
21863 \begin_layout Plain Layout
21864 View\SpecialChar menuseparator
21870 menu and select the
21871 \begin_inset Quotes eld
21875 \begin_inset Quotes erd
21880 \begin_inset Quotes eld
21883 New\SpecialChar ldots
21885 \begin_inset Quotes erd
21888 button and, in the window that opens, enter
21889 \begin_inset Quotes eld
21894 \begin_inset Quotes erd
21897 (or any other name you like) in the
21898 \begin_inset Quotes eld
21902 \begin_inset Quotes erd
21906 Now click on the button labeled
21907 \begin_inset Quotes eld
21912 \begin_inset Quotes erd
21915 to open a file dialog and navigate to the directory containing the
21916 \begin_inset Flex Code
21919 \begin_layout Plain Layout
21925 program (which is installed by default on Cygwin along with the \SpecialChar LyX
21928 \begin_inset Flex Code
21931 \begin_layout Plain Layout
21937 and then specify the program arguments as
21938 \begin_inset Flex Code
21941 \begin_layout Plain Layout
21948 In this way, you will be using the
21952 for communicating with \SpecialChar LyX
21954 If, for whatever reason, you want to use the
21959 \begin_inset Flex Code
21962 \begin_layout Plain Layout
21968 option and be sure to specify the \SpecialChar LyX
21969 Server pipe path in the \SpecialChar LyX
21973 \begin_layout Standard
21974 In yap, reverse search is triggered by double-click.
21977 \begin_layout Subsubsection*
21978 SumatraPDF (Cygwin)
21981 \begin_layout Standard
21982 In order to use SumatraPDF for inverse search, enter
21983 \begin_inset Flex Code
21986 \begin_layout Plain Layout
21987 SumatraPDF -inverse-search "lyxeditor -g %f %l"
21992 in the viewer setting in
21993 \begin_inset Flex Noun
21996 \begin_layout Plain Layout
21997 Preferences\SpecialChar menuseparator
21998 File Handling\SpecialChar menuseparator
21999 File formats\SpecialChar menuseparator
22006 If SumatraPDF.exe is not in your command PATH, use its full posix path.
22008 \begin_inset Flex Code
22011 \begin_layout Plain Layout
22017 enables communication via the
22023 \begin_inset Flex Code
22026 \begin_layout Plain Layout
22032 option if you want to use the
22036 , and be sure to specify the \SpecialChar LyX
22037 Server pipe path in the \SpecialChar LyX
22041 \begin_layout Standard
22042 Reverse search is triggered by double-click.
22045 \begin_layout Section
22049 \begin_layout Standard
22050 Forward search is, as the name implies, in a sense the
22051 \begin_inset Quotes eld
22055 \begin_inset Quotes erd
22059 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
22061 If forward search is set up (as described in what follows), you can put
22062 the cursor anywhere in your \SpecialChar LyX
22064 \begin_inset Flex Noun
22067 \begin_layout Plain Layout
22068 Navigate\SpecialChar menuseparator
22075 \begin_inset Flex Noun
22078 \begin_layout Plain Layout
22084 in the context menu via right mouse click), and then the viewer will jump
22085 to that position as well.
22086 This implies, of course, that your viewer supports this function.
22089 \begin_layout Standard
22090 To make forward search possible, you first need to provide the generated
22091 output PDF/DVI file with additional information about the \SpecialChar TeX
22093 This can be done via the methods described in the section
22094 \begin_inset CommandInset ref
22096 reference "subsec:rev-search"
22103 \begin_layout Standard
22104 Additionally, you need to configure \SpecialChar LyX
22105 for using your viewers in
22106 \begin_inset Flex Noun
22109 \begin_layout Plain Layout
22110 Tools\SpecialChar menuseparator
22111 Preferences\SpecialChar menuseparator
22112 Output\SpecialChar menuseparator
22119 We provide a range of tested configurations for some viewers, which you
22120 can select from the drop down list.
22121 If none of these configurations suits you, you have to find out and enter
22122 a suitable configuration yourself.
22123 The definition syntax uses the following placeholders:
22126 \begin_layout Itemize
22128 \begin_inset Flex Code
22131 \begin_layout Plain Layout
22140 \begin_layout Itemize
22142 \begin_inset Flex Code
22145 \begin_layout Plain Layout
22151 : name of the (temporary) exported .tex file (without path)
22154 \begin_layout Itemize
22156 \begin_inset Flex Code
22159 \begin_layout Plain Layout
22165 : name of the (temporary) exported .tex file (including path)
22168 \begin_layout Itemize
22170 \begin_inset Flex Code
22173 \begin_layout Plain Layout
22179 : name of the exported output file (either dvi or pdf, depending on which
22180 one exists in the temporary directory)
22183 \begin_layout Standard
22184 Note that only some of the viewers provide full and usable forward search
22185 functionality out of the box, among them yap, xdvi, okular
22189 \begin_layout Plain Layout
22190 You might want to set
22191 \begin_inset Flex Code
22194 \begin_layout Plain Layout
22201 \begin_inset Flex Noun
22204 \begin_layout Plain Layout
22205 Tools\SpecialChar menuseparator
22206 Preferences\SpecialChar menuseparator
22207 File Handling\SpecialChar menuseparator
22209 \begin_inset space ~
22222 , qpdfview, and SumatraPDF
22226 \begin_layout Plain Layout
22227 SumatraPDF can also use DDE commands through the external program CMCDDE
22228 — downloadable from
22229 \begin_inset CommandInset href
22231 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
22242 Others, such as evince
22246 \begin_layout Plain Layout
22247 Forward search with evince can be achieved by means of third party helper
22250 \begin_inset CommandInset href
22252 target "https://wiki.lyx.org/LyX/SyncTeX"
22262 , require some extra tools in order to use forward search.
22263 While many of the widespread PDF viewers (most notably Adobe Reader) do
22264 not support forward search at all, some other viewers – e.
22265 \begin_inset space \thinspace{}
22269 xpdf – allow at least to reload the document and jump to a specific page
22270 of the file, so you can at least navigate
22271 \begin_inset Quotes eld
22275 \begin_inset Quotes erd
22279 This latter functionality is provided by an external call of synctex (see
22280 the predefined example configurations).
22284 \begin_layout Standard
22285 Forward search works both with DVI and PDF output.
22287 simply checks which preview format you have used before (i.
22288 \begin_inset space \thinspace{}
22291 e., which format is already there in the temporary directory) and chooses
22292 the appropriate configuration for the respective format.
22295 \begin_layout Chapter
22297 \change_deleted 564990737 1671097409
22298 Special Document Classes
22303 \begin_layout Section
22305 \change_deleted 564990737 1669742044
22309 \begin_layout Standard
22311 \change_deleted 564990737 1669742044
22317 \begin_layout Subsection
22319 \change_deleted 564990737 1669742044
22323 \begin_layout Standard
22325 \change_deleted 564990737 1669742044
22326 This section describes how \SpecialChar LyX
22327 can be used to write articles for submission
22328 to the scientific journal
22330 Astronomy and Astrophysics
22333 \begin_inset Flex URL
22336 \begin_layout Plain Layout
22338 https://www.aanda.org/
22343 ) using Version 5.01 of the document class
22348 This package can be downloaded from the ftp site
22351 \begin_layout Standard
22353 \change_deleted 564990737 1669742044
22354 \begin_inset VSpace medskip
22360 \begin_layout Standard
22363 \change_deleted 564990737 1669742044
22364 \begin_inset Flex URL
22367 \begin_layout Plain Layout
22369 ftp://ftp.edpsciences.org/pub/aa/readme.html
22377 \begin_layout Standard
22379 \change_deleted 564990737 1669742044
22380 \begin_inset VSpace medskip
22386 \begin_layout Standard
22388 \change_deleted 564990737 1669742044
22389 A manual comes together with that package, and this text is not meant to
22390 replace the original manual but is merely a short guide in how to realize
22391 the correct form of your paper.
22395 \begin_layout Standard
22397 \change_deleted 564990737 1669742044
22398 Please note that the publisher of the journal was changed from Springer
22399 to EDP Sciences starting January 1, 2001.
22400 That change involved also some slight changes to the style files, namely
22401 the removal of the thesaurus command.
22402 The \SpecialChar LyX
22403 class aa supports the newest version of these style files, V 5.01.
22404 If you have an older version installed, please upgrade.
22405 For compatibility, the old (version 4) layout has been kept as
22410 Please refer to the comments in
22413 Dir/layouts/aapaper.layout
22418 \begin_layout Subsection
22420 \change_deleted 564990737 1669742044
22424 \begin_layout Standard
22426 \change_deleted 564990737 1669742044
22427 It is recommended you start from the example template distributed with \SpecialChar LyX
22429 If you are not using a template, note the following settings:
22432 \begin_layout Itemize
22434 \change_deleted 564990737 1669742044
22441 Document\SpecialChar menuseparator
22444 dialog (OK, that one was obvious).
22447 \begin_layout Itemize
22449 \change_deleted 564990737 1669742044
22450 Don't change the option
22453 \begin_inset space ~
22463 The whole layout is done by the macros, you shouldn't change anything.
22466 \begin_layout Subsection
22468 \change_deleted 564990737 1669742044
22472 \begin_layout Standard
22474 \change_deleted 564990737 1669742044
22475 First thing to enter is the header information.
22476 It consists of seven entries, of which some are optional.
22480 \begin_layout Itemize
22482 \change_deleted 564990737 1669742044
22490 \begin_layout Itemize
22492 \change_deleted 564990737 1669742044
22500 \begin_layout Itemize
22502 \change_deleted 564990737 1669742044
22510 \begin_layout Itemize
22512 \change_deleted 564990737 1669742044
22520 \begin_layout Itemize
22522 \change_deleted 564990737 1669742044
22527 : [optional] if more than one author: whom to contact for offprint requests.
22530 \begin_layout Itemize
22532 \change_deleted 564990737 1669742044
22537 : [optional] mail address for contacts.
22540 \begin_layout Itemize
22542 \change_deleted 564990737 1669742044
22548 Suggested format is
22550 Received: <date>; Accepted <date>
22553 \begin_layout Standard
22555 \change_deleted 564990737 1669742044
22556 There is no need to issue the
22562 command, this is done automatically by \SpecialChar LyX
22563 when the header is finished.
22564 Although the order of the single header entries doesn't matter it is advised
22565 to keep the above sequence, just to get the best optics and meets the layout
22566 of the real document.
22569 \begin_layout Standard
22571 \change_deleted 564990737 1669742044
22572 If you want to place footnotes in the header block, e.
22573 \begin_inset space \thinspace{}
22577 \begin_inset space \space{}
22580 to state your present address, just use the standard footnote via the menu
22583 Insert\SpecialChar menuseparator
22588 will automagically use the term
22597 \begin_layout Standard
22599 \change_deleted 564990737 1669742044
22602 Edit\SpecialChar menuseparator
22605 , you'll find two insets which are relevant for the titling:
22608 \begin_layout Itemize
22610 \change_deleted 564990737 1669742044
22617 to mark corresponding author\SpecialChar breakableslash
22619 The institutes are numbered sequentially as they appear in the
22623 field, so you have to put a marker to each author.
22626 \begin_layout Itemize
22628 \change_deleted 564990737 1669742044
22633 to supply an email address for fast contact.
22636 \begin_layout Standard
22638 \change_deleted 564990737 1669742044
22639 In addition to these topics, the macros use one additional \SpecialChar LaTeX
22641 has no counterpart in \SpecialChar LyX
22645 \begin_layout Itemize
22647 \change_deleted 564990737 1669742044
22654 to separate different names for more than one author and institute, respectivel
22658 \begin_layout Standard
22660 \change_deleted 564990737 1669742044
22661 The appropriate command has to be entered in \SpecialChar LyX
22662 and marked as \SpecialChar LaTeX
22668 \begin_layout Subsection
22670 \change_deleted 564990737 1669742044
22674 \begin_layout Standard
22676 \change_deleted 564990737 1669742044
22677 The abstract should immediately follow the header block.
22678 With version 5 the abstract environment was changed to a command, and there
22679 is now a restriction to only one paragraph.
22680 In addition, it should contain an entry with the keywords.
22681 This is done via the paragraph style
22686 Refer to the example paper.
22689 \begin_layout Subsection
22691 \change_deleted 564990737 1669742044
22692 Supported environments
22695 \begin_layout Standard
22697 \change_deleted 564990737 1669742044
22698 The A&A paper layout supports the following environments for structuring
22702 \begin_layout Itemize
22704 \change_deleted 564990737 1669742044
22710 \begin_layout Itemize
22712 \change_deleted 564990737 1669742044
22718 \begin_layout Itemize
22720 \change_deleted 564990737 1669742044
22726 \begin_layout Itemize
22728 \change_deleted 564990737 1669742044
22734 \begin_layout Itemize
22736 \change_deleted 564990737 1669742044
22742 \begin_layout Itemize
22744 \change_deleted 564990737 1669742044
22750 \begin_layout Itemize
22752 \change_deleted 564990737 1669742044
22758 \begin_layout Itemize
22760 \change_deleted 564990737 1669742044
22766 \begin_layout Itemize
22768 \change_deleted 564990737 1669742044
22774 \begin_layout Itemize
22776 \change_deleted 564990737 1669742044
22782 \begin_layout Itemize
22784 \change_deleted 564990737 1669742044
22790 \begin_layout Itemize
22792 \change_deleted 564990737 1669742044
22799 \begin_layout Subsection
22801 \change_deleted 564990737 1669742044
22802 Commands not supported by \SpecialChar LyX
22806 \begin_layout Standard
22808 \change_deleted 564990737 1669742044
22809 Some commands are not yet supported by the
22813 layout for \SpecialChar LyX
22815 Some have already been mentioned.
22816 For the sake of completeness, they are listed all together here:
22819 \begin_layout Itemize
22821 \change_deleted 564990737 1669742044
22829 \begin_layout Itemize
22831 \change_deleted 564990737 1669742044
22839 \begin_layout Itemize
22841 \change_deleted 564990737 1669742044
22849 \begin_layout Itemize
22851 \change_deleted 564990737 1669742044
22859 \begin_layout Standard
22861 \change_deleted 564990737 1669742044
22862 If you want to use any of these commands, you have to enter them yourself.
22865 Do not forget to mark them as \SpecialChar LaTeX
22869 \begin_layout Subsection
22871 \change_deleted 564990737 1669742044
22872 Figure and Table Floats
22875 \begin_layout Standard
22877 \change_deleted 564990737 1669742044
22879 provides support for the necessary float environments
22881 figure, figure*, table
22887 , therefore we won't tell much about it here.
22891 \begin_inset space ~
22897 Just remember that tables should be left-aligned.
22898 For that, select the table and change the alignment in
22900 Edit\SpecialChar menuseparator
22902 \begin_inset space ~
22908 \begin_layout Standard
22910 \change_deleted 564990737 1669742044
22911 There is only one special thing: the figures with caption besides the figure.
22912 To create such a figure, you have to do the following:
22915 \begin_layout Enumerate
22917 \change_deleted 564990737 1669742044
22918 Create a wide figure float:
22920 Insert\SpecialChar menuseparator
22921 Float\SpecialChar menuseparator
22924 , then right click in the figure and select
22927 \begin_inset space ~
22935 \begin_layout Enumerate
22937 \change_deleted 564990737 1669742044
22938 Enter your caption text.
22941 \begin_layout Enumerate
22943 \change_deleted 564990737 1669742044
22948 to move the cursor above the caption.
22951 \begin_layout Enumerate
22953 \change_deleted 564990737 1669742044
22957 \begin_layout Enumerate
22959 \change_deleted 564990737 1669742044
22960 Position the cursor behind the figure and insert a horizontal fill:
22962 Insert\SpecialChar menuseparator
22964 \begin_inset space ~
22967 Character\SpecialChar menuseparator
22969 \begin_inset space ~
22977 \begin_layout Enumerate
22979 \change_deleted 564990737 1669742044
22980 Switch to \SpecialChar LaTeX
22984 \begin_inset space ~
22992 \begin_layout Enumerate
22994 \change_deleted 564990737 1669742044
23004 Do not close the brace!
23007 \begin_layout Enumerate
23009 \change_deleted 564990737 1669742044
23010 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
23015 \begin_inset space ~
23027 \begin_layout Standard
23029 \change_deleted 564990737 1669742044
23030 Also, refer to the figures in the example paper.
23033 \begin_layout Subsection
23035 \change_deleted 564990737 1669742044
23039 \begin_layout Standard
23041 \change_deleted 564990737 1669742044
23042 For submission, the paper has to be formated in a special double-spacing
23044 For this purpose, you have to give the option
23048 to the document class.
23049 This must be done using the custom class options field in the
23051 Document\SpecialChar menuseparator
23055 Just enter the string
23062 \begin_layout Subsection
23064 \change_deleted 564990737 1669742044
23068 \begin_layout Standard
23070 \change_deleted 564990737 1669742044
23075 directory contains an example paper written with \SpecialChar LyX
23077 It is the example paper from the original macro package, translated to
23080 Use it for inspiration, and compare the original \SpecialChar LaTeX
23081 code with \SpecialChar LyX
23085 \begin_layout Section
23087 \change_deleted 564990737 1671097429
23091 \begin_layout Standard
23093 \change_deleted 564990737 1671097429
23098 can be used to type letters according to German conventions.
23099 A template file is included in
23101 .../lyx/share/templates
23103 for you to use as a starting point.
23106 \begin_layout Section
23108 \change_deleted 564990737 1671097429
23112 \begin_layout Standard
23114 \change_deleted 564990737 1671097429
23115 See the \SpecialChar LyX
23121 It contains all infos you need.
23124 \begin_layout Section
23126 \change_deleted 564990737 1669755802
23130 \begin_layout Standard
23132 \change_deleted 564990737 1669755802
23135 Panayotis Papasotiriou
23138 \begin_layout Subsection
23140 \change_deleted 564990737 1669755802
23144 \begin_layout Standard
23146 \change_deleted 564990737 1669755802
23147 The ijmpc package is a set of macros that facilitates electronic manuscript
23150 International Journal of Modern Physics C
23153 Similarly, the ijmpd package is for creating manuscripts to be submitted
23156 International Journal of Modern Physics D
23159 Both journals are published by World Scientific.
23160 The corresponding document classes are named
23169 These files, together with instructions for the authors, can be downloaded
23171 \begin_inset Flex URL
23174 \begin_layout Plain Layout
23176 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
23182 \begin_inset Flex URL
23185 \begin_layout Plain Layout
23187 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
23193 Both packages are modified versions of the standard
23194 \begin_inset Quotes eld
23198 \begin_inset Quotes erd
23201 package, and they are almost (but not exactly) identical.
23202 Most of their features are supported by \SpecialChar LyX
23204 I have used \SpecialChar LyX
23205 successfully to write articles submitted to both journals
23206 without any problem.
23209 \begin_layout Subsection
23211 \change_deleted 564990737 1669755802
23215 \begin_layout Standard
23217 \change_deleted 564990737 1669755802
23218 As usual, the easiest way to write a paper is to start with a template.
23221 File\SpecialChar menuseparator
23237 This will give an (almost) empty document that includes the most common
23238 fields found in a manuscript.
23239 Simply overwrite the existing text (including the brackets,
23244 You should keep in mind the following remarks.
23247 \begin_layout Enumerate
23249 \change_deleted 564990737 1669755802
23251 won't let you change the font size and the page style of the document,
23252 because such modifications are not allowed by both packages.
23255 \begin_layout Enumerate
23257 \change_deleted 564990737 1669755802
23258 The language of the document should not be changed.
23259 Before previewing your paper, be sure that the babel package is not used.
23260 To do this, click on
23263 arg "dialog-show document"
23268 \SpecialChar menuseparator
23272 \begin_inset Quotes eld
23276 \begin_inset Quotes erd
23286 \begin_layout Enumerate
23288 \change_deleted 564990737 1669755802
23290 \begin_inset Quotes eld
23294 \begin_inset Quotes erd
23297 style must be used to define keywords.
23300 \begin_layout Enumerate
23302 \change_deleted 564990737 1669755802
23303 The ijmpc package provides a style named
23304 \begin_inset Quotes eld
23307 Classification Codes
23308 \begin_inset Quotes erd
23311 , which can be used to define classification codes, such as PACS numbers.
23312 Note that this facility is not supported by the ijmpd package.
23315 \begin_layout Enumerate
23317 \change_deleted 564990737 1669755802
23318 Several new environments are available:
23319 \begin_inset Quotes eld
23323 \begin_inset Quotes erd
23327 \begin_inset Quotes eld
23331 \begin_inset Quotes erd
23335 \begin_inset Quotes eld
23339 \begin_inset Quotes erd
23343 \begin_inset Quotes eld
23347 \begin_inset Quotes erd
23351 \begin_inset Quotes eld
23355 \begin_inset Quotes erd
23359 \begin_inset Quotes eld
23363 \begin_inset Quotes erd
23367 \begin_inset Quotes eld
23371 \begin_inset Quotes erd
23375 \begin_inset Quotes eld
23379 \begin_inset Quotes erd
23383 \begin_inset Quotes eld
23387 \begin_inset Quotes erd
23391 \begin_inset Quotes eld
23395 \begin_inset Quotes erd
23399 \begin_inset Quotes eld
23403 \begin_inset Quotes erd
23407 \begin_inset Quotes eld
23411 \begin_inset Quotes erd
23415 \begin_inset Quotes eld
23419 \begin_inset Quotes erd
23423 \begin_inset Quotes eld
23427 \begin_inset Quotes erd
23431 Their use is more or less obvious.
23433 supports all these environments; it will use the proper label, text style,
23434 and numbering scheme for each of them.
23437 \begin_layout Enumerate
23439 \change_deleted 564990737 1669755802
23440 Both packages use basic citations; the natbib package should not be used.
23441 In \SpecialChar LyX
23442 , citation references are shown as usual; in the output, citations are
23443 shown as superscripts.
23444 If you want to use a citation as normal text, you should use the
23449 \begin_inset space \thinspace{}
23453 \begin_inset space \space{}
23457 \begin_inset Quotes eld
23461 \begin_inset space \space{}
23471 \begin_inset Quotes erd
23477 \begin_layout Enumerate
23479 \change_deleted 564990737 1669755802
23481 \begin_inset Quotes eld
23485 \begin_inset Quotes erd
23488 section in both packages.
23489 To put acknowledgments, just use the
23490 \begin_inset Quotes eld
23494 \begin_inset Quotes erd
23500 \begin_layout Enumerate
23502 \change_deleted 564990737 1669755802
23503 Appendices may be added to the paper,
23507 the Acknowledgments and
23513 provides a special environment, called
23514 \begin_inset Quotes eld
23518 \begin_inset Quotes erd
23521 which marks the beginning of the appendices.
23522 This environment should be left blank; it just sends a \SpecialChar LaTeX
23523 command, but nothing
23525 In \SpecialChar LyX
23527 \begin_inset Quotes eld
23531 \begin_inset Quotes erd
23534 is printed with blue letters, as a signal that all sections after that
23535 point are appendices.
23536 To write an appendix, use the
23537 \begin_inset Quotes eld
23541 \begin_inset Quotes erd
23546 will number each appendix with capital letters, as required by both journals.
23548 \begin_inset Quotes eld
23552 \begin_inset Quotes erd
23559 be present before the first appendix; if not, all appendices will be numbered
23560 as normal sections in the output.
23563 \begin_layout Enumerate
23565 \change_deleted 564990737 1669755802
23566 The ijmpc and the ijmpd packages use the
23570 command to implement table captions.
23571 As a result, a table created by \SpecialChar LyX
23572 is printed correctly, but its caption
23574 However, you can use some \SpecialChar TeX
23575 code to overcome this problem, so that captions
23576 are printed as expected.
23577 To do so, create a float table as usual, remove the caption, and replace
23578 it with the \SpecialChar TeX
23589 (sic); you must also the \SpecialChar TeX
23594 immediately after the tabular material.
23595 Study the example table included in the template files to see how this
23596 trick is implemented.
23597 Alternatively, If you need table captions, you should implement the whole
23602 file, then include this file to the \SpecialChar LyX
23605 Insert\SpecialChar menuseparator
23606 File\SpecialChar menuseparator
23608 \begin_inset space ~
23614 Details on how to create a table float can be found in the files
23622 , included in the corresponding packages.
23625 \begin_layout Subsection
23627 \change_deleted 564990737 1669755802
23628 Preparing a paper for submission
23631 \begin_layout Standard
23633 \change_deleted 564990737 1669755802
23634 Before you submit your paper you must export the \SpecialChar LyX
23635 document as a \SpecialChar LaTeX
23638 File\SpecialChar menuseparator
23639 Export\SpecialChar menuseparator
23647 \begin_layout Plain Layout
23648 Actually you have the choice between \SpecialChar LaTeX
23649 (plain) and pdflatex.
23650 If you intend to use pdflatex to prepare the paper, you should use the
23651 pdflatex option so that included graphics are converted to PDF format,
23652 ready for use by pdflatex.
23657 , then make the following changes to the resulting
23664 \begin_layout Enumerate
23666 \change_deleted 564990737 1669755802
23667 Remove the comment lines before the
23676 \begin_layout Enumerate
23678 \change_deleted 564990737 1669755802
23679 Remove everything between (and including) the
23691 commands, except for any commands you specifically put into the \SpecialChar LaTeX
23695 \begin_layout Standard
23697 \change_deleted 564990737 1669755802
23702 file should be saved and processed through \SpecialChar LaTeX
23703 as many times as necessary.
23704 You may also want to check the resulting
23713 \begin_layout Section
23715 \change_deleted 564990737 1669801478
23719 \begin_layout Standard
23721 \change_deleted 564990737 1669801478
23727 \begin_layout Subsection
23729 \change_deleted 564990737 1669801478
23733 \begin_layout Standard
23735 \change_deleted 564990737 1669801478
23736 The iopart package provides a document class to create electronic manuscript
23737 submission to the journals published by the Institute of Physics.
23738 Instructions for the authors how to create a paper using the iopart class
23739 can be downloaded together with the iopart package from the site
23740 \begin_inset Flex URL
23743 \begin_layout Plain Layout
23745 ftp://ftp.iop.org/pub/journals/latex2e
23753 \begin_layout Subsection
23755 \change_deleted 564990737 1669801478
23759 \begin_layout Standard
23761 \change_deleted 564990737 1669801478
23762 The easiest way to write a paper is to start with the template
23766 that is available via
23768 File\SpecialChar menuseparator
23771 The template explains how to use the special text environments.
23772 Here are the most important advices:
23775 \begin_layout Itemize
23777 \change_deleted 564990737 1669801478
23778 To be able to compile your document to a PDF, PS, or DVI, ensure that the
23779 no AMS packages are loaded in
23781 Document\SpecialChar menuseparator
23782 Settings\SpecialChar menuseparator
23788 \begin_layout Itemize
23790 \change_deleted 564990737 1669801478
23793 The title environment defines the kind of your paper.
23794 So use one of the following environments for the title:
23798 \begin_layout Itemize
23800 \change_deleted 564990737 1669801478
23809 \begin_layout Itemize
23811 \change_deleted 564990737 1669801478
23820 \begin_layout Itemize
23822 \change_deleted 564990737 1669801478
23828 for a Topical review
23831 \begin_layout Itemize
23833 \change_deleted 564990737 1669801478
23842 \begin_layout Itemize
23844 \change_deleted 564990737 1669801478
23853 \begin_layout Itemize
23855 \change_deleted 564990737 1669801478
23861 for a Paper (same as Title)
23864 \begin_layout Itemize
23866 \change_deleted 564990737 1669801478
23872 for a Preliminary communication
23875 \begin_layout Itemize
23877 \change_deleted 564990737 1669801478
23883 for a Rapid communication
23886 \begin_layout Itemize
23888 \change_deleted 564990737 1669801478
23894 for a Letter to the editor
23898 \begin_layout Itemize
23900 \change_deleted 564990737 1669801478
23903 All title environments except of
23907 can have an optional short title.
23910 \begin_layout Itemize
23912 \change_deleted 564990737 1669801478
23913 There is a general title environment
23917 which is not directly supported by \SpecialChar LyX
23919 This can be used as \SpecialChar TeX
23920 code when your document doesn't fit into one of the
23924 \begin_layout Standard
23926 \change_deleted 564990737 1669801478
23927 For more informations like hints for special table and formula formatting,
23928 look at the IOP author guidelines.
23933 \begin_layout Section
23935 \change_deleted 564990737 1670317155
23939 \begin_layout Standard
23941 \change_deleted 564990737 1670317155
23944 Panayotis Papasotiriou
23947 \begin_layout Subsection
23949 \change_deleted 564990737 1670317155
23953 \begin_layout Standard
23955 \change_deleted 564990737 1670317155
23956 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
23957 that facilitates electronic manuscript submission to the journals they
23959 Most known of them (at least in my domain of interest) are
23961 Astrophysics and Space Science
23967 , but there are many others (see a complete list at
23968 \begin_inset Flex URL
23971 \begin_layout Plain Layout
23973 http://www.wkap.nl/jrnllist.htm/JRNLHOME
23979 The Kluwer package may be downloaded from the site
23980 \begin_inset Flex URL
23983 \begin_layout Plain Layout
23985 http://www.wkap.nl/kaphtml.htm/STYLEFILES
23991 A complete user guide is contained in that package (but it can also be
23992 downloaded separately).
23995 \begin_layout Standard
23997 \change_deleted 564990737 1670317155
23999 supports many features of the package but not everything.
24000 However, the \SpecialChar TeX
24001 code needed is reduced to some
24002 \begin_inset Quotes eld
24006 \begin_inset Quotes erd
24009 commands of the package (see
24010 \begin_inset space ~
24014 \begin_inset CommandInset ref
24016 reference "subsec:kluwer_peculiarities"
24021 I have recently used \SpecialChar LyX
24022 to write an article submitted to the
24024 Astrophysics and Space Science
24026 without any problem.
24029 \begin_layout Subsection
24031 \change_deleted 564990737 1670317155
24035 \begin_layout Standard
24037 \change_deleted 564990737 1670317155
24038 The easiest way to write a paper is to start with the Kluwer template file.
24041 File\SpecialChar menuseparator
24053 This will give an (almost) empty document that includes the most common
24054 fields found in a manuscript and a short description of their use.
24055 As in most templates, simply overwrite the existing text (including the
24060 ) with the correct information.
24063 \begin_layout Subsection
24065 \change_deleted 564990737 1670317155
24066 Preparing a paper for submission
24069 \begin_layout Standard
24071 \change_deleted 564990737 1670317155
24072 As in the AAS\SpecialChar TeX
24073 package, before you submit your paper to a journal you must
24075 \begin_inset Quotes eld
24079 \begin_inset Quotes erd
24085 \begin_layout Enumerate
24087 \change_deleted 564990737 1670317155
24088 Export your paper as a \SpecialChar LaTeX
24090 To do this, click on
24092 File\SpecialChar menuseparator
24093 Export\SpecialChar menuseparator
24101 \begin_layout Enumerate
24103 \change_deleted 564990737 1670317155
24108 file with a text editor and make the following changes
24112 \begin_layout Enumerate
24114 \change_deleted 564990737 1670317155
24115 remove the comment lines before the
24124 \begin_layout Enumerate
24126 \change_deleted 564990737 1670317155
24127 remove everything between (and including) the
24139 commands, except for any commands you specifically put into the \SpecialChar LaTeX
24143 \begin_layout Standard
24145 \change_deleted 564990737 1670317155
24154 \begin_layout Enumerate
24156 \change_deleted 564990737 1670317155
24161 file through \SpecialChar LaTeX
24162 as many times as necessary (usually up to three).
24165 \begin_layout Enumerate
24167 \change_deleted 564990737 1670317155
24173 \begin_inset space \thinspace{}
24177 \begin_inset space \space{}
24184 , and check if everything is OK (it should, if you didn't make any mistake).
24187 \begin_layout Subsection
24189 \change_deleted 564990737 1670317155
24190 \begin_inset Quotes eld
24194 \begin_inset Quotes erd
24197 of the Kluwer package
24198 \begin_inset CommandInset label
24200 name "subsec:kluwer_peculiarities"
24207 \begin_layout Standard
24209 \change_deleted 564990737 1670317155
24210 The Kluwer package has the following
24211 \begin_inset Quotes eld
24215 \begin_inset Quotes erd
24221 \begin_layout Enumerate
24223 \change_deleted 564990737 1670317155
24224 It is possible to write multiple articles in the same \SpecialChar LaTeX
24229 \begin_layout Plain Layout
24230 I can't imagine any good reason to do this.
24236 Each article must be included in the environment
24237 \begin_inset Quotes eld
24241 \begin_inset Quotes erd
24245 Unfortunately, this environment cannot be omitted, even if you write just
24247 Therefore, each article starts with the command
24253 and, obviously, ends with the command
24260 Although this can be implemented in \SpecialChar LyX
24261 , I didn't included it, since it looks
24262 ugly and can confuse the novice user.
24263 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
24266 \begin_inset Quotes eld
24271 \begin_inset Quotes erd
24277 \begin_layout Enumerate
24279 \change_deleted 564990737 1670317155
24280 Information given at the beginning of the article (i.
24281 \begin_inset space \thinspace{}
24285 \begin_inset space \space{}
24288 title, subtitle, author, institution, running title, running author, abstract
24289 and keywords) must be included in an environment called
24290 \begin_inset Quotes eld
24294 \begin_inset Quotes erd
24298 This is not implemented in \SpecialChar LyX
24299 , so you must enter title, subtitle etc.
24300 \begin_inset space ~
24303 between two \SpecialChar TeX
24319 \begin_layout Enumerate
24321 \change_deleted 564990737 1670317155
24322 According to the user manual, the label of each bibliography item must be
24346 \begin_layout Standard
24348 \change_deleted 564990737 1670317155
24353 template takes care of all these
24354 \begin_inset Quotes eld
24358 \begin_inset Quotes erd
24362 If you start a new paper using this template you don't need to do anything
24367 \begin_layout Enumerate
24369 \change_deleted 564990737 1670317155
24370 don't delete the \SpecialChar TeX
24371 code included in the template, and
24374 \begin_layout Enumerate
24376 \change_deleted 564990737 1670317155
24377 copy the example bibliography item included in the template and modify it
24378 as necessary to enter new bibliography items.
24381 \begin_layout Section
24383 \change_deleted 564990737 1671097446
24387 \begin_layout Standard
24389 \change_deleted 564990737 1671097446
24394 provides an alternative to the standard
24399 It provides similar functionality, but you might prefer this layout with
24400 sans serif sections, headings, and more.
24403 \begin_layout Section
24405 \change_deleted 564990737 1671097446
24406 Springer Journals (
24413 \begin_layout Standard
24415 \change_deleted 564990737 1671097446
24421 \begin_layout Subsection
24423 \change_deleted 564990737 1671097446
24427 \begin_layout Standard
24429 \change_deleted 564990737 1671097446
24430 These are the layout files for some of the journal formats used by Springer
24431 Verlag and listed on
24432 \begin_inset Flex URL
24435 \begin_layout Plain Layout
24437 http://www.springer.de/author/tex/help-journals.html
24442 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
24444 It is a modular system: the things common to all journals are implemented
24449 , which journal-specific layout files (such as, e.
24450 \begin_inset space \thinspace{}
24454 \begin_inset space \space{}
24461 for Journal of Geodesy) can include.
24464 \begin_layout Standard
24466 \change_deleted 564990737 1671097446
24467 This means that implementing support for any other Springer journal on this
24468 list is as simple as writing your own
24476 file following the outline given in
24484 \begin_layout Standard
24486 \change_deleted 564990737 1671097446
24487 It is reasonably well tested only for the Journal of Geodesy.
24496 come with the standard \SpecialChar LyX
24498 Install the relevant class file (downloaded from Springer) in a proper
24499 directory, reconfigure \SpecialChar LaTeX
24500 (in the te\SpecialChar TeX
24505 , as root if necessary — doesn't \SpecialChar LyX
24506 take care of this?), reconfigure \SpecialChar LyX
24511 \begin_layout Subsection
24513 \change_deleted 564990737 1671097446
24517 \begin_layout Standard
24519 \change_deleted 564990737 1671097446
24520 A large number of theorem-like styles —
24532 \begin_layout Standard
24534 \change_deleted 564990737 1671097446
24537 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
24538 _Title, Author_Running, Institute,
24539 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
24542 See the Springer class file documentation for details.
24545 \begin_layout Subsection
24547 \change_deleted 564990737 1671097446
24551 \begin_layout Itemize
24553 \change_deleted 564990737 1671097446
24565 \begin_layout Itemize
24567 \change_deleted 564990737 1671097446
24570 Probability Theory and Related Fields
24576 — Jean-Marc Lasgouttes
24579 \begin_layout Standard
24581 \change_deleted 564990737 1671097446
24582 Add your own, it isn't so hard!
24585 \begin_layout Subsection
24587 \change_deleted 564990737 1671097446
24591 \begin_layout Standard
24593 \change_deleted 564990737 1671097446
24594 These files are partly based on the older
24598 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
24600 file from Springer.
24605 layout, are now defunct.
24606 Jean-Marc Lasgouttes helped out big in making me find my way around the
24608 layout file mechanism.
24611 \begin_layout Subsection
24613 \change_deleted 564990737 1671097446
24617 \begin_layout Standard
24619 \change_deleted 564990737 1671097446
24621 But probably less than in the old hacked-\SpecialChar LaTeX
24629 \begin_layout Chapter
24631 Features needing Extra Software
24634 \begin_layout Section
24635 Checking \SpecialChar TeX
24639 \begin_layout Standard
24645 \begin_layout Subsection
24649 \begin_layout Standard
24658 \begin_layout Plain Layout
24663 is not yet available when you are using the \SpecialChar LaTeX
24664 distribution MiK\SpecialChar TeX
24670 , you'll find in the
24677 \begin_inset space ~
24688 \begin_inset Newline newline
24692 \begin_inset CommandInset href
24694 target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
24702 \begin_layout Standard
24705 Chk\SpecialChar TeX
24708 package is a program that was written by
24709 \begin_inset Flex Noun
24712 \begin_layout Plain Layout
24714 \begin_inset space ~
24722 in frustration because some constructs in \SpecialChar LaTeX
24723 are sometimes non-intuitive,
24724 and easy to forget.
24725 The program runs over your \SpecialChar LaTeX
24726 file, checks the integrity of the file, and
24727 flags some common errors.
24728 In other technical words, it is
24732 for \SpecialChar LaTeX
24736 \begin_layout Standard
24737 Well, what is a syntax checker doing in \SpecialChar LyX
24738 which is supposed to produce correct
24740 anyways? The answer is simple: Just as
24744 not only checks the
24748 of C programs, but also does
24752 checks for type-errors,
24754 Chk\SpecialChar TeX
24757 catches some common
24761 errors, in addition to the syntactical ones.
24764 Chk\SpecialChar TeX
24767 is capable of detecting several common errors, such as
24770 \begin_layout Itemize
24771 Ellipsis detection:
24772 \begin_inset Newline newline
24775 Use \SpecialChar ldots
24779 \begin_layout Itemize
24780 No space in front of/after parenthesis:
24781 \begin_inset Newline newline
24787 \begin_layout Itemize
24788 Enforcement of normal space after common abbreviations:
24789 \begin_inset Newline newline
24793 \begin_inset space \thinspace{}
24797 \begin_inset space \space{}
24800 is too wide spacing.
24803 \begin_layout Itemize
24804 Enforcement of end-of-sentence space when the last sentence ends with a
24806 \begin_inset Newline newline
24810 And this is wrong spacing.
24813 \begin_layout Itemize
24814 Space in front of labels and similar commands:
24815 \begin_inset Newline newline
24818 The label should stick right up to the text to avoid falling to a wrong
24821 \begin_inset CommandInset label
24831 \begin_layout Plain Layout
24832 This footnote is in danger of falling off to a wrong page
24837 The label is separated too much.
24840 \begin_layout Itemize
24841 Space in front of references, instead of hard spaces:
24842 \begin_inset Newline newline
24845 If you have bad luck, the text will break right between the referenced text
24846 and reference number, and that's a pity.
24848 \begin_inset CommandInset ref
24850 reference "sec:chktex"
24857 \begin_layout Itemize
24859 \begin_inset Quotes eld
24863 \begin_inset Quotes erd
24867 \begin_inset Formula $\times$
24871 \begin_inset Newline newline
24874 2x2 looks cheap compared to
24875 \begin_inset Formula $2\times2$
24881 \begin_layout Standard
24882 and more \SpecialChar ldots
24883 It is an invaluable tool when you are
24884 \begin_inset Quotes eld
24888 \begin_inset Quotes erd
24891 your document before printing, and you should run it right after the obligatory
24892 spelling check, and before you go fine tuning the typesetting.
24895 \begin_layout Subsection
24899 \begin_layout Standard
24900 If you have the program installed, usage is as simple as choosing
24902 Tools\SpecialChar menuseparator
24904 \begin_inset space ~
24910 This will make \SpecialChar LyX
24911 generate a \SpecialChar LaTeX
24912 file of your document, start
24914 Chk\SpecialChar TeX
24917 to check it, and then make \SpecialChar LyX
24919 \begin_inset Quotes eld
24923 \begin_inset Quotes erd
24926 with the warnings from
24928 Chk\SpecialChar TeX
24931 , if there were any.
24932 The warnings will be placed close to the point of the mistake, and you
24933 can quickly find them by using the
24935 Navigate\SpecialChar menuseparator
24938 menu item, or the shortcut key
24947 Open the error boxes by clicking on them with the mouse, or use the shortcut
24956 bindings, or the corresponding
24965 Read the warning and correct the mistake, if it is a mistake.
24966 If you have trouble understanding what the warning is about, you can safely
24968 Remember that there is a hidden layer between the document on screen and
24969 the technical details in invoking
24971 Chk\SpecialChar TeX
24974 , and this gap can make some warnings seem arcane or just plain silly.
24977 \begin_layout Standard
24978 This document is an excellent testing bed for the feature, and it should
24979 provide quite a few warnings for you to fiddle with.
24980 Since computers are only so smart, expect most of the warnings to be false
24984 \begin_layout Subsection
24985 How to fine tune it
24988 \begin_layout Standard
24989 Sometimes, you'll find that
24991 Chk\SpecialChar TeX
24994 makes more noise than suits your mood.
24995 Then you can choose not to use it, wait until your mood changes, or try
24998 Chk\SpecialChar TeX
25001 to get better along with you.
25004 \begin_layout Standard
25007 Chk\SpecialChar TeX
25014 very configurable and extensible, you should not expect to solve all problems
25017 Chk\SpecialChar TeX
25020 in \SpecialChar LyX
25022 Since \SpecialChar LyX
25023 has to generate a somewhat special \SpecialChar LaTeX
25024 file to be able to match the
25025 line numbers from the
25027 Chk\SpecialChar TeX
25034 \begin_layout Plain Layout
25035 You can inspect the specific output from
25041 Document\SpecialChar menuseparator
25044 \begin_inset space ~
25058 to the internal document structure, some of the warnings will not appear
25060 There are two things you can do about this:
25063 \begin_layout Itemize
25066 Chk\SpecialChar TeX
25069 invocation command line in
25070 \begin_inset Flex Noun
25073 \begin_layout Plain Layout
25074 Tools\SpecialChar menuseparator
25075 Preferences\SpecialChar menuseparator
25076 Output\SpecialChar menuseparator
25077 LaTeX\SpecialChar menuseparator
25085 Chk\SpecialChar TeX
25088 installation configuration file (usually with the file
25093 See below to learn what warnings can be enabled and disabled on the command
25097 \begin_layout Itemize
25098 Export your document as a raw \SpecialChar LaTeX
25101 File\SpecialChar menuseparator
25102 Export\SpecialChar menuseparator
25111 Invoked in this way, it can be a hassle to find the corresponding place
25112 in the document inside \SpecialChar LyX
25113 , but with a little patience, you should be able
25117 \begin_layout Standard
25118 Here follows the warning messages that can be enabled and disabled in
25127 to disable a warning, and
25131 to enable a warning.
25132 The emphasized entries are disabled by default, because the default is
25135 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
25140 \begin_layout Standard
25141 Notice that you should only use the options that enable and disable warnings,
25142 because \SpecialChar LyX
25143 relies on some of the other command line parameters to be set
25144 in a specific way to have a chance to communicate with
25151 \begin_layout Enumerate
25155 Command terminated with space.
25158 \begin_layout Enumerate
25161 Non-breaking space (
25162 \begin_inset Quotes eld
25170 \begin_inset Quotes erd
25173 ) should have been used.
25176 \begin_layout Enumerate
25180 You should enclose the previous parenthesis with
25181 \begin_inset Quotes eld
25189 \begin_inset Quotes erd
25195 \begin_layout Enumerate
25198 Italic correction (
25199 \begin_inset Quotes eld
25209 \begin_inset Quotes erd
25212 ) found in non-italic buffer.
25215 \begin_layout Enumerate
25218 Italic correction (
25219 \begin_inset Quotes eld
25229 \begin_inset Quotes erd
25232 ) found more than once.
25235 \begin_layout Enumerate
25239 No italic correction (
25240 \begin_inset Quotes eld
25250 \begin_inset Quotes erd
25256 \begin_layout Enumerate
25260 \begin_inset Quotes eld
25268 \begin_inset Quotes erd
25272 \begin_inset Quotes eld
25280 \begin_inset Quotes erd
25286 \begin_layout Enumerate
25289 Wrong length of dash may have been used.
25292 \begin_layout Enumerate
25296 \begin_inset Quotes eld
25304 \begin_inset Quotes erd
25308 \begin_inset Quotes eld
25316 \begin_inset Quotes erd
25322 \begin_layout Enumerate
25326 \begin_inset Quotes eld
25334 \begin_inset Quotes erd
25340 \begin_layout Enumerate
25344 \begin_inset Quotes eld
25352 \begin_inset Quotes erd
25355 to achieve an ellipsis.
25358 \begin_layout Enumerate
25361 Inter-word spacing (
25362 \begin_inset Quotes eld
25372 \begin_inset Quotes eld
25375 ) should perhaps be used.
25378 \begin_layout Enumerate
25381 Inter-sentence spacing (
25382 \begin_inset Quotes eld
25392 \begin_inset Quotes erd
25395 ) should perhaps be used.
25398 \begin_layout Enumerate
25401 Could not find argument for command.
25404 \begin_layout Enumerate
25408 \begin_inset Quotes eld
25416 \begin_inset Quotes erd
25422 \begin_layout Enumerate
25425 Math mode still on at end of \SpecialChar LaTeX
25429 \begin_layout Enumerate
25433 \begin_inset Quotes eld
25441 \begin_inset Quotes erd
25444 doesn't match the number of
25445 \begin_inset Quotes eld
25453 \begin_inset Quotes erd
25459 \begin_layout Enumerate
25462 You should use either
25465 \begin_inset Quotes eld
25473 \begin_inset Quotes erd
25478 as an alternative to
25479 \begin_inset Quotes eld
25487 \begin_inset Quotes erd
25493 \begin_layout Enumerate
25500 " (ASCII 39) instead of "
25507 \begin_layout Enumerate
25510 User-specified pattern found.
25513 \begin_layout Enumerate
25516 This command might not be intended.
25519 \begin_layout Enumerate
25526 \begin_layout Enumerate
25544 \begin_layout Enumerate
25547 Delete this space to maintain correct page references.
25550 \begin_layout Enumerate
25554 You might wish to put this between a pair of
25555 \begin_inset Quotes eld
25563 \begin_inset Quotes erd
25569 \begin_layout Enumerate
25572 You ought to remove spaces in front of punctuation.
25575 \begin_layout Enumerate
25578 Could not execute \SpecialChar LaTeX
25582 \begin_layout Enumerate
25591 in front of small punctuation.
25594 \begin_layout Enumerate
25602 may look prettier here.
25605 \begin_layout Enumerate
25609 Multiple spaces detected in output.
25612 \begin_layout Enumerate
25615 This text may be ignored.
25618 \begin_layout Enumerate
25624 \begin_inset Quotes eld
25629 to begin quotation, not
25636 \begin_layout Enumerate
25643 to end quotation, not
25646 \begin_inset Quotes eld
25654 \begin_layout Enumerate
25660 \begin_layout Enumerate
25663 You should perhaps use
25664 \begin_inset Quotes eld
25672 \begin_inset Quotes erd
25678 \begin_layout Enumerate
25681 You should put a space in front of/after parenthesis.
25684 \begin_layout Enumerate
25687 You should avoid spaces in front of/after parenthesis.
25690 \begin_layout Enumerate
25694 You should not use punctuation in front of/after quotes.
25697 \begin_layout Enumerate
25700 Double space found.
25703 \begin_layout Enumerate
25706 You should put punctuation outside inner/inside display math mode.
25709 \begin_layout Enumerate
25712 You ought to not use primitive \SpecialChar TeX
25713 in \SpecialChar LaTeX
25717 \begin_layout Enumerate
25720 You should remove spaces in front of
25721 \begin_inset Quotes eld
25729 \begin_inset Quotes erd
25735 \begin_layout Enumerate
25738 \begin_inset Quotes eld
25746 \begin_inset Quotes erd
25749 is normally not followed by
25750 \begin_inset Quotes eld
25758 \begin_inset Quotes erd
25764 \begin_layout Standard
25765 In later versions of \SpecialChar LyX
25766 , we hope to provide a more complete interface to this
25767 tool (and it's smaller cousin
25771 ) to exploit the full power of it.
25772 But it's not exactly useless as it is now: go try it on one of your existing
25773 documents of a certain length and be surprised.
25776 \begin_layout Section
25777 Version Control in \SpecialChar LyX
25781 \begin_layout Standard
25784 Lars Gullik Bjønnes
25791 \begin_layout Subsection
25795 \begin_layout Standard
25797 supports some of the most basic RCS/CVS/SVN/GIT commands.
25798 If you need something a bit more sophisticated you will have to do that
25799 manually in a terminal.
25802 \begin_layout Standard
25803 Also note that CVS support is not as good as subversion support, so we advise
25805 A good place to start learning Subversion is the SVN Book
25809 \begin_layout Plain Layout
25810 \begin_inset CommandInset href
25812 target "http://svnbook.red-bean.com/"
25823 In the case of RCS you should read
25824 \begin_inset Quotes eld
25828 \begin_inset Quotes erd
25831 (a man file, read it with
25836 This file describes all the basic features of RCS.
25837 You should especially notice the comment about a RCS directory, and the
25838 notion of a master RCS file (the file ending in
25845 \begin_layout Standard
25846 Before you begin to use the version control features in \SpecialChar LyX
25848 familiar with RCS/CVS/SVN/GIT usage.
25849 The implementation in \SpecialChar LyX
25850 assumes a recent version of the GNU RCS or CVS/SVN
25851 package — no guarantees are made for older versions.
25852 Most of the log messages are not currently displayed after operations —
25853 you can check them in the Messages pane if you are unsure.
25854 Regular users of version control will appreciate the VC toolbar, which
25857 View\SpecialChar menuseparator
25858 Toolbars\SpecialChar menuseparator
25860 \begin_inset space ~
25868 \begin_layout Standard
25869 For introducing your own external commands consult
25870 \begin_inset Flex Code
25873 \begin_layout Plain Layout
25887 \begin_layout Standard
25888 It is strongly recommended to store documents in uncompressed format if
25889 using version control (uncheck
25891 Document\SpecialChar menuseparator
25894 if it is checked): Uncompressed LyX documents are text files and therefore
25895 for merging two different versions by version control systems.
25896 Compressed LyX documents are binary files, which cannot be merged by version
25900 \begin_layout Subsection
25901 RCS commands in \SpecialChar LyX
25905 \begin_layout Standard
25906 The following sections describe the RCS commands supported by \SpecialChar LyX
25908 You can find them in the
25910 File\SpecialChar menuseparator
25912 \begin_inset space ~
25919 was tested against RCS 5.7/5.8.
25922 \begin_layout Subsubsection
25928 \begin_layout Standard
25929 If your document is not under revision control, this is the only item shown
25931 And if it is under revision control, the
25935 item is not visible.
25939 \begin_layout Standard
25940 This command registers your document with RCS (unless you are under the
25941 directory managed by CVS)\SpecialChar endofsentence
25942 You are asked interactively to supply an initial
25943 description of the document.
25944 The document is now set in Read-Only mode and you have to
25947 \begin_inset space ~
25951 \begin_inset space ~
25955 \begin_inset space ~
25960 , before making any changes to it.
25961 A document under revision control has a
25962 \begin_inset Quotes eld
25965 [RCS:<version> <locker>]
25966 \begin_inset Quotes erd
25969 item tagged to the filename in the minibuffer.
25972 \begin_layout Standard
25973 RCS command that is run:
25976 \begin_layout LyX-Code
25979 ci -q -u -i -t-"<initial description>" <file-name>
25982 \begin_layout Standard
25987 to understand the switches.
25991 \begin_layout Subsubsection
25997 \begin_layout Standard
25998 When you are finished editing a file, you check in your changes.
25999 When you do this, you are asked for a description of the changes.
26000 This is stored in the history log.
26001 The version number is bumped, your changes are applied to the master RCS
26002 file, the document is unlocked and set to Read-Only mode.
26005 \begin_layout Itemize
26008 ci -q -u -m"<description>" <file-name>
26011 \begin_layout Subsubsection
26017 \begin_layout Standard
26018 By doing this you lock the document so that only you can edit it.
26019 This will also make the document Read-Write only for you.
26020 You will usually continue editing for a while and when you are finished
26021 you check in your changes.
26022 The status line is changed to reflect that you have locked the file.
26025 \begin_layout Itemize
26028 co -q -l <file-name>
26031 \begin_layout Subsubsection
26034 Revert To Repository Version
26037 \begin_layout Standard
26038 This will discard all changes made to the document since the last check
26040 You get a warning before changes are discarded.
26043 \begin_layout Itemize
26046 co -f -u<version> <file-name>
26049 \begin_layout Subsubsection
26055 \begin_layout Standard
26056 This will create a copy of the current document.
26057 Since RCS does not support copy operations natively, the version history
26058 is not preserved, and the copy is added as a new file.
26059 It requires a clean document without any changes since the last checkin.
26060 You are asked for a file name and a description of the copy operation.
26061 After that the copy is created, both locally and in the repository.
26062 If the parent directories of the copied and original document differ, all
26063 relative paths of included files of the copy are adjusted (like in
26065 File\SpecialChar menuseparator
26070 Finally, the copy is loaded instead of the original document.
26073 \begin_layout Labeling
26074 \labelwidthstring 00.00.0000
26076 \begin_inset space ~
26080 \begin_inset space ~
26084 \begin_inset Newline newline
26088 \begin_inset Flex Code
26091 \begin_layout Plain Layout
26094 \begin_inset Quotes qld
26098 \begin_inset Quotes qld
26107 \begin_inset Flex Code
26110 \begin_layout Plain Layout
26113 \begin_inset Quotes qld
26117 \begin_inset Quotes qld
26126 \begin_inset Newline newline
26130 \begin_inset Flex Code
26133 \begin_layout Plain Layout
26137 \begin_inset Quotes qld
26141 \begin_inset Quotes qld
26152 \begin_layout Subsubsection
26158 \begin_layout Standard
26159 This makes as if the last check in never happened.
26160 No changes are made to the document loaded into \SpecialChar LyX
26161 , but the last version
26162 is removed from the master RCS file.
26165 \begin_layout Itemize
26168 rcs -o<version> <file-name>
26171 \begin_layout Subsubsection
26177 \begin_layout Standard
26178 This shows the complete history of the RCS document.
26183 is shown in a browser.
26191 \begin_layout Subsubsection
26195 \begin_layout Standard
26197 supports RCS version number, author name, date and time of last commit.
26198 All those are extracted from
26200 rlog -r <file-name>
26204 \begin_inset CommandInset ref
26206 reference "subsec:VCS-Revision-Information"
26213 \begin_layout Subsection
26214 CVS commands in \SpecialChar LyX
26218 \begin_layout Standard
26219 A subset of CVS operations is supported by \SpecialChar LyX
26221 You can find the commands in the
26223 File\SpecialChar menuseparator
26225 \begin_inset space ~
26231 The version control system SVN is more powerful, so please use it instead
26232 of CVS if possible.
26235 \begin_layout Subsubsection
26241 \begin_layout Standard
26242 If you start from scratch with CVS you have to create your repository and
26243 checkout the working copy with external tools.
26244 If you're using a client-server setup you may need to login before doing
26245 the first repository checkout.
26248 \begin_layout Standard
26249 If your documents are under revision control and others are using the same
26250 repository problems arise when different changes to the same document at
26251 the same location happen.
26252 Standard CVS repositories don't operate with a file locking mechanism.
26253 This may be surprising, but conflicts only occur if people disagree on
26254 the proper content of the same part of a document.
26255 So, if co-workers are used to communicate regularly, these conflicts occur
26257 If they don't communicate they have a fundamental problem anyway.
26258 Nevertheless some people like to work with so called
26259 \begin_inset Quotes eld
26263 \begin_inset Quotes erd
26267 If they do so the working copy of all files is readonly when checked out
26268 first and the user starts editing after using a special command to make
26269 the working copy writable.
26270 When the changes are checked in the working copy returns to readonly state.
26271 With \SpecialChar LyX
26272 one has to edit the
26273 \begin_inset Flex Code
26276 \begin_layout Plain Layout
26282 file and add the line
26283 \begin_inset Flex Code
26286 \begin_layout Plain Layout
26292 to work with reserved checkouts.
26293 The benefit is the possibility to see who is using a writable copy of some
26295 It's not guaranteed only one user makes a copy writable.
26298 \begin_layout Standard
26300 tries to guess if you're using reserved or non-reserved checkouts.
26301 If your working copy is readonly or it is writable and an additional copy
26302 of your document exists in the CVS/Base sub-directory a reserved otherwise
26303 a non-reserved checkout is assumed.
26304 When a reserved checkout is detected you have to use
26305 \begin_inset Flex Noun
26308 \begin_layout Plain Layout
26314 to make your working copy writable if it's readonly.
26316 \begin_inset Flex Noun
26319 \begin_layout Plain Layout
26325 operation is possible and that makes your working copy readonly again after
26326 transferring your changes to the repository.
26329 \begin_layout Standard
26330 More information about CVS can be found here
26331 \begin_inset Flex URL
26334 \begin_layout Plain Layout
26336 http://www.nongnu.org/cvs
26342 \begin_inset Flex URL
26345 \begin_layout Plain Layout
26347 http://ximbiot.com/cvs
26355 \begin_layout Standard
26360 to understand the sub-commands and the switches mentioned below.
26363 \begin_layout Subsubsection
26369 \begin_layout Standard
26370 If your document is not under revision control, this is the only item shown
26372 And if it is under revision control, the
26376 item is not visible.
26380 \begin_layout Standard
26381 This command registers in CVS your document
26382 \begin_inset Flex Strong
26385 \begin_layout Plain Layout
26393 in the case you have already the documents directory under CVS control
26399 This means you have to create or checkout the archive by yourself using
26401 (In case you forget that step \SpecialChar LyX
26402 registers the document with RCS.)
26405 \begin_layout Standard
26406 Then you are asked interactively to supply an initial description of the
26408 Don't forget that registered file is not yet checked in.
26411 \begin_layout Standard
26412 CVS command that is run:
26414 cvs -q add -m"<entered message>" "<file-name>"
26417 \begin_layout Standard
26422 above and for all other CVS commands is an abbreviation for
26423 \begin_inset Quotes eld
26426 change the current working directory to file location and use the file name
26427 without path component as argument
26428 \begin_inset Quotes erd
26434 \begin_layout Subsubsection
26440 \begin_layout Standard
26441 When you are finished editing a file, you commit your changes.
26442 When you do this and you had changed the document, you are asked for a
26443 description of the changes.
26444 After that changes are written to the repository.
26445 In case you didn't change the document and a reserved checkout is detected
26446 the reservation made on
26447 \begin_inset Flex Noun
26450 \begin_layout Plain Layout
26459 \begin_layout Labeling
26460 \labelwidthstring 00.00.0000
26462 \begin_inset space ~
26466 \begin_inset space ~
26470 \begin_inset Newline newline
26474 \begin_inset Flex Code
26477 \begin_layout Plain Layout
26480 -q commit -m"<description>" "<file-name>"
26486 \begin_inset Newline newline
26490 \begin_inset Flex Code
26493 \begin_layout Plain Layout
26504 \begin_layout Subsubsection
26510 \begin_layout Standard
26511 When you are sharing a repository with others, you may have to incorporate
26512 their changes into your working copy.
26515 \begin_layout Standard
26518 cvs -q update "<file-name>"
26521 \begin_layout Standard
26522 If a readonly checkout is detected the working copy is made writable and
26526 \begin_layout Standard
26529 cvs -q edit "<file-name>"
26532 \begin_layout Subsubsection
26535 Revert To Repository Version
26538 \begin_layout Standard
26539 This will discard all changes made to the document since the last check
26541 You get a warning before changes are discarded.
26542 Firstly the file is deleted, secondly CVS update command is run.
26545 \begin_layout Standard
26548 cvs -q update "<file-name>"
26551 \begin_layout Standard
26552 If a reserved checkout is detected and the working copy has no changes only
26553 the reservation is undone.
26556 \begin_layout Standard
26559 cvs -q unedit "<file-name>"
26562 \begin_layout Subsubsection
26568 \begin_layout Standard
26569 This will create a copy of the current document.
26570 Since CVS does not support copy operations natively, the version history
26571 is not preserved, and the copy is added as a new file.
26572 It requires a clean document without any changes since the last checkin.
26573 You are asked for a file name and a description of the copy operation.
26574 After that the copy is created, both locally and in the repository.
26575 If the parent directories of the copied and original document differ, all
26576 relative paths of included files of the copy are adjusted (like in
26578 File\SpecialChar menuseparator
26583 Finally, the copy is loaded instead of the original document.
26586 \begin_layout Labeling
26587 \labelwidthstring 00.00.0000
26589 \begin_inset space ~
26593 \begin_inset space ~
26597 \begin_inset Newline newline
26601 \begin_inset Flex Code
26604 \begin_layout Plain Layout
26611 \begin_inset Flex Code
26614 \begin_layout Plain Layout
26621 \begin_inset Newline newline
26625 \begin_inset Flex Code
26628 \begin_layout Plain Layout
26629 cvs -q add "<new-file-name>"
26637 \begin_layout Subsubsection
26643 \begin_layout Standard
26644 This will rename the current document.
26645 Since CVS does not support rename operations natively, the version history
26646 is not preserved, the renamed document is added as a new file, and the
26647 original document is deleted.
26648 It requires a clean document without any changes since the last checkin.
26649 You are asked for a file name and a description of the rename operation.
26650 After that the document is renamed, both locally and in the repository.
26651 If the parent directories of the new and old file names differ, all relative
26652 paths of included files are adjusted (like in
26654 File\SpecialChar menuseparator
26659 Finally, the document is reloaded using the new name.
26662 \begin_layout Labeling
26663 \labelwidthstring 00.00.0000
26665 \begin_inset space ~
26669 \begin_inset space ~
26673 \begin_inset Newline newline
26677 \begin_inset Flex Code
26680 \begin_layout Plain Layout
26687 \begin_inset Flex Code
26690 \begin_layout Plain Layout
26697 \begin_inset Newline newline
26701 \begin_inset Flex Code
26704 \begin_layout Plain Layout
26705 cvs -q add "<new-file-name>"
26711 \begin_inset Newline newline
26715 \begin_inset Flex Code
26718 \begin_layout Plain Layout
26719 cvs -q remove "<file-name>"
26727 \begin_layout Subsubsection
26728 Update of the local directory checkout from repository
26731 \begin_layout Standard
26732 Once your documents gets more complex, containing sub-documents and pictures,
26734 \begin_inset Flex Code
26737 \begin_layout Plain Layout
26743 files and so on using version control becomes more complicated.
26745 supports updating the whole tree in which resides the document.
26746 This become especially useful once you cooperate with people which neither
26747 have detailed knowledge about CVS usage nor they have ambition to commit
26748 additional material to the repository.
26749 You have to organize the files structure so that all external files are
26750 in the same directory or subdirectories of the document.
26751 It's good practice anyway to store multipart documents in an extra directory.
26754 \begin_layout Standard
26756 \begin_inset Flex Code
26759 \begin_layout Plain Layout
26760 Update local directory from repository
26765 command updates the whole directory.
26766 If local changes are detected user is warned before update starts.
26767 In case of merge conflicts both versions of the conflicting document parts
26768 are placed in the final document.
26769 You have to review and correct the result of the merge.
26770 You'll find the conflicts enclosed in pairs of
26771 \begin_inset Flex Code
26774 \begin_layout Plain Layout
26781 \begin_inset Flex Code
26784 \begin_layout Plain Layout
26791 \begin_inset Flex Code
26794 \begin_layout Plain Layout
26801 The first part is your version as before the update operation with the
26802 document name prepended.
26803 The second one is the repository version with the version number after
26805 \begin_inset Flex Code
26808 \begin_layout Plain Layout
26817 \begin_layout Labeling
26818 \labelwidthstring 00.00.0000
26820 \begin_inset space ~
26824 \begin_inset space ~
26828 \begin_inset Newline newline
26832 \begin_inset Flex Code
26835 \begin_layout Plain Layout
26843 (Ask if changes are detected.)
26844 \begin_inset Newline newline
26848 \begin_inset Flex Code
26851 \begin_layout Plain Layout
26852 cd $path; cvs -q update
26862 \begin_layout Standard
26864 \begin_inset Flex Code
26867 \begin_layout Plain Layout
26873 stands for the path to the document.
26876 \begin_layout Subsubsection
26882 \begin_layout Standard
26883 This shows the complete history of the CVS document.
26886 cvs log "<file-name>"
26888 is shown in a browser.
26891 \begin_layout Subsubsection
26895 \begin_layout Standard
26897 supports CVS version number, author name, date and time of last commit.
26898 All those are extracted from
26900 cvs log -r <file-name>
26904 \begin_inset CommandInset ref
26906 reference "subsec:VCS-Revision-Information"
26913 \begin_layout Subsection
26914 SVN commands in \SpecialChar LyX
26918 \begin_layout Standard
26919 SVN is now partially supported by \SpecialChar LyX
26921 You can find the commands in the
26923 File\SpecialChar menuseparator
26925 \begin_inset space ~
26931 Please note that if you use password protected access to repository via
26932 ssh, you will be asked in terminal window.
26934 was tested against SVN 1.5, 1.6, 1.7 and 1.8
26938 \begin_layout Plain Layout
26939 Most of the commands will work with 1.4 too, see
26940 \begin_inset CommandInset ref
26942 reference "subsec:SVN-Repo-Update"
26947 There seems to be currently unresolved permissions problem under SVN 1.8
26948 with reverting changes when file is locked.
26956 \begin_layout Subsubsection
26962 \begin_layout Standard
26963 If your document is not under revision control, this is the only item shown
26965 And if it is under revision control, the
26969 item is not visible.
26972 \begin_layout Standard
26973 This command registers in SVN your document ONLY in case you have already
26974 the documents directory under SVN control (in particular
26979 This means you have to checkout the archive by yourself.
26982 \begin_layout Standard
26983 Then you are asked interactively to supply an initial description of the
26985 Don't forget that registered file is not yet commited.
26988 \begin_layout Standard
26989 SVN command that is run:
26992 \begin_inset Quotes qld
26996 \begin_inset Quotes qld
27002 \begin_layout Standard
27007 to understand the switches.
27010 \begin_layout Subsubsection
27016 \begin_layout Standard
27017 When you are finished editing a file, you commit your changes.
27018 When you do this, you are asked for a description of the changes.
27019 After that changes are commited.
27022 \begin_layout Standard
27027 \begin_layout Plain Layout
27028 In case locking is not enabled.
27030 \begin_inset CommandInset ref
27032 reference "subsec:SVN-File-Locking"
27043 svn commit -q -m"<description>" <file-name>
27046 \begin_layout Subsubsection
27052 \begin_layout Standard
27053 Updates the changes of this file from the repository.
27054 Be sure you understand SVN merging and conflicts resolving before using
27055 this function, because all conflicts has to be resolved manually by you!
27058 \begin_layout Standard
27063 \begin_layout Plain Layout
27071 svn update --non-interactive
27072 \begin_inset Quotes qld
27076 \begin_inset Quotes qld
27082 \begin_layout Subsubsection
27085 Revert To Repository Version
27088 \begin_layout Standard
27089 This will discard all changes made to the document since the last check
27091 You get a warning before changes are discarded.
27094 \begin_layout Standard
27098 \begin_inset Quotes qld
27102 \begin_inset Quotes qld
27108 \begin_layout Subsubsection
27114 \begin_layout Standard
27115 This will create a copy of the current document including the version history.
27116 It requires a clean document without any changes since the last checkin.
27117 You are asked for a file name and a description of the copy operation.
27118 After that the copy is created, both locally and in the repository.
27119 If the parent directories of the copied and original document differ, all
27120 relative paths of included files of the copy are adjusted (like in
27122 File\SpecialChar menuseparator
27127 Finally, the copy is loaded instead of the original document.
27130 \begin_layout Labeling
27131 \labelwidthstring 00.00.0000
27133 \begin_inset space ~
27137 \begin_inset space ~
27141 \begin_inset Newline newline
27145 \begin_inset Flex Code
27148 \begin_layout Plain Layout
27152 \begin_inset Quotes qld
27156 \begin_inset Quotes qld
27160 \begin_inset Quotes qld
27164 \begin_inset Quotes qld
27173 \begin_inset Newline newline
27177 \begin_inset Flex Code
27180 \begin_layout Plain Layout
27189 \begin_layout Subsubsection
27195 \begin_layout Standard
27196 This will rename the current document including the version history.
27197 It requires a clean document without any changes since the last checkin.
27198 You are asked for a file name and a description of the rename operation.
27199 After that the document is renamed, both locally and in the repository.
27200 If the parent directories of the new and old file names differ, all relative
27201 paths of included files are adjusted (like in
27203 File\SpecialChar menuseparator
27208 Finally, the document is reloaded using the new name.
27211 \begin_layout Labeling
27212 \labelwidthstring 00.00.0000
27214 \begin_inset space ~
27218 \begin_inset space ~
27222 \begin_inset Newline newline
27226 \begin_inset Flex Code
27229 \begin_layout Plain Layout
27233 \begin_inset Quotes qld
27237 \begin_inset Quotes qld
27241 \begin_inset Quotes qld
27245 \begin_inset Quotes qld
27254 \begin_inset Newline newline
27258 \begin_inset Flex Code
27261 \begin_layout Plain Layout
27270 \begin_layout Subsubsection
27271 \begin_inset CommandInset label
27273 name "subsec:SVN-Repo-Update"
27277 Update of the local directory checkout from repository
27281 \begin_layout Plain Layout
27282 Note that this command will work only with subversion
27283 \begin_inset Formula $\geqq1.5$
27294 \begin_layout Standard
27295 All the commands above have one shortcoming – they deal with the current
27297 Once your document contains pictures, includes external
27298 \begin_inset Flex Code
27301 \begin_layout Plain Layout
27307 files and so on administration becomes more complicated.
27309 now supports updating the whole tree in which resides the document
27313 \begin_layout Plain Layout
27314 One need to organize the files structure so that all external files are
27315 in the same directory or subdirectories of the document.
27322 This become especially useful once you cooperate with people which neither
27323 know about subversion management nor they have ambition to commit additional
27324 material to the repository.
27328 \begin_layout Standard
27329 \begin_inset Flex Code
27332 \begin_layout Plain Layout
27333 Update local directory from repository
27338 command updates the whole directory and in case of merge conflicts local
27339 version of the files are left, so no unintended data loss occurs.
27340 If local changes are detected user is warned before update starts.
27343 \begin_layout Labeling
27344 \labelwidthstring 00.00.0000
27346 \begin_inset space ~
27350 \begin_inset space ~
27354 \begin_inset Newline newline
27358 \begin_inset Flex Code
27361 \begin_layout Plain Layout
27367 (Ask if changes are detected.)
27368 \begin_inset Newline newline
27372 \begin_inset Flex Code
27375 \begin_layout Plain Layout
27376 svn update --accept mine-full $path
27384 \begin_layout Standard
27386 \begin_inset Flex Code
27389 \begin_layout Plain Layout
27395 stands for the path to the document.
27398 \begin_layout Subsubsection
27404 \begin_layout Standard
27405 This shows the complete history of the SVN document.
27409 \begin_inset Quotes qld
27413 \begin_inset Quotes qld
27418 is shown in a browser.
27421 \begin_layout Subsubsection
27423 \begin_inset CommandInset label
27425 name "subsec:SVN-File-Locking"
27432 \begin_layout Standard
27433 The file exchange through various revision control systems brings the problem
27434 of merge conflicts in case two different users try to edit the same (parts
27436 When such a conflict happens it needs manual resolving and one reasonable
27437 alternative is to provide some kind of locking mechanism, which guarantees
27438 that only one user is allowed to edit file at the given time.
27441 \begin_layout Standard
27442 SVN has two such mechanisms to provide mutual exclusivity for file access
27443 – locks and automatic setting of write permissions (see sec.
27445 \begin_inset CommandInset ref
27447 reference "subsec:Automatical-Locking-Property"
27452 \begin_inset Flex Code
27455 \begin_layout Plain Layout
27465 \begin_layout Plain Layout
27466 \begin_inset Flex URL
27469 \begin_layout Plain Layout
27471 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
27482 If this property is detected for a given document \SpecialChar LyX
27483 starts to use SVN locks
27484 for document editing automatically and the whole check-in/out mechanism
27485 switches to the same regimen as for RCS.
27486 This in particular means there are two different modes of file use in \SpecialChar LyX
27490 \begin_layout Itemize
27492 The loaded file is in the read-only mode.
27493 For editing on needs to check-out.
27498 consists of updating from the repository and gaining write lock.
27499 If the lock is not possible to obtain, we remain in unlocked state.
27502 \begin_layout Itemize
27504 The loaded file is in the
27505 \begin_inset Quotes els
27509 \begin_inset Quotes ers
27513 No other user is allowed to edit the file.
27518 consists of commiting changes and releasing write-lock.
27519 If no changes have been made to the document, no commit will be produced
27523 \begin_layout Plain Layout
27524 Don't be puzzled by the fact that you will be asked for commit message anyway.
27529 and only the write-lock will be released.
27532 \begin_layout Standard
27536 \begin_layout Labeling
27537 \labelwidthstring 00.00.0000
27540 svn commit -q -m"<description>" "<file-name>"
27541 \begin_inset Newline newline
27544 svn unlock "<file-name>"
27547 \begin_layout Labeling
27548 \labelwidthstring 00.00.0000
27551 svn update "<file-name>"
27552 \begin_inset Newline newline
27555 svn lock "<file-name>"
27558 \begin_layout Subsubsection
27561 \begin_inset CommandInset label
27563 name "subsec:Automatical-Locking-Property"
27569 Automatic Locking Property
27572 \begin_layout Standard
27573 The above mentioned automatic setting of write permissions of the .lyx file
27576 File\SpecialChar menuseparator
27578 \begin_inset space ~
27581 Control\SpecialChar menuseparator
27582 Use Locking Property
27585 This command is active only when the file is not locked on the svn server
27587 you need to check-out before proceeding).
27590 \begin_layout Labeling
27591 \labelwidthstring 00.00.0000
27593 \begin_inset space ~
27599 \begin_layout Labeling
27600 \labelwidthstring 00.00.0000
27603 svn propset svn:needs-lock ON "<file-name>"
27606 \begin_layout Labeling
27607 \labelwidthstring 00.00.0000
27610 svn propdel svn:needs-lock "<file-name>"
27613 \begin_layout Subsubsection
27614 \begin_inset CommandInset label
27616 name "subsec:VCS-Revision-Information"
27620 Revision Information in Documents
27623 \begin_layout Standard
27624 There are more possibilities how to activate revision information in our
27628 \begin_layout Itemize
27634 \begin_layout Itemize
27635 tree revision information (
27636 \begin_inset Flex Code
27639 \begin_layout Plain Layout
27646 The result is the output of the
27647 \begin_inset Flex Code
27650 \begin_layout Plain Layout
27656 command, the following table gives you an idea, how to read the results.
27659 \begin_layout Standard
27661 \begin_inset Tabular
27662 <lyxtabular version="3" rows="6" columns="2">
27663 <features tabularvalignment="middle">
27664 <column alignment="left" valignment="top">
27665 <column alignment="left" valignment="top">
27667 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
27670 \begin_layout Plain Layout
27678 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
27681 \begin_layout Plain Layout
27691 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
27694 \begin_layout Plain Layout
27700 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
27703 \begin_layout Plain Layout
27704 mixed revision working copy
27711 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
27714 \begin_layout Plain Layout
27720 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
27723 \begin_layout Plain Layout
27724 modified working copy
27731 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
27734 \begin_layout Plain Layout
27740 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
27743 \begin_layout Plain Layout
27744 switched working copy
27751 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
27754 \begin_layout Plain Layout
27760 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
27763 \begin_layout Plain Layout
27764 partial working copy, from a sparse checkout
27771 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
27774 \begin_layout Plain Layout
27780 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
27783 \begin_layout Plain Layout
27784 mixed revision, modified, switched working copy
27797 \begin_layout Itemize
27798 file revision information.
27799 The result comes from parsing the output of
27800 \begin_inset Flex Code
27803 \begin_layout Plain Layout
27805 \begin_inset space ~
27809 \begin_inset space ~
27813 \begin_inset space ~
27822 Supported flags are:
27826 \begin_layout Itemize
27827 version number of the last commit (
27828 \begin_inset Flex Code
27831 \begin_layout Plain Layout
27840 \begin_layout Itemize
27841 author of the last commit (
27842 \begin_inset Flex Code
27845 \begin_layout Plain Layout
27854 \begin_layout Itemize
27855 date of the last commit (
27856 \begin_inset Flex Code
27859 \begin_layout Plain Layout
27868 \begin_layout Itemize
27869 time of the last commit (
27870 \begin_inset Flex Code
27873 \begin_layout Plain Layout
27883 \begin_layout Standard
27884 You can obtain this info via InsetInfo (
27885 \change_inserted 5863208 1564400022
27888 Insert\SpecialChar menuseparator
27889 Field\SpecialChar menuseparator
27890 Version Control Revision
27891 \change_deleted 5863208 1564399852
27896 \begin_inset Flex Code
27899 \begin_layout Plain Layout
27900 info-insert buffer vcs-date
27908 The information will be available only when you have the file stored under
27909 svn managment (i.e.
27911 \begin_inset Flex Code
27914 \begin_layout Plain Layout
27920 directory is available with your document).
27924 \begin_layout Itemize
27925 Another—a hacking one—possibility is to use svn keywords
27929 \begin_layout Plain Layout
27930 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
27936 In short – you set file keywords property (e.g.
27939 svn propset svn:keywords 'Rev' file.lyx
27941 ) and then paste keyword \SpecialChar TeX
27946 \begin_layout Plain Layout
27947 This is an easy way how to ensure that \SpecialChar LyX
27948 won't break the line in the middle
27954 tag in your document (e.g.
27956 \begin_inset Flex Code
27959 \begin_layout Plain Layout
27966 This way svn client will automatically substitute revision number (e.g.
27968 \begin_inset Flex Code
27971 \begin_layout Plain Layout
27977 ) after each update and commit.
27978 There are more problems with this approach.
27979 Firstly, the '$' character is used in \SpecialChar TeX
27980 world for math equations, so any
27981 occurence of math formula
27982 \begin_inset Formula $Rev$
27986 \begin_inset Formula $Rev:59$
27989 in your \SpecialChar LyX
27991 Similarly for other keywords like Id, Date, Author, etc.
27992 Secondly svn output is dependent on your locales, so its very easy that
27993 svn would produce some problematic strings once Date is used.
27994 Thirdly you get the whole 'Rev: 59' string in your document instead of
27996 Until subversion implements user's custom keywords it will be hard to use
27997 this approach reliably or let \SpecialChar LyX
27998 to support it directly.
28001 \begin_layout Subsection
28002 SVN and Windows Environment
28005 \begin_layout Quote
28006 My inclination is to say that if the user cannot figure out the command
28007 line operations on their own fairly quickly, they would be well advised
28008 to use TortoiseSVN.
28014 \begin_layout Subsubsection
28018 \begin_layout Standard
28019 In addition to installing \SpecialChar LyX
28020 , and having access to a Subversion repository,
28021 the user will need to install the Subversion client program.
28022 A Windows installer for the client program is available from
28023 \begin_inset CommandInset href
28026 target "http://www.collab.net/nonav/downloads/subversion/"
28032 The user may also want to install
28033 \begin_inset CommandInset href
28036 target "http://tortoisesvn.tigris.org/"
28041 , which integrates Subversion operations into the context (rightclick) menu
28042 of Windows Explorer.
28043 Operations done outside \SpecialChar LyX
28044 will typically be more convenient using the Explorer
28046 Note that TortoiseSVN is not a replacement for the client program, which
28047 is what \SpecialChar LyX
28051 \begin_layout Subsubsection
28052 Bringing a document under Subversion control
28055 \begin_layout Standard
28056 Before a \SpecialChar LyX
28057 document can be brought under version control in Subversion, its
28058 parent directory needs to be under version control.
28059 If the document is being added to a project already in the repository,
28060 this is accomplished by checking the project out to the directory where
28061 the new document will be placed.
28062 If the project itself is not yet under version control (for instance, if
28063 this document starts a new project), the directory must be imported into
28065 This is done outside \SpecialChar LyX
28067 Both import and checkout are easily accomplished from the Explorer context
28068 menu using TortoiseSVN, or alternatively can be done using the command
28069 line client at a DOS prompt.
28070 The procedure for importing the project using TortoiseSVN is described
28071 below, assuming an existing repository and a new project being started
28079 For information on using the Subversion client program, run
28086 \begin_layout Enumerate
28093 in Windows Explorer, right click it, and select
28095 TortoiseSVN\SpecialChar menuseparator
28099 If necessary, adjust the URL for the repository, then click OK.
28102 \begin_layout Enumerate
28103 Right click the level of the repository under which you want to place the
28104 new project folder (typically the top level) and click
28108 Supply a name for the project folder and click OK.
28109 Add a message for the log file if desired, then click OK again.
28110 The new project folder should appear in the repository.
28111 Finally, click OK again to exit the repository browser.
28114 \begin_layout Enumerate
28115 Once again right click
28121 , this time selecting SVN Checkout\SpecialChar ldots
28122 Select the URL of the project folder
28123 you just created in the repository, and set the checkout directory to
28131 You will be warned about a non-empty folder; click OK to proceed.
28132 You should now have a
28143 \begin_layout Enumerate
28144 Create or open your document in \SpecialChar LyX
28147 File\SpecialChar menuseparator
28149 \begin_inset space ~
28152 Control\SpecialChar menuseparator
28156 Add a log message and click OK to commit the document to version control.
28159 \begin_layout Standard
28160 From this point onward, you should have full functionality in the
28162 File\SpecialChar menuseparator
28164 \begin_inset space ~
28170 You also have the option of checking the document in and out, viewing its
28172 using the TortoiseSVN context menu in Windows Explorer or the Subversion
28173 client program from a command prompt.
28176 \begin_layout Subsubsection
28177 SSH tunnel used with SVN under Windows
28180 \begin_layout Standard
28181 Compared with Linux setting up an svn client to communicate over ssh under
28182 Windows is a rather troublesome task.
28183 We will at least offer some hints how to setup the client side but prior
28184 knowledge about ssh and the Windows command line is needed, also be prepared
28185 for a great deal of frustration\SpecialChar ldots
28189 \begin_layout Enumerate
28190 Get an svn client for windows, as described in the previous sections.
28191 When it is a fresh install run some svn command (e.g.
28193 \begin_inset Flex Code
28196 \begin_layout Plain Layout
28202 ) to create config files, which you will need to change later on.
28205 \begin_layout Enumerate
28206 Choose an ssh client for Windows.
28207 There are several possibilities, we will use the one from Putty tools
28211 \begin_layout Plain Layout
28212 \begin_inset Flex URL
28215 \begin_layout Plain Layout
28217 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
28228 You will need to set the connection up so that the client doesn't ask for
28229 any password from you.
28230 To keep things easy we will use only keys without any additional password
28235 \begin_layout Enumerate
28237 \begin_inset Flex Code
28240 \begin_layout Plain Layout
28247 Save your private .ppk key file and put the public one on the server side.
28248 If the SVN server runs on Linux, note that the format of the public key
28249 is not compatible with Linux openssh and you will need to direcly copy-paste
28251 \begin_inset Quotes eld
28256 Public key for pasting into OpenSSH authorized_keys file
28259 \begin_inset Quotes erd
28262 edit field into the server's
28263 \begin_inset Flex Code
28266 \begin_layout Plain Layout
28267 ~/.ssh/authorized_keys
28273 \begin_inset Flex Code
28276 \begin_layout Plain Layout
28285 \begin_layout Enumerate
28287 \begin_inset Flex Code
28290 \begin_layout Plain Layout
28297 In the SVN config file
28301 \begin_layout Plain Layout
28302 Exact path depends on Windows version, usually somewhere around
28303 \begin_inset Flex Code
28306 \begin_layout Plain Layout
28309 Documents and Settings
28323 \begin_inset Flex Code
28326 \begin_layout Plain Layout
28341 , section [tunnels], setup ssh command, e.g.
28343 \begin_inset Flex Code
28346 \begin_layout Plain Layout
28347 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
28356 \begin_layout Plain Layout
28357 It will usually take a lot of time to get exact command right and it depends
28359 For example do not have some remote server saved as a default session in
28361 If things fail, try to connect via plink without SVN first.
28370 \begin_layout Enumerate
28371 Checkout the SVN archive, e.
28372 \begin_inset space \thinspace{}
28376 \begin_inset Newline newline
28380 \begin_inset Flex Code
28383 \begin_layout Plain Layout
28384 svn co svn+ssh://user@server/repository_path
28392 \begin_layout Subsubsection
28393 End-of-Line Conversions
28396 \begin_layout Standard
28397 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
28399 use different line endings inside the .lyx files.
28400 This is not a problem as far as \SpecialChar LyX
28401 functionality is concerned, but the commit
28402 diffs will be huge and merge-conflicts prone.
28403 Fortunately SVN itself knows
28407 \begin_layout Plain Layout
28408 \begin_inset Flex URL
28411 \begin_layout Plain Layout
28413 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
28423 how to deal with CR/LF problems when switching .lyx files to the
28424 \begin_inset Flex Code
28427 \begin_layout Plain Layout
28437 \begin_layout Plain Layout
28439 \begin_inset Flex Code
28442 \begin_layout Plain Layout
28443 svn propset svn:eol-style native FILE_NAME
28456 \begin_layout Subsection
28457 GIT commands in \SpecialChar LyX
28461 \begin_layout Standard
28462 A minimal subset of GIT commands is now supported by \SpecialChar LyX
28464 You can find the commands in the
28466 File\SpecialChar menuseparator
28468 \begin_inset space ~
28474 Please note that if you use password protected access to repository via
28475 ssh, you will be asked in terminal window.
28477 was tested against GIT 1.7.
28481 \begin_layout Plain Layout
28482 Windows users please note that you need to ensure that git is on the path.
28483 This can be set from within \SpecialChar LyX
28486 Tools\SpecialChar menuseparator
28487 Preferences\SpecialChar menuseparator
28488 Paths\SpecialChar menuseparator
28499 \begin_layout Standard
28500 One big difference of GIT and the other supported version control systems
28501 is the distributed nature of GIT: With traditional version control systems
28502 there is one central server which hosts the repository.
28503 Users commit their changes to the server, and get updates made by other
28505 With GIT, users commit to a local repository.
28506 The local repository can be synchronized with one or more remote repositories
28508 \begin_inset Flex Code
28511 \begin_layout Plain Layout
28518 \begin_inset Flex Code
28521 \begin_layout Plain Layout
28529 does not interact in any way with remote GIT repositories.
28530 It works exclusively with the local repository in a very similar way as
28531 with a central CVS or SVN repository.
28532 If you use remote GIT repositories you need to do the
28533 \begin_inset Flex Code
28536 \begin_layout Plain Layout
28543 \begin_inset Flex Code
28546 \begin_layout Plain Layout
28552 operations with your favourite GIT client.
28555 \begin_layout Subsubsection
28561 \begin_layout Standard
28562 If your document is not under revision control, this is the only item shown
28564 And if it is under revision control, the
28568 item is not visible.
28571 \begin_layout Standard
28572 This command registers in GIT your document ONLY in case you have already
28573 the documents directory under GIT control (in particular
28578 This means you have to checkout the archive by yourself.
28581 \begin_layout Standard
28582 Then you are asked interactively to supply an initial description of the
28584 Don't forget that registered file is not yet committed.
28587 \begin_layout Standard
28588 GIT command that is run:
28591 \begin_inset Quotes qld
28595 \begin_inset Quotes qld
28601 \begin_layout Standard
28606 to understand the switches.
28609 \begin_layout Subsubsection
28615 \begin_layout Standard
28616 When you are finished editing a file, you commit your changes.
28617 When you do this, you are asked for a description of the changes.
28618 After that changes are committed.
28621 \begin_layout Standard
28624 git commit -q -m"<description>" <file-name>
28627 \begin_layout Subsubsection
28630 Revert To Repository Version
28633 \begin_layout Standard
28634 This will discard all changes made to the document since the last check
28636 You get a warning before changes are discarded.
28639 \begin_layout Standard
28643 \begin_inset Quotes qld
28647 \begin_inset Quotes qld
28653 \begin_layout Subsubsection
28659 \begin_layout Standard
28660 This will rename the current document including the version history.
28661 It requires a clean document without any changes since the last checkin.
28662 You are asked for a file name and a description of the rename operation.
28663 After that the document is renamed, both locally and in the repository.
28664 If the parent directories of the new and old file names differ, all relative
28665 paths of included files are adjusted (like in
28667 File\SpecialChar menuseparator
28672 Finally, the document is reloaded using the new name.
28675 \begin_layout Labeling
28676 \labelwidthstring 00.00.0000
28678 \begin_inset space ~
28682 \begin_inset space ~
28686 \begin_inset Newline newline
28690 \begin_inset Flex Code
28693 \begin_layout Plain Layout
28697 \begin_inset Quotes qld
28701 \begin_inset Quotes qld
28705 \begin_inset Quotes qld
28709 \begin_inset Quotes qld
28718 \begin_inset Newline newline
28722 \begin_inset Flex Code
28725 \begin_layout Plain Layout
28734 \begin_layout Subsubsection
28740 \begin_layout Standard
28741 This shows the complete history of the GIT document.
28745 \begin_inset Quotes qld
28749 \begin_inset Quotes qld
28754 is shown in a browser.
28757 \begin_layout Subsubsection
28761 \begin_layout Standard
28763 supports GIT hash number of the last commit to the file,
28764 \change_inserted 1119979965 1564297456
28765 its abbreviated form,
28767 author name, date and time of last commit.
28768 All those are extracted from
28770 git log -n 1 --pretty=format:%H%n
28771 \change_inserted 1119979965 1564297427
28777 Tree version information is obtained via
28779 git describe --abbrev --dirty --long
28783 \begin_inset CommandInset ref
28785 reference "subsec:VCS-Revision-Information"
28792 \begin_layout Subsection
28796 \begin_layout Standard
28797 With the recent addition of the
28798 \begin_inset Flex Code
28801 \begin_layout Plain Layout
28807 function \SpecialChar LyX
28808 power users are allowed to create their own commands for revision
28812 \begin_layout Standard
28813 As an example you can see how two TortoiseSVN commands could be integrated
28817 \begin_layout Description
28819 \begin_inset Flex Code
28822 \begin_layout Plain Layout
28823 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
28831 \begin_layout Description
28833 \begin_inset Flex Code
28836 \begin_layout Plain Layout
28837 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
28845 \begin_layout Subsection
28846 Version control and Document comparison
28849 \begin_layout Standard
28850 One of the typical uses of version control is to inspect the changes between
28851 revisions, usually by creating
28852 \begin_inset Flex Code
28855 \begin_layout Plain Layout
28862 While this is useful for plain text files, it is much less useful in the
28863 case of \SpecialChar LyX
28864 files, which have more a complicated structure.
28865 Hence we provide binding to the Document comparison feature.
28866 There are two ways of calling this feature – either by direct call of
28867 \begin_inset Flex Code
28870 \begin_layout Plain Layout
28877 function (for details see \SpecialChar LyX
28878 functions manual) or by the toolbar icon
28891 One can either compare two chosen revisions of the document or he can simply
28892 compare the current version of edited text with older revisions (where
28894 \begin_inset Flex Noun
28897 \begin_layout Plain Layout
28903 ' revisions back means comparison of the edited file with last commited
28908 \begin_layout Standard
28909 This feature is supported for SVN and RCS though due to the more complicated
28910 versioning scheme of RCS there is a constraint – when addressing the revisions
28911 in dialog, numbers always point to the last number in RCS revision number,
28914 We don't currently support GIT addressing of revisions, one can just compare
28915 edited document with its revision X steps backs, where X is addressed as
28917 \begin_inset Flex Code
28920 \begin_layout Plain Layout
28929 \begin_layout Section
28930 Literate Programming
28933 \begin_layout Standard
28938 (kayvan@sylvan.com)
28942 original documentation written by
28944 Edmar Wienskoski Jr.
28947 (edmar-w-jr@technologist.com)
28950 \begin_layout Subsection
28954 \begin_layout Standard
28955 The main purpose of this documentation is to show you how to use \SpecialChar LyX
28957 programming, where it is assumed that you are familiar with this programming
28958 technique, and know what
28959 \begin_inset Quotes eld
28963 \begin_inset Quotes erd
28967 \begin_inset Quotes eld
28971 \begin_inset Quotes erd
28975 If that is not the case, please follow the web links provided in the following
28977 There is a lot of good documentation out there covering old development
28978 history to the latest tools tips.
28981 \begin_layout Standard
28982 It is also assumed that you are familiar with \SpecialChar LyX
28983 itself to a point that you
28984 are comfortable changing your \SpecialChar LyX
28985 preferences, and X resources file.
28986 If that is not the case please refer to other \SpecialChar LyX
28987 documentation to cover your
28991 \begin_layout Subsection
28992 Literate Programming
28995 \begin_layout Standard
28996 From the Literate Programming FAQ:
28999 \begin_layout Quotation
29000 Literate programming is the combination of documentation and source together
29001 in a fashion suited for reading by human beings.
29002 In fact, literate programs should be enjoyable reading, even inviting!
29003 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
29004 and documentation in a single file.
29005 Literate programming tools then parse the file to produce either readable
29006 documentation or compilable source.
29007 The WEB style of literate programming was created by D.
29008 \begin_inset space \thinspace{}
29012 Knuth during the development of his \SpecialChar TeX
29013 typesetting software.
29017 \begin_layout Standard
29018 Another excerpt says:
29021 \begin_layout Quotation
29024 How is literate programming different from verbose commenting?
29027 \begin_layout Quotation
29028 There are three distinguishing characteristics.
29029 In order of importance, they are:
29033 \begin_layout Itemize
29034 flexible order of elaboration
29037 \begin_layout Itemize
29038 automatic support for browsing
29041 \begin_layout Itemize
29042 typeset documentation, especially diagrams and mathematics
29046 \begin_layout Standard
29047 Now that I sparked your curiosity, take a look in the references.
29050 \begin_layout Subsubsection
29054 \begin_layout Standard
29055 The complete Literate Programming FAQ can be found at:
29058 \begin_layout Quote
29059 Literate Programming FAQ
29060 \begin_inset Flex URL
29063 \begin_layout Plain Layout
29065 http://www.literateprogramming.com/lpfaq.pdf
29073 \begin_layout Standard
29074 The FAQ lists 23 (twenty three!) different literate programming tools.
29075 Where some are specialized or
29076 \begin_inset Quotes eld
29080 \begin_inset Quotes erd
29083 for particular programming languages, while other have general scope.
29088 for my own use for several reasons:
29091 \begin_layout Itemize
29092 It can generate the documentation either in \SpecialChar LaTeX
29096 \begin_layout Itemize
29097 It has a open architecture, i.
29098 \begin_inset space \thinspace{}
29102 \begin_inset space \space{}
29105 it is easy to plug in new filters
29109 \begin_layout Plain Layout
29114 are programs that read a given data stream and output a manipulated data
29116 That way, a WEB file (consisting of literate code) can be turned into a
29117 file consisting only of C program code or \SpecialChar LaTeX
29123 and to perform special processing that you may need.
29127 \begin_layout Itemize
29128 There is a good selection of filters available already (the HTML is one
29132 \begin_layout Itemize
29136 \begin_layout Standard
29137 The Noweb web page can be found at:
29140 \begin_layout Quote
29142 \begin_inset Flex URL
29145 \begin_layout Plain Layout
29147 https://www.cs.tufts.edu/~nr/noweb/
29155 \begin_layout Standard
29156 Starting from there you can reach many other interesting links and even
29157 some literate program examples.
29160 \begin_layout Subsection
29162 and Literate Programming with Noweb
29165 \begin_layout Standard
29166 The \SpecialChar LyX
29167 support for Literate Programming is provided by using the generic \SpecialChar LyX
29169 converters mechanism.
29170 This support is provided in a
29171 \begin_inset Quotes eld
29175 \begin_inset Quotes erd
29179 \begin_inset space \thinspace{}
29183 \begin_inset space \space{}
29186 you will be able to use this new \SpecialChar LyX
29187 feature with some other literate programming
29188 tool of your choice by just changing your \SpecialChar LyX
29192 \begin_layout Subsubsection
29193 Generating documents and code (weaving and tangling)
29196 \begin_layout Paragraph
29197 Using the noweb module
29200 \begin_layout Standard
29201 If you have installed Noweb and \SpecialChar LyX
29202 successfully, whenever you open a new document,
29203 after you have chosen its document class, use the
29205 Document\SpecialChar menuseparator
29209 \begin_inset Quotes eld
29213 \begin_inset Quotes erd
29217 If Noweb is correctly installed, when you click on the
29218 \begin_inset Quotes eld
29222 \begin_inset Quotes erd
29225 link, you will see the
29226 \begin_inset Quotes eld
29230 \begin_inset Quotes erd
29233 module in the available list and you can add it to your document.
29236 \begin_layout Paragraph
29240 \begin_layout Standard
29242 enables you to write code with a custom inset named
29243 \begin_inset Flex Noun
29246 \begin_layout Plain Layout
29253 Noweb delimits chunks like this:
29256 \begin_layout LyX-Code
29260 \begin_layout LyX-Code
29264 \begin_layout LyX-Code
29268 \begin_layout LyX-Code
29272 \begin_layout LyX-Code
29276 \begin_layout Standard
29277 The problem is that whatever is written in between the << and the
29281 must be taken literally, i.
29282 \begin_inset space \thinspace{}
29286 \begin_inset space \space{}
29290 should be prevented from making any special interpretation of what has
29292 This is also handled by
29293 \begin_inset Flex Noun
29296 \begin_layout Plain Layout
29302 , that works like a normal text inset but has a free spacing capability.
29305 \begin_layout Standard
29306 As a special note, you can also use the
29307 \begin_inset Quotes eld
29311 \begin_inset Quotes erd
29314 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
29318 \begin_layout LyX-Code
29322 \begin_layout LyX-Code
29323 def some_function(args):
29326 \begin_layout LyX-Code
29327 "This is the doc string for this function."
29330 \begin_layout LyX-Code
29331 print "My args: ", args
29334 \begin_layout LyX-Code
29335 @ %def some_function
29338 \begin_layout Standard
29339 For an example of this usage and the resulting cross-reference output, look
29340 at the Literate python program in
29342 LIBDIR/examples/listerrors.lyx
29344 which should make this all clear.
29347 \begin_layout Paragraph
29348 Generating the documentation
29351 \begin_layout Standard
29352 At this point you already have a new document file with a proper document
29353 class, and with some code and text on it.
29354 How do I print it? The answer is simple, you select
29356 View\SpecialChar menuseparator
29360 Just like you would do for a plain document.
29361 No special procedure is required.
29364 \begin_layout Standard
29365 To help orientate you, I will now explain what happens inside \SpecialChar LyX
29369 \begin_layout Enumerate
29372 Update\SpecialChar menuseparator
29375 menu option is chosen, a \SpecialChar LaTeX
29381 \begin_layout Standard
29382 If the document is of any literate class the generated file will be named
29383 with an extension name defined by the
29384 \begin_inset Quotes eld
29388 \begin_inset Quotes erd
29391 format (defined in the Preferences panel), otherwise the file will have
29400 \begin_layout Enumerate
29401 Note that the only difference so far is in the name of the file, no special
29402 processing is required by \SpecialChar LyX
29404 Given that you formatted the code using the
29405 \begin_inset Flex Noun
29408 \begin_layout Plain Layout
29414 inset that, by itself, takes care of the business.
29417 \begin_layout Enumerate
29418 If the document is of any literate class \SpecialChar LyX
29419 will then use the internal \SpecialChar LyX
29421 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
29426 \begin_layout Plain Layout
29427 The converters are defined in the
29429 Tools\SpecialChar menuseparator
29433 \begin_inset Quotes eld
29437 \begin_inset Quotes erd
29449 manual for general information about converters.
29454 to generate the \SpecialChar LaTeX
29459 \begin_layout Standard
29460 Otherwise it will just skip this step.
29464 \begin_layout Enumerate
29465 Finally, \SpecialChar LaTeX
29466 is invoked and the regular post processing continues as in a plain
29470 \begin_layout Standard
29471 Independence from a particular
29472 \begin_inset Quotes eld
29476 \begin_inset Quotes erd
29479 is easily achieved by changing the commands that are run by the various
29483 \begin_layout Paragraph
29484 Generating the code
29487 \begin_layout Standard
29488 When the build menu option is chosen or the corresponding button in the
29489 toolbar is pressed, a \SpecialChar LaTeX
29490 file is generated just like step 1 above.
29491 Next, \SpecialChar LyX
29497 This converter needs to be defined by the user and is not installed by
29498 default, though the Program format is.
29499 This converter (like any other converter) will have two parts:
29502 \begin_layout Enumerate
29503 The converter program itself.
29504 This program performs the conversion from the one format to the other (in
29505 this case, from the Noweb format to the Program pseudo-format).
29508 \begin_layout Enumerate
29509 The error log parser.
29510 This is a program whose sole purpose is to rewrite error messages in a
29511 format that \SpecialChar LyX
29513 This makes it possible for \SpecialChar LyX
29514 to place error boxes in the right places in
29518 \begin_layout Standard
29519 The first part, the
29520 \begin_inset Quotes eld
29524 \begin_inset Quotes erd
29527 setting, should be set to
29530 \begin_layout LyX-Code
29538 \begin_layout Standard
29539 This basically means that \SpecialChar LyX
29541 \begin_inset Quotes eld
29545 \begin_inset Quotes erd
29548 (a program or script) with the name of the Noweb file (normally a file
29549 in the \SpecialChar LyX
29550 temp directory) and the directory path of the original \SpecialChar LyX
29555 \begin_layout Standard
29556 This is an implementation of
29557 \begin_inset Quotes eld
29561 \begin_inset Quotes erd
29564 that you can place in a directory on your path:
29567 \begin_layout LyX-Code
29573 \begin_layout LyX-Code
29579 \begin_layout LyX-Code
29582 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
29585 \begin_layout Standard
29586 The next part of the converter setting is the
29587 \begin_inset Quotes eld
29591 \begin_inset Quotes erd
29594 which is to be set to
29597 \begin_layout LyX-Code
29600 parselog=$$s/scripts/listerrors
29603 \begin_layout Standard
29604 This will run any errors that are generated by the
29605 \begin_inset Quotes eld
29609 \begin_inset Quotes erd
29612 process through the
29613 \begin_inset Quotes eld
29617 \begin_inset Quotes erd
29623 \begin_layout Standard
29624 The build will normally take place in \SpecialChar LyX
29625 's temporary directory, so the files
29626 produced by the conversion will be in that directory.
29628 will copy out what it regards as the `main' file, but the
29632 conversion may produce several files, and so most of these would then be
29633 deleted when \SpecialChar LyX
29635 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
29636 the build-script chunk can place the generated files in that location.
29639 \begin_layout Paragraph
29640 Build instructions in the document
29643 \begin_layout Standard
29644 The last piece of the integration between \SpecialChar LyX
29646 \begin_inset Quotes eld
29650 \begin_inset Quotes erd
29654 Generally, the instructions for building your program should be embedded
29655 in a chunk of its own.
29657 \begin_inset Quotes eld
29661 \begin_inset Quotes erd
29664 above uses the notangle command to look for this chunk (called
29665 \begin_inset Quotes eld
29669 \begin_inset Quotes erd
29672 ) and runs its contents through
29673 \begin_inset Quotes eld
29677 \begin_inset Quotes erd
29683 \begin_layout Standard
29684 Typically, such a chunk would look something like this:
29687 \begin_layout LyX-Code
29691 \begin_layout LyX-Code
29693 \begin_inset Newline newline
29696 if [ -z "${NOWEB_SOURCE}" ]
29697 \begin_inset Newline newline
29703 \begin_layout LyX-Code
29704 NOWEB_SOURCE=myfile.nw
29705 \begin_inset Newline newline
29709 \begin_inset Newline newline
29713 code to extract files ...
29714 use NOWEB_OUTPUT_DIR here ...]
29715 \begin_inset Newline newline
29719 code to compile files ...]
29720 \begin_inset Newline newline
29726 \begin_layout Standard
29729 LIBDIR/examples/listerrors.lyx
29733 LIBDIR/examples/Literate.lyx
29735 which implement two versions of the
29736 \begin_inset Quotes eld
29740 \begin_inset Quotes erd
29743 program for some illustrations of how all of these pieces go together or
29746 LIBDIR/examples/noweb2lyx.lyx.
29749 Interestingly, these three files show off the language-indepence of the
29751 literate programming support since they are written in Python, C and Perl
29755 \begin_layout Subsubsection
29756 Configuring \SpecialChar LyX
29760 \begin_layout Standard
29761 All the Literate Programming support is configured by the
29763 Tools\SpecialChar menuseparator
29767 \begin_inset Quotes eld
29771 \begin_inset Quotes erd
29775 The important parts are:
29778 \begin_layout Description
29780 \begin_inset space ~
29784 \begin_inset Quotes eld
29788 \begin_inset Quotes erd
29792 \begin_inset space ~
29795 format Set up via the File Formats tab, this is where the Noweb-specific
29805 , the file extension is set to
29810 This tells \SpecialChar LyX
29811 to create a file with a
29815 extension in the first step of the conversion process.
29818 \begin_layout Description
29820 \begin_inset space ~
29828 \begin_inset space ~
29831 format This is an empty format whose sole purpose is to be the endpoint
29832 of a conversion (which then allows us to set up a converter for it).
29835 \begin_layout Description
29845 This converter performs the
29846 \begin_inset Quotes eld
29850 \begin_inset Quotes erd
29853 of the literate document.
29854 For Noweb, it is set to
29855 \begin_inset Quotes eld
29860 noweave -delay -index $$i > $$o
29863 \begin_inset Quotes erd
29869 \begin_layout Description
29879 \begin_inset Quotes eld
29883 \begin_inset Quotes erd
29887 As stated above, the Converter is set to
29888 \begin_inset Quotes eld
29896 \begin_inset Quotes erd
29899 , with Flags set to
29900 \begin_inset Newline newline
29904 \begin_inset Quotes eld
29909 parselog=$$s/scripts/listerrors
29912 \begin_inset Quotes erd
29918 \begin_layout Subsubsection
29922 \begin_layout Standard
29923 There is also a new function implemented in the \SpecialChar LyX
29925 \begin_inset Quotes eld
29928 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
29932 \begin_layout Standard
29933 When debugging code with ddd/gdb, it is possible to invoke a text editor
29934 at the current execution position with a single key stroke.
29935 The default ddd configuration for that is shift-ctrl-V.
29936 It happens that you can define the editor command line invocation in ddd
29939 Edit\SpecialChar menuseparator
29940 Preferences\SpecialChar menuseparator
29943 dialog and changing the "Edit Sources" entry.
29946 \begin_layout Standard
29947 I take advantage of the newly created \SpecialChar LyX
29948 server function and this ddd feature,
29950 \begin_inset Quotes eld
29954 \begin_inset Quotes erd
29960 \begin_layout LyX-Code
29961 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
29964 \begin_layout Standard
29965 With this, whenever you are using ddd and find a point in the program that
29966 you want to edit, you just press shift-ctrl-V (in the ddd window), and
29967 ddd will forward this information to \SpecialChar LyX
29968 through the \SpecialChar LyX
29969 server and then the
29971 window will show the same file with the cursor at the same position ddd
29973 No more guessing or long scrolling to locate a point in the program back
29977 \begin_layout Standard
29978 Note however that you must enable the \SpecialChar LyX
29979 server to get this feature working
29980 (it is disabled by default).
29982 \begin_inset space ~
29986 \begin_inset CommandInset ref
29988 reference "sec:Starting-the-Server"
29992 explains how to do that.
29995 \begin_layout Subsubsection
29999 \begin_layout Standard
30000 There are six new buttons that can be added to your \SpecialChar LyX
30002 Four of these buttons are short cuts to layout styles:
30020 , one for the custom inset
30025 The last one is a short cut to the
30026 \begin_inset Quotes eld
30030 \begin_inset Quotes erd
30037 \begin_layout Standard
30039 has a range of buttons that are available for tool bar customization.
30040 In my toolbar I like to combine the six short cuts above with two more:
30045 \SpecialChar menuseparator
30050 \SpecialChar menuseparator
30057 Document\SpecialChar menuseparator
30058 View\SpecialChar menuseparator
30062 Here is how it looks like:
30065 \begin_layout LyX-Code
30069 \begin_layout LyX-Code
30073 \begin_layout LyX-Code
30074 Icon "layout Standard"
30077 \begin_layout LyX-Code
30078 Icon "layout Section"
30081 \begin_layout LyX-Code
30082 Icon "layout \SpecialChar LaTeX
30086 \begin_layout LyX-Code
30087 Icon "layout \SpecialChar LyX
30091 \begin_layout LyX-Code
30092 Icon "flex.insert Chunk"
30095 \begin_layout LyX-Code
30099 \begin_layout LyX-Code
30103 \begin_layout LyX-Code
30104 Icon "buffer-typeset"
30107 \begin_layout LyX-Code
30108 Icon "build-program"
30111 \begin_layout LyX-Code
30115 \begin_layout LyX-Code
30119 \begin_layout LyX-Code
30123 \begin_layout LyX-Code
30127 \begin_layout LyX-Code
30131 \begin_layout Subsubsection
30132 Colors customization
30135 \begin_layout Standard
30136 There are a number of colors in \SpecialChar LyX
30137 that can be customized in
30142 One of the things that bothers people is the \SpecialChar LaTeX
30144 The default color is red, since the chunks uses \SpecialChar LaTeX
30145 font, and there is a lot
30146 of chunks in literate documents, you may get tired of seeing everything
30148 You can change it by going to the tabs
30157 \begin_layout Standard
30158 The next thing is the visible presence of the newline character in the screen.
30159 You can choose the color of this particular character and make it blend
30161 I recommend you choosing a color that is close to the background but not
30162 equal, that way you still can see it is there, but it is not bothering
30166 \begin_layout Subsection
30171 \begin_layout Standard
30181 \change_deleted 564990737 1671643409
30187 \change_inserted 564990737 1671643443
30191 File\SpecialChar menuseparator
30192 Open Example\SpecialChar menuseparator
30193 Modules\SpecialChar menuseparator
30200 \change_deleted 564990737 1671643461
30201 the Sweave manual (menu
30203 Help\SpecialChar menuseparator
30207 \change_inserted 564990737 1671643461
30211 Help\SpecialChar menuseparator
30212 Specific Manuals\SpecialChar menuseparator
30221 \begin_layout Chapter
30223 \change_deleted 564990737 1671355343
30227 \begin_layout Standard
30229 \change_deleted 564990737 1671355343
30230 You can do everything with \SpecialChar LyX
30231 that you can do with \SpecialChar LaTeX
30233 However, \SpecialChar LyX
30234 cannot support every \SpecialChar LaTeX
30236 But you can always use \SpecialChar TeX
30238 This chapter shows you some more special things you might want to use.
30239 For other special things you can do with figures, tables, floats, boxes
30240 and notes, have a look at the
30243 \begin_inset space ~