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
13255 Multiple Text Columns
13258 \begin_layout Standard
13259 This feature is independent of the option
13261 Two-column document
13263 in the document settings under
13268 If you want to have 2
13269 \begin_inset space ~
13272 columns for the whole document, it is recommended to use the
13274 Two-column document
13277 For all other cases use this feature.
13280 \begin_layout Standard
13281 To use multiple text columns in your document, you have to load the module
13288 Document\SpecialChar menuseparator
13289 Settings\SpecialChar menuseparator
13292 ) and must have the \SpecialChar LaTeX
13294 \begin_inset Flex Code
13297 \begin_layout Plain Layout
13306 \begin_layout Standard
13307 Footnotes within multiple columns will be placed at the bottom of the page
13308 and not under each column.
13309 Within the different columns you can use everything, with the limitation
13310 that for floats you need to use the float option
13317 \begin_layout Subsection
13321 \begin_layout Standard
13322 If you want to have 2
13323 \begin_inset space ~
13326 columns in your text, insert a multicolumn inset via the menu
13328 Insert\SpecialChar menuseparator
13330 \begin_inset space ~
13333 Insets\SpecialChar menuseparator
13335 \begin_inset space ~
13340 where the columns should start.
13341 Write all text that should be printed in 2
13342 \begin_inset space ~
13345 columns into this inset.
13348 \begin_layout Standard
13349 Here is an example:
13352 \begin_layout Standard
13354 \begin_inset Flex Multiple Columns
13357 \begin_layout Plain Layout
13362 The Adventure of the Empty House
13365 \begin_inset Newline newline
13368 by Sir Arthur Conan Doyle
13371 \begin_layout Plain Layout
13374 It was in the spring of the year 1894 that all London was interested, and
13375 the fashionable world dismayed, by the murder of the Honourable Ronald
13376 Adair under most unusual and inexplicable circumstances.
13377 The public has already learned those particulars of the crime which came
13378 out in the police investigation, but a good deal was suppressed upon that
13379 occasion, since the case for the prosecution was so overwhelmingly strong
13380 that it was not necessary to bring forward all the facts.
13381 Only now, at the end of nearly ten years, am I allowed to supply those
13382 missing links which make up the whole of that remarkable chain.
13383 The crime was of interest in itself, but that interest was as nothing to
13384 me compared to the inconceivable sequel, which afforded me the greatest
13385 shock and surprise of any event in my adventurous life.
13386 Even now, after this long interval, I find myself thrilling as I think
13387 of it, and feeling once more that sudden flood of joy, amazement, and increduli
13388 ty which utterly submerged my mind.
13389 Let me say to that public, which has shown some interest in those glimpses
13390 which I have occasionally given them of the thoughts and actions of a very
13391 remarkable man, that they are not to blame me if I have not shared my knowledge
13392 with them, for I should have considered it my first duty to do so, had
13393 I not been barred by a positive prohibition from his own lips, which was
13394 only withdrawn upon the third of last month.
13402 \begin_layout Standard
13403 To get 3 or more columns, set the cursor into the multicolumn inset and
13406 Insert\SpecialChar menuseparator
13408 \begin_inset space ~
13412 \begin_inset space ~
13418 The number of the desired columns is written into that inset (for 3
13419 \begin_inset space ~
13423 \begin_inset Quotes eld
13427 \begin_inset Quotes erd
13431 \begin_inset Newline newline
13434 Here is an example with 3
13435 \begin_inset space ~
13441 \begin_layout Standard
13442 \begin_inset Flex Multiple Columns
13445 \begin_layout Plain Layout
13448 \begin_inset Argument 1
13451 \begin_layout Plain Layout
13458 It can be imagined that my close intimacy with Sherlock Holmes had interested
13459 me deeply in crime, and that after his disappearance I never failed to
13460 read with care the various problems which came before the public.
13461 And I even attempted, more than once, for my own private satisfaction,
13462 to employ his methods in their solution, though with indifferent success.
13463 There was none, however, which appealed to me like this tragedy of Ronald
13465 As I read the evidence at the inquest, which led up to a verdict of willful
13466 murder against some person or persons unknown, I realized more clearly
13467 than I had ever done the loss which the community had sustained by the
13468 death of Sherlock Holmes.
13469 There were points about this strange business which would, I was sure,
13470 have specially appealed to him, and the efforts of the police would have
13471 been supplemented, or more probably anticipated, by the trained observation
13472 and the alert mind of the first criminal agent in Europe.
13473 All day, as I drove upon my round, I turned over the case in my mind and
13474 found no explanation which appeared to me to be adequate.
13475 At the risk of telling a twice-told tale, I will recapitulate the facts
13476 as they were known to the public at the conclusion of the inquest.
13484 \begin_layout Standard
13485 You can have up to 10
13486 \begin_inset space ~
13489 columns if you want to, but that might not be very pleasant for the readers
13493 \begin_layout Standard
13494 \begin_inset Newpage newpage
13500 \begin_layout Subsection
13501 Columns inside Columns
13504 \begin_layout Standard
13505 You can also have columns inside columns:
13508 \begin_layout Standard
13509 \begin_inset Flex Multiple Columns
13512 \begin_layout Plain Layout
13515 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
13516 at that time governor of one of the Australian colonies.
13517 Adair's mother had returned from Australia to undergo the operation for
13518 cataract, and she, her son Ronald, and her daughter Hilda were living together
13522 \begin_layout Plain Layout
13523 \begin_inset Flex Multiple Columns
13526 \begin_layout Plain Layout
13529 The youth moved in the best society
13530 \begin_inset space ~
13533 – had, so far as was known, no enemies and no particular vices.
13534 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
13535 had been broken off by mutual consent some months before, and there was
13536 no sign that it had left any very profound feeling behind it.
13537 For the rest {sic} the man's life moved in a narrow and conventional circle,
13538 for his habits were quiet and his nature unemotional.
13539 Yet it was upon this easy-going young aristocrat that death came, in most
13540 strange and unexpected form, between the hours of ten and eleven-twenty
13541 on the night of March 30, 1894.
13549 \begin_layout Plain Layout
13552 Ronald Adair was fond of cards
13553 \begin_inset space ~
13556 – playing continually, but never for such stakes as would hurt him.
13557 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
13558 It was shown that, after dinner on the day of his death, he had played
13559 a rubber of whist at the latter club.
13560 He had also played there in the afternoon.
13565 The evidence of those who had played with him
13566 \begin_inset space ~
13570 Murray, Sir John Hardy, and Colonel Moran
13571 \begin_inset space ~
13574 – showed that the game was whist, and that there was a fairly equal fall
13576 Adair might have lost five pounds, but not more.
13577 His fortune was a considerable one, and such a loss could not in any way
13579 He had played nearly every day at one club or other, but he was a cautious
13580 player, and usually rose a winner.
13581 It came out in evidence that, in partnership with Colonel Moran, he had
13582 actually won as much as four hundred and twenty pounds in a sitting, some
13583 weeks before, from Godfrey Milner and Lord Balmoral.
13584 So much for his recent history as it came out at the inquest.
13592 \begin_layout Subsection
13596 \begin_layout Standard
13597 The examples in this section show some more special features of multiple
13601 \begin_layout Standard
13602 For more features of multiple columns, have a look at the
13603 \begin_inset CommandInset href
13605 name "documentation"
13606 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
13611 of the \SpecialChar LaTeX
13613 \begin_inset Flex Code
13616 \begin_layout Plain Layout
13625 \begin_layout Subsubsection
13629 \begin_layout Standard
13630 To add a preface text for multiple columns, set the cursor into the multicolumn
13631 inset and use the menu
13633 Insert\SpecialChar menuseparator
13637 Write your preface text into that inset.
13638 \begin_inset Newline newline
13641 This is an example with some preface text:
13644 \begin_layout Standard
13645 \begin_inset VSpace bigskip
13651 \begin_layout Standard
13652 \begin_inset Flex Multiple Columns
13655 \begin_layout Plain Layout
13656 \begin_inset Argument 2
13659 \begin_layout Plain Layout
13660 And the story continues and continues and continues and continues\SpecialChar ldots
13668 On the evening of the crime, he returned from the club exactly at ten.
13669 His mother and sister were out spending the evening with a relation.
13670 The servant deposed that she heard him enter the front room on the second
13671 floor, generally used as his sitting-room.
13672 She had lit a fire there, and as it smoked she had opened the window.
13673 No sound was heard from the room until eleven-twenty, the hour of the return
13674 of Lady Maynooth and her daughter.
13675 Desiring to say good-night, she attempted to enter her son's room.
13676 The door was locked on the inside, and no answer could be got to their
13677 cries and knocking.
13678 Help was obtained, and the door forced.
13679 The unfortunate young man was found lying near the table.
13680 His head had been horribly mutilated by an expanding revolver bullet, but
13681 no weapon of any sort was to be found in the room.
13689 \begin_layout Standard
13690 You can also use a section heading as the preface if you use a section command
13691 as \SpecialChar TeX
13693 For example the command
13696 \begin_layout LyX-Code
13699 subsection{subsection title}
13702 \begin_layout Standard
13703 creates a subsection.
13704 In this example the preface is a subsubsection:
13707 \begin_layout Standard
13708 \begin_inset Flex Multiple Columns
13711 \begin_layout Plain Layout
13712 \begin_inset Argument 2
13715 \begin_layout Plain Layout
13719 \begin_layout Plain Layout
13728 This is a subsubsection heading as a preface
13732 \begin_layout Plain Layout
13746 A minute examination of the circumstances served only to make the case more
13748 In the first place, no reason could be given why the young man should have
13749 fastened the door upon the inside.
13750 There was the possibility that the murderer had done this, and had afterwards
13751 escaped by the window.
13752 The drop was at least twenty feet, however, and a bed of crocuses in full
13754 Neither the flowers nor the earth showed any sign of having been disturbed,
13755 nor were there any marks upon the narrow strip of grass which separated
13756 the house from the road.
13757 Apparently, therefore, it was the young man himself who had fastened the
13759 But how did he come by his death? No one could have climbed up to the window
13760 without leaving traces.
13761 Suppose a man had fired through the window, he would indeed be a remarkable
13762 shot who could with a revolver inflict so deadly a wound.
13763 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
13764 a hundred yards of the house.
13765 No one had heard a shot.
13773 \begin_layout Standard
13774 If there is less vertical space than 6
13775 \begin_inset space ~
13778 text lines is left on the page at the beginning of the multiple columns,
13779 a page break will be inserted before the multiple columns.
13780 Depending on the number of lines of the preface text, you might want to
13782 This is done by setting the cursor into the mulitcolumn inset behind the
13783 preface (if there is any) and using the menu
13785 Insert\SpecialChar menuseparator
13787 \begin_inset space ~
13791 \begin_inset space ~
13795 \begin_inset space ~
13801 Insert into that inset the amount of space like e.
13802 \begin_inset space \thinspace{}
13806 \begin_inset space \space{}
13810 \begin_inset Quotes eld
13814 \begin_inset Quotes erd
13818 \begin_inset Newline newline
13821 In this example the space is set to 7
13822 \begin_inset space ~
13825 text lines by using
13826 \begin_inset Flex Code
13829 \begin_layout Plain Layout
13838 \begin_inset Flex Code
13841 \begin_layout Plain Layout
13849 needs to be inserted as \SpecialChar TeX
13853 \begin_layout Standard
13854 \begin_inset Flex Multiple Columns
13857 \begin_layout Plain Layout
13858 \begin_inset Argument 3
13861 \begin_layout Plain Layout
13866 \begin_layout Plain Layout
13882 On the evening of the crime, he returned from the club exactly at ten.
13883 His mother and sister were out spending the evening with a relation.
13884 The servant deposed that she heard him enter the front room on the second
13885 floor, generally used as his sitting-room.
13886 She had lit a fire there, and as it smoked she had opened the window.
13887 No sound was heard from the room until eleven-twenty, the hour of the return
13888 of Lady Maynooth and her daughter.
13889 Desiring to say good-night, she attempted to enter her son's room.
13890 The door was locked on the inside, and no answer could be got to their
13891 cries and knocking.
13892 Help was obtained, and the door forced.
13893 The unfortunate young man was found lying near the table.
13894 His head had been horribly mutilated by an expanding revolver bullet, but
13895 no weapon of any sort was to be found in the room.
13903 \begin_layout Subsubsection
13907 \begin_layout Standard
13908 The amount of space before and after multiple columns can be changed by
13909 changing the length
13910 \begin_inset Flex Code
13913 \begin_layout Plain Layout
13922 For example the command
13925 \begin_layout LyX-Code
13933 \begin_layout Standard
13934 in \SpecialChar TeX
13935 Code changes its value to 3
13936 \begin_inset space \thinspace{}
13940 The change must be made before the multiple columns' start.
13941 The predefined value is 13
13942 \begin_inset space \thinspace{}
13948 \begin_layout Standard
13950 \begin_inset Flex Code
13953 \begin_layout Plain Layout
13962 \begin_inset space \thinspace{}
13968 \begin_layout Standard
13972 \begin_layout Plain Layout
13978 multicolsep}{2.5cm}
13986 \begin_layout Standard
13987 \begin_inset Flex Multiple Columns
13990 \begin_layout Plain Layout
13993 All day I turned these facts over in my mind, endeavouring to hit upon some
13994 theory which could reconcile them all, and to find that line of least resistanc
13995 e which my poor friend had declared to be the starting-point of every investigat
13997 I confess that I made little progress.
13998 In the evening I strolled across the Park, and found myself about six o'clock
13999 at the Oxford Street end of Park Lane.
14000 A group of loafers upon the pavements, all staring up at a particular window,
14001 directed me to the house which I had come to see.
14002 A tall, thin man with coloured glasses, whom I strongly suspected of being
14003 a plain-clothes detective, was pointing out some theory of his own, while
14004 the others crowded round to listen to what he said.
14005 I got as near him as I could, but his observations seemed to me to be absurd,
14006 so I withdrew again in some disgust.
14007 As I did so I struck against an elderly, deformed man, who had been behind
14008 me, and I knocked down several books which he was carrying.
14016 \begin_layout Standard
14017 \begin_inset Note Greyedout
14020 \begin_layout Plain Layout
14025 The values you set with
14026 \begin_inset Flex Code
14029 \begin_layout Plain Layout
14037 will be used for all following multiple columns until you change them again.
14045 \begin_layout Standard
14049 \begin_layout Plain Layout
14061 \begin_inset Note Note
14064 \begin_layout Plain Layout
14065 go back to the default
14073 \begin_layout Standard
14074 \begin_inset Newpage newpage
14080 \begin_layout Subsubsection
14084 \begin_layout Standard
14085 A column break can be forced by inserting the command
14086 \begin_inset Flex Code
14089 \begin_layout Plain Layout
14097 as \SpecialChar TeX
14098 Code to that position in the text where the column should be broken.
14099 Note that this leads in most cases to whitespace in the text.
14100 \begin_inset Newline newline
14103 Here is an example:
14106 \begin_layout Standard
14107 \begin_inset Flex Multiple Columns
14110 \begin_layout Plain Layout
14113 \begin_inset Quotes eld
14116 You're surprised to see me, sir,
14117 \begin_inset Quotes erd
14120 said he, in a strange, croaking voice.
14123 \begin_layout Plain Layout
14126 I acknowledged that I was.
14129 \begin_layout Plain Layout
14132 \begin_inset Quotes eld
14135 Well, I've a conscience, sir, and when I chanced to see you go into this
14136 house, as I came hobbling after you, I thought to myself, I'll just step
14137 in and see that kind gentleman, and tell him that if I was a bit gruff
14138 in my manner there was not any harm meant, and that I am much obliged to
14139 him for picking up my books.
14140 \begin_inset Quotes erd
14146 \begin_layout Plain Layout
14149 \begin_inset Quotes eld
14152 You make too much of a trifle,
14153 \begin_inset Quotes erd
14158 \begin_inset Quotes eld
14161 May I ask how you knew who I was?
14162 \begin_inset Quotes erd
14165 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
14169 \begin_layout Plain Layout
14181 \begin_layout Plain Layout
14184 \begin_inset Quotes eld
14187 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
14188 you'll find my little bookshop at the corner of Church Street, and very
14189 happy to see you, I am sure.
14190 Maybe you collect yourself, sir.
14194 \begin_inset space ~
14208 \begin_inset space ~
14211 – a bargain, every one of them.
14212 With five volumes you could just fill that gap on that second shelf.
14213 It looks untidy, does it not, sir?
14214 \begin_inset Quotes erd
14225 \begin_layout Subsubsection
14229 \begin_layout Standard
14230 The width of the columns is automatically calculated, but you can modify
14231 the space between the columns.
14232 This is done by changing the length
14233 \begin_inset Flex Code
14236 \begin_layout Plain Layout
14245 Its predefined value is 10
14246 \begin_inset space \thinspace{}
14250 Here is an example where
14251 \begin_inset Flex Code
14254 \begin_layout Plain Layout
14263 \begin_inset space \thinspace{}
14269 \begin_layout Standard
14273 \begin_layout Plain Layout
14287 \begin_layout Standard
14288 \begin_inset Flex Multiple Columns
14291 \begin_layout Plain Layout
14294 My observations of No.
14295 \begin_inset space \space{}
14298 427 Park Lane did little to clear up the problem in which I was interested.
14299 The house was separated from the street by a low wall and railing, the
14300 whole not more than five feet high.
14301 It was perfectly easy, therefore, for anyone to get into the garden, but
14302 the window was entirely inaccessible, since there was no water pipe or
14303 anything which could help the most active man to climb it.
14304 More puzzled than ever, I retraced my steps to Kensington.
14305 I had not been in my study five minutes when the maid entered to say that
14306 a person desired to see me.
14307 To my astonishment it was none other than my strange old book collector,
14308 his sharp, wizened face peering out from a frame of white hair, and his
14309 precious volumes, a dozen of them at least, wedged under his right arm.
14317 \begin_layout Standard
14321 \begin_layout Plain Layout
14333 \begin_inset Note Note
14336 \begin_layout Plain Layout
14337 go back to the default
14345 \begin_layout Subsubsection
14349 \begin_layout Standard
14350 Between the columns a rule with a width of the length
14351 \begin_inset Flex Code
14354 \begin_layout Plain Layout
14363 If this rule width is set to 0
14364 \begin_inset space \thinspace{}
14367 pt (this is the default), the rule is suppressed.
14368 In the following example the rule is 2
14369 \begin_inset space \thinspace{}
14375 \begin_layout Standard
14379 \begin_layout Plain Layout
14385 columnseprule}{2pt}
14393 \begin_layout Standard
14394 \begin_inset Flex Multiple Columns
14397 \begin_layout Plain Layout
14400 \begin_inset Quotes eld
14403 You're surprised to see me, sir,
14404 \begin_inset Quotes erd
14407 said he, in a strange, croaking voice.
14410 \begin_layout Plain Layout
14413 I acknowledged that I was.
14416 \begin_layout Plain Layout
14419 \begin_inset Quotes eld
14422 Well, I've a conscience, sir, and when I chanced to see you go into this
14423 house, as I came hobbling after you, I thought to myself, I'll just step
14424 in and see that kind gentleman, and tell him that if I was a bit gruff
14425 in my manner there was not any harm meant, and that I am much obliged to
14426 him for picking up my books.
14427 \begin_inset Quotes erd
14433 \begin_layout Plain Layout
14436 \begin_inset Quotes eld
14439 You make too much of a trifle,
14440 \begin_inset Quotes erd
14445 \begin_inset Quotes eld
14448 May I ask how you knew who I was?
14449 \begin_inset Quotes erd
14455 \begin_layout Plain Layout
14458 \begin_inset Quotes eld
14461 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
14462 you'll find my little bookshop at the corner of Church Street, and very
14463 happy to see you, I am sure.
14464 Maybe you collect yourself, sir.
14468 \begin_inset space ~
14482 \begin_inset space ~
14485 – a bargain, every one of them.
14486 With five volumes you could just fill that gap on that second shelf.
14487 It looks untidy, does it not, sir?
14488 \begin_inset Quotes erd
14499 \begin_layout Standard
14500 \begin_inset VSpace defskip
14506 \begin_layout Standard
14507 The rule can be colored by redefining the command
14508 \begin_inset Flex Code
14511 \begin_layout Plain Layout
14520 This is done by inserting the command
14523 \begin_layout LyX-Code
14528 columnseprulecolor}{
14533 \begin_layout Standard
14534 as \SpecialChar TeX
14535 Code before the multicolumn inset.
14537 \begin_inset Flex Code
14540 \begin_layout Plain Layout
14546 in this command by a color of your choice.
14547 You can use all pre- and self-defined colors.
14555 \begin_inset space ~
14560 for more information about pre- and self-defined colors.
14561 To go back to the default color insert the command
14564 \begin_layout LyX-Code
14569 columnseprulecolor}{
14574 \begin_layout Standard
14575 Here is the example with a cyan rule and 1
14576 \begin_inset space \thinspace{}
14579 cm column separation:
14582 \begin_layout Standard
14586 \begin_layout Plain Layout
14595 \begin_layout Plain Layout
14601 columnseprulecolor}{
14611 \begin_layout Standard
14612 \begin_inset Flex Multiple Columns
14615 \begin_layout Plain Layout
14618 \begin_inset Quotes eld
14621 You're surprised to see me, sir,
14622 \begin_inset Quotes erd
14625 said he, in a strange, croaking voice.
14628 \begin_layout Plain Layout
14631 I acknowledged that I was.
14634 \begin_layout Plain Layout
14637 \begin_inset Quotes eld
14640 Well, I've a conscience, sir, and when I chanced to see you go into this
14641 house, as I came hobbling after you, I thought to myself, I'll just step
14642 in and see that kind gentleman, and tell him that if I was a bit gruff
14643 in my manner there was not any harm meant, and that I am much obliged to
14644 him for picking up my books.
14645 \begin_inset Quotes erd
14651 \begin_layout Plain Layout
14654 \begin_inset Quotes eld
14657 You make too much of a trifle,
14658 \begin_inset Quotes erd
14663 \begin_inset Quotes eld
14666 May I ask how you knew who I was?
14667 \begin_inset Quotes erd
14673 \begin_layout Plain Layout
14676 \begin_inset Quotes eld
14679 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
14680 you'll find my little bookshop at the corner of Church Street, and very
14681 happy to see you, I am sure.
14682 Maybe you collect yourself, sir.
14686 \begin_inset space ~
14700 \begin_inset space ~
14703 – a bargain, every one of them.
14704 With five volumes you could just fill that gap on that second shelf.
14705 It looks untidy, does it not, sir?
14706 \begin_inset Quotes erd
14717 \begin_layout Standard
14721 \begin_layout Plain Layout
14727 columnseprule}{0pt}
14730 \begin_layout Plain Layout
14736 columnseprulecolor}{
14744 \begin_inset Note Note
14747 \begin_layout Plain Layout
14748 go back to the default
14756 \begin_layout Section
14758 \change_inserted 564990737 1671270380
14762 \begin_layout Subsection
14764 \change_inserted 564990737 1671270398
14766 \change_deleted 564990737 1671270396
14772 \begin_layout Standard
14775 as well as any other text processor uses by default rectangular paragraphs.
14776 For special cases like for example posters, invitation cards or poems you
14777 can modify the paragraph shape to one of your choice.
14778 This can be done by using the \SpecialChar LaTeX
14780 \begin_inset Flex Code
14783 \begin_layout Plain Layout
14789 which is loaded by using in the document settings the module
14791 Custom paragraph shapes
14796 \begin_layout Subsubsection
14800 \begin_layout Standard
14805 provides the following shapes:
14808 \begin_layout Standard
14809 \begin_inset Tabular
14810 <lyxtabular version="3" rows="13" columns="3">
14811 <features booktabs="true" islongtable="true" longtabularalignment="center">
14812 <column alignment="left" valignment="middle" width="16col%">
14813 <column alignment="left" valignment="middle" width="40col%">
14814 <column alignment="left" valignment="middle" width="35col%">
14815 <row endhead="true">
14816 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
14819 \begin_layout Plain Layout
14828 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
14831 \begin_layout Plain Layout
14840 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
14843 \begin_layout Plain Layout
14853 <row interlinespace="default">
14854 <cell alignment="left" valignment="top" usebox="none">
14857 \begin_layout Plain Layout
14865 <cell alignment="left" valignment="top" usebox="none">
14868 \begin_layout Plain Layout
14871 Circle with circular hole (in the size of a CD/DVD)
14876 <cell alignment="left" valignment="top" usebox="none">
14879 \begin_layout Plain Layout
14882 Cannot be scaled, take care there is not too much text
14888 <row interlinespace="default">
14889 <cell alignment="left" valignment="top" usebox="none">
14892 \begin_layout Plain Layout
14900 <cell alignment="left" valignment="top" usebox="none">
14903 \begin_layout Plain Layout
14911 <cell alignment="left" valignment="top" usebox="none">
14914 \begin_layout Plain Layout
14917 Fragile, calculation might fail
14923 <row interlinespace="default">
14924 <cell alignment="left" valignment="top" usebox="none">
14927 \begin_layout Plain Layout
14935 <cell alignment="left" valignment="top" usebox="none">
14938 \begin_layout Plain Layout
14941 Rhomboid (symbolizing a
14942 \begin_inset Quotes eld
14946 \begin_inset Quotes erd
14954 <cell alignment="left" valignment="top" usebox="none">
14957 \begin_layout Plain Layout
14966 <row interlinespace="default">
14967 <cell alignment="left" valignment="top" usebox="none">
14970 \begin_layout Plain Layout
14978 <cell alignment="left" valignment="top" usebox="none">
14981 \begin_layout Plain Layout
14989 <cell alignment="left" valignment="top" usebox="none">
14992 \begin_layout Plain Layout
15001 <row interlinespace="default">
15002 <cell alignment="left" valignment="top" usebox="none">
15005 \begin_layout Plain Layout
15013 <cell alignment="left" valignment="top" usebox="none">
15016 \begin_layout Plain Layout
15024 <cell alignment="left" valignment="top" usebox="none">
15027 \begin_layout Plain Layout
15036 <row interlinespace="default">
15037 <cell alignment="left" valignment="top" usebox="none">
15040 \begin_layout Plain Layout
15048 <cell alignment="left" valignment="top" usebox="none">
15051 \begin_layout Plain Layout
15054 Nut for bolt (hexagon with circular hole)
15059 <cell alignment="left" valignment="top" usebox="none">
15062 \begin_layout Plain Layout
15071 <row interlinespace="default">
15072 <cell alignment="left" valignment="top" usebox="none">
15075 \begin_layout Plain Layout
15083 <cell alignment="left" valignment="top" usebox="none">
15086 \begin_layout Plain Layout
15094 <cell alignment="left" valignment="top" usebox="none">
15097 \begin_layout Plain Layout
15106 <row interlinespace="default">
15107 <cell alignment="left" valignment="top" usebox="none">
15110 \begin_layout Plain Layout
15118 <cell alignment="left" valignment="top" usebox="none">
15121 \begin_layout Plain Layout
15129 <cell alignment="left" valignment="top" usebox="none">
15132 \begin_layout Plain Layout
15141 <row interlinespace="default">
15142 <cell alignment="left" valignment="top" usebox="none">
15145 \begin_layout Plain Layout
15153 <cell alignment="left" valignment="top" usebox="none">
15156 \begin_layout Plain Layout
15164 <cell alignment="left" valignment="top" usebox="none">
15167 \begin_layout Plain Layout
15176 <row interlinespace="default">
15177 <cell alignment="left" valignment="top" usebox="none">
15180 \begin_layout Plain Layout
15188 <cell alignment="left" valignment="top" usebox="none">
15191 \begin_layout Plain Layout
15194 Normal/reversed rain drop
15199 <cell alignment="left" valignment="top" usebox="none">
15202 \begin_layout Plain Layout
15205 Fragile, calculation might fail
15211 <row interlinespace="default">
15212 <cell alignment="left" valignment="top" usebox="none">
15215 \begin_layout Plain Layout
15224 <cell alignment="left" valignment="top" usebox="none">
15227 \begin_layout Plain Layout
15230 The \SpecialChar TeX
15236 <cell alignment="left" valignment="top" usebox="none">
15239 \begin_layout Plain Layout
15248 <row interlinespace="default">
15249 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
15252 \begin_layout Plain Layout
15256 \begin_inset Newline newline
15264 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
15267 \begin_layout Plain Layout
15270 Triangles in different orientations
15275 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
15278 \begin_layout Plain Layout
15294 \begin_layout Standard
15295 To use a shape for your paragraph, simply select it in \SpecialChar LyX
15297 for environments in the toolbar.
15300 \begin_layout Standard
15301 \begin_inset Newpage newpage
15307 \begin_layout Standard
15308 Here is an example paragraph in the shape of a nut:
15311 \begin_layout Standard
15312 \begin_inset VSpace bigskip
15321 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
15322 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
15324 At vero eos et accusam et justo duo dolores et ea rebum.
15325 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
15327 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
15328 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
15332 \begin_layout Standard
15333 \begin_inset VSpace bigskip
15339 \begin_layout Standard
15340 \begin_inset Note Greyedout
15343 \begin_layout Plain Layout
15352 paragraphs cannot run over a page break.
15360 \begin_layout Standard
15361 \begin_inset VSpace bigskip
15367 \begin_layout Standard
15369 \begin_inset Flex Code
15372 \begin_layout Plain Layout
15378 takes care that the shape will always be preserved, no matter how much
15379 text is in the paragraph.
15380 Therefore the paragraph size changes with the amount of contained text.
15381 This can lead to paragraph sizes exceeding the page margins.
15382 To demonstrate the size scaling, here is the same example paragraph but
15383 with twice as much text:
15386 \begin_layout Standard
15387 \begin_inset Newpage newpage
15396 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
15397 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
15399 At vero eos et accusam et justo duo dolores et ea rebum.
15400 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
15402 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
15403 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
15405 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
15406 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
15408 At vero eos et accusam et justo duo dolores et ea rebum.
15409 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
15411 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
15412 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
15416 \begin_layout Standard
15417 \begin_inset VSpace bigskip
15423 \begin_layout Standard
15424 An exception is the shape
15429 It cannot be scaled because it must fit the size of a CD/DVD.
15430 Therefore the amount of text that fits into the shape is limited.
15431 \begin_inset Newline newline
15442 shape are fragile, meaning that the calculation of their size can fail,
15443 depending on the amount of text.
15444 You will then get the \SpecialChar LaTeX
15446 \begin_inset Quotes eld
15449 Arithmetic overflow
15450 \begin_inset Quotes erd
15454 In this case one can try to remove or add some text; if nothing works one
15455 has to use another shape.
15458 \begin_layout Standard
15459 \begin_inset VSpace bigskip
15465 \begin_layout Standard
15466 For shapes with tips you will maybe see that \SpecialChar LaTeX
15467 's hyphenation routine fails
15468 for text in the tips.
15469 Therefore it is often necessary to add hyphenation points
15474 arg "specialchar-insert hyphenation"
15479 ) to the corresponding text parts.
15482 \begin_layout Standard
15483 \begin_inset VSpace bigskip
15489 \begin_layout Standard
15490 Shapepar paragraphs are either always centered or placed on the page so
15491 that their left border touches the left page margin.
15492 You can therefore not use the paragraph dialog to align such paragraphs.
15493 A solution is to put the paragraph into a minipage or parbox and align
15495 The problem is hereby to find the right width for the box.
15496 Because if it is too wide and you center the box, the paragraph is not
15497 centered too because it sticks at the left side of the box.
15498 So you might have to play a bit with the width until it fits.
15499 Here are two heart-shaped paragraphs, the first one is not aligned, the
15500 second one is right-aligned:
15503 \begin_layout Standard
15504 \begin_inset Newpage newpage
15510 \begin_layout Heart
15514 Lo\SpecialChar softhyphen
15515 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
15516 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
15518 At vero eos et accusam et justo duo dolores et ea rebum.
15519 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
15523 \begin_layout Standard
15524 \begin_inset VSpace bigskip
15530 \begin_layout Standard
15533 \begin_inset Box Frameless
15543 height_special "totalheight"
15548 backgroundcolor "none"
15551 \begin_layout Heart
15555 Lo\SpecialChar softhyphen
15556 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
15557 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
15559 At vero eos et accusam et justo duo dolores et ea rebum.
15560 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
15569 \begin_layout Subsubsection
15573 \begin_layout Standard
15574 You can define any shape you want.
15575 Doing this manually is a lot of work because every coordinate must be specified.
15576 But there is a way to let the computer calculate the coordinates:
15579 \begin_layout Enumerate
15580 Install the program
15581 \begin_inset CommandInset href
15584 target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
15592 \begin_layout Enumerate
15599 TeX/LaTeX\SpecialChar menuseparator
15600 Settings\SpecialChar menuseparator
15603 and select the font size you are using in your document.
15604 For example this document uses the size 12
15605 \begin_inset space \thinspace{}
15611 \begin_layout Enumerate
15615 \begin_layout Enumerate
15618 TeX/LaTeX\SpecialChar menuseparator
15621 to export the shape to coordinates.
15622 In the appearing dialog use either the outline of your shape for the coordinate
15623 s or the path itself.
15627 \begin_layout Plain Layout
15628 For more information see
15629 \begin_inset CommandInset href
15631 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
15644 \begin_layout Standard
15645 The coordinates are written into a \SpecialChar TeX
15647 To use it for your \SpecialChar LyX
15651 \begin_layout Enumerate
15652 Place the cursor before the first character of your paragraph (or into a
15656 \begin_layout Enumerate
15657 Open in \SpecialChar LyX
15660 Insert\SpecialChar menuseparator
15661 File\SpecialChar menuseparator
15663 \begin_inset space ~
15668 , select the file and use
15677 \begin_layout Standard
15678 \begin_inset VSpace defskip
15684 \begin_layout Standard
15685 \begin_inset Note Greyedout
15688 \begin_layout Plain Layout
15693 : The changed shape only applies to the current paragraph; everything is
15694 reset to normal for the next paragraph.
15695 Therefore the shape definition file must be input into every paragraph
15696 with the desired shape.
15704 \begin_layout Standard
15705 \begin_inset VSpace bigskip
15711 \begin_layout Standard
15712 Here is an example:
15715 \begin_layout Standard
15716 \begin_inset VSpace bigskip
15722 \begin_layout Standard
15723 \begin_inset CommandInset include
15725 filename "SpecialParagraphShape.tex"
15732 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
15733 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
15735 At vero eos et accusam et justo duo dolores et ea rebum.
15736 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
15738 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
15739 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
15743 \begin_layout Standard
15744 \begin_inset VSpace bigskip
15750 \begin_layout Standard
15755 to draw complexer shapes in
15759 you can draw the shape in a program of your choice and import the resulting
15765 Then you only need to draw a line or spline along the outline of the image.
15768 \begin_layout Standard
15769 \begin_inset VSpace bigskip
15775 \begin_layout Standard
15778 Custom paragraph shapes
15780 also provides the two commands
15788 which can be used to define custom shapes coordinate by coordinate.
15792 \begin_layout Plain Layout
15793 These commands are internally used for all shapes described here.
15798 For information how these styles are used and about further customization
15799 possibilities, have a look at the
15800 \begin_inset CommandInset href
15802 name "documentation"
15803 target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
15809 \begin_inset Flex Code
15812 \begin_layout Plain Layout
15821 \begin_layout Chapter
15823 \change_deleted 564990737 1671304317
15827 \change_inserted 564990737 1671304322
15829 \change_deleted 564990737 1671304331
15830 ies with Bib\SpecialChar TeX
15836 \begin_layout Standard
15837 The most basic information about how to use Bib\SpecialChar TeX
15842 with \SpecialChar LyX
15843 is contained in the section
15845 Bibliography databases
15852 The following subsections explain special bibliography features supported
15853 by \SpecialChar LyX
15857 \begin_layout Section
15858 Alternative Citation Styles
15861 \begin_layout Standard
15862 Standard Bib\SpecialChar TeX
15864 \begin_inset space \thinspace{}
15868 \begin_inset space \space{}
15872 \begin_inset Quotes eld
15876 \begin_inset Quotes erd
15879 ) to refer to a cited work.
15880 However, in many scientific disciplines, other citation styles are in use.
15881 The most common one is the author-year style (e.
15882 \begin_inset space \thinspace{}
15886 \begin_inset space \space{}
15890 \begin_inset Quotes eld
15894 \begin_inset Quotes erd
15899 supports three packages that provide this style,
15900 \begin_inset Flex Code
15903 \begin_layout Plain Layout
15910 \begin_inset Flex Code
15913 \begin_layout Plain Layout
15920 \begin_inset Flex Code
15923 \begin_layout Plain Layout
15930 Each of these packages has their pros and cons, which cannot be listed
15932 If you only want to have simple author-year (or author-numerical) style,
15933 or if you want to use one of the countless style files for
15934 \begin_inset Flex Code
15937 \begin_layout Plain Layout
15943 , then the established
15944 \begin_inset Flex Code
15947 \begin_layout Plain Layout
15953 package is probably your choice.
15954 If you look for specific citation styles common in law studies, you might
15956 \begin_inset Flex Code
15959 \begin_layout Plain Layout
15966 If you want to have full control over the formatting or look for advanced
15967 features such as ibidem, footnote citations, full title citations, advanced
15968 date formats (such as 400 BC) or full localization to other languages than
15969 English, you should definitely consider
15970 \begin_inset Flex Code
15973 \begin_layout Plain Layout
15979 , which exceeds all other packages in terms of features, but is also quite
15980 heavy and more resource-hungry.
15983 \begin_layout Standard
15984 The handling of these packages in \SpecialChar LyX
15985 is basically the same.
15987 \begin_inset Flex Noun
15990 \begin_layout Plain Layout
15991 Document\SpecialChar menuseparator
15998 \begin_inset Flex Noun
16001 \begin_layout Plain Layout
16008 \begin_inset Flex Noun
16011 \begin_layout Plain Layout
16018 \begin_inset Flex Noun
16021 \begin_layout Plain Layout
16028 \begin_inset Flex Noun
16031 \begin_layout Plain Layout
16038 \begin_inset Flex Noun
16041 \begin_layout Plain Layout
16042 Biblatex (Natbib mode)
16048 \begin_inset Flex Noun
16051 \begin_layout Plain Layout
16058 \begin_inset Flex Noun
16061 \begin_layout Plain Layout
16068 \begin_inset space ~
16071 6.5.3 in the User's Guide for more information on these choices).
16072 With all these packages, you will get some extra features in the citation
16073 dialog and you can select the style of the reference (
16074 \begin_inset Quotes eld
16078 \begin_inset Quotes erd
16082 \begin_inset Quotes eld
16086 \begin_inset Quotes erd
16090 \begin_inset Quotes eld
16094 \begin_inset Quotes erd
16098 \begin_inset Quotes eld
16102 \begin_inset Quotes erd
16106 Note that either package needs specifically designed style files.
16107 They all ship their own, but there are lots of additional style files,
16108 and there is even an interactive style file builder
16112 \begin_layout Plain Layout
16114 \begin_inset Flex URL
16117 \begin_layout Plain Layout
16119 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
16130 \begin_inset Flex Code
16133 \begin_layout Plain Layout
16142 \begin_layout Section
16143 Subdivided Bibliographies
16146 \begin_layout Standard
16147 Sometimes you might need to divide your bibliography into several sections.
16148 If you are for instance a historian, the possibility to separate sources
16149 and scientific works is most likely a
16150 \begin_inset Quotes eld
16154 \begin_inset Quotes erd
16158 Unfortunately, Bib\SpecialChar TeX
16159 itself does not allow you to do this.
16160 But with the help of some \SpecialChar LaTeX
16161 packages, Bib\SpecialChar TeX
16162 can be extended to fit your needs.
16165 \begin_layout Standard
16167 provides native support for one of these packages,
16175 \begin_layout Plain Layout
16177 \begin_inset Flex URL
16180 \begin_layout Plain Layout
16182 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
16192 The advantage of this package (compared to other packages such as
16196 ) is that you don't need to define new citation commands.
16197 Instead, you need to prepare different bibliographic databases which include
16198 the entries for the different sections of the bibliography.
16199 For example: If you want to divide your bibliography into the sections
16201 \begin_inset Quotes eld
16205 \begin_inset Quotes erd
16209 \begin_inset Quotes eld
16213 \begin_inset Quotes erd
16216 , you first need to create two bibliographic databases, e.
16217 \begin_inset space \thinspace{}
16221 \begin_inset space \space{}
16225 \begin_inset Flex Code
16228 \begin_layout Plain Layout
16235 \begin_inset Flex Code
16238 \begin_layout Plain Layout
16248 \begin_layout Standard
16250 \begin_inset Flex Noun
16253 \begin_layout Plain Layout
16254 Document\SpecialChar menuseparator
16261 \begin_inset Flex Noun
16264 \begin_layout Plain Layout
16271 \begin_inset Flex Noun
16274 \begin_layout Plain Layout
16275 Subdivided bibliography
16281 Now you can insert multiple Bib\SpecialChar TeX
16282 bibliographies, one for each section of
16284 Returning to our example: Insert the Bib\SpecialChar TeX
16286 \begin_inset Flex Code
16289 \begin_layout Plain Layout
16295 and a second one for the database
16296 \begin_inset Flex Code
16299 \begin_layout Plain Layout
16306 You are free to use the same or different styles for each section.
16307 Additionally, you can choose if the bibliography section should contain
16309 \begin_inset Quotes eld
16312 all cited references
16313 \begin_inset Quotes erd
16316 of the specified database(s) (which is the default),
16317 \begin_inset Quotes eld
16320 all uncited references
16321 \begin_inset Quotes erd
16325 \begin_inset Quotes eld
16329 \begin_inset Quotes erd
16333 This might be useful if you would like to separate your bibliography into
16335 \begin_inset Quotes eld
16339 \begin_inset Quotes erd
16343 \begin_inset Quotes eld
16347 \begin_inset Quotes erd
16351 \begin_inset Quotes eld
16355 \begin_inset Quotes erd
16359 The titles for the sections can be added as ordinary sections or subsections.
16361 \begin_inset Flex Code
16364 \begin_layout Plain Layout
16370 removes the bibliography title, you have to manually re-add that, too (as
16371 a chapter* or section*, for instance).
16374 \begin_layout Standard
16379 , the procedure is a bit different.
16388 , the aforementioned
16389 \begin_inset Flex Noun
16392 \begin_layout Plain Layout
16393 Subdivided bibliography
16398 option is disabled if you use
16407 provides its own means to generate subdivided bibliographies.
16408 You can either add keywords to bibliography entries via the
16409 \begin_inset Flex Code
16412 \begin_layout Plain Layout
16418 entry option and then filter bibliography sections by keyword (by adding
16420 \begin_inset Flex Code
16423 \begin_layout Plain Layout
16430 \begin_inset Flex Noun
16433 \begin_layout Plain Layout
16439 field of the dialog that opens if you left-click on the
16440 \begin_inset Flex Noun
16443 \begin_layout Plain Layout
16444 Biblatex Generated Bibliography
16449 button), or you can filter by entry types (such as
16458 \begin_inset space \thinspace{}
16463 \begin_inset Flex Code
16466 \begin_layout Plain Layout
16473 \begin_inset Flex Code
16476 \begin_layout Plain Layout
16483 \begin_inset Flex Noun
16486 \begin_layout Plain Layout
16492 field, or you can create so-called
16493 \begin_inset Quotes eld
16496 Bibliography Categories
16497 \begin_inset Quotes erd
16500 to which you can assign individual entries.
16501 Please refer to the Biblatex manual, section
16503 Subdivided Bibliographies
16508 \begin_layout Section
16509 Multiple Bibliographies
16510 \begin_inset CommandInset label
16512 name "subsec:Multiple-Bibliographies"
16519 \begin_layout Standard
16520 Multiple bibliographies, e.
16521 \begin_inset space \thinspace{}
16525 \begin_inset space \space{}
16528 a bibliography for each part, chapter, section, subsection or child (sub-documen
16529 t) of the document, are also supported by \SpecialChar LyX
16531 In order to enable it, go to
16532 \begin_inset Flex Noun
16535 \begin_layout Plain Layout
16536 Document\SpecialChar menuseparator
16537 Settings\SpecialChar menuseparator
16543 and select the relevant unit (e.
16544 \begin_inset space \thinspace{}
16548 \begin_inset Quotes eld
16552 \begin_inset Quotes erd
16556 \begin_inset Flex Noun
16559 \begin_layout Plain Layout
16560 Multiple Bibliographies
16566 Then add a Bib(la)\SpecialChar TeX
16567 bibliography to each unit (e.
16568 \begin_inset space \thinspace{}
16571 g., section) of your document.
16572 In the output, a separate bibliography, containing only the references
16573 done in the current unit is generated.
16576 \begin_layout Standard
16577 If you use Bib\SpecialChar TeX
16579 \begin_inset Flex Code
16582 \begin_layout Plain Layout
16589 \begin_inset Flex Code
16592 \begin_layout Plain Layout
16598 package is used to create multiple bibliographies.
16599 The former package is used if you select
16600 \begin_inset Quotes eld
16604 \begin_inset Quotes erd
16612 \begin_inset Flex Noun
16615 \begin_layout Plain Layout
16616 Sectioned Bibliography
16622 In all other cases,
16623 \begin_inset Flex Code
16626 \begin_layout Plain Layout
16636 \begin_layout Plain Layout
16637 An alternative approach, if you are willing to use some
16638 \begin_inset Flex Noun
16641 \begin_layout Plain Layout
16649 \begin_inset space ~
16653 \begin_inset CommandInset ref
16655 reference "sec:Inserting-TeX-Code"
16660 \begin_inset Flex Code
16663 \begin_layout Plain Layout
16675 \begin_inset Flex Code
16678 \begin_layout Plain Layout
16684 is used, \SpecialChar LyX
16685 encloses the specified units in
16686 \begin_inset Flex Code
16689 \begin_layout Plain Layout
16696 \begin_inset Flex Code
16699 \begin_layout Plain Layout
16708 \begin_inset Flex Code
16711 \begin_layout Plain Layout
16719 in order to create the units.
16720 Note that this approach has some limitations.
16721 First, every citation reference has to be inside some
16722 \begin_inset Flex Code
16725 \begin_layout Plain Layout
16732 So citations outside a defined unit (e.
16733 \begin_inset space \thinspace{}
16736 g., before the first section if you use
16737 \begin_inset Quotes eld
16741 \begin_inset Quotes erd
16745 \begin_inset Quotes eld
16749 \begin_inset Quotes erd
16753 You can also create your own units by entering
16754 \begin_inset Flex Code
16757 \begin_layout Plain Layout
16766 \begin_inset Flex Code
16769 \begin_layout Plain Layout
16777 as \SpecialChar TeX
16778 code (for instance to work around the mentioned limitation).
16780 \begin_inset Flex Code
16783 \begin_layout Plain Layout
16789 s cannot be nested.
16790 A second limitation is that
16791 \begin_inset Flex Code
16794 \begin_layout Plain Layout
16800 always processes all references of a bibliography database, even if they
16802 This can result in odd labels (e.
16803 \begin_inset space \thinspace{}
16808 \begin_inset Quotes eld
16812 \begin_inset Quotes erd
16815 if two works of this author from 2014 are in the database, even if only
16819 \begin_layout Standard
16825 \begin_inset Flex Code
16828 \begin_layout Plain Layout
16834 option is used instead.
16835 If you need specific units, you can start them with the \SpecialChar TeX
16837 \begin_inset Flex Code
16840 \begin_layout Plain Layout
16849 \begin_inset Flex Code
16852 \begin_layout Plain Layout
16861 If you also want to control the end of the unit, use the environment
16862 \begin_inset Flex Code
16865 \begin_layout Plain Layout
16875 \begin_inset Flex Code
16878 \begin_layout Plain Layout
16888 \begin_inset Flex Code
16891 \begin_layout Plain Layout
16897 s cannot be nested.
16898 In addition to the individual bibliography of the current unit,
16902 also provides an easy way to output all bibliographies, subsequently, at
16904 \begin_inset space \thinspace{}
16907 g., at the end of the document).
16909 \begin_inset Quotes eld
16912 all reference units
16913 \begin_inset Quotes erd
16916 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve
16918 Please refer to the
16922 manual for more information on this topic.
16925 \begin_layout Chapter
16927 \change_deleted 564990737 1671355654
16931 \change_inserted 564990737 1671355667
16933 \change_deleted 564990737 1671355661
16935 \change_inserted 564990737 1671355684
16937 \begin_inset CommandInset label
16939 name "chap:bullets"
16944 \change_deleted 564990737 1671355684
16946 \begin_inset CommandInset label
16957 \begin_layout Standard
16963 \begin_layout Section
16967 \begin_layout Standard
16969 provides 216 bullet shapes that can be accessed from a simple dialog.
16970 Using this dialog you can easily specify what bullet shape to use at each
16971 level of an itemized list.
16972 These settings are document-wide so you won't be able to specify different
16973 sets of bullets for different paragraphs.
16977 \begin_layout Plain Layout
16978 Well, actually you can but you'll have to do it by hand.
16986 \begin_layout Section
16990 \begin_layout Standard
16991 Open the dialog by selecting the
16992 \begin_inset Flex Noun
16995 \begin_layout Plain Layout
16996 Document\SpecialChar menuseparator
17002 menu item and then select the
17003 \begin_inset Flex Noun
17006 \begin_layout Plain Layout
17015 \begin_layout Standard
17016 The dialog provides you with a table of bullet shapes.
17017 A column of buttons on the left of the table provides access to the six
17018 different panels of bullet shapes.
17019 The row of buttons across the top is used to select which bullet depth
17022 \change_deleted 244031559 1603875981
17023 A text entry under the table shows the currently selected bullet shape's
17025 equivalent and this can be edited if desired.
17026 If you do modify the text you will also need to specify any needed packages
17027 in the \SpecialChar LaTeX
17033 \begin_layout Standard
17034 The six panels are divided up by the packages they require.
17035 The following table shows the mappings from button name to \SpecialChar LaTeX
17039 \begin_layout Standard
17041 \begin_inset Tabular
17042 <lyxtabular version="3" rows="7" columns="2">
17043 <features tabularvalignment="middle">
17044 <column alignment="center" valignment="top" width="0pt">
17045 <column alignment="center" valignment="top" width="0pt">
17047 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
17050 \begin_layout Plain Layout
17065 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
17068 \begin_layout Plain Layout
17085 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
17088 \begin_layout Plain Layout
17103 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
17106 \begin_layout Plain Layout
17115 base \SpecialChar LaTeX
17123 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
17126 \begin_layout Plain Layout
17141 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
17144 \begin_layout Plain Layout
17161 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
17164 \begin_layout Plain Layout
17179 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
17182 \begin_layout Plain Layout
17199 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
17202 \begin_layout Plain Layout
17217 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
17220 \begin_layout Plain Layout
17237 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
17240 \begin_layout Plain Layout
17255 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
17258 \begin_layout Plain Layout
17275 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
17278 \begin_layout Plain Layout
17293 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
17296 \begin_layout Plain Layout
17319 \begin_layout Standard
17321 doesn't stop you using bullets from packages you don't have.
17322 If you get errors from \SpecialChar LaTeX
17323 when you try to view or print the file, then it
17324 is likely you are missing a package.
17328 \begin_layout Plain Layout
17330 doesn't restrict your use since you may be editing locally and exporting
17339 \begin_layout Section
17343 \begin_layout Standard
17344 Select which bullet depth you want to change then select the bullet shape
17346 Any changes will not be visible in \SpecialChar LyX
17347 , but are visible when viewing the document.
17350 \begin_layout Standard
17351 You can reset a bullet shape to the default simply by clicking your right
17352 mouse button on the appropriate bullet depth button.
17356 \begin_layout Plain Layout
17361 want to have multiple sets of paragraphs with different sets of bullets
17362 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
17364 The bullet selection dialog can help though because it provides you with
17365 the \SpecialChar LaTeX
17366 code for a wide range of bullet shapes.
17367 To make your own custom paragraphs you have the following options:
17370 \begin_layout Plain Layout
17374 \begin_layout Plain Layout
17390 \begin_layout Plain Layout
17394 \begin_layout Plain Layout
17416 \begin_layout Itemize
17417 Use the \SpecialChar LaTeX
17419 \begin_inset Flex Code
17422 \begin_layout Plain Layout
17430 to specify a new bullet shape for a given depth.
17431 You'll also need to save the current bullet shape so you can restore it
17433 In this itemized list the following \SpecialChar LaTeX
17434 code was used to change the bullet
17435 used for the first depth.
17439 \begin_layout LyX-Code
17449 \begin_layout LyX-Code
17466 \begin_layout Itemize
17467 Note that the itemize depth is specified in Roman numerals as part of the
17477 \begin_layout Itemize
17478 \begin_inset Argument item:1
17481 \begin_layout Plain Layout
17485 \begin_layout Plain Layout
17503 Specify each individual entry by starting each item with the bullet shape
17505 \begin_inset Quotes eld
17509 \begin_inset Quotes erd
17512 inset (available at
17514 Insert\SpecialChar menuseparator
17518 \begin_inset Flex Noun
17521 \begin_layout Plain Layout
17529 For example, this item was started with
17530 \begin_inset Flex Code
17533 \begin_layout Plain Layout
17548 \begin_layout Plain Layout
17552 \begin_layout Plain Layout
17568 \begin_layout Plain Layout
17569 You'll also need to revert the labelitem back to its previous setting for
17570 the global bullet shape settings to remain in effect.
17571 The way used here was:
17574 \begin_layout LyX-Code
17589 \begin_layout Chapter
17593 \begin_layout Section
17594 Multipart Documents
17597 \begin_layout Subsection
17601 \begin_layout Standard
17602 When you are working on a large file with many sections, it is often convenient
17603 to break up the document into several files, or perhaps you have something
17604 where a table may change from time to time, but the preceding text does
17606 In these cases, you should seriously consider using multipart documents.
17607 For example, scientific papers often have five major sections: the introduction
17608 , observations, results, discussion, and conclusion.
17609 Each of these could be its own separate \SpecialChar LyX
17611 \begin_inset Quotes eld
17615 \begin_inset Quotes erd
17618 file which contains the title, authors, abstract, references, etc., plus
17619 the five included files.
17620 It is important to note that each of these files is a full \SpecialChar LyX
17622 can be formatted and printed on its own, as well as included in a master
17624 Each of these files must have the same document class, however—don't attempt
17625 to mix book classes with article classes.
17626 You may also include \SpecialChar LaTeX
17627 files; however, these files must not have their own
17629 \begin_inset space \thinspace{}
17633 \begin_inset space \space{}
17636 everything up to and including the
17637 \begin_inset Flex Code
17640 \begin_layout Plain Layout
17648 line as well as the
17649 \begin_inset Flex Code
17652 \begin_layout Plain Layout
17660 line must be deleted) or else errors will be generated when you try to
17664 \begin_layout Standard
17666 allows you to include files quite easily with
17667 \begin_inset Flex Noun
17670 \begin_layout Plain Layout
17671 Insert\SpecialChar menuseparator
17673 \begin_inset space ~
17682 When you click on this selection a small box is inserted into the file
17683 at the current cursor location.
17684 Clicking on the box raises a dialog which allows you to select the file
17685 to be included, and the method of its inclusion.
17689 \begin_layout Standard
17690 The file selection box should by now be obvious.
17691 The three inclusion methods are
17692 \begin_inset Quotes eld
17696 \begin_inset Quotes erd
17700 \begin_inset Quotes eld
17704 \begin_inset Quotes erd
17708 \begin_inset Quotes eld
17712 \begin_inset Quotes erd
17717 \begin_inset Quotes eld
17721 \begin_inset Quotes erd
17725 \begin_inset Quotes eld
17729 \begin_inset Quotes erd
17732 are similar in many ways, but there are also some notable differences:
17735 \begin_layout Enumerate
17737 \begin_inset Quotes eld
17741 \begin_inset Quotes erd
17744 are typeset beginning on a new page, while files that are
17745 \begin_inset Quotes eld
17749 \begin_inset Quotes erd
17752 are typeset starting on the current page.
17755 \begin_layout Enumerate
17756 \begin_inset Quotes eld
17760 \begin_inset Quotes erd
17763 files cannot themselves
17764 \begin_inset Quotes eld
17768 \begin_inset Quotes erd
17772 \begin_inset Quotes eld
17776 \begin_inset Quotes erd
17781 \begin_inset Quotes eld
17785 \begin_inset Quotes erd
17788 , on the other hand, infinite sub-inputting is possible.
17791 \begin_layout Enumerate
17792 \begin_inset Quotes eld
17796 \begin_inset Quotes erd
17799 allow for the output of only selected
17800 \begin_inset Quotes eld
17804 \begin_inset Quotes erd
17807 files, while maintaining the actual counters (pagination etc.) and references
17808 (please refer to the section
17811 \begin_inset space ~
17819 \begin_inset space ~
17824 manual for details).
17827 \begin_layout Standard
17829 \begin_inset Quotes eld
17833 \begin_inset Quotes erd
17836 is the preferred method for chapters that are outsourced to child documents,
17838 \begin_inset Quotes eld
17842 \begin_inset Quotes erd
17845 is more suitable for arbitrary file inheritance.
17848 \begin_layout Standard
17850 \begin_inset Quotes eld
17854 \begin_inset Quotes erd
17857 included file allows you to include a file typeset exactly as it appears
17859 \begin_inset space \thinspace{}
17863 \begin_inset space \space{}
17867 \begin_inset Flex Code
17870 \begin_layout Plain Layout
17876 mode, with the characters set in a fixed-width typewriter font.
17877 Normally, spaces in this file are invisible, though two consecutive spaces
17878 are conserved, unlike \SpecialChar LyX
17879 's normal treatment of spaces.
17880 However, setting the
17881 \begin_inset Flex Noun
17884 \begin_layout Plain Layout
17886 \begin_inset space ~
17890 \begin_inset space ~
17894 \begin_inset space ~
17902 checkbox typesets a mark to unambiguously define the presence of a space.
17906 \begin_layout Standard
17907 Generally, the master file is converted into a full \SpecialChar LaTeX
17908 file before typesetting,
17909 while the included files are converted to \SpecialChar LaTeX
17910 files that do not have all the
17911 preamble information.
17914 \begin_layout Subsection
17915 Cross-References Between Files
17918 \begin_layout Standard
17919 \begin_inset Box Shadowbox
17929 height_special "totalheight"
17934 backgroundcolor "none"
17937 \begin_layout Plain Layout
17938 This section is somewhat out of date.
17939 Need to describe default master documents and how children are opened when
17949 \begin_layout Standard
17950 It is possible to set up cross-references between the different files.
17951 First, open all the files in question: let's call them A and B in a two
17952 file example, where B is included in A.
17953 Let's say you insert a label in A, then want to reference it in B.
17954 Open the cross-reference dialog whilst in document B, and you can select
17956 \begin_inset Quotes eld
17960 \begin_inset Quotes erd
17966 \begin_layout Subsection
17967 Bibliography Lists in all Subdocuments
17970 \begin_layout Standard
17971 If you work with child documents, you might want to have only one main bibliogra
17972 phy at the end, but still be able to have a selected bibliography for the
17973 child if you output it on its own.
17974 Here is how to achieve this.
17977 \begin_layout Standard
17978 For the main document, you just insert a bibliography inset at the place
17979 where the main bibliography has to appear (within the master file or within
17981 If the bibliography inset is in the master file, the references will be
17982 inherited by all children, so they are available in the citation dialog
17986 \begin_layout Standard
17987 For child-specific bibliographies, insert bibliography insets within the
17988 child documents, at the place where the bibliography should appear when
17989 the child is compiled separately.
17990 However, the trick is to insert them into a branch (
17992 Insert\SpecialChar menuseparator
17993 Branch\SpecialChar menuseparator
17994 Insert New Branch...
17997 \begin_inset space \thinspace{}
18002 \begin_inset Quotes eld
18006 \begin_inset Quotes erd
18010 Within the children, activate the branch (
18012 Document\SpecialChar menuseparator
18013 Settings...\SpecialChar menuseparator
18017 Within the master, deactivate the branch (
18019 Document\SpecialChar menuseparator
18020 Settings...\SpecialChar menuseparator
18024 Now the child's bibliography will be ignored by the master, but considered
18028 \begin_layout Standard
18029 If you need multiple bibliographies (e.
18030 \begin_inset space \thinspace{}
18033 g., one per child in the
18037 ), please refer to sec.
18038 \begin_inset space ~
18042 \begin_inset CommandInset ref
18044 reference "subsec:Multiple-Bibliographies"
18051 \begin_layout Section
18056 \begin_layout Standard
18057 Users sometimes need to be able to
18058 \begin_inset Quotes eld
18062 \begin_inset Quotes erd
18066 file together with all the images (and other files) on which it depends,
18067 either for sending to a publisher or for sharing with a co-author.
18069 includes a Python script (
18070 \begin_inset Flex Code
18073 \begin_layout Plain Layout
18079 ) that automates this process.
18080 To use it, you must have either the
18081 \begin_inset Flex Code
18084 \begin_layout Plain Layout
18091 \begin_inset Flex Code
18094 \begin_layout Plain Layout
18100 python modules installed on your system.
18101 By default, the script prefers the
18102 \begin_inset Flex Code
18105 \begin_layout Plain Layout
18112 \begin_inset Flex Code
18115 \begin_layout Plain Layout
18121 format on Unix-like systems and the
18122 \begin_inset Flex Code
18125 \begin_layout Plain Layout
18134 \begin_layout Standard
18136 's configuration process will set the script up to export a `\SpecialChar LyX
18138 and this format will then be available under
18139 \begin_inset Flex Code
18142 \begin_layout Plain Layout
18143 File\SpecialChar menuseparator
18152 \begin_layout Standard
18153 Independently of the platform, the generation of a particular archive format
18154 can be forced by adding either the
18155 \begin_inset Flex Code
18158 \begin_layout Plain Layout
18165 \begin_inset Flex Code
18168 \begin_layout Plain Layout
18175 \begin_inset Flex Code
18178 \begin_layout Plain Layout
18185 \begin_inset Flex Code
18188 \begin_layout Plain Layout
18194 format) switch to the
18195 \begin_inset Flex Code
18198 \begin_layout Plain Layout
18200 \SpecialChar menuseparator
18208 \begin_inset Flex Code
18211 \begin_layout Plain Layout
18212 Tools\SpecialChar menuseparator
18213 Preferences\SpecialChar menuseparator
18214 File Handling\SpecialChar menuseparator
18221 (Make sure you add the switch after the script name, not before it.)
18224 \begin_layout Section
18225 Fancy Headers and Footers
18228 \begin_layout Standard
18229 The default page layout is rather plain; for an
18230 \begin_inset Flex Code
18233 \begin_layout Plain Layout
18239 document class, all you get is a centered page number at the bottom of
18241 This document uses KOMA-script's book class, so it appears to be a bit
18243 But to really put on a show, you need to set the document page style to
18245 \begin_inset Quotes eld
18249 \begin_inset Quotes erd
18252 , as mentioned in the
18257 This section describes the \SpecialChar LaTeX
18258 code you need to insert in your \SpecialChar LaTeX
18260 order to get the desired effects.
18263 \begin_layout Standard
18264 For more information on fancy headers, see the
18265 \begin_inset Flex Code
18268 \begin_layout Plain Layout
18274 package documentation.
18276 \begin_inset Flex URL
18279 \begin_layout Plain Layout
18281 https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
18289 \begin_layout Standard
18290 The page header is divided into three fields, not surprisingly labeled
18291 \begin_inset Quotes eld
18295 \begin_inset Quotes erd
18299 \begin_inset Quotes eld
18303 \begin_inset Quotes erd
18307 \begin_inset Quotes eld
18311 \begin_inset Quotes erd
18315 The footer is also divided into these three fields.
18316 The \SpecialChar LaTeX
18317 commands to set these fields in the simplest manner are
18318 \begin_inset Flex Code
18321 \begin_layout Plain Layout
18330 \begin_inset Flex Code
18333 \begin_layout Plain Layout
18342 \begin_inset Flex Code
18345 \begin_layout Plain Layout
18354 \begin_inset Flex Code
18357 \begin_layout Plain Layout
18366 Suppose you wish to put your name in the upper left hand corner of each
18368 Simply insert the following command in the preamble:
18371 \begin_layout Standard
18380 \begin_layout Standard
18381 You will now see your name in the upper left.
18382 If a field has a default entry that you would like to get rid of (often
18383 the page number appears in the central footer) simply include a command
18384 with a blank argument, e.
18385 \begin_inset space \thinspace{}
18391 \begin_layout Standard
18399 \begin_layout Standard
18400 Let's get really fancy: lets put the section number with the word
18401 \begin_inset Quotes eld
18405 \begin_inset Quotes erd
18409 \begin_inset space \thinspace{}
18413 \begin_inset space \space{}
18416 Section 3) in the upper left, the page number (e.
18417 \begin_inset space \thinspace{}
18421 \begin_inset space \space{}
18424 Page 4) in the upper right, your name in the lower left, and the date in
18426 The following commands should now appear in the preamble:
18429 \begin_layout Standard
18439 \begin_layout Standard
18447 \begin_layout Standard
18457 \begin_layout Standard
18466 \begin_layout Standard
18474 \begin_layout Standard
18484 \begin_layout Standard
18486 \begin_inset Flex Code
18489 \begin_layout Plain Layout
18498 \begin_inset Flex Code
18501 \begin_layout Plain Layout
18509 access \SpecialChar LaTeX
18510 's section and page counters, and so print out the current section
18513 \begin_inset Flex Code
18516 \begin_layout Plain Layout
18524 simply prints out today's date.
18527 \begin_layout Standard
18528 The thicknesses of the horizontal rules drawn beneath the header and above
18529 the footer can also be modified.
18530 If you don't want one of the rules, set its thickness to 0.
18531 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
18537 \begin_inset Flex Code
18540 \begin_layout Plain Layout
18545 headrulewidth}{0.4pt}
18551 \begin_inset Flex Code
18554 \begin_layout Plain Layout
18559 footrulewidth}{0.4pt}
18564 to set the thicknesses.
18567 \begin_layout Standard
18568 You can switch the header/footer settings on and off for individual pages
18569 using commands like
18570 \begin_inset Flex Code
18573 \begin_layout Plain Layout
18576 thispagestyle{empty}
18582 \begin_inset Flex Code
18585 \begin_layout Plain Layout
18588 thispagestyle{plain}
18594 \begin_inset Flex Code
18597 \begin_layout Plain Layout
18600 thispagestyle{fancy}
18606 Simply insert them in the text on the page you want changed and mark them
18607 as \SpecialChar TeX
18609 In fact, title pages are marked as plain by default, while following pages
18610 are marked fancy when using the global fancy setting.
18613 \begin_layout Standard
18614 As a final example, it is possible to include an image in the header or
18616 Suppose you want to put a company logo in the upper lefthand corner.
18617 You might try something like
18620 \begin_layout Standard
18629 includegraphics{logo.eps}}}
18632 \begin_layout Standard
18634 (you may need to preface this with
18635 \begin_inset Flex Code
18638 \begin_layout Plain Layout
18641 usepackage{graphics}
18646 if you don't include graphics elsewhere in your document).
18649 \begin_layout Chapter
18651 and the World Wide Web
18654 \begin_layout Standard
18656 has long supported the export of documents to various web-friendly formats,
18658 Before version 2.0, however, HTML export was always accomplished by the
18659 use of external converters.
18663 \begin_layout Plain Layout
18664 For details on the use of external converters with \SpecialChar LyX
18669 section of the Customization manual.
18674 These fall into two large groups: there are converters that use \SpecialChar LaTeX
18676 intermediate format, such as
18677 \begin_inset Flex Code
18680 \begin_layout Plain Layout
18687 \begin_inset Flex Code
18690 \begin_layout Plain Layout
18697 \begin_inset Flex Code
18700 \begin_layout Plain Layout
18706 , relying upon \SpecialChar LyX
18707 to produce the \SpecialChar LaTeX
18708 ; and there is a converter that works directly
18709 on \SpecialChar LyX
18711 \begin_inset Flex Code
18714 \begin_layout Plain Layout
18722 All of these have different advantages and disadvantages.
18726 \begin_layout Standard
18727 The \SpecialChar LaTeX
18728 -based converters have the advantage that, in principle, they know everythin
18729 g about the exported document that \SpecialChar LaTeX
18731 Such converters do not care, for example, if a certain block of code was
18732 produced by \SpecialChar LyX
18733 or was Evil Red Text.
18734 These converters know about
18735 \begin_inset Flex Code
18738 \begin_layout Plain Layout
18744 files, counters, and references, and can often make use of the
18745 \begin_inset Flex Code
18748 \begin_layout Plain Layout
18754 files generated by Bib\SpecialChar TeX
18756 On the other hand, \SpecialChar LaTeX
18757 is a very hard language to parse—it is sometimes said
18758 that only \SpecialChar TeX
18759 itself understands \SpecialChar TeX
18760 —and \SpecialChar LaTeX
18761 -based converters will often choke on
18762 what seem to be quite simple constructs; complex ones can throw them completely
18763 , and as of this writing, for example, the
18767 manual will not export with
18768 \begin_inset Flex Code
18771 \begin_layout Plain Layout
18777 , though the others will.
18778 The other issue concerns how math is handled.
18779 These converters typically convert the formulae into little pictures that
18780 are then linked from the HTML document.
18781 Since these are actually generated by \SpecialChar LaTeX
18782 , they are accurate.
18783 But they do not scale well, and just getting them to look as if they are
18784 actually meant to be in your document—so that the font sizes seem to be
18785 roughly the same—can be a challenge.
18788 \begin_layout Standard
18790 \begin_inset Flex Code
18793 \begin_layout Plain Layout
18801 \begin_inset CommandInset href
18803 name "http://pinchito.es/elyxer/"
18804 target "http://pinchito.es/elyxer/"
18809 ) solves some of these problems.
18810 In particular, the formulae it produces scale perfectly, since it renders
18811 math using a combination of HTML and CSS rather than converting the formulae
18813 But even moderately complex formula are rendered less well than with
18814 \begin_inset Flex Code
18817 \begin_layout Plain Layout
18823 ; this reflects the limitations of HTML.
18827 \begin_layout Plain Layout
18829 \begin_inset Flex Code
18832 \begin_layout Plain Layout
18839 can also use jsMath and MathJax for equations, but this setting is only
18840 available globally and requires one to have access to a server that runs
18846 More importantly (as of version 1.1.1, at least),
18847 \begin_inset Flex Code
18850 \begin_layout Plain Layout
18857 has limited support for math macros and no support for user-defined paragraph
18858 or character styles.
18859 These limitations make
18860 \begin_inset Flex Code
18863 \begin_layout Plain Layout
18870 unsuitable for many of the documents \SpecialChar LyX
18872 In principle, of course, these problems could be solved, but the \SpecialChar LyX
18874 have decided to follow a different path and have made \SpecialChar LyX
18876 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
18877 , DocBook, and plaintext.
18880 \begin_layout Standard
18881 As of this writing, XHTML output remains under development and should probably
18883 \begin_inset Quotes eld
18887 \begin_inset Quotes erd
18894 \begin_layout Plain Layout
18896 \begin_inset Flex Code
18899 \begin_layout Plain Layout
18900 development/HTML/HTML.notes
18905 , which can be found in the \SpecialChar LyX
18907 \begin_inset CommandInset href
18909 name "accessed online"
18910 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
18915 , usually contains up-to-date information about the state of XHTML output.
18916 See also the list of XHTML bugs on
18917 \begin_inset CommandInset href
18919 name "the bug tracker"
18920 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"
18930 Still, the developers have chosen this approach because it has several
18931 potential advantages over the other two.
18934 \begin_layout Standard
18935 These advantages are primarily due to the fact that the XHTML output routines,
18936 since they are part of \SpecialChar LyX
18937 , know everything \SpecialChar LyX
18938 knows about the document being
18943 \begin_layout Plain Layout
18944 Another advantage is that, since these routines are internal to \SpecialChar LyX
18946 immune to changes in \SpecialChar LyX
18947 's file format, or to changes in the semantics of
18953 So they know about the table of contents (as displayed in the outline),
18954 about the counters associated with different paragraph styles, and about
18955 user-defined styles.
18956 The XHTML output routines know what \SpecialChar LyX
18957 knows about internationalization,
18958 too, so they will output
18959 \begin_inset Quotes eld
18963 \begin_inset Quotes erd
18967 \begin_inset Quotes eld
18975 \begin_inset Quotes erd
18978 , depending upon the language in effect at the time.
18982 \begin_layout Standard
18983 Quite generally, the output routines know what \SpecialChar LyX
18984 knows about document layout,
18985 that is, about how the document is to be rendered on screen.
18986 We use this information when we output the document as XHTML.
18987 In particular, \SpecialChar LyX
18992 generates CSS style information corresponding to the layout information
18993 it uses to render the document on screen: if section headings are supposed
18994 to be sans-serif and bold as seen in \SpecialChar LyX
18995 , then (by default) they will be sans-seri
18996 f and bold when viewed in a web browser, too.
18997 And this is true not just for pre-defined styles, like Section, but for
18998 any style, including user-defined styles.
18999 Indeed, the XHTML output routines make no distinction between user-defined
19001 \change_deleted 244031559 1603876931
19003 \change_inserted 244031559 1603876940
19006 styles and \SpecialChar LyX
19007 's own pre-defined styles: in each case, everything \SpecialChar LyX
19009 the styles is contained in the layout files.
19010 And much the same is true as regards pre-defined textual insets, such as
19011 footnotes, and various custom insets.
19015 \begin_layout Standard
19016 The result is that XHTML output can be customized and extended in exactly
19017 the same way \SpecialChar LaTeX
19018 output can be customized and extended: through layout files
19020 See chapter five of the
19024 manual for the details.
19027 \begin_layout Standard
19028 The remainder of this chapter contains more detailed information on XHTML
19029 output, its limitations, and ways to work around those limitations.
19032 \begin_layout Section
19033 Math Output in XHTML
19036 \begin_layout Standard
19038 offers four choices for how math is rendered.
19039 These have various advantages and disadvantages:
19042 \begin_layout Itemize
19044 \begin_inset Newline newline
19047 MathML is a dialect of XML designed specifically for mathematics on the
19048 web, and it typically renders very well in browsers that support it.
19049 The disadvantage is that not all browsers support MathML, and support is
19050 not complete even in the Gecko-based browsers, such as Firefox.
19051 \begin_inset Newline newline
19054 If \SpecialChar LyX
19055 is unable to render a formula as MathML—for example, if the formula
19057 \begin_inset Flex Code
19060 \begin_layout Plain Layout
19066 package or ERT—then it will instead output the formula as an image.
19070 \begin_layout Itemize
19072 \begin_inset Newline newline
19075 As mentioned above,
19076 \begin_inset Flex Code
19079 \begin_layout Plain Layout
19085 outputs math as HTML, styled by CSS.
19089 \begin_layout Plain Layout
19091 has borrowed some of the CSS for its HTML output from
19092 \begin_inset Flex Code
19095 \begin_layout Plain Layout
19106 For simple formulae, this can work quite well, though with more complicated
19107 formulae it tends to break down.
19108 Still, this method has the advantage that it is very widely supported and
19109 so it may be appropriate for documents that contain only a little, fairly
19111 \begin_inset Newline newline
19114 If Lyx is unable to render a formula as HTML—for example, if the formula
19116 \begin_inset Flex Code
19119 \begin_layout Plain Layout
19125 package or ERT—then it will instead output the formula as an image.
19129 \begin_layout Itemize
19131 \begin_inset Newline newline
19135 \begin_inset Flex Code
19138 \begin_layout Plain Layout
19145 will output formulae as images, the very same images, in fact, that are
19146 used for instant preview.
19150 \begin_layout Plain Layout
19151 Instant preview does
19155 have to be on for images to be output, however.
19160 The advantage to this method is that the images are simply generated by
19162 , so they are very accurate.
19163 The disadvantage, as mentioned earlier, is that these are bitmapped images,
19164 so they do not scale terribly well, and one cannot copy them, etc.
19165 \begin_inset Newline newline
19168 The size of the images can be controlled by setting the
19169 \begin_inset Quotes eld
19172 Math Images Scaling
19173 \begin_inset Quotes erd
19177 \begin_inset Flex Noun
19180 \begin_layout Plain Layout
19181 Document\SpecialChar menuseparator
19182 Settings\SpecialChar menuseparator
19192 \begin_layout Plain Layout
19193 For those who want to know, this controls the resolution of the image in
19194 dots per inch and is based upon a default of 75 dpi.
19200 \begin_inset Newline newline
19203 If \SpecialChar LyX
19204 for some reason fails to create an image for a formula (e.g., if a required
19206 package is not installed), then it will fall back to outputing the raw
19211 \begin_layout Itemize
19214 \begin_inset Newline newline
19217 Finally, \SpecialChar LyX
19218 will happily output math as \SpecialChar LaTeX
19220 As well as being the output of last resort, this method can be used with
19222 \begin_inset CommandInset href
19225 target "http://www.math.union.edu/~dpvc/jsMath/"
19230 , which uses JavaScript to render \SpecialChar LaTeX
19231 embedded in HTML documents.
19233 wraps the \SpecialChar LaTeX
19235 \begin_inset Flex Code
19238 \begin_layout Plain Layout
19244 (for inline formulas) or
19245 \begin_inset Flex Code
19248 \begin_layout Plain Layout
19254 (for displayed formulas) with
19255 \begin_inset Flex Code
19258 \begin_layout Plain Layout
19264 , as is required for jsMath.
19267 \begin_layout Standard
19268 One of these output methods must be selected under
19269 \begin_inset Flex Noun
19272 \begin_layout Plain Layout
19273 Document\SpecialChar menuseparator
19274 Settings\SpecialChar menuseparator
19281 By default, \SpecialChar LyX
19283 This is a document-wide setting, therefore.
19286 \begin_layout Standard
19287 Eventually, \SpecialChar LyX
19288 will offer the user the option to select an alternate output
19289 method for a particular inset, say, one that isn't being rendered very
19294 \begin_layout Plain Layout
19295 That said, since \SpecialChar LyX
19296 falls back to images if the inset contains ERT, then one
19297 can force output as an image by putting some harmless ERT into the math,
19299 \begin_inset Formula $a=b\relax$
19310 \begin_layout Section
19311 Bibliography and Citations
19314 \begin_layout Standard
19315 XHTML output fully supports bibliographies and citations.
19319 \begin_layout Standard
19320 Citation labels are generated by the same machinery that generates \SpecialChar LyX
19322 labels, so the labels will look in the output much as they do in \SpecialChar LyX
19325 If you are using numerical citations, then \SpecialChar LyX
19326 will output numerical labels,
19327 such as [1] or [17], rather than simply showing the citation key in square
19328 brackets, as it does on-screen.
19329 If you are using author-year citations, then \SpecialChar LyX
19330 will add lowercase letters
19331 to the years, just as Bib\SpecialChar TeX
19332 does, if it finds more than one citation for
19333 a given author-year combination.
19334 The labels will be printed with the bibliography entries.
19335 Note that there is, at present, no way to customize the appearance of the
19336 labels, for example, to choose between square brackets and parentheses.
19339 \begin_layout Standard
19340 Bibliography output is handled by the same machinery that handles the presentati
19341 on of reference information in the citation dialog, so you will see in the
19342 XHTML output pretty much what you would see if you were to look at a given
19343 entry in the citation dialog.
19344 The formatting can be customized in your layout file or, preferably, in
19350 manual for the details.
19353 \begin_layout Standard
19354 The main defect at present is that cross-referenced information is printed
19355 with every entry with which it is associated.
19356 So you can see things like this:
19359 \begin_layout Quote
19361 \begin_inset Quotes eld
19364 Context and Logical Form
19365 \begin_inset Quotes erd
19370 Language in Context: Selected Essays
19372 (Oxford: Oxford University Press, 2007), pp.
19376 \begin_layout Quote
19378 \begin_inset Quotes eld
19381 Semantics in Context
19382 \begin_inset Quotes erd
19387 Language in Context: Selected Essays
19389 (Oxford: Oxford University Press, 2007), pp.
19393 \begin_layout Standard
19394 This should be fixed before long.
19397 \begin_layout Standard
19398 There is no support at present for sectioned bibliographies.
19399 If you have multiple bibliographies, then \SpecialChar LyX
19400 will print the same bibliography
19404 \begin_layout Section
19408 \begin_layout Standard
19410 will happily export indexes as XHTML, but with certain limitations at the
19414 \begin_layout Standard
19415 Index export will be most reliable when you do not attempt to use the fancy
19416 constructs that are described in the section on indexes in the
19424 \begin_layout Plain Layout
19425 The main issue here is that \SpecialChar LyX
19426 itself does not really handle these.
19427 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
19433 We'll describe how they are handled using the subsection headings from
19437 \begin_layout Itemize
19438 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
19439 makes an effort to support these,
19440 but the entries must be separated by
19441 \begin_inset Quotes eld
19445 \begin_inset Quotes erd
19448 , that is, there must be spaces around the exclamation point.
19449 This is because it is otherwise too difficult to check for escaped exclamation
19450 points, ones in math, and so forth.
19453 \begin_layout Itemize
19454 Page Ranges: There is no support at all for page ranges, since these make
19455 no sense with XHMTL.
19456 Instead, you will just get two index entries, one at either end.
19459 \begin_layout Itemize
19460 Cross-referencing: There is no support for cross-referencing.
19461 If \SpecialChar LyX
19462 finds an entry containing the
19463 \begin_inset Quotes eld
19466 |see\SpecialChar ldots
19468 \begin_inset Quotes erd
19471 construct, it is just dropped, and the rest is treated as an ordinary index
19475 \begin_layout Itemize
19476 Index Entry Order: \SpecialChar LyX
19477 does support attempts to fix the sorting order.
19478 It will take what is before the first `@' it finds and use that for sorting,
19479 taking what follows the first `@' to be the actual entry.
19480 At present, \SpecialChar LyX
19481 does not check for escaped `@', so do not try to index email
19485 \begin_layout Itemize
19486 Index Entry Layout: You can format entries by using the text style dialog,
19487 or by using any other method available within \SpecialChar LyX
19489 There is no support for constructs like:
19490 \begin_inset Quotes eld
19494 \begin_inset Quotes erd
19498 Indeed, if \SpecialChar LyX
19499 finds a pipe symbol, `|', in an entry, it will delete it and
19500 everything that follows it.
19503 \begin_layout Itemize
19504 Multiple Indexes: There is no support for multiple indexes.
19505 Rather, all index entries will be printed as one large index.
19506 To avoid our printing several versions of the index, we print only the
19507 main index, so make sure you have one.
19510 \begin_layout Section
19511 Nomenclature and Glossary
19514 \begin_layout Standard
19515 There is at present no support for glossaries.
19516 Adding it would be fairly trivial, and welcome.
19519 \begin_layout Chapter
19521 \change_inserted 1075283030 1616534180
19525 \begin_layout Standard
19527 \change_inserted 1075283030 1616534386
19528 Apart from HTML, \SpecialChar LyX
19529 can generate documents in the DocBook XML vocabulary.
19530 With versions 2.3 and before, only select templates could be used to generate
19531 DocBook documents (only version 4).
19532 Starting with \SpecialChar LyX
19533 2.4, most \SpecialChar LyX
19534 layouts can generate valid DocBook documents (only
19536 This feature is built into \SpecialChar LyX
19537 and does not require the use of external tools.
19540 \begin_layout Standard
19542 \change_inserted 1075283030 1616534437
19543 The result is that the DocBook output can be customized and extended in
19544 exactly the same way \SpecialChar LaTeX
19545 output can be customized and extended: through layout
19547 See chapter five of the
19551 manual for the details.
19554 \begin_layout Standard
19556 \change_inserted 1075283030 1616534475
19557 Most \SpecialChar LyX
19558 features are supported with DocBook, like math output.
19561 \begin_layout Itemize
19563 \change_inserted 1075283030 1616534741
19564 Math output is performed mostly in MathML (the major exception being constructio
19565 ns not supported by \SpecialChar LyX
19568 All formulae are also available in raw \SpecialChar TeX
19569 in the DocBook output for further
19573 \begin_layout Itemize
19575 \change_inserted 1075283030 1616534852
19576 Bibliographies and citations are implemented, including with an external
19578 Bibliography entries are not prerendered when the detailed information
19579 are available, but rather output with the standard DocBook constructs.
19580 The external DocBook processor is expected to handle the rendering of entries.
19583 \begin_layout Itemize
19585 \change_inserted 1075283030 1616534863
19586 Indexes are supported, including multiple indices.
19591 ), page ranges, and cross-references (
19595 ) are supported, with the exception of the same symbols escaped.
19604 ) are not supported.
19605 There is no support for escaping of index entries.
19608 \begin_layout Itemize
19610 \change_inserted 1075283030 1616534884
19611 Glossaries are implemented.
19614 \begin_layout Standard
19616 \change_inserted 1075283030 1616534894
19617 Two major parameters can be set at the document level.
19620 \begin_layout Itemize
19622 \change_inserted 1075283030 1616534948
19623 Format for tables: \SpecialChar LyX
19624 can generate tables either as HTML (default value) or
19625 CALS, depending on the user's requirements.
19626 Most DocBook processors accept both formats.
19629 \begin_layout Itemize
19631 \change_inserted 1075283030 1616535006
19632 MathML prefix: in DocBook, MathML is included within its own name space,
19634 The implication is that there must be an indication of the tags belonging
19635 to the MathML standard.
19636 Three choices are offered:
19640 \begin_layout Itemize
19642 \change_inserted 1075283030 1616535044
19643 Inline: the MathML name space is defined for each formula (using the
19647 attribute on each formula)
19650 \begin_layout Itemize
19652 \change_inserted 1075283030 1616535090
19657 prefix (default): the MathML name space is defined at the document level
19662 attribute on the root element).
19663 Each MathML is prefixed with
19672 \begin_layout Itemize
19674 \change_inserted 1075283030 1616620405
19679 prefix: similar to the
19688 \begin_layout Standard
19690 \change_inserted 1075283030 1616620470
19691 This option is especially useful if you want \SpecialChar LyX
19692 to match your personal style
19693 or to work with buggy software that only accepts one prefix for MathML.
19699 \begin_layout Chapter
19700 The \SpecialChar LyX
19704 \begin_layout Section
19708 \begin_layout Standard
19709 The `\SpecialChar LyX
19710 server' allows other programs to talk to \SpecialChar LyX
19711 , invoke \SpecialChar LyX
19712 commands, and retrieve
19713 information about the \SpecialChar LyX
19715 This is only intended for advanced users, but they should find it useful.
19716 It is by writing to the \SpecialChar LyX
19717 server, for example, that bibliography managers,
19718 such as JabRef, are able to
19719 \begin_inset Quotes eld
19723 \begin_inset Quotes erd
19726 citations to \SpecialChar LyX
19730 \begin_layout Section
19731 Starting the \SpecialChar LyX
19733 \begin_inset CommandInset label
19735 name "sec:Starting-the-Server"
19742 \begin_layout Standard
19743 The \SpecialChar LyX
19744 server works through the use of a pair of named pipes.
19745 These are usually located in
19746 \begin_inset Flex Code
19749 \begin_layout Plain Layout
19755 , (except on Windows, where
19759 named pipes are special objects located in
19760 \begin_inset Flex Code
19763 \begin_layout Plain Layout
19775 ) and have the names
19776 \begin_inset Quotes eld
19780 \begin_inset Flex Code
19783 \begin_layout Plain Layout
19790 \begin_inset Quotes erd
19794 \begin_inset Quotes eld
19798 \begin_inset Flex Code
19801 \begin_layout Plain Layout
19808 \begin_inset Quotes erd
19812 External programs write into
19813 \begin_inset Flex Code
19816 \begin_layout Plain Layout
19822 and read back data from
19823 \begin_inset Flex Code
19826 \begin_layout Plain Layout
19833 The stem of the pipe names can be defined in the
19834 \begin_inset Flex Noun
19837 \begin_layout Plain Layout
19838 Tools\SpecialChar menuseparator
19844 dialog, for example
19845 \begin_inset Flex Code
19848 \begin_layout Plain Layout
19849 "/home/myhome/lyxpipe"
19855 \begin_inset Flex Code
19858 \begin_layout Plain Layout
19872 on Windows (where any working path instead of lyxpipe can be used, for
19874 \begin_inset Flex Code
19877 \begin_layout Plain Layout
19900 configure this manually in order for the server to start.
19903 \begin_layout Standard
19906 \begin_inset Flex Code
19909 \begin_layout Plain Layout
19916 \begin_inset Flex Code
19919 \begin_layout Plain Layout
19925 ' to create the pipes.
19926 If one of the pipes already exists, \SpecialChar LyX
19927 will assume that another \SpecialChar LyX
19929 is already running and will not start the server.
19930 On POSIX (Unix like) systems, if for some other reason, an unused
19931 \begin_inset Quotes eld
19935 \begin_inset Quotes erd
19938 pipe is left in existence when \SpecialChar LyX
19939 closes, then \SpecialChar LyX
19940 will try to delete it.
19941 If this fails for some reason, you will need to delete the pipes manually
19942 and then restart \SpecialChar LyX
19944 On Windows, pipes are deleted by the OS on program termination or crash,
19946 \begin_inset Quotes eld
19950 \begin_inset Quotes erd
19953 pipes should not be possible.
19956 \begin_layout Standard
19957 To have several \SpecialChar LyX
19958 processes with servers at the same time, you have to use
19959 different configurations, perhaps by using separate user directories, each
19961 \begin_inset Flex Code
19964 \begin_layout Plain Layout
19970 file, for each process.
19973 \begin_layout Standard
19974 If you are developing a client program, you might find it useful to enable
19975 debugging information from the \SpecialChar LyX
19977 Do this by starting \SpecialChar LyX
19979 \begin_inset Flex Code
19982 \begin_layout Plain Layout
19991 \begin_layout Standard
19992 You can find a complete example client written in C++ in the source distribution
19994 \begin_inset Flex Code
19997 \begin_layout Plain Layout
19998 development/lyxserver/server_monitor.cpp
20006 \begin_layout Standard
20007 Another useful tool is the command-line based client found in
20008 \begin_inset Flex Code
20011 \begin_layout Plain Layout
20012 src/client/lyxclient
20020 \begin_layout Section
20021 Normal communication
20024 \begin_layout Standard
20025 To issue a \SpecialChar LyX
20026 call, the client writes a line of ASCII text into the input
20028 This line has the following format:
20031 \begin_layout Quote
20045 \begin_layout Description
20046 clientname is a name that the client can choose arbitrarily.
20047 Its only use is that \SpecialChar LyX
20048 will echo it if it sends an answer—so a client can
20049 dispatch results from different requesters.
20052 \begin_layout Description
20053 function is the function you want \SpecialChar LyX
20055 It is the same as the commands you'd use in the minibuffer.
20058 \begin_layout Description
20059 argument is an optional argument which is meaningful only to some functions
20061 \begin_inset Quotes eld
20065 \begin_inset Quotes erd
20068 LFUN will insert the argument as text at the cursor position).
20071 \begin_layout Standard
20072 The answer from \SpecialChar LyX
20073 will arrive in the output pipe and be of the form
20076 \begin_layout Quote
20090 \begin_layout Standard
20099 are just echoed from the command request, while
20103 is more or less useful information filled according to how the command
20104 execution worked out.
20105 Some commands, such as
20106 \begin_inset Quotes eld
20110 \begin_inset Quotes erd
20113 , will return information about the internal state of \SpecialChar LyX
20115 return an empty data-response.
20116 This means that the command execution went fine.
20119 \begin_layout Standard
20120 In case of errors, the response from \SpecialChar LyX
20121 will have this form
20124 \begin_layout Quote
20138 \begin_layout Standard
20143 should contain an explanation of why the command failed.
20146 \begin_layout Standard
20150 \begin_layout LyX-Code
20151 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
20152 \begin_inset Newline newline
20155 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
20156 \begin_inset Newline newline
20159 read a <~/.lyxpipe.out
20160 \begin_inset Newline newline
20166 \begin_layout Subsection
20167 AppleScript (Mac OS X)
20170 \begin_layout Standard
20171 Since \SpecialChar LyX
20172 2.1, \SpecialChar LyX
20173 supports basic interactions with AppleScript for normal communicatio
20174 n through the command run.
20175 This command takes a direct argument (the
20179 to perform) and an optional argument.
20180 It either returns the output of the function or triggers an error with
20181 the error message and code.
20184 \begin_layout Standard
20188 \begin_layout LyX-Code
20189 tell application "\SpecialChar LyX
20193 \begin_layout LyX-Code
20197 \begin_layout LyX-Code
20198 -- Stores the current file name into f
20201 \begin_layout LyX-Code
20202 set f to (run "server-get-filename" with argument "")
20205 \begin_layout LyX-Code
20206 on error the error_message number the error_number
20209 \begin_layout LyX-Code
20210 display dialog "Error: " & the error_number & ".
20214 \begin_layout LyX-Code
20215 & the error_message buttons {"OK"} default button 1
20218 \begin_layout LyX-Code
20222 \begin_layout LyX-Code
20226 \begin_layout Section
20230 \begin_layout Standard
20232 can notify clients of events going on asynchronously.
20233 Currently it will only do this if the user binds a key sequence with the
20235 \begin_inset Quotes eld
20239 \begin_inset Quotes erd
20243 The format of the string \SpecialChar LyX
20244 sends is as follows:
20247 \begin_layout Quote
20248 \begin_inset Flex Code
20251 \begin_layout Plain Layout
20262 \begin_layout Standard
20267 is the printed representation of the key sequence that was actually typed
20271 \begin_layout Standard
20272 This mechanism can be used to extend \SpecialChar LyX
20273 's command set and implement macros.
20274 Bind some key sequence to
20275 \begin_inset Quotes eld
20279 \begin_inset Quotes erd
20283 Then start a client that listens on the output pipe, dispatches the command
20284 according to the sequence, and starts a function that may use \SpecialChar LyX
20287 requests to issue a command or a series of commands to \SpecialChar LyX
20291 \begin_layout Section
20292 The simple \SpecialChar LyX
20296 \begin_layout Standard
20298 implements a simple protocol that can be used for session management.
20299 All messages are of the form
20302 \begin_layout Quote
20312 \begin_layout Standard
20318 \begin_inset Quotes eld
20322 \begin_inset Quotes erd
20326 \begin_inset Quotes eld
20330 \begin_inset Quotes erd
20335 \begin_inset Quotes eld
20339 \begin_inset Quotes erd
20342 is received from a client, \SpecialChar LyX
20343 will report back to inform the client that
20344 it's listening to it's messages, while
20345 \begin_inset Quotes eld
20349 \begin_inset Quotes erd
20352 sent from \SpecialChar LyX
20353 will inform clients that \SpecialChar LyX
20357 \begin_layout Section
20358 Reverse DVI/PDF search
20361 \begin_layout Standard
20362 Some DVI/PDF viewers
20366 \begin_layout Plain Layout
20367 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
20368 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
20377 facility (also called
20382 This means that you can tell \SpecialChar LyX
20383 to put the cursor to a specific line in the
20384 document by clicking at the respective position in the DVI/PDF output.
20385 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
20387 This is done via the \SpecialChar LyX
20388 server either by using the named pipe (
20392 ), or the UNIX domain socket (
20396 ) that \SpecialChar LyX
20397 creates in its temporary directory (this is the way the
20398 \begin_inset Flex Code
20401 \begin_layout Plain Layout
20407 program communicates with \SpecialChar LyX
20409 In some cases, you need a helper script that mediates between the viewer
20410 and \SpecialChar LyX
20411 , in others, the viewer can communicate with \SpecialChar LyX
20413 This depends on the selected viewer and on your operating system.
20414 The same applies to the way viewers need to be configured and the way the
20415 reverse search is actually performed.
20416 In what follows, we will thus describe how to setup reverse search for
20418 Before we turn to this, though, we will explain what needs to be done generally
20419 to enable reverse search in the DVI/PDF output.
20422 \begin_layout Subsection
20424 \begin_inset CommandInset label
20426 name "subsec:rev-search"
20433 \begin_layout Standard
20434 In most cases \SpecialChar LyX
20435 will do the work for you by pressing the following button
20439 arg "buffer-toggle-output-sync"
20443 Alternatively, you can also enable the feature by checking
20445 Synchronize with Output
20448 \begin_inset Flex Noun
20451 \begin_layout Plain Layout
20452 Document\SpecialChar menuseparator
20453 Settings\SpecialChar menuseparator
20460 In such a case \SpecialChar LyX
20461 will automatically insert the necessary Sync\SpecialChar TeX
20463 PDF) or load the srcltx package (for DVI) respectively.
20464 This option can be easily reached also on
20465 \begin_inset Flex Code
20468 \begin_layout Plain Layout
20477 \begin_layout Standard
20478 If you need a different setting, you can select or input a custom macro
20479 from the drop down box just below
20480 \begin_inset Flex Noun
20483 \begin_layout Plain Layout
20484 Document\SpecialChar menuseparator
20485 Settings\SpecialChar menuseparator
20486 Output\SpecialChar menuseparator
20487 Synchronize with Output
20495 \begin_layout Standard
20496 Note that the method
20497 \begin_inset Flex Code
20500 \begin_layout Plain Layout
20508 enables gzip compression.
20509 If your viewer does not support it, you should instead use
20510 \begin_inset Flex Code
20513 \begin_layout Plain Layout
20524 \begin_layout Standard
20525 Please also note that including the
20526 \begin_inset Flex Code
20529 \begin_layout Plain Layout
20536 \begin_inset Flex Code
20539 \begin_layout Plain Layout
20545 sometimes has an undesired impact on the typesetting.
20546 Thus, you should switch output synchronization off for the final typesetting
20548 \begin_inset Flex Code
20551 \begin_layout Plain Layout
20558 \begin_inset Flex Code
20561 \begin_layout Plain Layout
20571 \begin_layout Standard
20572 In case you need some more special settings that are not covered by the
20573 automatic settings, read the next section about how to set up output synchroniz
20575 If the automatic setup suits your needs, you can readily jump to section
20576 \begin_inset space ~
20580 \begin_inset CommandInset ref
20582 reference "subsec:configuring-viewers"
20586 , where the necessary configuration steps in your viewer – needed both with
20587 the automatic and the manual setup – are described.
20590 \begin_layout Subsection
20594 \begin_layout Standard
20596 provides several different methods for reverse search.
20597 Some are built-in in the
20598 \begin_inset Flex Code
20601 \begin_layout Plain Layout
20607 program, some are provided by external packages.
20608 Your choice depends on whether your \SpecialChar LaTeX
20609 distribution already provides a given
20610 method (the built-in methods are rather new) and whether your viewer can
20612 The available methods are described in the following.
20615 \begin_layout Subsubsection*
20616 Built-in DVI-search via src-specials (DVI only)
20619 \begin_layout Standard
20620 This method provides the DVI file with the necessary information for reverse
20622 It is available in \SpecialChar LaTeX
20623 since quite some time (any somewhat recent \SpecialChar LaTeX
20625 should include it), and it works reliably.
20626 To enable it, change the
20627 \begin_inset Flex Noun
20630 \begin_layout Plain Layout
20641 \begin_inset Flex Noun
20644 \begin_layout Plain Layout
20655 \begin_inset Flex Noun
20658 \begin_layout Plain Layout
20659 Preferences\SpecialChar menuseparator
20660 File Handling\SpecialChar menuseparator
20667 \begin_inset Flex Code
20670 \begin_layout Plain Layout
20671 latex -src-specials $$i
20677 If this doesn't work, check if your \SpecialChar TeX
20678 engine needs different options (the
20679 syntax might differ in some distributions).
20682 \begin_layout Subsubsection*
20683 External Packages (PDFSync and scrltx)
20686 \begin_layout Standard
20695 provide reverse search facility for PDF output (via pdflatex) and DVI output,
20697 In order to enable it, load the packages in the \SpecialChar LyX
20701 \begin_layout Itemize
20702 \begin_inset Flex Code
20705 \begin_layout Plain Layout
20708 usepackage{pdfsync}
20713 for reverse PDF search,
20716 \begin_layout Itemize
20717 \begin_inset Flex Code
20720 \begin_layout Plain Layout
20723 usepackage[active]{srcltx}
20728 for reverse DVI search.
20731 \begin_layout Standard
20732 If you want to be able to perform both DVI and PDF reverse searches, you
20733 can also insert in the preamble the following lines
20736 \begin_layout LyX-Code
20740 \begin_inset Newline newline
20746 \begin_inset Newline newline
20751 usepackage{pdfsync}
20752 \begin_inset Newline newline
20758 \begin_inset Newline newline
20763 usepackage[active]{srcltx}
20764 \begin_inset Newline newline
20772 \begin_layout Standard
20773 This way, you can preview the file as either DVI or PDF (pdflatex) and the
20774 right package will be used.
20777 \begin_layout Standard
20778 Note that PDFSync might affect the output layout of your document.
20779 It is therefore advised to disable PDFsync for final documents.
20782 \begin_layout Subsubsection*
20783 Built-in reverse search via Sync\SpecialChar TeX
20787 \begin_layout Standard
20789 \begin_inset Flex Code
20792 \begin_layout Plain Layout
20798 have built-in support for both PDF and DVI reverse search.
20801 Sync\SpecialChar TeX
20804 facility is basically the result of the integration of the PDFSync package
20805 to the pdftex program and its merge with the
20810 You need at least \SpecialChar TeX
20811 Live 2008 or a recent Mik\SpecialChar TeX
20812 distribution in order to use
20817 \begin_layout Plain Layout
20818 For some reason, Mik\SpecialChar TeX
20819 does not understand/obey the command \SpecialChar LyX
20821 the preamble when you check the "Enable Forward/Reverse Search" button
20822 in the toolbar and does not generate the necessary info.
20825 \begin_layout Plain Layout
20826 The generation of the required info can be forced by changing the converter
20827 "\SpecialChar LaTeX
20828 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
20829 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
20830 the -synctex=1 switch).
20835 Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
20836 Skim on the Mac, SumatraPDF on Windows; see the next section for details)
20837 already provide Sync\SpecialChar TeX
20841 \begin_layout Standard
20842 To enable Sync\SpecialChar TeX
20843 for DVI output, change the
20844 \begin_inset Flex Noun
20847 \begin_layout Plain Layout
20858 \begin_inset Flex Noun
20861 \begin_layout Plain Layout
20866 (plain) -> DraftDVI
20872 \begin_inset Flex Noun
20875 \begin_layout Plain Layout
20876 Preferences\SpecialChar menuseparator
20877 File Handling\SpecialChar menuseparator
20884 \begin_inset Flex Code
20887 \begin_layout Plain Layout
20888 latex -synctex=1 $$i
20893 , and for PDF output, change the
20894 \begin_inset Flex Noun
20897 \begin_layout Plain Layout
20902 (pdflatex) -> PDF (pdflatex)
20908 \begin_inset Flex Code
20911 \begin_layout Plain Layout
20912 pdflatex -synctex=1 $$i
20918 Should your viewer not be considered in the following description, or in
20919 case of missing success, please check the documentation of your viewer
20920 whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
20925 \begin_layout Plain Layout
20926 Note that the option
20927 \begin_inset Flex Code
20930 \begin_layout Plain Layout
20936 option enables gzip compression.
20937 If your viewer does not support it, you should instead use
20938 \begin_inset Flex Code
20941 \begin_layout Plain Layout
20955 \begin_layout Subsection
20956 Configuring and using specific viewers
20957 \begin_inset CommandInset label
20959 name "subsec:configuring-viewers"
20966 \begin_layout Subsubsection*
20967 Xdvi (all platforms)
20970 \begin_layout Standard
20972 \begin_inset Flex Code
20975 \begin_layout Plain Layout
20981 , you don't need to do anything else for performing a reverse DVI search,
20982 as \SpecialChar LyX
20983 already provides the necessary hooks for automatically using the
20984 \begin_inset Flex Code
20987 \begin_layout Plain Layout
20994 Just setup your document as described above (reverse search is triggered
20995 by Ctrl-click or Alt-click on Mac OSX, respectively).
20998 \begin_layout Standard
20999 However, if for whatever reason you want to use the named pipe instead of
21000 the socket for communicating with \SpecialChar LyX
21001 , simply change the DVI viewer in
21002 \begin_inset Flex Noun
21005 \begin_layout Plain Layout
21006 Preferences\SpecialChar menuseparator
21007 File Handling\SpecialChar menuseparator
21017 \begin_layout Plain Layout
21018 On Mac OSX you have to use
21019 \begin_inset Flex Code
21022 \begin_layout Plain Layout
21023 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
21034 \begin_inset Flex Code
21037 \begin_layout Plain Layout
21038 xdvi -editor "lyxeditor.sh %f %l"
21044 \begin_inset Flex Code
21047 \begin_layout Plain Layout
21053 is a suitable script.
21054 For example, a minimal shell script is the following one:
21057 \begin_layout LyX-Code
21059 \begin_inset Newline newline
21062 LYXPIPE="/path/to/lyxpipe"
21063 \begin_inset Newline newline
21066 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
21067 \begin_inset Newline newline
21070 echo "$COMMAND" > "${LYXPIPE}".in || exit
21071 \begin_inset Newline newline
21074 read TMP < "${LYXPIPE}".out || exit
21077 \begin_layout Standard
21079 \begin_inset Flex Code
21082 \begin_layout Plain Layout
21088 is the LyXServer pipe path specified in
21089 \begin_inset Flex Noun
21092 \begin_layout Plain Layout
21093 Preferences\SpecialChar menuseparator
21103 \begin_layout Plain Layout
21105 \begin_inset Flex Code
21108 \begin_layout Plain Layout
21114 folder of a source distribution you can find a
21115 \begin_inset Flex Code
21118 \begin_layout Plain Layout
21124 script which is able to locate the
21128 based on your preferences.
21136 \begin_layout Subsubsection*
21140 \begin_layout Standard
21142 \begin_inset Flex Code
21145 \begin_layout Plain Layout
21146 /Applications/MacDviX_Folder/calleditor.script
21151 , add the following lines:
21154 \begin_layout LyX-Code
21155 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
21156 \begin_inset Newline newline
21162 \begin_layout Standard
21163 Modify the lines accordingly if you install \SpecialChar LyX
21164 somewhere else than in the
21165 Applications folder.
21168 \begin_layout Standard
21169 Reverse search is triggered by Alt-click (OPTION-click).
21172 \begin_layout Subsubsection*
21176 \begin_layout Standard
21178 \begin_inset Flex Code
21181 \begin_layout Plain Layout
21182 open -a Skim.app $$i
21187 to the viewer setting in
21188 \begin_inset Flex Noun
21191 \begin_layout Plain Layout
21192 Preferences\SpecialChar menuseparator
21193 File Handling\SpecialChar menuseparator
21194 File formats\SpecialChar menuseparator
21201 \begin_inset Flex Noun
21204 \begin_layout Plain Layout
21205 Skim\SpecialChar menuseparator
21206 Preferences\SpecialChar menuseparator
21213 \begin_inset Flex Noun
21216 \begin_layout Plain Layout
21222 preset and enter command
21223 \begin_inset Flex Noun
21226 \begin_layout Plain Layout
21227 /Applications/\SpecialChar LyX
21228 .app/Contents/MacOS/lyxeditor
21236 \begin_layout Standard
21237 Reverse search is triggered by COMMAND-SHIFT-click
21240 \begin_layout Subsubsection*
21244 \begin_layout Standard
21245 Reverse search with evince does not work out of the box, but it can be achieved
21246 by means of some third party helper scripts.
21248 \begin_inset CommandInset href
21250 target "https://wiki.lyx.org/LyX/SyncTeX"
21258 \begin_layout Subsubsection*
21262 \begin_layout Standard
21264 \begin_inset Flex Noun
21267 \begin_layout Plain Layout
21268 Settings\SpecialChar menuseparator
21269 Configure Okular\SpecialChar menuseparator
21276 \begin_inset Quotes erd
21280 This inserts the appropriate command (
21281 \begin_inset Flex Code
21284 \begin_layout Plain Layout
21293 \begin_layout Standard
21294 Reverse search is triggered by SHIFT-click.
21296 \change_inserted -712698321 1578211026
21297 Note that this only works if Okular is in
21298 \begin_inset Quotes eld
21302 \begin_inset Quotes erd
21306 \begin_inset space \thinspace{}
21309 e., the hand symbol is clicked).
21314 \begin_layout Subsubsection*
21318 \begin_layout Standard
21319 Qpdfview supports Sync\SpecialChar TeX
21320 since version 0.3.5.
21322 \begin_inset Flex Noun
21325 \begin_layout Plain Layout
21326 Edit\SpecialChar menuseparator
21327 Settings\SpecialChar menuseparator
21333 , click on the input field of the
21334 \begin_inset Quotes eld
21338 \begin_inset Quotes erd
21341 item and add the command
21342 \begin_inset Flex Code
21345 \begin_layout Plain Layout
21354 \begin_layout Standard
21355 Reverse search is triggered by double-click or, in more recent versions,
21359 \begin_layout Subsubsection*
21363 \begin_layout Standard
21364 Launch yap, choose its
21365 \begin_inset Flex Noun
21368 \begin_layout Plain Layout
21369 View\SpecialChar menuseparator
21375 menu and select the
21376 \begin_inset Quotes eld
21380 \begin_inset Quotes erd
21385 \begin_inset Quotes eld
21388 New\SpecialChar ldots
21390 \begin_inset Quotes erd
21393 button and, in the window that opens, enter
21394 \begin_inset Quotes eld
21399 \begin_inset Quotes erd
21402 (or any other name you like) in the
21403 \begin_inset Quotes eld
21407 \begin_inset Quotes erd
21411 Now click on the button labeled
21412 \begin_inset Quotes eld
21417 \begin_inset Quotes erd
21420 to open a file dialog and navigate to the directory containing the batch
21422 \begin_inset Flex Code
21425 \begin_layout Plain Layout
21433 \begin_inset Flex Code
21436 \begin_layout Plain Layout
21442 and then specify the program arguments as
21443 \begin_inset Flex Code
21446 \begin_layout Plain Layout
21454 \begin_inset Flex Code
21457 \begin_layout Plain Layout
21463 wrapper is used for communicating with \SpecialChar LyX
21471 \begin_layout LyX-Code
21473 \begin_inset Newline newline
21476 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
21485 \begin_inset Newline newline
21499 \begin_layout Standard
21500 Make sure that the \SpecialChar LyX
21501 Server pipe path you specified in \SpecialChar LyX
21503 \begin_inset Flex Code
21506 \begin_layout Plain Layout
21520 , otherwise change the
21521 \begin_inset Flex Code
21524 \begin_layout Plain Layout
21530 wrapper accordingly.
21533 \begin_layout Standard
21534 In yap, reverse search is triggered by double-click.
21537 \begin_layout Subsubsection*
21538 SumatraPDF (Windows)
21541 \begin_layout Standard
21542 In order to use SumatraPDF for inverse search, enter
21543 \begin_inset Flex Code
21546 \begin_layout Plain Layout
21547 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
21552 in the viewer setting in
21553 \begin_inset Flex Noun
21556 \begin_layout Plain Layout
21557 Preferences\SpecialChar menuseparator
21558 File Handling\SpecialChar menuseparator
21559 File formats\SpecialChar menuseparator
21566 \begin_inset Flex Code
21569 \begin_layout Plain Layout
21575 is the previous wrapper.
21576 If SumatraPDF.exe is not in your command PATH, use its full file name.
21579 \begin_layout Standard
21580 Reverse search is triggered by double-click.
21583 \begin_layout Subsubsection*
21587 \begin_layout Standard
21588 First of all, make sure that yap is your default DVI viewer in the Windows
21589 environment, then launch it, choose its
21590 \begin_inset Flex Noun
21593 \begin_layout Plain Layout
21594 View\SpecialChar menuseparator
21600 menu and select the
21601 \begin_inset Quotes eld
21605 \begin_inset Quotes erd
21610 \begin_inset Quotes eld
21613 New\SpecialChar ldots
21615 \begin_inset Quotes erd
21618 button and, in the window that opens, enter
21619 \begin_inset Quotes eld
21624 \begin_inset Quotes erd
21627 (or any other name you like) in the
21628 \begin_inset Quotes eld
21632 \begin_inset Quotes erd
21636 Now click on the button labeled
21637 \begin_inset Quotes eld
21642 \begin_inset Quotes erd
21645 to open a file dialog and navigate to the directory containing the
21646 \begin_inset Flex Code
21649 \begin_layout Plain Layout
21655 program (which is installed by default on Cygwin along with the \SpecialChar LyX
21658 \begin_inset Flex Code
21661 \begin_layout Plain Layout
21667 and then specify the program arguments as
21668 \begin_inset Flex Code
21671 \begin_layout Plain Layout
21678 In this way, you will be using the
21682 for communicating with \SpecialChar LyX
21684 If, for whatever reason, you want to use the
21689 \begin_inset Flex Code
21692 \begin_layout Plain Layout
21698 option and be sure to specify the \SpecialChar LyX
21699 Server pipe path in the \SpecialChar LyX
21703 \begin_layout Standard
21704 In yap, reverse search is triggered by double-click.
21707 \begin_layout Subsubsection*
21708 SumatraPDF (Cygwin)
21711 \begin_layout Standard
21712 In order to use SumatraPDF for inverse search, enter
21713 \begin_inset Flex Code
21716 \begin_layout Plain Layout
21717 SumatraPDF -inverse-search "lyxeditor -g %f %l"
21722 in the viewer setting in
21723 \begin_inset Flex Noun
21726 \begin_layout Plain Layout
21727 Preferences\SpecialChar menuseparator
21728 File Handling\SpecialChar menuseparator
21729 File formats\SpecialChar menuseparator
21736 If SumatraPDF.exe is not in your command PATH, use its full posix path.
21738 \begin_inset Flex Code
21741 \begin_layout Plain Layout
21747 enables communication via the
21753 \begin_inset Flex Code
21756 \begin_layout Plain Layout
21762 option if you want to use the
21766 , and be sure to specify the \SpecialChar LyX
21767 Server pipe path in the \SpecialChar LyX
21771 \begin_layout Standard
21772 Reverse search is triggered by double-click.
21775 \begin_layout Section
21779 \begin_layout Standard
21780 Forward search is, as the name implies, in a sense the
21781 \begin_inset Quotes eld
21785 \begin_inset Quotes erd
21789 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
21791 If forward search is set up (as described in what follows), you can put
21792 the cursor anywhere in your \SpecialChar LyX
21794 \begin_inset Flex Noun
21797 \begin_layout Plain Layout
21798 Navigate\SpecialChar menuseparator
21805 \begin_inset Flex Noun
21808 \begin_layout Plain Layout
21814 in the context menu via right mouse click), and then the viewer will jump
21815 to that position as well.
21816 This implies, of course, that your viewer supports this function.
21819 \begin_layout Standard
21820 To make forward search possible, you first need to provide the generated
21821 output PDF/DVI file with additional information about the \SpecialChar TeX
21823 This can be done via the methods described in the section
21824 \begin_inset CommandInset ref
21826 reference "subsec:rev-search"
21833 \begin_layout Standard
21834 Additionally, you need to configure \SpecialChar LyX
21835 for using your viewers in
21836 \begin_inset Flex Noun
21839 \begin_layout Plain Layout
21840 Tools\SpecialChar menuseparator
21841 Preferences\SpecialChar menuseparator
21842 Output\SpecialChar menuseparator
21849 We provide a range of tested configurations for some viewers, which you
21850 can select from the drop down list.
21851 If none of these configurations suits you, you have to find out and enter
21852 a suitable configuration yourself.
21853 The definition syntax uses the following placeholders:
21856 \begin_layout Itemize
21858 \begin_inset Flex Code
21861 \begin_layout Plain Layout
21870 \begin_layout Itemize
21872 \begin_inset Flex Code
21875 \begin_layout Plain Layout
21881 : name of the (temporary) exported .tex file (without path)
21884 \begin_layout Itemize
21886 \begin_inset Flex Code
21889 \begin_layout Plain Layout
21895 : name of the (temporary) exported .tex file (including path)
21898 \begin_layout Itemize
21900 \begin_inset Flex Code
21903 \begin_layout Plain Layout
21909 : name of the exported output file (either dvi or pdf, depending on which
21910 one exists in the temporary directory)
21913 \begin_layout Standard
21914 Note that only some of the viewers provide full and usable forward search
21915 functionality out of the box, among them yap, xdvi, okular
21919 \begin_layout Plain Layout
21920 You might want to set
21921 \begin_inset Flex Code
21924 \begin_layout Plain Layout
21931 \begin_inset Flex Noun
21934 \begin_layout Plain Layout
21935 Tools\SpecialChar menuseparator
21936 Preferences\SpecialChar menuseparator
21937 File Handling\SpecialChar menuseparator
21939 \begin_inset space ~
21952 , qpdfview, and SumatraPDF
21956 \begin_layout Plain Layout
21957 SumatraPDF can also use DDE commands through the external program CMCDDE
21958 — downloadable from
21959 \begin_inset CommandInset href
21961 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
21972 Others, such as evince
21976 \begin_layout Plain Layout
21977 Forward search with evince can be achieved by means of third party helper
21980 \begin_inset CommandInset href
21982 target "https://wiki.lyx.org/LyX/SyncTeX"
21992 , require some extra tools in order to use forward search.
21993 While many of the widespread PDF viewers (most notably Adobe Reader) do
21994 not support forward search at all, some other viewers – e.
21995 \begin_inset space \thinspace{}
21999 xpdf – allow at least to reload the document and jump to a specific page
22000 of the file, so you can at least navigate
22001 \begin_inset Quotes eld
22005 \begin_inset Quotes erd
22009 This latter functionality is provided by an external call of synctex (see
22010 the predefined example configurations).
22014 \begin_layout Standard
22015 Forward search works both with DVI and PDF output.
22017 simply checks which preview format you have used before (i.
22018 \begin_inset space \thinspace{}
22021 e., which format is already there in the temporary directory) and chooses
22022 the appropriate configuration for the respective format.
22025 \begin_layout Chapter
22027 \change_deleted 564990737 1671097409
22028 Special Document Classes
22033 \begin_layout Section
22035 \change_deleted 564990737 1669742044
22039 \begin_layout Standard
22041 \change_deleted 564990737 1669742044
22047 \begin_layout Subsection
22049 \change_deleted 564990737 1669742044
22053 \begin_layout Standard
22055 \change_deleted 564990737 1669742044
22056 This section describes how \SpecialChar LyX
22057 can be used to write articles for submission
22058 to the scientific journal
22060 Astronomy and Astrophysics
22063 \begin_inset Flex URL
22066 \begin_layout Plain Layout
22068 https://www.aanda.org/
22073 ) using Version 5.01 of the document class
22078 This package can be downloaded from the ftp site
22081 \begin_layout Standard
22083 \change_deleted 564990737 1669742044
22084 \begin_inset VSpace medskip
22090 \begin_layout Standard
22093 \change_deleted 564990737 1669742044
22094 \begin_inset Flex URL
22097 \begin_layout Plain Layout
22099 ftp://ftp.edpsciences.org/pub/aa/readme.html
22107 \begin_layout Standard
22109 \change_deleted 564990737 1669742044
22110 \begin_inset VSpace medskip
22116 \begin_layout Standard
22118 \change_deleted 564990737 1669742044
22119 A manual comes together with that package, and this text is not meant to
22120 replace the original manual but is merely a short guide in how to realize
22121 the correct form of your paper.
22125 \begin_layout Standard
22127 \change_deleted 564990737 1669742044
22128 Please note that the publisher of the journal was changed from Springer
22129 to EDP Sciences starting January 1, 2001.
22130 That change involved also some slight changes to the style files, namely
22131 the removal of the thesaurus command.
22132 The \SpecialChar LyX
22133 class aa supports the newest version of these style files, V 5.01.
22134 If you have an older version installed, please upgrade.
22135 For compatibility, the old (version 4) layout has been kept as
22140 Please refer to the comments in
22143 Dir/layouts/aapaper.layout
22148 \begin_layout Subsection
22150 \change_deleted 564990737 1669742044
22154 \begin_layout Standard
22156 \change_deleted 564990737 1669742044
22157 It is recommended you start from the example template distributed with \SpecialChar LyX
22159 If you are not using a template, note the following settings:
22162 \begin_layout Itemize
22164 \change_deleted 564990737 1669742044
22171 Document\SpecialChar menuseparator
22174 dialog (OK, that one was obvious).
22177 \begin_layout Itemize
22179 \change_deleted 564990737 1669742044
22180 Don't change the option
22183 \begin_inset space ~
22193 The whole layout is done by the macros, you shouldn't change anything.
22196 \begin_layout Subsection
22198 \change_deleted 564990737 1669742044
22202 \begin_layout Standard
22204 \change_deleted 564990737 1669742044
22205 First thing to enter is the header information.
22206 It consists of seven entries, of which some are optional.
22210 \begin_layout Itemize
22212 \change_deleted 564990737 1669742044
22220 \begin_layout Itemize
22222 \change_deleted 564990737 1669742044
22230 \begin_layout Itemize
22232 \change_deleted 564990737 1669742044
22240 \begin_layout Itemize
22242 \change_deleted 564990737 1669742044
22250 \begin_layout Itemize
22252 \change_deleted 564990737 1669742044
22257 : [optional] if more than one author: whom to contact for offprint requests.
22260 \begin_layout Itemize
22262 \change_deleted 564990737 1669742044
22267 : [optional] mail address for contacts.
22270 \begin_layout Itemize
22272 \change_deleted 564990737 1669742044
22278 Suggested format is
22280 Received: <date>; Accepted <date>
22283 \begin_layout Standard
22285 \change_deleted 564990737 1669742044
22286 There is no need to issue the
22292 command, this is done automatically by \SpecialChar LyX
22293 when the header is finished.
22294 Although the order of the single header entries doesn't matter it is advised
22295 to keep the above sequence, just to get the best optics and meets the layout
22296 of the real document.
22299 \begin_layout Standard
22301 \change_deleted 564990737 1669742044
22302 If you want to place footnotes in the header block, e.
22303 \begin_inset space \thinspace{}
22307 \begin_inset space \space{}
22310 to state your present address, just use the standard footnote via the menu
22313 Insert\SpecialChar menuseparator
22318 will automagically use the term
22327 \begin_layout Standard
22329 \change_deleted 564990737 1669742044
22332 Edit\SpecialChar menuseparator
22335 , you'll find two insets which are relevant for the titling:
22338 \begin_layout Itemize
22340 \change_deleted 564990737 1669742044
22347 to mark corresponding author\SpecialChar breakableslash
22349 The institutes are numbered sequentially as they appear in the
22353 field, so you have to put a marker to each author.
22356 \begin_layout Itemize
22358 \change_deleted 564990737 1669742044
22363 to supply an email address for fast contact.
22366 \begin_layout Standard
22368 \change_deleted 564990737 1669742044
22369 In addition to these topics, the macros use one additional \SpecialChar LaTeX
22371 has no counterpart in \SpecialChar LyX
22375 \begin_layout Itemize
22377 \change_deleted 564990737 1669742044
22384 to separate different names for more than one author and institute, respectivel
22388 \begin_layout Standard
22390 \change_deleted 564990737 1669742044
22391 The appropriate command has to be entered in \SpecialChar LyX
22392 and marked as \SpecialChar LaTeX
22398 \begin_layout Subsection
22400 \change_deleted 564990737 1669742044
22404 \begin_layout Standard
22406 \change_deleted 564990737 1669742044
22407 The abstract should immediately follow the header block.
22408 With version 5 the abstract environment was changed to a command, and there
22409 is now a restriction to only one paragraph.
22410 In addition, it should contain an entry with the keywords.
22411 This is done via the paragraph style
22416 Refer to the example paper.
22419 \begin_layout Subsection
22421 \change_deleted 564990737 1669742044
22422 Supported environments
22425 \begin_layout Standard
22427 \change_deleted 564990737 1669742044
22428 The A&A paper layout supports the following environments for structuring
22432 \begin_layout Itemize
22434 \change_deleted 564990737 1669742044
22440 \begin_layout Itemize
22442 \change_deleted 564990737 1669742044
22448 \begin_layout Itemize
22450 \change_deleted 564990737 1669742044
22456 \begin_layout Itemize
22458 \change_deleted 564990737 1669742044
22464 \begin_layout Itemize
22466 \change_deleted 564990737 1669742044
22472 \begin_layout Itemize
22474 \change_deleted 564990737 1669742044
22480 \begin_layout Itemize
22482 \change_deleted 564990737 1669742044
22488 \begin_layout Itemize
22490 \change_deleted 564990737 1669742044
22496 \begin_layout Itemize
22498 \change_deleted 564990737 1669742044
22504 \begin_layout Itemize
22506 \change_deleted 564990737 1669742044
22512 \begin_layout Itemize
22514 \change_deleted 564990737 1669742044
22520 \begin_layout Itemize
22522 \change_deleted 564990737 1669742044
22529 \begin_layout Subsection
22531 \change_deleted 564990737 1669742044
22532 Commands not supported by \SpecialChar LyX
22536 \begin_layout Standard
22538 \change_deleted 564990737 1669742044
22539 Some commands are not yet supported by the
22543 layout for \SpecialChar LyX
22545 Some have already been mentioned.
22546 For the sake of completeness, they are listed all together here:
22549 \begin_layout Itemize
22551 \change_deleted 564990737 1669742044
22559 \begin_layout Itemize
22561 \change_deleted 564990737 1669742044
22569 \begin_layout Itemize
22571 \change_deleted 564990737 1669742044
22579 \begin_layout Itemize
22581 \change_deleted 564990737 1669742044
22589 \begin_layout Standard
22591 \change_deleted 564990737 1669742044
22592 If you want to use any of these commands, you have to enter them yourself.
22595 Do not forget to mark them as \SpecialChar LaTeX
22599 \begin_layout Subsection
22601 \change_deleted 564990737 1669742044
22602 Figure and Table Floats
22605 \begin_layout Standard
22607 \change_deleted 564990737 1669742044
22609 provides support for the necessary float environments
22611 figure, figure*, table
22617 , therefore we won't tell much about it here.
22621 \begin_inset space ~
22627 Just remember that tables should be left-aligned.
22628 For that, select the table and change the alignment in
22630 Edit\SpecialChar menuseparator
22632 \begin_inset space ~
22638 \begin_layout Standard
22640 \change_deleted 564990737 1669742044
22641 There is only one special thing: the figures with caption besides the figure.
22642 To create such a figure, you have to do the following:
22645 \begin_layout Enumerate
22647 \change_deleted 564990737 1669742044
22648 Create a wide figure float:
22650 Insert\SpecialChar menuseparator
22651 Float\SpecialChar menuseparator
22654 , then right click in the figure and select
22657 \begin_inset space ~
22665 \begin_layout Enumerate
22667 \change_deleted 564990737 1669742044
22668 Enter your caption text.
22671 \begin_layout Enumerate
22673 \change_deleted 564990737 1669742044
22678 to move the cursor above the caption.
22681 \begin_layout Enumerate
22683 \change_deleted 564990737 1669742044
22687 \begin_layout Enumerate
22689 \change_deleted 564990737 1669742044
22690 Position the cursor behind the figure and insert a horizontal fill:
22692 Insert\SpecialChar menuseparator
22694 \begin_inset space ~
22697 Character\SpecialChar menuseparator
22699 \begin_inset space ~
22707 \begin_layout Enumerate
22709 \change_deleted 564990737 1669742044
22710 Switch to \SpecialChar LaTeX
22714 \begin_inset space ~
22722 \begin_layout Enumerate
22724 \change_deleted 564990737 1669742044
22734 Do not close the brace!
22737 \begin_layout Enumerate
22739 \change_deleted 564990737 1669742044
22740 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
22745 \begin_inset space ~
22757 \begin_layout Standard
22759 \change_deleted 564990737 1669742044
22760 Also, refer to the figures in the example paper.
22763 \begin_layout Subsection
22765 \change_deleted 564990737 1669742044
22769 \begin_layout Standard
22771 \change_deleted 564990737 1669742044
22772 For submission, the paper has to be formated in a special double-spacing
22774 For this purpose, you have to give the option
22778 to the document class.
22779 This must be done using the custom class options field in the
22781 Document\SpecialChar menuseparator
22785 Just enter the string
22792 \begin_layout Subsection
22794 \change_deleted 564990737 1669742044
22798 \begin_layout Standard
22800 \change_deleted 564990737 1669742044
22805 directory contains an example paper written with \SpecialChar LyX
22807 It is the example paper from the original macro package, translated to
22810 Use it for inspiration, and compare the original \SpecialChar LaTeX
22811 code with \SpecialChar LyX
22815 \begin_layout Section
22817 \change_deleted 564990737 1671097429
22821 \begin_layout Standard
22823 \change_deleted 564990737 1671097429
22828 can be used to type letters according to German conventions.
22829 A template file is included in
22831 .../lyx/share/templates
22833 for you to use as a starting point.
22836 \begin_layout Section
22838 \change_deleted 564990737 1671097429
22842 \begin_layout Standard
22844 \change_deleted 564990737 1671097429
22845 See the \SpecialChar LyX
22851 It contains all infos you need.
22854 \begin_layout Section
22856 \change_deleted 564990737 1669755802
22860 \begin_layout Standard
22862 \change_deleted 564990737 1669755802
22865 Panayotis Papasotiriou
22868 \begin_layout Subsection
22870 \change_deleted 564990737 1669755802
22874 \begin_layout Standard
22876 \change_deleted 564990737 1669755802
22877 The ijmpc package is a set of macros that facilitates electronic manuscript
22880 International Journal of Modern Physics C
22883 Similarly, the ijmpd package is for creating manuscripts to be submitted
22886 International Journal of Modern Physics D
22889 Both journals are published by World Scientific.
22890 The corresponding document classes are named
22899 These files, together with instructions for the authors, can be downloaded
22901 \begin_inset Flex URL
22904 \begin_layout Plain Layout
22906 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
22912 \begin_inset Flex URL
22915 \begin_layout Plain Layout
22917 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
22923 Both packages are modified versions of the standard
22924 \begin_inset Quotes eld
22928 \begin_inset Quotes erd
22931 package, and they are almost (but not exactly) identical.
22932 Most of their features are supported by \SpecialChar LyX
22934 I have used \SpecialChar LyX
22935 successfully to write articles submitted to both journals
22936 without any problem.
22939 \begin_layout Subsection
22941 \change_deleted 564990737 1669755802
22945 \begin_layout Standard
22947 \change_deleted 564990737 1669755802
22948 As usual, the easiest way to write a paper is to start with a template.
22951 File\SpecialChar menuseparator
22967 This will give an (almost) empty document that includes the most common
22968 fields found in a manuscript.
22969 Simply overwrite the existing text (including the brackets,
22974 You should keep in mind the following remarks.
22977 \begin_layout Enumerate
22979 \change_deleted 564990737 1669755802
22981 won't let you change the font size and the page style of the document,
22982 because such modifications are not allowed by both packages.
22985 \begin_layout Enumerate
22987 \change_deleted 564990737 1669755802
22988 The language of the document should not be changed.
22989 Before previewing your paper, be sure that the babel package is not used.
22990 To do this, click on
22993 arg "dialog-show document"
22998 \SpecialChar menuseparator
23002 \begin_inset Quotes eld
23006 \begin_inset Quotes erd
23016 \begin_layout Enumerate
23018 \change_deleted 564990737 1669755802
23020 \begin_inset Quotes eld
23024 \begin_inset Quotes erd
23027 style must be used to define keywords.
23030 \begin_layout Enumerate
23032 \change_deleted 564990737 1669755802
23033 The ijmpc package provides a style named
23034 \begin_inset Quotes eld
23037 Classification Codes
23038 \begin_inset Quotes erd
23041 , which can be used to define classification codes, such as PACS numbers.
23042 Note that this facility is not supported by the ijmpd package.
23045 \begin_layout Enumerate
23047 \change_deleted 564990737 1669755802
23048 Several new environments are available:
23049 \begin_inset Quotes eld
23053 \begin_inset Quotes erd
23057 \begin_inset Quotes eld
23061 \begin_inset Quotes erd
23065 \begin_inset Quotes eld
23069 \begin_inset Quotes erd
23073 \begin_inset Quotes eld
23077 \begin_inset Quotes erd
23081 \begin_inset Quotes eld
23085 \begin_inset Quotes erd
23089 \begin_inset Quotes eld
23093 \begin_inset Quotes erd
23097 \begin_inset Quotes eld
23101 \begin_inset Quotes erd
23105 \begin_inset Quotes eld
23109 \begin_inset Quotes erd
23113 \begin_inset Quotes eld
23117 \begin_inset Quotes erd
23121 \begin_inset Quotes eld
23125 \begin_inset Quotes erd
23129 \begin_inset Quotes eld
23133 \begin_inset Quotes erd
23137 \begin_inset Quotes eld
23141 \begin_inset Quotes erd
23145 \begin_inset Quotes eld
23149 \begin_inset Quotes erd
23153 \begin_inset Quotes eld
23157 \begin_inset Quotes erd
23161 Their use is more or less obvious.
23163 supports all these environments; it will use the proper label, text style,
23164 and numbering scheme for each of them.
23167 \begin_layout Enumerate
23169 \change_deleted 564990737 1669755802
23170 Both packages use basic citations; the natbib package should not be used.
23171 In \SpecialChar LyX
23172 , citation references are shown as usual; in the output, citations are
23173 shown as superscripts.
23174 If you want to use a citation as normal text, you should use the
23179 \begin_inset space \thinspace{}
23183 \begin_inset space \space{}
23187 \begin_inset Quotes eld
23191 \begin_inset space \space{}
23201 \begin_inset Quotes erd
23207 \begin_layout Enumerate
23209 \change_deleted 564990737 1669755802
23211 \begin_inset Quotes eld
23215 \begin_inset Quotes erd
23218 section in both packages.
23219 To put acknowledgments, just use the
23220 \begin_inset Quotes eld
23224 \begin_inset Quotes erd
23230 \begin_layout Enumerate
23232 \change_deleted 564990737 1669755802
23233 Appendices may be added to the paper,
23237 the Acknowledgments and
23243 provides a special environment, called
23244 \begin_inset Quotes eld
23248 \begin_inset Quotes erd
23251 which marks the beginning of the appendices.
23252 This environment should be left blank; it just sends a \SpecialChar LaTeX
23253 command, but nothing
23255 In \SpecialChar LyX
23257 \begin_inset Quotes eld
23261 \begin_inset Quotes erd
23264 is printed with blue letters, as a signal that all sections after that
23265 point are appendices.
23266 To write an appendix, use the
23267 \begin_inset Quotes eld
23271 \begin_inset Quotes erd
23276 will number each appendix with capital letters, as required by both journals.
23278 \begin_inset Quotes eld
23282 \begin_inset Quotes erd
23289 be present before the first appendix; if not, all appendices will be numbered
23290 as normal sections in the output.
23293 \begin_layout Enumerate
23295 \change_deleted 564990737 1669755802
23296 The ijmpc and the ijmpd packages use the
23300 command to implement table captions.
23301 As a result, a table created by \SpecialChar LyX
23302 is printed correctly, but its caption
23304 However, you can use some \SpecialChar TeX
23305 code to overcome this problem, so that captions
23306 are printed as expected.
23307 To do so, create a float table as usual, remove the caption, and replace
23308 it with the \SpecialChar TeX
23319 (sic); you must also the \SpecialChar TeX
23324 immediately after the tabular material.
23325 Study the example table included in the template files to see how this
23326 trick is implemented.
23327 Alternatively, If you need table captions, you should implement the whole
23332 file, then include this file to the \SpecialChar LyX
23335 Insert\SpecialChar menuseparator
23336 File\SpecialChar menuseparator
23338 \begin_inset space ~
23344 Details on how to create a table float can be found in the files
23352 , included in the corresponding packages.
23355 \begin_layout Subsection
23357 \change_deleted 564990737 1669755802
23358 Preparing a paper for submission
23361 \begin_layout Standard
23363 \change_deleted 564990737 1669755802
23364 Before you submit your paper you must export the \SpecialChar LyX
23365 document as a \SpecialChar LaTeX
23368 File\SpecialChar menuseparator
23369 Export\SpecialChar menuseparator
23377 \begin_layout Plain Layout
23378 Actually you have the choice between \SpecialChar LaTeX
23379 (plain) and pdflatex.
23380 If you intend to use pdflatex to prepare the paper, you should use the
23381 pdflatex option so that included graphics are converted to PDF format,
23382 ready for use by pdflatex.
23387 , then make the following changes to the resulting
23394 \begin_layout Enumerate
23396 \change_deleted 564990737 1669755802
23397 Remove the comment lines before the
23406 \begin_layout Enumerate
23408 \change_deleted 564990737 1669755802
23409 Remove everything between (and including) the
23421 commands, except for any commands you specifically put into the \SpecialChar LaTeX
23425 \begin_layout Standard
23427 \change_deleted 564990737 1669755802
23432 file should be saved and processed through \SpecialChar LaTeX
23433 as many times as necessary.
23434 You may also want to check the resulting
23443 \begin_layout Section
23445 \change_deleted 564990737 1669801478
23449 \begin_layout Standard
23451 \change_deleted 564990737 1669801478
23457 \begin_layout Subsection
23459 \change_deleted 564990737 1669801478
23463 \begin_layout Standard
23465 \change_deleted 564990737 1669801478
23466 The iopart package provides a document class to create electronic manuscript
23467 submission to the journals published by the Institute of Physics.
23468 Instructions for the authors how to create a paper using the iopart class
23469 can be downloaded together with the iopart package from the site
23470 \begin_inset Flex URL
23473 \begin_layout Plain Layout
23475 ftp://ftp.iop.org/pub/journals/latex2e
23483 \begin_layout Subsection
23485 \change_deleted 564990737 1669801478
23489 \begin_layout Standard
23491 \change_deleted 564990737 1669801478
23492 The easiest way to write a paper is to start with the template
23496 that is available via
23498 File\SpecialChar menuseparator
23501 The template explains how to use the special text environments.
23502 Here are the most important advices:
23505 \begin_layout Itemize
23507 \change_deleted 564990737 1669801478
23508 To be able to compile your document to a PDF, PS, or DVI, ensure that the
23509 no AMS packages are loaded in
23511 Document\SpecialChar menuseparator
23512 Settings\SpecialChar menuseparator
23518 \begin_layout Itemize
23520 \change_deleted 564990737 1669801478
23523 The title environment defines the kind of your paper.
23524 So use one of the following environments for the title:
23528 \begin_layout Itemize
23530 \change_deleted 564990737 1669801478
23539 \begin_layout Itemize
23541 \change_deleted 564990737 1669801478
23550 \begin_layout Itemize
23552 \change_deleted 564990737 1669801478
23558 for a Topical review
23561 \begin_layout Itemize
23563 \change_deleted 564990737 1669801478
23572 \begin_layout Itemize
23574 \change_deleted 564990737 1669801478
23583 \begin_layout Itemize
23585 \change_deleted 564990737 1669801478
23591 for a Paper (same as Title)
23594 \begin_layout Itemize
23596 \change_deleted 564990737 1669801478
23602 for a Preliminary communication
23605 \begin_layout Itemize
23607 \change_deleted 564990737 1669801478
23613 for a Rapid communication
23616 \begin_layout Itemize
23618 \change_deleted 564990737 1669801478
23624 for a Letter to the editor
23628 \begin_layout Itemize
23630 \change_deleted 564990737 1669801478
23633 All title environments except of
23637 can have an optional short title.
23640 \begin_layout Itemize
23642 \change_deleted 564990737 1669801478
23643 There is a general title environment
23647 which is not directly supported by \SpecialChar LyX
23649 This can be used as \SpecialChar TeX
23650 code when your document doesn't fit into one of the
23654 \begin_layout Standard
23656 \change_deleted 564990737 1669801478
23657 For more informations like hints for special table and formula formatting,
23658 look at the IOP author guidelines.
23663 \begin_layout Section
23665 \change_deleted 564990737 1670317155
23669 \begin_layout Standard
23671 \change_deleted 564990737 1670317155
23674 Panayotis Papasotiriou
23677 \begin_layout Subsection
23679 \change_deleted 564990737 1670317155
23683 \begin_layout Standard
23685 \change_deleted 564990737 1670317155
23686 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
23687 that facilitates electronic manuscript submission to the journals they
23689 Most known of them (at least in my domain of interest) are
23691 Astrophysics and Space Science
23697 , but there are many others (see a complete list at
23698 \begin_inset Flex URL
23701 \begin_layout Plain Layout
23703 http://www.wkap.nl/jrnllist.htm/JRNLHOME
23709 The Kluwer package may be downloaded from the site
23710 \begin_inset Flex URL
23713 \begin_layout Plain Layout
23715 http://www.wkap.nl/kaphtml.htm/STYLEFILES
23721 A complete user guide is contained in that package (but it can also be
23722 downloaded separately).
23725 \begin_layout Standard
23727 \change_deleted 564990737 1670317155
23729 supports many features of the package but not everything.
23730 However, the \SpecialChar TeX
23731 code needed is reduced to some
23732 \begin_inset Quotes eld
23736 \begin_inset Quotes erd
23739 commands of the package (see
23740 \begin_inset space ~
23744 \begin_inset CommandInset ref
23746 reference "subsec:kluwer_peculiarities"
23751 I have recently used \SpecialChar LyX
23752 to write an article submitted to the
23754 Astrophysics and Space Science
23756 without any problem.
23759 \begin_layout Subsection
23761 \change_deleted 564990737 1670317155
23765 \begin_layout Standard
23767 \change_deleted 564990737 1670317155
23768 The easiest way to write a paper is to start with the Kluwer template file.
23771 File\SpecialChar menuseparator
23783 This will give an (almost) empty document that includes the most common
23784 fields found in a manuscript and a short description of their use.
23785 As in most templates, simply overwrite the existing text (including the
23790 ) with the correct information.
23793 \begin_layout Subsection
23795 \change_deleted 564990737 1670317155
23796 Preparing a paper for submission
23799 \begin_layout Standard
23801 \change_deleted 564990737 1670317155
23802 As in the AAS\SpecialChar TeX
23803 package, before you submit your paper to a journal you must
23805 \begin_inset Quotes eld
23809 \begin_inset Quotes erd
23815 \begin_layout Enumerate
23817 \change_deleted 564990737 1670317155
23818 Export your paper as a \SpecialChar LaTeX
23820 To do this, click on
23822 File\SpecialChar menuseparator
23823 Export\SpecialChar menuseparator
23831 \begin_layout Enumerate
23833 \change_deleted 564990737 1670317155
23838 file with a text editor and make the following changes
23842 \begin_layout Enumerate
23844 \change_deleted 564990737 1670317155
23845 remove the comment lines before the
23854 \begin_layout Enumerate
23856 \change_deleted 564990737 1670317155
23857 remove everything between (and including) the
23869 commands, except for any commands you specifically put into the \SpecialChar LaTeX
23873 \begin_layout Standard
23875 \change_deleted 564990737 1670317155
23884 \begin_layout Enumerate
23886 \change_deleted 564990737 1670317155
23891 file through \SpecialChar LaTeX
23892 as many times as necessary (usually up to three).
23895 \begin_layout Enumerate
23897 \change_deleted 564990737 1670317155
23903 \begin_inset space \thinspace{}
23907 \begin_inset space \space{}
23914 , and check if everything is OK (it should, if you didn't make any mistake).
23917 \begin_layout Subsection
23919 \change_deleted 564990737 1670317155
23920 \begin_inset Quotes eld
23924 \begin_inset Quotes erd
23927 of the Kluwer package
23928 \begin_inset CommandInset label
23930 name "subsec:kluwer_peculiarities"
23937 \begin_layout Standard
23939 \change_deleted 564990737 1670317155
23940 The Kluwer package has the following
23941 \begin_inset Quotes eld
23945 \begin_inset Quotes erd
23951 \begin_layout Enumerate
23953 \change_deleted 564990737 1670317155
23954 It is possible to write multiple articles in the same \SpecialChar LaTeX
23959 \begin_layout Plain Layout
23960 I can't imagine any good reason to do this.
23966 Each article must be included in the environment
23967 \begin_inset Quotes eld
23971 \begin_inset Quotes erd
23975 Unfortunately, this environment cannot be omitted, even if you write just
23977 Therefore, each article starts with the command
23983 and, obviously, ends with the command
23990 Although this can be implemented in \SpecialChar LyX
23991 , I didn't included it, since it looks
23992 ugly and can confuse the novice user.
23993 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
23996 \begin_inset Quotes eld
24001 \begin_inset Quotes erd
24007 \begin_layout Enumerate
24009 \change_deleted 564990737 1670317155
24010 Information given at the beginning of the article (i.
24011 \begin_inset space \thinspace{}
24015 \begin_inset space \space{}
24018 title, subtitle, author, institution, running title, running author, abstract
24019 and keywords) must be included in an environment called
24020 \begin_inset Quotes eld
24024 \begin_inset Quotes erd
24028 This is not implemented in \SpecialChar LyX
24029 , so you must enter title, subtitle etc.
24030 \begin_inset space ~
24033 between two \SpecialChar TeX
24049 \begin_layout Enumerate
24051 \change_deleted 564990737 1670317155
24052 According to the user manual, the label of each bibliography item must be
24076 \begin_layout Standard
24078 \change_deleted 564990737 1670317155
24083 template takes care of all these
24084 \begin_inset Quotes eld
24088 \begin_inset Quotes erd
24092 If you start a new paper using this template you don't need to do anything
24097 \begin_layout Enumerate
24099 \change_deleted 564990737 1670317155
24100 don't delete the \SpecialChar TeX
24101 code included in the template, and
24104 \begin_layout Enumerate
24106 \change_deleted 564990737 1670317155
24107 copy the example bibliography item included in the template and modify it
24108 as necessary to enter new bibliography items.
24111 \begin_layout Section
24113 \change_deleted 564990737 1671097446
24117 \begin_layout Standard
24119 \change_deleted 564990737 1671097446
24124 provides an alternative to the standard
24129 It provides similar functionality, but you might prefer this layout with
24130 sans serif sections, headings, and more.
24133 \begin_layout Section
24135 \change_deleted 564990737 1671097446
24136 Springer Journals (
24143 \begin_layout Standard
24145 \change_deleted 564990737 1671097446
24151 \begin_layout Subsection
24153 \change_deleted 564990737 1671097446
24157 \begin_layout Standard
24159 \change_deleted 564990737 1671097446
24160 These are the layout files for some of the journal formats used by Springer
24161 Verlag and listed on
24162 \begin_inset Flex URL
24165 \begin_layout Plain Layout
24167 http://www.springer.de/author/tex/help-journals.html
24172 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
24174 It is a modular system: the things common to all journals are implemented
24179 , which journal-specific layout files (such as, e.
24180 \begin_inset space \thinspace{}
24184 \begin_inset space \space{}
24191 for Journal of Geodesy) can include.
24194 \begin_layout Standard
24196 \change_deleted 564990737 1671097446
24197 This means that implementing support for any other Springer journal on this
24198 list is as simple as writing your own
24206 file following the outline given in
24214 \begin_layout Standard
24216 \change_deleted 564990737 1671097446
24217 It is reasonably well tested only for the Journal of Geodesy.
24226 come with the standard \SpecialChar LyX
24228 Install the relevant class file (downloaded from Springer) in a proper
24229 directory, reconfigure \SpecialChar LaTeX
24230 (in the te\SpecialChar TeX
24235 , as root if necessary — doesn't \SpecialChar LyX
24236 take care of this?), reconfigure \SpecialChar LyX
24241 \begin_layout Subsection
24243 \change_deleted 564990737 1671097446
24247 \begin_layout Standard
24249 \change_deleted 564990737 1671097446
24250 A large number of theorem-like styles —
24262 \begin_layout Standard
24264 \change_deleted 564990737 1671097446
24267 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
24268 _Title, Author_Running, Institute,
24269 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
24272 See the Springer class file documentation for details.
24275 \begin_layout Subsection
24277 \change_deleted 564990737 1671097446
24281 \begin_layout Itemize
24283 \change_deleted 564990737 1671097446
24295 \begin_layout Itemize
24297 \change_deleted 564990737 1671097446
24300 Probability Theory and Related Fields
24306 — Jean-Marc Lasgouttes
24309 \begin_layout Standard
24311 \change_deleted 564990737 1671097446
24312 Add your own, it isn't so hard!
24315 \begin_layout Subsection
24317 \change_deleted 564990737 1671097446
24321 \begin_layout Standard
24323 \change_deleted 564990737 1671097446
24324 These files are partly based on the older
24328 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
24330 file from Springer.
24335 layout, are now defunct.
24336 Jean-Marc Lasgouttes helped out big in making me find my way around the
24338 layout file mechanism.
24341 \begin_layout Subsection
24343 \change_deleted 564990737 1671097446
24347 \begin_layout Standard
24349 \change_deleted 564990737 1671097446
24351 But probably less than in the old hacked-\SpecialChar LaTeX
24359 \begin_layout Chapter
24361 Features needing Extra Software
24364 \begin_layout Section
24365 Checking \SpecialChar TeX
24369 \begin_layout Standard
24375 \begin_layout Subsection
24379 \begin_layout Standard
24388 \begin_layout Plain Layout
24393 is not yet available when you are using the \SpecialChar LaTeX
24394 distribution MiK\SpecialChar TeX
24400 , you'll find in the
24407 \begin_inset space ~
24418 \begin_inset Newline newline
24422 \begin_inset CommandInset href
24424 target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
24432 \begin_layout Standard
24435 Chk\SpecialChar TeX
24438 package is a program that was written by
24439 \begin_inset Flex Noun
24442 \begin_layout Plain Layout
24444 \begin_inset space ~
24452 in frustration because some constructs in \SpecialChar LaTeX
24453 are sometimes non-intuitive,
24454 and easy to forget.
24455 The program runs over your \SpecialChar LaTeX
24456 file, checks the integrity of the file, and
24457 flags some common errors.
24458 In other technical words, it is
24462 for \SpecialChar LaTeX
24466 \begin_layout Standard
24467 Well, what is a syntax checker doing in \SpecialChar LyX
24468 which is supposed to produce correct
24470 anyways? The answer is simple: Just as
24474 not only checks the
24478 of C programs, but also does
24482 checks for type-errors,
24484 Chk\SpecialChar TeX
24487 catches some common
24491 errors, in addition to the syntactical ones.
24494 Chk\SpecialChar TeX
24497 is capable of detecting several common errors, such as
24500 \begin_layout Itemize
24501 Ellipsis detection:
24502 \begin_inset Newline newline
24505 Use \SpecialChar ldots
24509 \begin_layout Itemize
24510 No space in front of/after parenthesis:
24511 \begin_inset Newline newline
24517 \begin_layout Itemize
24518 Enforcement of normal space after common abbreviations:
24519 \begin_inset Newline newline
24523 \begin_inset space \thinspace{}
24527 \begin_inset space \space{}
24530 is too wide spacing.
24533 \begin_layout Itemize
24534 Enforcement of end-of-sentence space when the last sentence ends with a
24536 \begin_inset Newline newline
24540 And this is wrong spacing.
24543 \begin_layout Itemize
24544 Space in front of labels and similar commands:
24545 \begin_inset Newline newline
24548 The label should stick right up to the text to avoid falling to a wrong
24551 \begin_inset CommandInset label
24561 \begin_layout Plain Layout
24562 This footnote is in danger of falling off to a wrong page
24567 The label is separated too much.
24570 \begin_layout Itemize
24571 Space in front of references, instead of hard spaces:
24572 \begin_inset Newline newline
24575 If you have bad luck, the text will break right between the referenced text
24576 and reference number, and that's a pity.
24578 \begin_inset CommandInset ref
24580 reference "sec:chktex"
24587 \begin_layout Itemize
24589 \begin_inset Quotes eld
24593 \begin_inset Quotes erd
24597 \begin_inset Formula $\times$
24601 \begin_inset Newline newline
24604 2x2 looks cheap compared to
24605 \begin_inset Formula $2\times2$
24611 \begin_layout Standard
24612 and more \SpecialChar ldots
24613 It is an invaluable tool when you are
24614 \begin_inset Quotes eld
24618 \begin_inset Quotes erd
24621 your document before printing, and you should run it right after the obligatory
24622 spelling check, and before you go fine tuning the typesetting.
24625 \begin_layout Subsection
24629 \begin_layout Standard
24630 If you have the program installed, usage is as simple as choosing
24632 Tools\SpecialChar menuseparator
24634 \begin_inset space ~
24640 This will make \SpecialChar LyX
24641 generate a \SpecialChar LaTeX
24642 file of your document, start
24644 Chk\SpecialChar TeX
24647 to check it, and then make \SpecialChar LyX
24649 \begin_inset Quotes eld
24653 \begin_inset Quotes erd
24656 with the warnings from
24658 Chk\SpecialChar TeX
24661 , if there were any.
24662 The warnings will be placed close to the point of the mistake, and you
24663 can quickly find them by using the
24665 Navigate\SpecialChar menuseparator
24668 menu item, or the shortcut key
24677 Open the error boxes by clicking on them with the mouse, or use the shortcut
24686 bindings, or the corresponding
24695 Read the warning and correct the mistake, if it is a mistake.
24696 If you have trouble understanding what the warning is about, you can safely
24698 Remember that there is a hidden layer between the document on screen and
24699 the technical details in invoking
24701 Chk\SpecialChar TeX
24704 , and this gap can make some warnings seem arcane or just plain silly.
24707 \begin_layout Standard
24708 This document is an excellent testing bed for the feature, and it should
24709 provide quite a few warnings for you to fiddle with.
24710 Since computers are only so smart, expect most of the warnings to be false
24714 \begin_layout Subsection
24715 How to fine tune it
24718 \begin_layout Standard
24719 Sometimes, you'll find that
24721 Chk\SpecialChar TeX
24724 makes more noise than suits your mood.
24725 Then you can choose not to use it, wait until your mood changes, or try
24728 Chk\SpecialChar TeX
24731 to get better along with you.
24734 \begin_layout Standard
24737 Chk\SpecialChar TeX
24744 very configurable and extensible, you should not expect to solve all problems
24747 Chk\SpecialChar TeX
24750 in \SpecialChar LyX
24752 Since \SpecialChar LyX
24753 has to generate a somewhat special \SpecialChar LaTeX
24754 file to be able to match the
24755 line numbers from the
24757 Chk\SpecialChar TeX
24764 \begin_layout Plain Layout
24765 You can inspect the specific output from
24771 Document\SpecialChar menuseparator
24774 \begin_inset space ~
24788 to the internal document structure, some of the warnings will not appear
24790 There are two things you can do about this:
24793 \begin_layout Itemize
24796 Chk\SpecialChar TeX
24799 invocation command line in
24800 \begin_inset Flex Noun
24803 \begin_layout Plain Layout
24804 Tools\SpecialChar menuseparator
24805 Preferences\SpecialChar menuseparator
24806 Output\SpecialChar menuseparator
24807 LaTeX\SpecialChar menuseparator
24815 Chk\SpecialChar TeX
24818 installation configuration file (usually with the file
24823 See below to learn what warnings can be enabled and disabled on the command
24827 \begin_layout Itemize
24828 Export your document as a raw \SpecialChar LaTeX
24831 File\SpecialChar menuseparator
24832 Export\SpecialChar menuseparator
24841 Invoked in this way, it can be a hassle to find the corresponding place
24842 in the document inside \SpecialChar LyX
24843 , but with a little patience, you should be able
24847 \begin_layout Standard
24848 Here follows the warning messages that can be enabled and disabled in
24857 to disable a warning, and
24861 to enable a warning.
24862 The emphasized entries are disabled by default, because the default is
24865 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
24870 \begin_layout Standard
24871 Notice that you should only use the options that enable and disable warnings,
24872 because \SpecialChar LyX
24873 relies on some of the other command line parameters to be set
24874 in a specific way to have a chance to communicate with
24881 \begin_layout Enumerate
24885 Command terminated with space.
24888 \begin_layout Enumerate
24891 Non-breaking space (
24892 \begin_inset Quotes eld
24900 \begin_inset Quotes erd
24903 ) should have been used.
24906 \begin_layout Enumerate
24910 You should enclose the previous parenthesis with
24911 \begin_inset Quotes eld
24919 \begin_inset Quotes erd
24925 \begin_layout Enumerate
24928 Italic correction (
24929 \begin_inset Quotes eld
24939 \begin_inset Quotes erd
24942 ) found in non-italic buffer.
24945 \begin_layout Enumerate
24948 Italic correction (
24949 \begin_inset Quotes eld
24959 \begin_inset Quotes erd
24962 ) found more than once.
24965 \begin_layout Enumerate
24969 No italic correction (
24970 \begin_inset Quotes eld
24980 \begin_inset Quotes erd
24986 \begin_layout Enumerate
24990 \begin_inset Quotes eld
24998 \begin_inset Quotes erd
25002 \begin_inset Quotes eld
25010 \begin_inset Quotes erd
25016 \begin_layout Enumerate
25019 Wrong length of dash may have been used.
25022 \begin_layout Enumerate
25026 \begin_inset Quotes eld
25034 \begin_inset Quotes erd
25038 \begin_inset Quotes eld
25046 \begin_inset Quotes erd
25052 \begin_layout Enumerate
25056 \begin_inset Quotes eld
25064 \begin_inset Quotes erd
25070 \begin_layout Enumerate
25074 \begin_inset Quotes eld
25082 \begin_inset Quotes erd
25085 to achieve an ellipsis.
25088 \begin_layout Enumerate
25091 Inter-word spacing (
25092 \begin_inset Quotes eld
25102 \begin_inset Quotes eld
25105 ) should perhaps be used.
25108 \begin_layout Enumerate
25111 Inter-sentence spacing (
25112 \begin_inset Quotes eld
25122 \begin_inset Quotes erd
25125 ) should perhaps be used.
25128 \begin_layout Enumerate
25131 Could not find argument for command.
25134 \begin_layout Enumerate
25138 \begin_inset Quotes eld
25146 \begin_inset Quotes erd
25152 \begin_layout Enumerate
25155 Math mode still on at end of \SpecialChar LaTeX
25159 \begin_layout Enumerate
25163 \begin_inset Quotes eld
25171 \begin_inset Quotes erd
25174 doesn't match the number of
25175 \begin_inset Quotes eld
25183 \begin_inset Quotes erd
25189 \begin_layout Enumerate
25192 You should use either
25195 \begin_inset Quotes eld
25203 \begin_inset Quotes erd
25208 as an alternative to
25209 \begin_inset Quotes eld
25217 \begin_inset Quotes erd
25223 \begin_layout Enumerate
25230 " (ASCII 39) instead of "
25237 \begin_layout Enumerate
25240 User-specified pattern found.
25243 \begin_layout Enumerate
25246 This command might not be intended.
25249 \begin_layout Enumerate
25256 \begin_layout Enumerate
25274 \begin_layout Enumerate
25277 Delete this space to maintain correct page references.
25280 \begin_layout Enumerate
25284 You might wish to put this between a pair of
25285 \begin_inset Quotes eld
25293 \begin_inset Quotes erd
25299 \begin_layout Enumerate
25302 You ought to remove spaces in front of punctuation.
25305 \begin_layout Enumerate
25308 Could not execute \SpecialChar LaTeX
25312 \begin_layout Enumerate
25321 in front of small punctuation.
25324 \begin_layout Enumerate
25332 may look prettier here.
25335 \begin_layout Enumerate
25339 Multiple spaces detected in output.
25342 \begin_layout Enumerate
25345 This text may be ignored.
25348 \begin_layout Enumerate
25354 \begin_inset Quotes eld
25359 to begin quotation, not
25366 \begin_layout Enumerate
25373 to end quotation, not
25376 \begin_inset Quotes eld
25384 \begin_layout Enumerate
25390 \begin_layout Enumerate
25393 You should perhaps use
25394 \begin_inset Quotes eld
25402 \begin_inset Quotes erd
25408 \begin_layout Enumerate
25411 You should put a space in front of/after parenthesis.
25414 \begin_layout Enumerate
25417 You should avoid spaces in front of/after parenthesis.
25420 \begin_layout Enumerate
25424 You should not use punctuation in front of/after quotes.
25427 \begin_layout Enumerate
25430 Double space found.
25433 \begin_layout Enumerate
25436 You should put punctuation outside inner/inside display math mode.
25439 \begin_layout Enumerate
25442 You ought to not use primitive \SpecialChar TeX
25443 in \SpecialChar LaTeX
25447 \begin_layout Enumerate
25450 You should remove spaces in front of
25451 \begin_inset Quotes eld
25459 \begin_inset Quotes erd
25465 \begin_layout Enumerate
25468 \begin_inset Quotes eld
25476 \begin_inset Quotes erd
25479 is normally not followed by
25480 \begin_inset Quotes eld
25488 \begin_inset Quotes erd
25494 \begin_layout Standard
25495 In later versions of \SpecialChar LyX
25496 , we hope to provide a more complete interface to this
25497 tool (and it's smaller cousin
25501 ) to exploit the full power of it.
25502 But it's not exactly useless as it is now: go try it on one of your existing
25503 documents of a certain length and be surprised.
25506 \begin_layout Section
25507 Version Control in \SpecialChar LyX
25511 \begin_layout Standard
25514 Lars Gullik Bjønnes
25521 \begin_layout Subsection
25525 \begin_layout Standard
25527 supports some of the most basic RCS/CVS/SVN/GIT commands.
25528 If you need something a bit more sophisticated you will have to do that
25529 manually in a terminal.
25532 \begin_layout Standard
25533 Also note that CVS support is not as good as subversion support, so we advise
25535 A good place to start learning Subversion is the SVN Book
25539 \begin_layout Plain Layout
25540 \begin_inset CommandInset href
25542 target "http://svnbook.red-bean.com/"
25553 In the case of RCS you should read
25554 \begin_inset Quotes eld
25558 \begin_inset Quotes erd
25561 (a man file, read it with
25566 This file describes all the basic features of RCS.
25567 You should especially notice the comment about a RCS directory, and the
25568 notion of a master RCS file (the file ending in
25575 \begin_layout Standard
25576 Before you begin to use the version control features in \SpecialChar LyX
25578 familiar with RCS/CVS/SVN/GIT usage.
25579 The implementation in \SpecialChar LyX
25580 assumes a recent version of the GNU RCS or CVS/SVN
25581 package — no guarantees are made for older versions.
25582 Most of the log messages are not currently displayed after operations —
25583 you can check them in the Messages pane if you are unsure.
25584 Regular users of version control will appreciate the VC toolbar, which
25587 View\SpecialChar menuseparator
25588 Toolbars\SpecialChar menuseparator
25590 \begin_inset space ~
25598 \begin_layout Standard
25599 For introducing your own external commands consult
25600 \begin_inset Flex Code
25603 \begin_layout Plain Layout
25617 \begin_layout Standard
25618 It is strongly recommended to store documents in uncompressed format if
25619 using version control (uncheck
25621 Document\SpecialChar menuseparator
25624 if it is checked): Uncompressed LyX documents are text files and therefore
25625 for merging two different versions by version control systems.
25626 Compressed LyX documents are binary files, which cannot be merged by version
25630 \begin_layout Subsection
25631 RCS commands in \SpecialChar LyX
25635 \begin_layout Standard
25636 The following sections describe the RCS commands supported by \SpecialChar LyX
25638 You can find them in the
25640 File\SpecialChar menuseparator
25642 \begin_inset space ~
25649 was tested against RCS 5.7/5.8.
25652 \begin_layout Subsubsection
25658 \begin_layout Standard
25659 If your document is not under revision control, this is the only item shown
25661 And if it is under revision control, the
25665 item is not visible.
25669 \begin_layout Standard
25670 This command registers your document with RCS (unless you are under the
25671 directory managed by CVS)\SpecialChar endofsentence
25672 You are asked interactively to supply an initial
25673 description of the document.
25674 The document is now set in Read-Only mode and you have to
25677 \begin_inset space ~
25681 \begin_inset space ~
25685 \begin_inset space ~
25690 , before making any changes to it.
25691 A document under revision control has a
25692 \begin_inset Quotes eld
25695 [RCS:<version> <locker>]
25696 \begin_inset Quotes erd
25699 item tagged to the filename in the minibuffer.
25702 \begin_layout Standard
25703 RCS command that is run:
25706 \begin_layout LyX-Code
25709 ci -q -u -i -t-"<initial description>" <file-name>
25712 \begin_layout Standard
25717 to understand the switches.
25721 \begin_layout Subsubsection
25727 \begin_layout Standard
25728 When you are finished editing a file, you check in your changes.
25729 When you do this, you are asked for a description of the changes.
25730 This is stored in the history log.
25731 The version number is bumped, your changes are applied to the master RCS
25732 file, the document is unlocked and set to Read-Only mode.
25735 \begin_layout Itemize
25738 ci -q -u -m"<description>" <file-name>
25741 \begin_layout Subsubsection
25747 \begin_layout Standard
25748 By doing this you lock the document so that only you can edit it.
25749 This will also make the document Read-Write only for you.
25750 You will usually continue editing for a while and when you are finished
25751 you check in your changes.
25752 The status line is changed to reflect that you have locked the file.
25755 \begin_layout Itemize
25758 co -q -l <file-name>
25761 \begin_layout Subsubsection
25764 Revert To Repository Version
25767 \begin_layout Standard
25768 This will discard all changes made to the document since the last check
25770 You get a warning before changes are discarded.
25773 \begin_layout Itemize
25776 co -f -u<version> <file-name>
25779 \begin_layout Subsubsection
25785 \begin_layout Standard
25786 This will create a copy of the current document.
25787 Since RCS does not support copy operations natively, the version history
25788 is not preserved, and the copy is added as a new file.
25789 It requires a clean document without any changes since the last checkin.
25790 You are asked for a file name and a description of the copy operation.
25791 After that the copy is created, both locally and in the repository.
25792 If the parent directories of the copied and original document differ, all
25793 relative paths of included files of the copy are adjusted (like in
25795 File\SpecialChar menuseparator
25800 Finally, the copy is loaded instead of the original document.
25803 \begin_layout Labeling
25804 \labelwidthstring 00.00.0000
25806 \begin_inset space ~
25810 \begin_inset space ~
25814 \begin_inset Newline newline
25818 \begin_inset Flex Code
25821 \begin_layout Plain Layout
25824 \begin_inset Quotes qld
25828 \begin_inset Quotes qld
25837 \begin_inset Flex Code
25840 \begin_layout Plain Layout
25843 \begin_inset Quotes qld
25847 \begin_inset Quotes qld
25856 \begin_inset Newline newline
25860 \begin_inset Flex Code
25863 \begin_layout Plain Layout
25867 \begin_inset Quotes qld
25871 \begin_inset Quotes qld
25882 \begin_layout Subsubsection
25888 \begin_layout Standard
25889 This makes as if the last check in never happened.
25890 No changes are made to the document loaded into \SpecialChar LyX
25891 , but the last version
25892 is removed from the master RCS file.
25895 \begin_layout Itemize
25898 rcs -o<version> <file-name>
25901 \begin_layout Subsubsection
25907 \begin_layout Standard
25908 This shows the complete history of the RCS document.
25913 is shown in a browser.
25921 \begin_layout Subsubsection
25925 \begin_layout Standard
25927 supports RCS version number, author name, date and time of last commit.
25928 All those are extracted from
25930 rlog -r <file-name>
25934 \begin_inset CommandInset ref
25936 reference "subsec:VCS-Revision-Information"
25943 \begin_layout Subsection
25944 CVS commands in \SpecialChar LyX
25948 \begin_layout Standard
25949 A subset of CVS operations is supported by \SpecialChar LyX
25951 You can find the commands in the
25953 File\SpecialChar menuseparator
25955 \begin_inset space ~
25961 The version control system SVN is more powerful, so please use it instead
25962 of CVS if possible.
25965 \begin_layout Subsubsection
25971 \begin_layout Standard
25972 If you start from scratch with CVS you have to create your repository and
25973 checkout the working copy with external tools.
25974 If you're using a client-server setup you may need to login before doing
25975 the first repository checkout.
25978 \begin_layout Standard
25979 If your documents are under revision control and others are using the same
25980 repository problems arise when different changes to the same document at
25981 the same location happen.
25982 Standard CVS repositories don't operate with a file locking mechanism.
25983 This may be surprising, but conflicts only occur if people disagree on
25984 the proper content of the same part of a document.
25985 So, if co-workers are used to communicate regularly, these conflicts occur
25987 If they don't communicate they have a fundamental problem anyway.
25988 Nevertheless some people like to work with so called
25989 \begin_inset Quotes eld
25993 \begin_inset Quotes erd
25997 If they do so the working copy of all files is readonly when checked out
25998 first and the user starts editing after using a special command to make
25999 the working copy writable.
26000 When the changes are checked in the working copy returns to readonly state.
26001 With \SpecialChar LyX
26002 one has to edit the
26003 \begin_inset Flex Code
26006 \begin_layout Plain Layout
26012 file and add the line
26013 \begin_inset Flex Code
26016 \begin_layout Plain Layout
26022 to work with reserved checkouts.
26023 The benefit is the possibility to see who is using a writable copy of some
26025 It's not guaranteed only one user makes a copy writable.
26028 \begin_layout Standard
26030 tries to guess if you're using reserved or non-reserved checkouts.
26031 If your working copy is readonly or it is writable and an additional copy
26032 of your document exists in the CVS/Base sub-directory a reserved otherwise
26033 a non-reserved checkout is assumed.
26034 When a reserved checkout is detected you have to use
26035 \begin_inset Flex Noun
26038 \begin_layout Plain Layout
26044 to make your working copy writable if it's readonly.
26046 \begin_inset Flex Noun
26049 \begin_layout Plain Layout
26055 operation is possible and that makes your working copy readonly again after
26056 transferring your changes to the repository.
26059 \begin_layout Standard
26060 More information about CVS can be found here
26061 \begin_inset Flex URL
26064 \begin_layout Plain Layout
26066 http://www.nongnu.org/cvs
26072 \begin_inset Flex URL
26075 \begin_layout Plain Layout
26077 http://ximbiot.com/cvs
26085 \begin_layout Standard
26090 to understand the sub-commands and the switches mentioned below.
26093 \begin_layout Subsubsection
26099 \begin_layout Standard
26100 If your document is not under revision control, this is the only item shown
26102 And if it is under revision control, the
26106 item is not visible.
26110 \begin_layout Standard
26111 This command registers in CVS your document
26112 \begin_inset Flex Strong
26115 \begin_layout Plain Layout
26123 in the case you have already the documents directory under CVS control
26129 This means you have to create or checkout the archive by yourself using
26131 (In case you forget that step \SpecialChar LyX
26132 registers the document with RCS.)
26135 \begin_layout Standard
26136 Then you are asked interactively to supply an initial description of the
26138 Don't forget that registered file is not yet checked in.
26141 \begin_layout Standard
26142 CVS command that is run:
26144 cvs -q add -m"<entered message>" "<file-name>"
26147 \begin_layout Standard
26152 above and for all other CVS commands is an abbreviation for
26153 \begin_inset Quotes eld
26156 change the current working directory to file location and use the file name
26157 without path component as argument
26158 \begin_inset Quotes erd
26164 \begin_layout Subsubsection
26170 \begin_layout Standard
26171 When you are finished editing a file, you commit your changes.
26172 When you do this and you had changed the document, you are asked for a
26173 description of the changes.
26174 After that changes are written to the repository.
26175 In case you didn't change the document and a reserved checkout is detected
26176 the reservation made on
26177 \begin_inset Flex Noun
26180 \begin_layout Plain Layout
26189 \begin_layout Labeling
26190 \labelwidthstring 00.00.0000
26192 \begin_inset space ~
26196 \begin_inset space ~
26200 \begin_inset Newline newline
26204 \begin_inset Flex Code
26207 \begin_layout Plain Layout
26210 -q commit -m"<description>" "<file-name>"
26216 \begin_inset Newline newline
26220 \begin_inset Flex Code
26223 \begin_layout Plain Layout
26234 \begin_layout Subsubsection
26240 \begin_layout Standard
26241 When you are sharing a repository with others, you may have to incorporate
26242 their changes into your working copy.
26245 \begin_layout Standard
26248 cvs -q update "<file-name>"
26251 \begin_layout Standard
26252 If a readonly checkout is detected the working copy is made writable and
26256 \begin_layout Standard
26259 cvs -q edit "<file-name>"
26262 \begin_layout Subsubsection
26265 Revert To Repository Version
26268 \begin_layout Standard
26269 This will discard all changes made to the document since the last check
26271 You get a warning before changes are discarded.
26272 Firstly the file is deleted, secondly CVS update command is run.
26275 \begin_layout Standard
26278 cvs -q update "<file-name>"
26281 \begin_layout Standard
26282 If a reserved checkout is detected and the working copy has no changes only
26283 the reservation is undone.
26286 \begin_layout Standard
26289 cvs -q unedit "<file-name>"
26292 \begin_layout Subsubsection
26298 \begin_layout Standard
26299 This will create a copy of the current document.
26300 Since CVS does not support copy operations natively, the version history
26301 is not preserved, and the copy is added as a new file.
26302 It requires a clean document without any changes since the last checkin.
26303 You are asked for a file name and a description of the copy operation.
26304 After that the copy is created, both locally and in the repository.
26305 If the parent directories of the copied and original document differ, all
26306 relative paths of included files of the copy are adjusted (like in
26308 File\SpecialChar menuseparator
26313 Finally, the copy is loaded instead of the original document.
26316 \begin_layout Labeling
26317 \labelwidthstring 00.00.0000
26319 \begin_inset space ~
26323 \begin_inset space ~
26327 \begin_inset Newline newline
26331 \begin_inset Flex Code
26334 \begin_layout Plain Layout
26341 \begin_inset Flex Code
26344 \begin_layout Plain Layout
26351 \begin_inset Newline newline
26355 \begin_inset Flex Code
26358 \begin_layout Plain Layout
26359 cvs -q add "<new-file-name>"
26367 \begin_layout Subsubsection
26373 \begin_layout Standard
26374 This will rename the current document.
26375 Since CVS does not support rename operations natively, the version history
26376 is not preserved, the renamed document is added as a new file, and the
26377 original document is deleted.
26378 It requires a clean document without any changes since the last checkin.
26379 You are asked for a file name and a description of the rename operation.
26380 After that the document is renamed, both locally and in the repository.
26381 If the parent directories of the new and old file names differ, all relative
26382 paths of included files are adjusted (like in
26384 File\SpecialChar menuseparator
26389 Finally, the document is reloaded using the new name.
26392 \begin_layout Labeling
26393 \labelwidthstring 00.00.0000
26395 \begin_inset space ~
26399 \begin_inset space ~
26403 \begin_inset Newline newline
26407 \begin_inset Flex Code
26410 \begin_layout Plain Layout
26417 \begin_inset Flex Code
26420 \begin_layout Plain Layout
26427 \begin_inset Newline newline
26431 \begin_inset Flex Code
26434 \begin_layout Plain Layout
26435 cvs -q add "<new-file-name>"
26441 \begin_inset Newline newline
26445 \begin_inset Flex Code
26448 \begin_layout Plain Layout
26449 cvs -q remove "<file-name>"
26457 \begin_layout Subsubsection
26458 Update of the local directory checkout from repository
26461 \begin_layout Standard
26462 Once your documents gets more complex, containing sub-documents and pictures,
26464 \begin_inset Flex Code
26467 \begin_layout Plain Layout
26473 files and so on using version control becomes more complicated.
26475 supports updating the whole tree in which resides the document.
26476 This become especially useful once you cooperate with people which neither
26477 have detailed knowledge about CVS usage nor they have ambition to commit
26478 additional material to the repository.
26479 You have to organize the files structure so that all external files are
26480 in the same directory or subdirectories of the document.
26481 It's good practice anyway to store multipart documents in an extra directory.
26484 \begin_layout Standard
26486 \begin_inset Flex Code
26489 \begin_layout Plain Layout
26490 Update local directory from repository
26495 command updates the whole directory.
26496 If local changes are detected user is warned before update starts.
26497 In case of merge conflicts both versions of the conflicting document parts
26498 are placed in the final document.
26499 You have to review and correct the result of the merge.
26500 You'll find the conflicts enclosed in pairs of
26501 \begin_inset Flex Code
26504 \begin_layout Plain Layout
26511 \begin_inset Flex Code
26514 \begin_layout Plain Layout
26521 \begin_inset Flex Code
26524 \begin_layout Plain Layout
26531 The first part is your version as before the update operation with the
26532 document name prepended.
26533 The second one is the repository version with the version number after
26535 \begin_inset Flex Code
26538 \begin_layout Plain Layout
26547 \begin_layout Labeling
26548 \labelwidthstring 00.00.0000
26550 \begin_inset space ~
26554 \begin_inset space ~
26558 \begin_inset Newline newline
26562 \begin_inset Flex Code
26565 \begin_layout Plain Layout
26573 (Ask if changes are detected.)
26574 \begin_inset Newline newline
26578 \begin_inset Flex Code
26581 \begin_layout Plain Layout
26582 cd $path; cvs -q update
26592 \begin_layout Standard
26594 \begin_inset Flex Code
26597 \begin_layout Plain Layout
26603 stands for the path to the document.
26606 \begin_layout Subsubsection
26612 \begin_layout Standard
26613 This shows the complete history of the CVS document.
26616 cvs log "<file-name>"
26618 is shown in a browser.
26621 \begin_layout Subsubsection
26625 \begin_layout Standard
26627 supports CVS version number, author name, date and time of last commit.
26628 All those are extracted from
26630 cvs log -r <file-name>
26634 \begin_inset CommandInset ref
26636 reference "subsec:VCS-Revision-Information"
26643 \begin_layout Subsection
26644 SVN commands in \SpecialChar LyX
26648 \begin_layout Standard
26649 SVN is now partially supported by \SpecialChar LyX
26651 You can find the commands in the
26653 File\SpecialChar menuseparator
26655 \begin_inset space ~
26661 Please note that if you use password protected access to repository via
26662 ssh, you will be asked in terminal window.
26664 was tested against SVN 1.5, 1.6, 1.7 and 1.8
26668 \begin_layout Plain Layout
26669 Most of the commands will work with 1.4 too, see
26670 \begin_inset CommandInset ref
26672 reference "subsec:SVN-Repo-Update"
26677 There seems to be currently unresolved permissions problem under SVN 1.8
26678 with reverting changes when file is locked.
26686 \begin_layout Subsubsection
26692 \begin_layout Standard
26693 If your document is not under revision control, this is the only item shown
26695 And if it is under revision control, the
26699 item is not visible.
26702 \begin_layout Standard
26703 This command registers in SVN your document ONLY in case you have already
26704 the documents directory under SVN control (in particular
26709 This means you have to checkout the archive by yourself.
26712 \begin_layout Standard
26713 Then you are asked interactively to supply an initial description of the
26715 Don't forget that registered file is not yet commited.
26718 \begin_layout Standard
26719 SVN command that is run:
26722 \begin_inset Quotes qld
26726 \begin_inset Quotes qld
26732 \begin_layout Standard
26737 to understand the switches.
26740 \begin_layout Subsubsection
26746 \begin_layout Standard
26747 When you are finished editing a file, you commit your changes.
26748 When you do this, you are asked for a description of the changes.
26749 After that changes are commited.
26752 \begin_layout Standard
26757 \begin_layout Plain Layout
26758 In case locking is not enabled.
26760 \begin_inset CommandInset ref
26762 reference "subsec:SVN-File-Locking"
26773 svn commit -q -m"<description>" <file-name>
26776 \begin_layout Subsubsection
26782 \begin_layout Standard
26783 Updates the changes of this file from the repository.
26784 Be sure you understand SVN merging and conflicts resolving before using
26785 this function, because all conflicts has to be resolved manually by you!
26788 \begin_layout Standard
26793 \begin_layout Plain Layout
26801 svn update --non-interactive
26802 \begin_inset Quotes qld
26806 \begin_inset Quotes qld
26812 \begin_layout Subsubsection
26815 Revert To Repository Version
26818 \begin_layout Standard
26819 This will discard all changes made to the document since the last check
26821 You get a warning before changes are discarded.
26824 \begin_layout Standard
26828 \begin_inset Quotes qld
26832 \begin_inset Quotes qld
26838 \begin_layout Subsubsection
26844 \begin_layout Standard
26845 This will create a copy of the current document including the version history.
26846 It requires a clean document without any changes since the last checkin.
26847 You are asked for a file name and a description of the copy operation.
26848 After that the copy is created, both locally and in the repository.
26849 If the parent directories of the copied and original document differ, all
26850 relative paths of included files of the copy are adjusted (like in
26852 File\SpecialChar menuseparator
26857 Finally, the copy is loaded instead of the original document.
26860 \begin_layout Labeling
26861 \labelwidthstring 00.00.0000
26863 \begin_inset space ~
26867 \begin_inset space ~
26871 \begin_inset Newline newline
26875 \begin_inset Flex Code
26878 \begin_layout Plain Layout
26882 \begin_inset Quotes qld
26886 \begin_inset Quotes qld
26890 \begin_inset Quotes qld
26894 \begin_inset Quotes qld
26903 \begin_inset Newline newline
26907 \begin_inset Flex Code
26910 \begin_layout Plain Layout
26919 \begin_layout Subsubsection
26925 \begin_layout Standard
26926 This will rename the current document including the version history.
26927 It requires a clean document without any changes since the last checkin.
26928 You are asked for a file name and a description of the rename operation.
26929 After that the document is renamed, both locally and in the repository.
26930 If the parent directories of the new and old file names differ, all relative
26931 paths of included files are adjusted (like in
26933 File\SpecialChar menuseparator
26938 Finally, the document is reloaded using the new name.
26941 \begin_layout Labeling
26942 \labelwidthstring 00.00.0000
26944 \begin_inset space ~
26948 \begin_inset space ~
26952 \begin_inset Newline newline
26956 \begin_inset Flex Code
26959 \begin_layout Plain Layout
26963 \begin_inset Quotes qld
26967 \begin_inset Quotes qld
26971 \begin_inset Quotes qld
26975 \begin_inset Quotes qld
26984 \begin_inset Newline newline
26988 \begin_inset Flex Code
26991 \begin_layout Plain Layout
27000 \begin_layout Subsubsection
27001 \begin_inset CommandInset label
27003 name "subsec:SVN-Repo-Update"
27007 Update of the local directory checkout from repository
27011 \begin_layout Plain Layout
27012 Note that this command will work only with subversion
27013 \begin_inset Formula $\geqq1.5$
27024 \begin_layout Standard
27025 All the commands above have one shortcoming – they deal with the current
27027 Once your document contains pictures, includes external
27028 \begin_inset Flex Code
27031 \begin_layout Plain Layout
27037 files and so on administration becomes more complicated.
27039 now supports updating the whole tree in which resides the document
27043 \begin_layout Plain Layout
27044 One need to organize the files structure so that all external files are
27045 in the same directory or subdirectories of the document.
27052 This become especially useful once you cooperate with people which neither
27053 know about subversion management nor they have ambition to commit additional
27054 material to the repository.
27058 \begin_layout Standard
27059 \begin_inset Flex Code
27062 \begin_layout Plain Layout
27063 Update local directory from repository
27068 command updates the whole directory and in case of merge conflicts local
27069 version of the files are left, so no unintended data loss occurs.
27070 If local changes are detected user is warned before update starts.
27073 \begin_layout Labeling
27074 \labelwidthstring 00.00.0000
27076 \begin_inset space ~
27080 \begin_inset space ~
27084 \begin_inset Newline newline
27088 \begin_inset Flex Code
27091 \begin_layout Plain Layout
27097 (Ask if changes are detected.)
27098 \begin_inset Newline newline
27102 \begin_inset Flex Code
27105 \begin_layout Plain Layout
27106 svn update --accept mine-full $path
27114 \begin_layout Standard
27116 \begin_inset Flex Code
27119 \begin_layout Plain Layout
27125 stands for the path to the document.
27128 \begin_layout Subsubsection
27134 \begin_layout Standard
27135 This shows the complete history of the SVN document.
27139 \begin_inset Quotes qld
27143 \begin_inset Quotes qld
27148 is shown in a browser.
27151 \begin_layout Subsubsection
27153 \begin_inset CommandInset label
27155 name "subsec:SVN-File-Locking"
27162 \begin_layout Standard
27163 The file exchange through various revision control systems brings the problem
27164 of merge conflicts in case two different users try to edit the same (parts
27166 When such a conflict happens it needs manual resolving and one reasonable
27167 alternative is to provide some kind of locking mechanism, which guarantees
27168 that only one user is allowed to edit file at the given time.
27171 \begin_layout Standard
27172 SVN has two such mechanisms to provide mutual exclusivity for file access
27173 – locks and automatic setting of write permissions (see sec.
27175 \begin_inset CommandInset ref
27177 reference "subsec:Automatical-Locking-Property"
27182 \begin_inset Flex Code
27185 \begin_layout Plain Layout
27195 \begin_layout Plain Layout
27196 \begin_inset Flex URL
27199 \begin_layout Plain Layout
27201 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
27212 If this property is detected for a given document \SpecialChar LyX
27213 starts to use SVN locks
27214 for document editing automatically and the whole check-in/out mechanism
27215 switches to the same regimen as for RCS.
27216 This in particular means there are two different modes of file use in \SpecialChar LyX
27220 \begin_layout Itemize
27222 The loaded file is in the read-only mode.
27223 For editing on needs to check-out.
27228 consists of updating from the repository and gaining write lock.
27229 If the lock is not possible to obtain, we remain in unlocked state.
27232 \begin_layout Itemize
27234 The loaded file is in the
27235 \begin_inset Quotes els
27239 \begin_inset Quotes ers
27243 No other user is allowed to edit the file.
27248 consists of commiting changes and releasing write-lock.
27249 If no changes have been made to the document, no commit will be produced
27253 \begin_layout Plain Layout
27254 Don't be puzzled by the fact that you will be asked for commit message anyway.
27259 and only the write-lock will be released.
27262 \begin_layout Standard
27266 \begin_layout Labeling
27267 \labelwidthstring 00.00.0000
27270 svn commit -q -m"<description>" "<file-name>"
27271 \begin_inset Newline newline
27274 svn unlock "<file-name>"
27277 \begin_layout Labeling
27278 \labelwidthstring 00.00.0000
27281 svn update "<file-name>"
27282 \begin_inset Newline newline
27285 svn lock "<file-name>"
27288 \begin_layout Subsubsection
27291 \begin_inset CommandInset label
27293 name "subsec:Automatical-Locking-Property"
27299 Automatic Locking Property
27302 \begin_layout Standard
27303 The above mentioned automatic setting of write permissions of the .lyx file
27306 File\SpecialChar menuseparator
27308 \begin_inset space ~
27311 Control\SpecialChar menuseparator
27312 Use Locking Property
27315 This command is active only when the file is not locked on the svn server
27317 you need to check-out before proceeding).
27320 \begin_layout Labeling
27321 \labelwidthstring 00.00.0000
27323 \begin_inset space ~
27329 \begin_layout Labeling
27330 \labelwidthstring 00.00.0000
27333 svn propset svn:needs-lock ON "<file-name>"
27336 \begin_layout Labeling
27337 \labelwidthstring 00.00.0000
27340 svn propdel svn:needs-lock "<file-name>"
27343 \begin_layout Subsubsection
27344 \begin_inset CommandInset label
27346 name "subsec:VCS-Revision-Information"
27350 Revision Information in Documents
27353 \begin_layout Standard
27354 There are more possibilities how to activate revision information in our
27358 \begin_layout Itemize
27364 \begin_layout Itemize
27365 tree revision information (
27366 \begin_inset Flex Code
27369 \begin_layout Plain Layout
27376 The result is the output of the
27377 \begin_inset Flex Code
27380 \begin_layout Plain Layout
27386 command, the following table gives you an idea, how to read the results.
27389 \begin_layout Standard
27391 \begin_inset Tabular
27392 <lyxtabular version="3" rows="6" columns="2">
27393 <features tabularvalignment="middle">
27394 <column alignment="left" valignment="top">
27395 <column alignment="left" valignment="top">
27397 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
27400 \begin_layout Plain Layout
27408 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
27411 \begin_layout Plain Layout
27421 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
27424 \begin_layout Plain Layout
27430 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
27433 \begin_layout Plain Layout
27434 mixed revision working copy
27441 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
27444 \begin_layout Plain Layout
27450 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
27453 \begin_layout Plain Layout
27454 modified working copy
27461 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
27464 \begin_layout Plain Layout
27470 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
27473 \begin_layout Plain Layout
27474 switched working copy
27481 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
27484 \begin_layout Plain Layout
27490 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
27493 \begin_layout Plain Layout
27494 partial working copy, from a sparse checkout
27501 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
27504 \begin_layout Plain Layout
27510 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
27513 \begin_layout Plain Layout
27514 mixed revision, modified, switched working copy
27527 \begin_layout Itemize
27528 file revision information.
27529 The result comes from parsing the output of
27530 \begin_inset Flex Code
27533 \begin_layout Plain Layout
27535 \begin_inset space ~
27539 \begin_inset space ~
27543 \begin_inset space ~
27552 Supported flags are:
27556 \begin_layout Itemize
27557 version number of the last commit (
27558 \begin_inset Flex Code
27561 \begin_layout Plain Layout
27570 \begin_layout Itemize
27571 author of the last commit (
27572 \begin_inset Flex Code
27575 \begin_layout Plain Layout
27584 \begin_layout Itemize
27585 date of the last commit (
27586 \begin_inset Flex Code
27589 \begin_layout Plain Layout
27598 \begin_layout Itemize
27599 time of the last commit (
27600 \begin_inset Flex Code
27603 \begin_layout Plain Layout
27613 \begin_layout Standard
27614 You can obtain this info via InsetInfo (
27615 \change_inserted 5863208 1564400022
27618 Insert\SpecialChar menuseparator
27619 Field\SpecialChar menuseparator
27620 Version Control Revision
27621 \change_deleted 5863208 1564399852
27626 \begin_inset Flex Code
27629 \begin_layout Plain Layout
27630 info-insert buffer vcs-date
27638 The information will be available only when you have the file stored under
27639 svn managment (i.e.
27641 \begin_inset Flex Code
27644 \begin_layout Plain Layout
27650 directory is available with your document).
27654 \begin_layout Itemize
27655 Another—a hacking one—possibility is to use svn keywords
27659 \begin_layout Plain Layout
27660 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
27666 In short – you set file keywords property (e.g.
27669 svn propset svn:keywords 'Rev' file.lyx
27671 ) and then paste keyword \SpecialChar TeX
27676 \begin_layout Plain Layout
27677 This is an easy way how to ensure that \SpecialChar LyX
27678 won't break the line in the middle
27684 tag in your document (e.g.
27686 \begin_inset Flex Code
27689 \begin_layout Plain Layout
27696 This way svn client will automatically substitute revision number (e.g.
27698 \begin_inset Flex Code
27701 \begin_layout Plain Layout
27707 ) after each update and commit.
27708 There are more problems with this approach.
27709 Firstly, the '$' character is used in \SpecialChar TeX
27710 world for math equations, so any
27711 occurence of math formula
27712 \begin_inset Formula $Rev$
27716 \begin_inset Formula $Rev:59$
27719 in your \SpecialChar LyX
27721 Similarly for other keywords like Id, Date, Author, etc.
27722 Secondly svn output is dependent on your locales, so its very easy that
27723 svn would produce some problematic strings once Date is used.
27724 Thirdly you get the whole 'Rev: 59' string in your document instead of
27726 Until subversion implements user's custom keywords it will be hard to use
27727 this approach reliably or let \SpecialChar LyX
27728 to support it directly.
27731 \begin_layout Subsection
27732 SVN and Windows Environment
27735 \begin_layout Quote
27736 My inclination is to say that if the user cannot figure out the command
27737 line operations on their own fairly quickly, they would be well advised
27738 to use TortoiseSVN.
27744 \begin_layout Subsubsection
27748 \begin_layout Standard
27749 In addition to installing \SpecialChar LyX
27750 , and having access to a Subversion repository,
27751 the user will need to install the Subversion client program.
27752 A Windows installer for the client program is available from
27753 \begin_inset CommandInset href
27756 target "http://www.collab.net/nonav/downloads/subversion/"
27762 The user may also want to install
27763 \begin_inset CommandInset href
27766 target "http://tortoisesvn.tigris.org/"
27771 , which integrates Subversion operations into the context (rightclick) menu
27772 of Windows Explorer.
27773 Operations done outside \SpecialChar LyX
27774 will typically be more convenient using the Explorer
27776 Note that TortoiseSVN is not a replacement for the client program, which
27777 is what \SpecialChar LyX
27781 \begin_layout Subsubsection
27782 Bringing a document under Subversion control
27785 \begin_layout Standard
27786 Before a \SpecialChar LyX
27787 document can be brought under version control in Subversion, its
27788 parent directory needs to be under version control.
27789 If the document is being added to a project already in the repository,
27790 this is accomplished by checking the project out to the directory where
27791 the new document will be placed.
27792 If the project itself is not yet under version control (for instance, if
27793 this document starts a new project), the directory must be imported into
27795 This is done outside \SpecialChar LyX
27797 Both import and checkout are easily accomplished from the Explorer context
27798 menu using TortoiseSVN, or alternatively can be done using the command
27799 line client at a DOS prompt.
27800 The procedure for importing the project using TortoiseSVN is described
27801 below, assuming an existing repository and a new project being started
27809 For information on using the Subversion client program, run
27816 \begin_layout Enumerate
27823 in Windows Explorer, right click it, and select
27825 TortoiseSVN\SpecialChar menuseparator
27829 If necessary, adjust the URL for the repository, then click OK.
27832 \begin_layout Enumerate
27833 Right click the level of the repository under which you want to place the
27834 new project folder (typically the top level) and click
27838 Supply a name for the project folder and click OK.
27839 Add a message for the log file if desired, then click OK again.
27840 The new project folder should appear in the repository.
27841 Finally, click OK again to exit the repository browser.
27844 \begin_layout Enumerate
27845 Once again right click
27851 , this time selecting SVN Checkout\SpecialChar ldots
27852 Select the URL of the project folder
27853 you just created in the repository, and set the checkout directory to
27861 You will be warned about a non-empty folder; click OK to proceed.
27862 You should now have a
27873 \begin_layout Enumerate
27874 Create or open your document in \SpecialChar LyX
27877 File\SpecialChar menuseparator
27879 \begin_inset space ~
27882 Control\SpecialChar menuseparator
27886 Add a log message and click OK to commit the document to version control.
27889 \begin_layout Standard
27890 From this point onward, you should have full functionality in the
27892 File\SpecialChar menuseparator
27894 \begin_inset space ~
27900 You also have the option of checking the document in and out, viewing its
27902 using the TortoiseSVN context menu in Windows Explorer or the Subversion
27903 client program from a command prompt.
27906 \begin_layout Subsubsection
27907 SSH tunnel used with SVN under Windows
27910 \begin_layout Standard
27911 Compared with Linux setting up an svn client to communicate over ssh under
27912 Windows is a rather troublesome task.
27913 We will at least offer some hints how to setup the client side but prior
27914 knowledge about ssh and the Windows command line is needed, also be prepared
27915 for a great deal of frustration\SpecialChar ldots
27919 \begin_layout Enumerate
27920 Get an svn client for windows, as described in the previous sections.
27921 When it is a fresh install run some svn command (e.g.
27923 \begin_inset Flex Code
27926 \begin_layout Plain Layout
27932 ) to create config files, which you will need to change later on.
27935 \begin_layout Enumerate
27936 Choose an ssh client for Windows.
27937 There are several possibilities, we will use the one from Putty tools
27941 \begin_layout Plain Layout
27942 \begin_inset Flex URL
27945 \begin_layout Plain Layout
27947 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
27958 You will need to set the connection up so that the client doesn't ask for
27959 any password from you.
27960 To keep things easy we will use only keys without any additional password
27965 \begin_layout Enumerate
27967 \begin_inset Flex Code
27970 \begin_layout Plain Layout
27977 Save your private .ppk key file and put the public one on the server side.
27978 If the SVN server runs on Linux, note that the format of the public key
27979 is not compatible with Linux openssh and you will need to direcly copy-paste
27981 \begin_inset Quotes eld
27986 Public key for pasting into OpenSSH authorized_keys file
27989 \begin_inset Quotes erd
27992 edit field into the server's
27993 \begin_inset Flex Code
27996 \begin_layout Plain Layout
27997 ~/.ssh/authorized_keys
28003 \begin_inset Flex Code
28006 \begin_layout Plain Layout
28015 \begin_layout Enumerate
28017 \begin_inset Flex Code
28020 \begin_layout Plain Layout
28027 In the SVN config file
28031 \begin_layout Plain Layout
28032 Exact path depends on Windows version, usually somewhere around
28033 \begin_inset Flex Code
28036 \begin_layout Plain Layout
28039 Documents and Settings
28053 \begin_inset Flex Code
28056 \begin_layout Plain Layout
28071 , section [tunnels], setup ssh command, e.g.
28073 \begin_inset Flex Code
28076 \begin_layout Plain Layout
28077 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
28086 \begin_layout Plain Layout
28087 It will usually take a lot of time to get exact command right and it depends
28089 For example do not have some remote server saved as a default session in
28091 If things fail, try to connect via plink without SVN first.
28100 \begin_layout Enumerate
28101 Checkout the SVN archive, e.
28102 \begin_inset space \thinspace{}
28106 \begin_inset Newline newline
28110 \begin_inset Flex Code
28113 \begin_layout Plain Layout
28114 svn co svn+ssh://user@server/repository_path
28122 \begin_layout Subsubsection
28123 End-of-Line Conversions
28126 \begin_layout Standard
28127 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
28129 use different line endings inside the .lyx files.
28130 This is not a problem as far as \SpecialChar LyX
28131 functionality is concerned, but the commit
28132 diffs will be huge and merge-conflicts prone.
28133 Fortunately SVN itself knows
28137 \begin_layout Plain Layout
28138 \begin_inset Flex URL
28141 \begin_layout Plain Layout
28143 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
28153 how to deal with CR/LF problems when switching .lyx files to the
28154 \begin_inset Flex Code
28157 \begin_layout Plain Layout
28167 \begin_layout Plain Layout
28169 \begin_inset Flex Code
28172 \begin_layout Plain Layout
28173 svn propset svn:eol-style native FILE_NAME
28186 \begin_layout Subsection
28187 GIT commands in \SpecialChar LyX
28191 \begin_layout Standard
28192 A minimal subset of GIT commands is now supported by \SpecialChar LyX
28194 You can find the commands in the
28196 File\SpecialChar menuseparator
28198 \begin_inset space ~
28204 Please note that if you use password protected access to repository via
28205 ssh, you will be asked in terminal window.
28207 was tested against GIT 1.7.
28211 \begin_layout Plain Layout
28212 Windows users please note that you need to ensure that git is on the path.
28213 This can be set from within \SpecialChar LyX
28216 Tools\SpecialChar menuseparator
28217 Preferences\SpecialChar menuseparator
28218 Paths\SpecialChar menuseparator
28229 \begin_layout Standard
28230 One big difference of GIT and the other supported version control systems
28231 is the distributed nature of GIT: With traditional version control systems
28232 there is one central server which hosts the repository.
28233 Users commit their changes to the server, and get updates made by other
28235 With GIT, users commit to a local repository.
28236 The local repository can be synchronized with one or more remote repositories
28238 \begin_inset Flex Code
28241 \begin_layout Plain Layout
28248 \begin_inset Flex Code
28251 \begin_layout Plain Layout
28259 does not interact in any way with remote GIT repositories.
28260 It works exclusively with the local repository in a very similar way as
28261 with a central CVS or SVN repository.
28262 If you use remote GIT repositories you need to do the
28263 \begin_inset Flex Code
28266 \begin_layout Plain Layout
28273 \begin_inset Flex Code
28276 \begin_layout Plain Layout
28282 operations with your favourite GIT client.
28285 \begin_layout Subsubsection
28291 \begin_layout Standard
28292 If your document is not under revision control, this is the only item shown
28294 And if it is under revision control, the
28298 item is not visible.
28301 \begin_layout Standard
28302 This command registers in GIT your document ONLY in case you have already
28303 the documents directory under GIT control (in particular
28308 This means you have to checkout the archive by yourself.
28311 \begin_layout Standard
28312 Then you are asked interactively to supply an initial description of the
28314 Don't forget that registered file is not yet committed.
28317 \begin_layout Standard
28318 GIT command that is run:
28321 \begin_inset Quotes qld
28325 \begin_inset Quotes qld
28331 \begin_layout Standard
28336 to understand the switches.
28339 \begin_layout Subsubsection
28345 \begin_layout Standard
28346 When you are finished editing a file, you commit your changes.
28347 When you do this, you are asked for a description of the changes.
28348 After that changes are committed.
28351 \begin_layout Standard
28354 git commit -q -m"<description>" <file-name>
28357 \begin_layout Subsubsection
28360 Revert To Repository Version
28363 \begin_layout Standard
28364 This will discard all changes made to the document since the last check
28366 You get a warning before changes are discarded.
28369 \begin_layout Standard
28373 \begin_inset Quotes qld
28377 \begin_inset Quotes qld
28383 \begin_layout Subsubsection
28389 \begin_layout Standard
28390 This will rename the current document including the version history.
28391 It requires a clean document without any changes since the last checkin.
28392 You are asked for a file name and a description of the rename operation.
28393 After that the document is renamed, both locally and in the repository.
28394 If the parent directories of the new and old file names differ, all relative
28395 paths of included files are adjusted (like in
28397 File\SpecialChar menuseparator
28402 Finally, the document is reloaded using the new name.
28405 \begin_layout Labeling
28406 \labelwidthstring 00.00.0000
28408 \begin_inset space ~
28412 \begin_inset space ~
28416 \begin_inset Newline newline
28420 \begin_inset Flex Code
28423 \begin_layout Plain Layout
28427 \begin_inset Quotes qld
28431 \begin_inset Quotes qld
28435 \begin_inset Quotes qld
28439 \begin_inset Quotes qld
28448 \begin_inset Newline newline
28452 \begin_inset Flex Code
28455 \begin_layout Plain Layout
28464 \begin_layout Subsubsection
28470 \begin_layout Standard
28471 This shows the complete history of the GIT document.
28475 \begin_inset Quotes qld
28479 \begin_inset Quotes qld
28484 is shown in a browser.
28487 \begin_layout Subsubsection
28491 \begin_layout Standard
28493 supports GIT hash number of the last commit to the file,
28494 \change_inserted 1119979965 1564297456
28495 its abbreviated form,
28497 author name, date and time of last commit.
28498 All those are extracted from
28500 git log -n 1 --pretty=format:%H%n
28501 \change_inserted 1119979965 1564297427
28507 Tree version information is obtained via
28509 git describe --abbrev --dirty --long
28513 \begin_inset CommandInset ref
28515 reference "subsec:VCS-Revision-Information"
28522 \begin_layout Subsection
28526 \begin_layout Standard
28527 With the recent addition of the
28528 \begin_inset Flex Code
28531 \begin_layout Plain Layout
28537 function \SpecialChar LyX
28538 power users are allowed to create their own commands for revision
28542 \begin_layout Standard
28543 As an example you can see how two TortoiseSVN commands could be integrated
28547 \begin_layout Description
28549 \begin_inset Flex Code
28552 \begin_layout Plain Layout
28553 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
28561 \begin_layout Description
28563 \begin_inset Flex Code
28566 \begin_layout Plain Layout
28567 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
28575 \begin_layout Subsection
28576 Version control and Document comparison
28579 \begin_layout Standard
28580 One of the typical uses of version control is to inspect the changes between
28581 revisions, usually by creating
28582 \begin_inset Flex Code
28585 \begin_layout Plain Layout
28592 While this is useful for plain text files, it is much less useful in the
28593 case of \SpecialChar LyX
28594 files, which have more a complicated structure.
28595 Hence we provide binding to the Document comparison feature.
28596 There are two ways of calling this feature – either by direct call of
28597 \begin_inset Flex Code
28600 \begin_layout Plain Layout
28607 function (for details see \SpecialChar LyX
28608 functions manual) or by the toolbar icon
28621 One can either compare two chosen revisions of the document or he can simply
28622 compare the current version of edited text with older revisions (where
28624 \begin_inset Flex Noun
28627 \begin_layout Plain Layout
28633 ' revisions back means comparison of the edited file with last commited
28638 \begin_layout Standard
28639 This feature is supported for SVN and RCS though due to the more complicated
28640 versioning scheme of RCS there is a constraint – when addressing the revisions
28641 in dialog, numbers always point to the last number in RCS revision number,
28644 We don't currently support GIT addressing of revisions, one can just compare
28645 edited document with its revision X steps backs, where X is addressed as
28647 \begin_inset Flex Code
28650 \begin_layout Plain Layout
28659 \begin_layout Section
28660 Literate Programming
28663 \begin_layout Standard
28668 (kayvan@sylvan.com)
28672 original documentation written by
28674 Edmar Wienskoski Jr.
28677 (edmar-w-jr@technologist.com)
28680 \begin_layout Subsection
28684 \begin_layout Standard
28685 The main purpose of this documentation is to show you how to use \SpecialChar LyX
28687 programming, where it is assumed that you are familiar with this programming
28688 technique, and know what
28689 \begin_inset Quotes eld
28693 \begin_inset Quotes erd
28697 \begin_inset Quotes eld
28701 \begin_inset Quotes erd
28705 If that is not the case, please follow the web links provided in the following
28707 There is a lot of good documentation out there covering old development
28708 history to the latest tools tips.
28711 \begin_layout Standard
28712 It is also assumed that you are familiar with \SpecialChar LyX
28713 itself to a point that you
28714 are comfortable changing your \SpecialChar LyX
28715 preferences, and X resources file.
28716 If that is not the case please refer to other \SpecialChar LyX
28717 documentation to cover your
28721 \begin_layout Subsection
28722 Literate Programming
28725 \begin_layout Standard
28726 From the Literate Programming FAQ:
28729 \begin_layout Quotation
28730 Literate programming is the combination of documentation and source together
28731 in a fashion suited for reading by human beings.
28732 In fact, literate programs should be enjoyable reading, even inviting!
28733 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
28734 and documentation in a single file.
28735 Literate programming tools then parse the file to produce either readable
28736 documentation or compilable source.
28737 The WEB style of literate programming was created by D.
28738 \begin_inset space \thinspace{}
28742 Knuth during the development of his \SpecialChar TeX
28743 typesetting software.
28747 \begin_layout Standard
28748 Another excerpt says:
28751 \begin_layout Quotation
28754 How is literate programming different from verbose commenting?
28757 \begin_layout Quotation
28758 There are three distinguishing characteristics.
28759 In order of importance, they are:
28763 \begin_layout Itemize
28764 flexible order of elaboration
28767 \begin_layout Itemize
28768 automatic support for browsing
28771 \begin_layout Itemize
28772 typeset documentation, especially diagrams and mathematics
28776 \begin_layout Standard
28777 Now that I sparked your curiosity, take a look in the references.
28780 \begin_layout Subsubsection
28784 \begin_layout Standard
28785 The complete Literate Programming FAQ can be found at:
28788 \begin_layout Quote
28789 Literate Programming FAQ
28790 \begin_inset Flex URL
28793 \begin_layout Plain Layout
28795 http://www.literateprogramming.com/lpfaq.pdf
28803 \begin_layout Standard
28804 The FAQ lists 23 (twenty three!) different literate programming tools.
28805 Where some are specialized or
28806 \begin_inset Quotes eld
28810 \begin_inset Quotes erd
28813 for particular programming languages, while other have general scope.
28818 for my own use for several reasons:
28821 \begin_layout Itemize
28822 It can generate the documentation either in \SpecialChar LaTeX
28826 \begin_layout Itemize
28827 It has a open architecture, i.
28828 \begin_inset space \thinspace{}
28832 \begin_inset space \space{}
28835 it is easy to plug in new filters
28839 \begin_layout Plain Layout
28844 are programs that read a given data stream and output a manipulated data
28846 That way, a WEB file (consisting of literate code) can be turned into a
28847 file consisting only of C program code or \SpecialChar LaTeX
28853 and to perform special processing that you may need.
28857 \begin_layout Itemize
28858 There is a good selection of filters available already (the HTML is one
28862 \begin_layout Itemize
28866 \begin_layout Standard
28867 The Noweb web page can be found at:
28870 \begin_layout Quote
28872 \begin_inset Flex URL
28875 \begin_layout Plain Layout
28877 https://www.cs.tufts.edu/~nr/noweb/
28885 \begin_layout Standard
28886 Starting from there you can reach many other interesting links and even
28887 some literate program examples.
28890 \begin_layout Subsection
28892 and Literate Programming with Noweb
28895 \begin_layout Standard
28896 The \SpecialChar LyX
28897 support for Literate Programming is provided by using the generic \SpecialChar LyX
28899 converters mechanism.
28900 This support is provided in a
28901 \begin_inset Quotes eld
28905 \begin_inset Quotes erd
28909 \begin_inset space \thinspace{}
28913 \begin_inset space \space{}
28916 you will be able to use this new \SpecialChar LyX
28917 feature with some other literate programming
28918 tool of your choice by just changing your \SpecialChar LyX
28922 \begin_layout Subsubsection
28923 Generating documents and code (weaving and tangling)
28926 \begin_layout Paragraph
28927 Using the noweb module
28930 \begin_layout Standard
28931 If you have installed Noweb and \SpecialChar LyX
28932 successfully, whenever you open a new document,
28933 after you have chosen its document class, use the
28935 Document\SpecialChar menuseparator
28939 \begin_inset Quotes eld
28943 \begin_inset Quotes erd
28947 If Noweb is correctly installed, when you click on the
28948 \begin_inset Quotes eld
28952 \begin_inset Quotes erd
28955 link, you will see the
28956 \begin_inset Quotes eld
28960 \begin_inset Quotes erd
28963 module in the available list and you can add it to your document.
28966 \begin_layout Paragraph
28970 \begin_layout Standard
28972 enables you to write code with a custom inset named
28973 \begin_inset Flex Noun
28976 \begin_layout Plain Layout
28983 Noweb delimits chunks like this:
28986 \begin_layout LyX-Code
28990 \begin_layout LyX-Code
28994 \begin_layout LyX-Code
28998 \begin_layout LyX-Code
29002 \begin_layout LyX-Code
29006 \begin_layout Standard
29007 The problem is that whatever is written in between the << and the
29011 must be taken literally, i.
29012 \begin_inset space \thinspace{}
29016 \begin_inset space \space{}
29020 should be prevented from making any special interpretation of what has
29022 This is also handled by
29023 \begin_inset Flex Noun
29026 \begin_layout Plain Layout
29032 , that works like a normal text inset but has a free spacing capability.
29035 \begin_layout Standard
29036 As a special note, you can also use the
29037 \begin_inset Quotes eld
29041 \begin_inset Quotes erd
29044 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
29048 \begin_layout LyX-Code
29052 \begin_layout LyX-Code
29053 def some_function(args):
29056 \begin_layout LyX-Code
29057 "This is the doc string for this function."
29060 \begin_layout LyX-Code
29061 print "My args: ", args
29064 \begin_layout LyX-Code
29065 @ %def some_function
29068 \begin_layout Standard
29069 For an example of this usage and the resulting cross-reference output, look
29070 at the Literate python program in
29072 LIBDIR/examples/listerrors.lyx
29074 which should make this all clear.
29077 \begin_layout Paragraph
29078 Generating the documentation
29081 \begin_layout Standard
29082 At this point you already have a new document file with a proper document
29083 class, and with some code and text on it.
29084 How do I print it? The answer is simple, you select
29086 View\SpecialChar menuseparator
29090 Just like you would do for a plain document.
29091 No special procedure is required.
29094 \begin_layout Standard
29095 To help orientate you, I will now explain what happens inside \SpecialChar LyX
29099 \begin_layout Enumerate
29102 Update\SpecialChar menuseparator
29105 menu option is chosen, a \SpecialChar LaTeX
29111 \begin_layout Standard
29112 If the document is of any literate class the generated file will be named
29113 with an extension name defined by the
29114 \begin_inset Quotes eld
29118 \begin_inset Quotes erd
29121 format (defined in the Preferences panel), otherwise the file will have
29130 \begin_layout Enumerate
29131 Note that the only difference so far is in the name of the file, no special
29132 processing is required by \SpecialChar LyX
29134 Given that you formatted the code using the
29135 \begin_inset Flex Noun
29138 \begin_layout Plain Layout
29144 inset that, by itself, takes care of the business.
29147 \begin_layout Enumerate
29148 If the document is of any literate class \SpecialChar LyX
29149 will then use the internal \SpecialChar LyX
29151 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
29156 \begin_layout Plain Layout
29157 The converters are defined in the
29159 Tools\SpecialChar menuseparator
29163 \begin_inset Quotes eld
29167 \begin_inset Quotes erd
29179 manual for general information about converters.
29184 to generate the \SpecialChar LaTeX
29189 \begin_layout Standard
29190 Otherwise it will just skip this step.
29194 \begin_layout Enumerate
29195 Finally, \SpecialChar LaTeX
29196 is invoked and the regular post processing continues as in a plain
29200 \begin_layout Standard
29201 Independence from a particular
29202 \begin_inset Quotes eld
29206 \begin_inset Quotes erd
29209 is easily achieved by changing the commands that are run by the various
29213 \begin_layout Paragraph
29214 Generating the code
29217 \begin_layout Standard
29218 When the build menu option is chosen or the corresponding button in the
29219 toolbar is pressed, a \SpecialChar LaTeX
29220 file is generated just like step 1 above.
29221 Next, \SpecialChar LyX
29227 This converter needs to be defined by the user and is not installed by
29228 default, though the Program format is.
29229 This converter (like any other converter) will have two parts:
29232 \begin_layout Enumerate
29233 The converter program itself.
29234 This program performs the conversion from the one format to the other (in
29235 this case, from the Noweb format to the Program pseudo-format).
29238 \begin_layout Enumerate
29239 The error log parser.
29240 This is a program whose sole purpose is to rewrite error messages in a
29241 format that \SpecialChar LyX
29243 This makes it possible for \SpecialChar LyX
29244 to place error boxes in the right places in
29248 \begin_layout Standard
29249 The first part, the
29250 \begin_inset Quotes eld
29254 \begin_inset Quotes erd
29257 setting, should be set to
29260 \begin_layout LyX-Code
29268 \begin_layout Standard
29269 This basically means that \SpecialChar LyX
29271 \begin_inset Quotes eld
29275 \begin_inset Quotes erd
29278 (a program or script) with the name of the Noweb file (normally a file
29279 in the \SpecialChar LyX
29280 temp directory) and the directory path of the original \SpecialChar LyX
29285 \begin_layout Standard
29286 This is an implementation of
29287 \begin_inset Quotes eld
29291 \begin_inset Quotes erd
29294 that you can place in a directory on your path:
29297 \begin_layout LyX-Code
29303 \begin_layout LyX-Code
29309 \begin_layout LyX-Code
29312 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
29315 \begin_layout Standard
29316 The next part of the converter setting is the
29317 \begin_inset Quotes eld
29321 \begin_inset Quotes erd
29324 which is to be set to
29327 \begin_layout LyX-Code
29330 parselog=$$s/scripts/listerrors
29333 \begin_layout Standard
29334 This will run any errors that are generated by the
29335 \begin_inset Quotes eld
29339 \begin_inset Quotes erd
29342 process through the
29343 \begin_inset Quotes eld
29347 \begin_inset Quotes erd
29353 \begin_layout Standard
29354 The build will normally take place in \SpecialChar LyX
29355 's temporary directory, so the files
29356 produced by the conversion will be in that directory.
29358 will copy out what it regards as the `main' file, but the
29362 conversion may produce several files, and so most of these would then be
29363 deleted when \SpecialChar LyX
29365 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
29366 the build-script chunk can place the generated files in that location.
29369 \begin_layout Paragraph
29370 Build instructions in the document
29373 \begin_layout Standard
29374 The last piece of the integration between \SpecialChar LyX
29376 \begin_inset Quotes eld
29380 \begin_inset Quotes erd
29384 Generally, the instructions for building your program should be embedded
29385 in a chunk of its own.
29387 \begin_inset Quotes eld
29391 \begin_inset Quotes erd
29394 above uses the notangle command to look for this chunk (called
29395 \begin_inset Quotes eld
29399 \begin_inset Quotes erd
29402 ) and runs its contents through
29403 \begin_inset Quotes eld
29407 \begin_inset Quotes erd
29413 \begin_layout Standard
29414 Typically, such a chunk would look something like this:
29417 \begin_layout LyX-Code
29421 \begin_layout LyX-Code
29423 \begin_inset Newline newline
29426 if [ -z "${NOWEB_SOURCE}" ]
29427 \begin_inset Newline newline
29433 \begin_layout LyX-Code
29434 NOWEB_SOURCE=myfile.nw
29435 \begin_inset Newline newline
29439 \begin_inset Newline newline
29443 code to extract files ...
29444 use NOWEB_OUTPUT_DIR here ...]
29445 \begin_inset Newline newline
29449 code to compile files ...]
29450 \begin_inset Newline newline
29456 \begin_layout Standard
29459 LIBDIR/examples/listerrors.lyx
29463 LIBDIR/examples/Literate.lyx
29465 which implement two versions of the
29466 \begin_inset Quotes eld
29470 \begin_inset Quotes erd
29473 program for some illustrations of how all of these pieces go together or
29476 LIBDIR/examples/noweb2lyx.lyx.
29479 Interestingly, these three files show off the language-indepence of the
29481 literate programming support since they are written in Python, C and Perl
29485 \begin_layout Subsubsection
29486 Configuring \SpecialChar LyX
29490 \begin_layout Standard
29491 All the Literate Programming support is configured by the
29493 Tools\SpecialChar menuseparator
29497 \begin_inset Quotes eld
29501 \begin_inset Quotes erd
29505 The important parts are:
29508 \begin_layout Description
29510 \begin_inset space ~
29514 \begin_inset Quotes eld
29518 \begin_inset Quotes erd
29522 \begin_inset space ~
29525 format Set up via the File Formats tab, this is where the Noweb-specific
29535 , the file extension is set to
29540 This tells \SpecialChar LyX
29541 to create a file with a
29545 extension in the first step of the conversion process.
29548 \begin_layout Description
29550 \begin_inset space ~
29558 \begin_inset space ~
29561 format This is an empty format whose sole purpose is to be the endpoint
29562 of a conversion (which then allows us to set up a converter for it).
29565 \begin_layout Description
29575 This converter performs the
29576 \begin_inset Quotes eld
29580 \begin_inset Quotes erd
29583 of the literate document.
29584 For Noweb, it is set to
29585 \begin_inset Quotes eld
29590 noweave -delay -index $$i > $$o
29593 \begin_inset Quotes erd
29599 \begin_layout Description
29609 \begin_inset Quotes eld
29613 \begin_inset Quotes erd
29617 As stated above, the Converter is set to
29618 \begin_inset Quotes eld
29626 \begin_inset Quotes erd
29629 , with Flags set to
29630 \begin_inset Newline newline
29634 \begin_inset Quotes eld
29639 parselog=$$s/scripts/listerrors
29642 \begin_inset Quotes erd
29648 \begin_layout Subsubsection
29652 \begin_layout Standard
29653 There is also a new function implemented in the \SpecialChar LyX
29655 \begin_inset Quotes eld
29658 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
29662 \begin_layout Standard
29663 When debugging code with ddd/gdb, it is possible to invoke a text editor
29664 at the current execution position with a single key stroke.
29665 The default ddd configuration for that is shift-ctrl-V.
29666 It happens that you can define the editor command line invocation in ddd
29669 Edit\SpecialChar menuseparator
29670 Preferences\SpecialChar menuseparator
29673 dialog and changing the "Edit Sources" entry.
29676 \begin_layout Standard
29677 I take advantage of the newly created \SpecialChar LyX
29678 server function and this ddd feature,
29680 \begin_inset Quotes eld
29684 \begin_inset Quotes erd
29690 \begin_layout LyX-Code
29691 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
29694 \begin_layout Standard
29695 With this, whenever you are using ddd and find a point in the program that
29696 you want to edit, you just press shift-ctrl-V (in the ddd window), and
29697 ddd will forward this information to \SpecialChar LyX
29698 through the \SpecialChar LyX
29699 server and then the
29701 window will show the same file with the cursor at the same position ddd
29703 No more guessing or long scrolling to locate a point in the program back
29707 \begin_layout Standard
29708 Note however that you must enable the \SpecialChar LyX
29709 server to get this feature working
29710 (it is disabled by default).
29712 \begin_inset space ~
29716 \begin_inset CommandInset ref
29718 reference "sec:Starting-the-Server"
29722 explains how to do that.
29725 \begin_layout Subsubsection
29729 \begin_layout Standard
29730 There are six new buttons that can be added to your \SpecialChar LyX
29732 Four of these buttons are short cuts to layout styles:
29750 , one for the custom inset
29755 The last one is a short cut to the
29756 \begin_inset Quotes eld
29760 \begin_inset Quotes erd
29767 \begin_layout Standard
29769 has a range of buttons that are available for tool bar customization.
29770 In my toolbar I like to combine the six short cuts above with two more:
29775 \SpecialChar menuseparator
29780 \SpecialChar menuseparator
29787 Document\SpecialChar menuseparator
29788 View\SpecialChar menuseparator
29792 Here is how it looks like:
29795 \begin_layout LyX-Code
29799 \begin_layout LyX-Code
29803 \begin_layout LyX-Code
29804 Icon "layout Standard"
29807 \begin_layout LyX-Code
29808 Icon "layout Section"
29811 \begin_layout LyX-Code
29812 Icon "layout \SpecialChar LaTeX
29816 \begin_layout LyX-Code
29817 Icon "layout \SpecialChar LyX
29821 \begin_layout LyX-Code
29822 Icon "flex.insert Chunk"
29825 \begin_layout LyX-Code
29829 \begin_layout LyX-Code
29833 \begin_layout LyX-Code
29834 Icon "buffer-typeset"
29837 \begin_layout LyX-Code
29838 Icon "build-program"
29841 \begin_layout LyX-Code
29845 \begin_layout LyX-Code
29849 \begin_layout LyX-Code
29853 \begin_layout LyX-Code
29857 \begin_layout LyX-Code
29861 \begin_layout Subsubsection
29862 Colors customization
29865 \begin_layout Standard
29866 There are a number of colors in \SpecialChar LyX
29867 that can be customized in
29872 One of the things that bothers people is the \SpecialChar LaTeX
29874 The default color is red, since the chunks uses \SpecialChar LaTeX
29875 font, and there is a lot
29876 of chunks in literate documents, you may get tired of seeing everything
29878 You can change it by going to the tabs
29887 \begin_layout Standard
29888 The next thing is the visible presence of the newline character in the screen.
29889 You can choose the color of this particular character and make it blend
29891 I recommend you choosing a color that is close to the background but not
29892 equal, that way you still can see it is there, but it is not bothering
29896 \begin_layout Subsection
29901 \begin_layout Standard
29911 \change_deleted 564990737 1671643409
29917 \change_inserted 564990737 1671643443
29921 File\SpecialChar menuseparator
29922 Open Example\SpecialChar menuseparator
29923 Modules\SpecialChar menuseparator
29930 \change_deleted 564990737 1671643461
29931 the Sweave manual (menu
29933 Help\SpecialChar menuseparator
29937 \change_inserted 564990737 1671643461
29941 Help\SpecialChar menuseparator
29942 Specific Manuals\SpecialChar menuseparator
29951 \begin_layout Chapter
29953 \change_deleted 564990737 1671355343
29957 \begin_layout Standard
29959 \change_deleted 564990737 1671355343
29960 You can do everything with \SpecialChar LyX
29961 that you can do with \SpecialChar LaTeX
29963 However, \SpecialChar LyX
29964 cannot support every \SpecialChar LaTeX
29966 But you can always use \SpecialChar TeX
29968 This chapter shows you some more special things you might want to use.
29969 For other special things you can do with figures, tables, floats, boxes
29970 and notes, have a look at the
29973 \begin_inset space ~