1 #LyX 2.4 created this file. For more info see https://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 % DO NOT ALTER THIS PREAMBLE!!!
11 % This preamble is designed to ensure that the manual prints
12 % out as advertised. If you mess with this preamble,
13 % parts of the manual may not print out as expected. If you
14 % have problems LaTeXing this file, please contact
15 % the documentation team
16 % email: lyx-docs@lists.lyx.org
18 % the pages of the TOC are numbered roman
19 % and a PDF-bookmark for the TOC is added
21 \let\myTOC\tableofcontents
22 \renewcommand{\tableofcontents}{%
23 \pdfbookmark[1]{\contentsname}{}
26 \pagenumbering{arabic}}
28 % extra space for tables
29 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
31 \options bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
32 \use_default_options false
40 \maintain_unincluded_children no
42 \language_package default
45 \font_roman "lmodern" "default"
46 \font_sans "lmss" "default"
47 \font_typewriter "lmtt" "default"
48 \font_math "auto" "auto"
49 \font_default_family default
50 \use_non_tex_fonts false
54 \font_typewriter_osf false
55 \font_sf_scale 100 100
56 \font_tt_scale 100 100
58 \use_dash_ligatures true
60 \default_output_format pdf2
62 \bibtex_command default
63 \index_command default
67 \pdf_title "LyX's Additional Features manual"
68 \pdf_author "LyX Team"
69 \pdf_subject "LyX's additional features documentation"
70 \pdf_keywords "LyX, Documentation, Additional"
72 \pdf_bookmarksnumbered true
73 \pdf_bookmarksopen false
74 \pdf_bookmarksopenlevel 1
79 \pdf_pdfusetitle false
80 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
83 \use_package amsmath 1
84 \use_package amssymb 1
87 \use_package mathdots 1
88 \use_package mathtools 1
90 \use_package stackrel 1
91 \use_package stmaryrd 1
92 \use_package undertilde 1
94 \cite_engine_type default
98 \paperorientation portrait
104 \notefontcolor #0000ff
111 \paragraph_separation indent
112 \paragraph_indentation default
114 \math_indentation default
115 \math_numbering_side default
116 \quotes_style english
120 \paperpagestyle headings
122 \tracking_changes true
123 \output_changes false
125 \postpone_fragile_content false
129 \docbook_table_output 0
130 \docbook_mathml_prefix 1
131 \author -712698321 "Jürgen Spitzmüller"
134 \author 244031559 "Yuriy"
135 \author 564990737 "John Lyx"
136 \author 630872221 "Jean-Pierre Chrétien" jeanpierre.chretien@free.fr
137 \author 1075283030 "Thibaut"
138 \author 1119979965 "Joel A. Kulesza"
144 Additional \SpecialChar LyX
148 \begin_layout Subtitle
150 \change_deleted 630872221 1622909155
152 \change_inserted 630872221 1622909155
159 by the \SpecialChar LyX
164 \begin_layout Plain Layout
166 Principal maintainer of this file is
168 Richard Kimberly Heck
171 If you have comments or error corrections, please send them to the \SpecialChar LyX
174 \begin_inset Flex Code
177 \begin_layout Plain Layout
178 <lyx-docs@lists.lyx.org>
191 \begin_layout Standard
192 \begin_inset CommandInset toc
193 LatexCommand tableofcontents
200 \begin_layout Chapter
204 \begin_layout Standard
205 This manual is essentially Part II of the
207 User's Guide\SpecialChar endofsentence
210 The reason for separating the two documents is simple: the
214 is already quite lengthy, and it contains information on all of the basic
215 features one needs to know in order to prepare most documents.
216 However, the \SpecialChar LyX
217 Team has worked to make \SpecialChar LyX
218 extensible through various configuration
219 files and external packages.
220 That means that if you want to support the Fizzwizzle \SpecialChar LaTeX
222 create a layout file (or module) for it without having to alter \SpecialChar LyX
224 We've already had contributions of several new features this way, and some
225 of them are documented here.
226 There are also some more `advanced' features, such as how to control the
227 presentation of bibliographies and how to work with multi-part documents,
228 that are not covered in the
232 and are discussed here.
235 \begin_layout Standard
236 This manual also documents some special features, like fax support
237 \change_deleted 244031559 1603802929
239 \change_inserted 244031559 1603802931
243 \change_deleted 244031559 1603802954
246 , which require additional software to work properly.
247 There is also a chapter on \SpecialChar LyX
249 And lastly, there's a chapter of \SpecialChar LaTeX
250 tools and tips, things you can use to
251 spruce up your documents by directly using the powerful features of \SpecialChar LaTeX
253 After all, \SpecialChar LyX
258 only WYSIWYM and will only ever interface to some, not all, \SpecialChar LaTeX
262 \begin_layout Standard
263 If you haven't read the
267 yet, you are definitely in the wrong manual.
272 is the first place to go, since it describes the notation and format of
274 You should also be thoroughly familiar with the
278 and all of the basic features of \SpecialChar LyX
279 before attempting to read this one.
282 \begin_layout Standard
283 Since many of the topics in this manual depend heavily on \SpecialChar LyX
285 with \SpecialChar LaTeX
286 , this first chapter covers the inner workings of \SpecialChar LyX
289 to generate exactly the \SpecialChar LaTeX
291 It is obviously for more seasoned \SpecialChar LyX
295 \begin_layout Chapter
297 and \SpecialChar LaTeX
301 \begin_layout Section
303 Uses \SpecialChar LaTeX
307 \begin_layout Standard
308 This chapter is for both \SpecialChar TeX
309 -nicians and the \SpecialChar LaTeX
311 In it, we'll explain how \SpecialChar LyX
312 and \SpecialChar LaTeX
313 work together to produce printable output.
314 This is the only place in any of the manuals where we assume you know something
315 about \SpecialChar LaTeX
319 \begin_layout Standard
320 At one time, \SpecialChar LyX
322 \begin_inset Quotes eld
325 WYSIWYM frontend to \SpecialChar LaTeX
327 \begin_inset Quotes erd
330 but that's no longer true.
331 There are frontends to \SpecialChar LaTeX
336 \begin_layout Plain Layout
337 Some familar ones are \SpecialChar TeX
338 maker and kile, on Linux, and \SpecialChar TeX
340 There are also the \SpecialChar LaTeX
341 modes for vi and emacs, of course.
346 These are basically text editors with the ability to run \SpecialChar LaTeX
348 errors in the file you're editing.
349 Although \SpecialChar LyX
358 run \SpecialChar LaTeX
359 , and it also indicates errors in the file, it also does much, much
361 For one thing, you don't need to know \SpecialChar LaTeX
362 to use \SpecialChar LyX
365 has added its own extensions to \SpecialChar LaTeX
367 Try the following sometime: select
368 \begin_inset Flex Noun
371 \begin_layout Plain Layout
372 Export\SpecialChar menuseparator
379 \begin_inset Flex Noun
382 \begin_layout Plain Layout
389 \begin_inset Flex Noun
392 \begin_layout Plain Layout
393 View\SpecialChar menuseparator
403 ), then look at the preamble of the resulting
404 \begin_inset Flex Code
407 \begin_layout Plain Layout
414 You'll notice a variety of new macros defined specifically by \SpecialChar LyX
416 These macros are defined automatically, according to the features you use
420 \begin_layout Standard
421 There are several commands that automatically invoke \SpecialChar LaTeX
426 \begin_layout Itemize
427 \begin_inset Flex Noun
430 \begin_layout Plain Layout
431 Document\SpecialChar menuseparator
440 \begin_layout Itemize
441 \begin_inset Flex Noun
444 \begin_layout Plain Layout
445 Document\SpecialChar menuseparator
454 \begin_layout Standard
455 They will only invoke \SpecialChar LaTeX
456 if the file has changed since the last time \SpecialChar LaTeX
462 \begin_layout Standard
463 When \SpecialChar LyX
464 runs \SpecialChar LaTeX
465 on the file you're editing, it performs these steps:
468 \begin_layout Enumerate
469 Convert the document to \SpecialChar LaTeX
470 and save to a file with the extension
471 \begin_inset Flex Code
474 \begin_layout Plain Layout
481 \begin_inset Flex Code
484 \begin_layout Plain Layout
493 \begin_layout Enumerate
494 Run \SpecialChar LaTeX
496 \begin_inset Flex Code
499 \begin_layout Plain Layout
505 file (maybe several times), and run any other commands (such as
506 \begin_inset Flex Code
509 \begin_layout Plain Layout
516 \begin_inset Flex Code
519 \begin_layout Plain Layout
525 ) needed to compile the \SpecialChar LaTeX
529 \begin_layout Enumerate
530 If there are any errors, show the error log.
533 \begin_layout Standard
534 If you have run \SpecialChar LaTeX
536 \begin_inset Flex Noun
539 \begin_layout Plain Layout
540 View\SpecialChar menuseparator
547 then runs a DVI viewer to display the DVI-file.
549 \begin_inset Flex Noun
552 \begin_layout Plain Layout
553 View\SpecialChar menuseparator
560 performs further steps:
563 \begin_layout Enumerate
565 \begin_inset Flex Code
568 \begin_layout Plain Layout
574 to convert the DVI file to PostScript.
577 \begin_layout Enumerate
578 Run a PostScript viewer, such as
579 \begin_inset Flex Code
582 \begin_layout Plain Layout
588 , to display the PostScript file.
591 \begin_layout Standard
593 does similar things when viewing, or exporting, other formats.
596 \begin_layout Section
597 Translating \SpecialChar LaTeX
598 files into \SpecialChar LyX
602 \begin_layout Standard
603 You can import a \SpecialChar LaTeX
604 file into \SpecialChar LyX
606 \begin_inset Flex Noun
609 \begin_layout Plain Layout
610 File\SpecialChar menuseparator
611 Import\SpecialChar menuseparator
617 command in \SpecialChar LyX
619 This will call a program named
620 \begin_inset Flex Code
623 \begin_layout Plain Layout
629 which will create a file
630 \begin_inset Flex Code
633 \begin_layout Plain Layout
640 \begin_inset Flex Code
643 \begin_layout Plain Layout
651 will then open that file.
655 \begin_layout Plain Layout
656 \begin_inset Flex Code
659 \begin_layout Plain Layout
665 can also be run from the command line, of course.
673 \begin_layout Standard
674 \begin_inset Flex Code
677 \begin_layout Plain Layout
683 will translate most legal \SpecialChar LaTeX
684 , but not everything.
685 It will put things it doesn't understand into \SpecialChar TeX
686 code, so after translating
688 \begin_inset Flex Code
691 \begin_layout Plain Layout
697 , you can look for \SpecialChar TeX
698 code and hand-edit it until it looks right.
701 \begin_layout Standard
702 If you don't know what \SpecialChar TeX
703 code is, read the next section.
706 \begin_layout Section
707 \begin_inset CommandInset label
709 name "sec:Inserting-TeX-Code"
713 Inserting \SpecialChar TeX
714 Code into \SpecialChar LyX
718 \begin_layout Standard
719 Anything you can do in \SpecialChar LaTeX
720 you can do in \SpecialChar LyX
721 , for a very simple reason: You can
722 always insert \SpecialChar TeX
723 code into any \SpecialChar LyX
726 cannot, and will never be able to, display every possible \SpecialChar LaTeX
728 If ever you need to insert \SpecialChar LaTeX
729 commands into your \SpecialChar LyX
730 document, you can use the
732 \begin_inset Flex Code
735 \begin_layout Plain Layout
742 box, which you can insert into your document with
743 \begin_inset Flex Noun
746 \begin_layout Plain Layout
747 Insert\SpecialChar menuseparator
757 or the keyboard shortcut
766 \begin_layout Standard
767 Here's an example of inserting \SpecialChar LaTeX
768 commands in a \SpecialChar LyX
770 The code looks like this:
773 \begin_layout LyX-Code
777 \begin_inset Newline newline
783 \begin_inset Newline newline
786 This is an example of a minipage environment.
788 \begin_inset Newline newline
791 can put nearly everything in it, even (non-floating)
792 \begin_inset Newline newline
797 \begin_inset Newline newline
803 \begin_inset Newline newline
807 \begin_inset Newline newline
813 \begin_inset Newline newline
819 \begin_inset Newline newline
825 \begin_inset Newline newline
830 \begin_inset Newline newline
836 \begin_inset Newline newline
842 \begin_inset Newline newline
848 \begin_inset Newline newline
856 \begin_layout LyX-Code
860 \begin_layout Standard
862 \begin_inset Flex Code
865 \begin_layout Plain Layout
872 box containing this text is directly after this paragraph.
873 Those of you reading the manual in \SpecialChar LyX
874 will only see the \SpecialChar TeX
876 Those reading a printed version of the manuals will see the actual results:
877 \begin_inset VSpace bigskip
883 \begin_layout Standard
887 \begin_layout Plain Layout
894 \begin_layout Plain Layout
901 \begin_layout Plain Layout
903 This is an example of a minipage environment.
904 You can put nearly everything in it, even (non-floating) figures and tables.
908 \begin_layout Plain Layout
915 \begin_layout Plain Layout
920 \begin_layout Plain Layout
927 \begin_layout Plain Layout
934 \begin_layout Plain Layout
941 \begin_layout Plain Layout
947 \begin_layout Plain Layout
954 \begin_layout Plain Layout
961 \begin_layout Plain Layout
968 \begin_layout Plain Layout
978 \begin_inset VSpace bigskip
984 \begin_layout Standard
985 In addition to using \SpecialChar TeX
986 code, you can also create a separate file containing
987 some complex \SpecialChar LaTeX
988 structure and then use
989 \begin_inset Flex Noun
992 \begin_layout Plain Layout
993 Insert\SpecialChar menuseparator
1003 to include your file (you should select the type
1004 \begin_inset Flex Code
1007 \begin_layout Plain Layout
1014 We recommend that you only do this if you have a
1015 \begin_inset Flex Code
1018 \begin_layout Plain Layout
1029 Otherwise, you'll have a big job tracking down \SpecialChar LaTeX
1033 \begin_layout Standard
1034 There are a few last points to emphasize:
1037 \begin_layout Itemize
1043 check if your \SpecialChar LaTeX
1047 \begin_layout Itemize
1048 Beware of reinventing the wheel.
1051 \begin_layout Standard
1052 On that last point, \SpecialChar LyX
1053 does have quite a few features tucked into it, and
1055 Be sure to check the manuals to make sure that \SpecialChar LyX
1056 doesn't have such-and-such
1057 feature before you decide you have to do it by hand.
1058 Moreover, there are numerous \SpecialChar LaTeX
1059 packages out there to do all sorts of things,
1060 from labels to envelopes to fancy multipage tables.
1062 \change_inserted 244031559 1603815732
1064 \begin_inset CommandInset href
1067 target "https://www.ctan.org/"
1073 \change_deleted 244031559 1603815732
1075 \begin_inset CommandInset href
1078 target "http://www.ctan.org/"
1088 \begin_layout Standard
1089 If you do need to do some wild and fancy things within your document, be
1090 sure to check out a good \SpecialChar LaTeX
1091 book for assistance.
1092 There are a number of them listed in the bibliography of the
1099 \begin_layout Section
1101 and the \SpecialChar LaTeX
1105 \begin_layout Subsection
1106 About the \SpecialChar LaTeX
1110 \begin_layout Standard
1111 If you already know \SpecialChar LaTeX
1112 , there is no need to explain here what the preamble
1114 If you don't, the following will give you some ideas—we recommend again
1115 that you consult a \SpecialChar LaTeX
1116 book for further information.
1117 In any case, you should read the points below, because they explain what
1118 you can do and what you don't need to do in the \SpecialChar LaTeX
1119 preamble of a \SpecialChar LyX
1123 \begin_layout Standard
1124 The \SpecialChar LaTeX
1125 preamble comes at the very beginning of a document,
1133 \begin_layout Itemize
1134 Declare the document class.
1136 \begin_inset Newline newline
1140 already does this for you.
1141 If you're a seasoned \SpecialChar LaTeX
1142 -nician, and you have a custom document class you
1143 want to use, check out the
1145 Customization Manual
1147 for information on how to make \SpecialChar LyX
1151 \begin_layout Itemize
1152 Declare the usage of packages.
1154 \begin_inset Newline newline
1158 packages provide special commands, which are only available within a document
1159 when the package has been declared in the preamble.
1160 In addition to providing special commands, the inclusion of a package can
1161 change the document.
1162 For example, the package
1163 \begin_inset Flex Code
1166 \begin_layout Plain Layout
1172 forces all paragraphs to be indented.
1173 There are other packages for labels, envelopes, margins, etc.
1177 \begin_layout Itemize
1178 Set counters, variables, lengths and widths.
1180 \begin_inset Newline newline
1183 There are several \SpecialChar LaTeX
1184 counters and variables that
1188 be set globally from within the preamble in order to have the desired effect.
1189 (There are variables that you can set and reset inside the document, too.)
1190 Margins are a good example of something that must be set in the preamble.
1191 Another example is the label format for lists.
1192 You can actually set these just about anywhere, but it's best to do it
1193 just once, inside the preamble.
1196 \begin_layout Itemize
1197 Declare user defined commands (with
1198 \begin_inset Flex Code
1201 \begin_layout Plain Layout
1210 \begin_inset Flex Code
1213 \begin_layout Plain Layout
1222 \begin_inset Newline newline
1225 These are abbreviations for \SpecialChar LaTeX
1226 commands which appear very often inside a document.
1227 Although the preamble is a good place to declare such commands, they
1231 be declared anywhere (before they are used for the first time, of course).
1232 This can be useful if there is a lot of raw \SpecialChar LaTeX
1233 code in your document, which
1234 normally should not be the case.
1237 \begin_layout Standard
1239 adds its own set of definitions to the preamble of the
1240 \begin_inset Flex Code
1243 \begin_layout Plain Layout
1250 This makes \SpecialChar LaTeX
1251 files generated by \SpecialChar LyX
1255 \begin_layout Subsection
1256 Changing the Preamble
1259 \begin_layout Standard
1260 The commands which \SpecialChar LyX
1261 adds to the preamble of a \SpecialChar LaTeX
1262 file are fixed; you can't
1263 change them without patching \SpecialChar LyX
1265 You can, however, add your own stuff to the preamble by selecting
1266 \begin_inset Flex Noun
1269 \begin_layout Plain Layout
1272 \begin_inset space ~
1281 \begin_inset Flex Noun
1284 \begin_layout Plain Layout
1285 Document\SpecialChar menuseparator
1293 adds anything in the
1294 \begin_inset Flex Noun
1297 \begin_layout Plain Layout
1303 dialog to its own built-in preamble.
1304 Before adding your own declarations in the preamble, you should make sure
1305 that \SpecialChar LyX
1306 doesn't already support what you want to do.
1307 (Remember what we said about reinventing the wheel?) Also,
1309 make sure your preamble code is correct
1313 doesn't check it for you.
1314 If there is an error, you're likely to get an error like
1315 \begin_inset Quotes eld
1319 \begin_inset Flex Code
1322 \begin_layout Plain Layout
1331 \begin_inset Quotes erd
1335 If you see this error, check your preamble.
1338 \begin_layout Subsection
1342 \begin_layout Standard
1343 Here are some examples of what you can add to a preamble, and what they
1347 \begin_layout Subsubsection
1351 \begin_layout Standard
1352 There are two variables under \SpecialChar LaTeX
1353 that control page position:
1354 \begin_inset Flex Code
1357 \begin_layout Plain Layout
1366 \begin_inset Flex Code
1369 \begin_layout Plain Layout
1378 Their names should be self-explanatory.
1379 These variables are useful if you think for a moment about computer labels.
1380 Sometimes, the size of a print medium and the area of the medium that you
1381 can actually print on aren't the same.
1383 \begin_inset Flex Code
1386 \begin_layout Plain Layout
1395 \begin_inset Flex Code
1398 \begin_layout Plain Layout
1409 \begin_layout Standard
1410 The default values for
1411 \begin_inset Flex Code
1414 \begin_layout Plain Layout
1423 \begin_inset Flex Code
1426 \begin_layout Plain Layout
1435 \begin_inset space \thinspace{}
1439 \begin_inset space \thinspace{}
1443 \begin_inset space \space{}
1446 the page isn't shifted.
1447 Unfortunately, some DVI drivers always seem to shift the page.
1448 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1449 If you're using \SpecialChar LyX
1450 on a system that you don't personally maintain, and your
1451 sysadmin is a doofus,
1452 \begin_inset Flex Code
1455 \begin_layout Plain Layout
1464 \begin_inset Flex Code
1467 \begin_layout Plain Layout
1476 Suppose your left and top margins are always 0.5
1477 \begin_inset space \thinspace{}
1481 You can add this to the preamble:
1484 \begin_layout LyX-Code
1492 \begin_layout LyX-Code
1500 \begin_layout Standard
1501 and your margins should now be correct.
1504 \begin_layout Subsubsection
1508 \begin_layout Standard
1509 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1510 There's a rather nice package, available at your nearest CTAN archive,
1511 for printing sheets of labels:
1512 \begin_inset Flex Code
1515 \begin_layout Plain Layout
1522 Now, your system may not have this package installed by default.
1523 We leave that up to you to check.
1524 You'll also want to read the documentation for it; we're not going to do
1526 Since this is an example, however, we'll give you an example of how you
1530 \begin_layout Standard
1531 First, make sure you're using the
1532 \begin_inset Flex Code
1535 \begin_layout Plain Layout
1542 Next, you need to put the following in your preamble:
1545 \begin_layout LyX-Code
1551 \begin_layout LyX-Code
1557 \begin_layout LyX-Code
1563 \begin_layout LyX-Code
1569 \begin_layout LyX-Code
1575 \begin_layout LyX-Code
1581 \begin_layout LyX-Code
1587 \begin_layout Standard
1588 This sets things up for Avery label sheets, stock #5360.
1589 You're now ready to print labels, but you'll need to insert \SpecialChar LaTeX
1592 \begin_inset Flex Code
1595 \begin_layout Plain Layout
1604 \begin_inset Flex Code
1607 \begin_layout Plain Layout
1615 around each label text.
1616 This and other special features of
1617 \begin_inset Flex Code
1620 \begin_layout Plain Layout
1626 are explained in its documentation.
1629 \begin_layout Standard
1630 Someday, someone may write a \SpecialChar LyX
1631 layout file to support this package directly.
1632 Maybe that someone is you.
1635 \begin_layout Subsubsection
1636 Example #3: Paragraph Indentation
1639 \begin_layout Standard
1640 Americans are trained to indent the first line of
1645 As with all of their other weird quirks, most Americans will whine and
1646 moan until they can have their way and indent the first line of all paragraphs.
1655 \begin_layout Standard
1656 Of course, this behavior isn't standard typography.
1657 In books, you typically only indent the first line of a paragraph
1661 it follows another one.
1662 The idea behind indenting the first line of a paragraph is to distinguish
1663 neighboring paragraphs from one another.
1664 If there is no previous paragraph—for example, if it follows a figure or
1665 is the first paragraph in a section—then there is no need for indentation.
1669 \begin_layout Standard
1670 If you're a typical American (we're still joking!), though, you don't care
1671 about such esoteric things; you want your indentation! Add this to the
1675 \begin_layout LyX-Code
1678 usepackage{indentfirst}
1681 \begin_layout Standard
1682 If your \SpecialChar TeX
1683 distribution isn't braindead, you'll have this package, and all
1684 of your paragraphs will get the indentation the Founding Fathers intended
1688 \begin_layout Subsubsection
1689 Example #4: This Document
1692 \begin_layout Standard
1693 You can also check out the preamble of this document to get an idea of some
1694 of the advanced things you can do.
1697 \begin_layout Section
1699 and \SpecialChar LaTeX
1703 \begin_layout Standard
1704 When \SpecialChar LyX
1705 calls \SpecialChar LaTeX
1706 , it tells \SpecialChar LaTeX
1707 to blithely ignore any errors and keep going.
1708 It then uses the logfile from the \SpecialChar LaTeX
1709 run to do a post-mortem.
1710 After analyzing the logfile, \SpecialChar LyX
1711 displays a dialog listing the errors.
1712 Clicking on any one of them will take you to the position in your \SpecialChar LyX
1714 where the error occurred.
1718 \begin_layout Plain Layout
1720 Analyzing the logfile is a tough job, and \SpecialChar LyX
1721 doesn't always go to the right
1723 There are also cases where \SpecialChar LaTeX
1724 reports the error on one line, but the actual
1726 This is not unlike forgetting a closing brace in a program: You'll get
1727 an error, but only later.
1735 \begin_layout Standard
1736 Some folks also like to look at the log file directly: It is available from
1738 \begin_inset Flex Noun
1741 \begin_layout Plain Layout
1742 Document\SpecialChar menuseparator
1744 \begin_inset space ~
1753 There are some fairly common error messages and warnings.
1754 We'll cover those here.
1755 You should look at a good \SpecialChar LaTeX
1756 book for a complete listing.
1759 \begin_layout Itemize
1760 \begin_inset Flex Code
1763 \begin_layout Plain Layout
1770 \begin_inset Newline newline
1773 Anything beginning with these words is a warning message for the purpose
1775 \begin_inset Quotes eld
1779 \begin_inset Quotes erd
1782 the \SpecialChar LaTeX
1784 You'll get messages like this if you added or changed cross-references
1785 or bibliography entries, in which case, \SpecialChar LaTeX
1786 is trying to tell you that you
1787 need to make another run.
1788 You can by-and-large ignore these.
1791 \begin_layout Itemize
1792 \begin_inset Flex Code
1795 \begin_layout Plain Layout
1802 \begin_inset Newline newline
1805 Another warning message, this time about fonts which \SpecialChar LaTeX
1807 The rest of the message will often say something about a replacement font
1808 that \SpecialChar LaTeX
1810 You can safely ignore these, too.
1813 \begin_layout Itemize
1814 \begin_inset Flex Code
1817 \begin_layout Plain Layout
1826 \begin_inset Newline newline
1835 It seems to generate at least one of these messages for just about any
1837 They are warnings about lines that were too long and run past the right
1839 This happens if \SpecialChar LaTeX
1840 does not find a reasonable way to break the lines (notoriously
1841 often with typewriter font, since this does not allow for automatic break
1843 In many cases, this is unnoticeable in the final output.
1844 (It can be just a point or two.) Sometimes, however, the lines run rather
1845 visibly into the margin; something you will not want to have in your final
1848 \begin_inset Newline newline
1851 There are several global ways to try to minimize the overfull lines.
1854 Enable micro-typographic extensions
1858 Document\SpecialChar menuseparator
1859 Settings\SpecialChar menuseparator
1862 might already improve things a lot.
1863 Furthermore, \SpecialChar LaTeX
1864 code such as the following in
1866 Document\SpecialChar menuseparator
1867 Settings\SpecialChar menuseparator
1870 usually reduces the overfull lines drastically (we use this in the preamble
1875 \begin_layout LyX-Code
1879 \begin_inset Newline newline
1885 \begin_inset Newline newline
1890 emergencystretch 1.5em
1891 \begin_inset Newline newline
1899 \begin_layout Standard
1900 In some cases, however, you eventually have to rewrite the text to get the
1901 line breaking right.
1905 \begin_layout Plain Layout
1906 For more information, see
1907 \begin_inset Flex URL
1910 \begin_layout Plain Layout
1912 http://www.tex.ac.uk/FAQ-overfull.html
1925 \begin_layout Standard
1926 In any case, you should check the respective lines, at least for the final
1927 version of your document.
1928 Your eyes will tell you if there's a problem with something that's too
1933 \begin_layout Plain Layout
1934 You can also enable the `draft' option in
1935 \begin_inset Flex Noun
1938 \begin_layout Plain Layout
1939 Document\SpecialChar menuseparator
1945 , and then \SpecialChar LaTeX
1946 will draw a black box in the margin of lines that are overfull.
1955 \begin_layout Itemize
1956 \begin_inset Flex Code
1959 \begin_layout Plain Layout
1968 \begin_inset Newline newline
1971 Not quite as common as its cousin.
1972 This happens again if \SpecialChar LaTeX
1973 does not find a reasonable break point and consequently
1974 generates too loose lines.
1975 As with the overfull lines, you should check if this is a visible problem.
1978 \begin_layout Itemize
1979 \begin_inset Flex Code
1982 \begin_layout Plain Layout
1991 \begin_inset Flex Code
1994 \begin_layout Plain Layout
2003 \begin_inset Newline newline
2006 Warnings about troubles breaking the page.
2007 Once again, just look at the output.
2008 Your eyes will tell you where something has gone wrong.
2011 \begin_layout Itemize
2012 \begin_inset Flex Code
2015 \begin_layout Plain Layout
2017 \begin_inset Quotes els
2021 \begin_inset Quotes ers
2030 \begin_inset Newline newline
2034 \begin_inset Quotes eld
2038 \begin_inset Quotes erd
2041 isn't installed on this system.
2042 This usually appears because some package your document needs isn't installed.
2043 If you didn't touch the preamble or didn't use the
2044 \begin_inset Flex Code
2047 \begin_layout Plain Layout
2055 command, then one of the packages \SpecialChar LyX
2056 tried to load is missing.
2058 \begin_inset Flex Noun
2061 \begin_layout Plain Layout
2062 Help\SpecialChar menuseparator
2069 to get a list of packages that \SpecialChar LyX
2071 This file is updated whenever you reconfigure \SpecialChar LyX
2073 \begin_inset Flex Noun
2076 \begin_layout Plain Layout
2077 Tools\SpecialChar menuseparator
2083 ) and tells you which packages have been detected and what they do.
2084 \begin_inset Newline newline
2088 \begin_inset Flex Code
2091 \begin_layout Plain Layout
2099 command and the package in question isn't installed, then you'll need to
2100 install it yourself.
2103 \begin_layout Itemize
2104 \begin_inset Flex Code
2107 \begin_layout Plain Layout
2108 LaTeX Error: Unknown option
2114 \begin_inset Newline newline
2117 Error messages beginning with this are trying to tell you that you specified
2118 a bad or undefined option to a package.
2119 Check the package's documentation.
2122 \begin_layout Itemize
2123 \begin_inset Flex Code
2126 \begin_layout Plain Layout
2127 Undefined control sequence
2133 \begin_inset Newline newline
2136 If you've inserted \SpecialChar LaTeX
2137 code into your document, but made a typo, you'll get
2139 You may have forgotten to load a package.
2140 In any case, this error message usually means that you used an undefined
2145 \begin_layout Standard
2146 There are other error and warning messages.
2147 Some are self-explanatory.
2148 These are usually \SpecialChar LaTeX
2150 Others are downright cryptic.
2151 These are usually \SpecialChar TeX
2152 error messages, and we really have
2156 what they mean or how to decipher them.
2160 \begin_layout Standard
2161 There's a general sequence you should follow if you get error messages:
2164 \begin_layout Enumerate
2165 Look at the \SpecialChar LaTeX
2166 code you inserted for typos.
2169 \begin_layout Enumerate
2170 If there are no typos, check that you used the command(s) correctly.
2173 \begin_layout Enumerate
2174 If you get a bunch of error boxes piled up at the very top of the document—and
2175 especially if you see a
2176 \begin_inset Quotes eld
2180 \begin_inset Flex Code
2183 \begin_layout Plain Layout
2192 \begin_inset Quotes erd
2195 error—it means that there are errors in the preamble.
2196 Start debugging your preamble.
2199 \begin_layout Enumerate
2200 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2202 document, the first suspect is your \SpecialChar LaTeX
2203 distribution itself.
2204 Check for missing packages and install them.
2207 \begin_layout Enumerate
2208 Okay, so there are no missing packages.
2209 Did you use any of the fine-tuning options in \SpecialChar LyX
2210 ? Specifically, did you
2214 any of them, like trying to manually insert lots of
2215 \begin_inset Flex Code
2218 \begin_layout Plain Layout
2220 \change_deleted 177693 1654669036
2222 \change_inserted 177693 1654669038
2226 \begin_inset space ~
2230 \change_deleted 177693 1654669040
2232 \change_inserted 177693 1654669041
2241 \begin_inset Flex Code
2244 \begin_layout Plain Layout
2251 \begin_inset Flex Code
2254 \begin_layout Plain Layout
2260 ? Did you try to kludge something together with these instead of using the
2261 appropriate paragraph environment?
2264 \begin_layout Enumerate
2265 All right, you didn't use any of the fine-tuning options, you played by
2267 Did you try to pull a fancy maneuver? Did you do something funky inside
2268 a table or an equation, like inserting a graphic into a table cell?
2271 \begin_layout Enumerate
2272 Do you have long sections of text where \SpecialChar LaTeX
2273 cannot find a place to break a
2274 line? By default, \SpecialChar LaTeX
2275 is rather strict about how much extra inter-word spacing
2276 it will add in order to break a line.
2277 Preferably, you should rework the paragraph to avoid the problem.
2280 \begin_layout Enumerate
2281 Did you go overboard with the nesting? \SpecialChar LyX
2282 (currently) doesn't check to make
2283 sure you're in the limits for nesting environments.
2284 If you nested a bunch of environments to the
2285 \begin_inset Formula $17^{\mathrm{th}}$
2288 level, that's the problem.
2289 (The limit in \SpecialChar LaTeX
2293 \begin_layout Enumerate
2294 Okay, you didn't get any error messages, but your output looks awful.
2295 If you have a table or figure that's too wide or long for the page, you
2300 \begin_layout Enumerate
2301 rescale the figure so it fits.
2304 \begin_layout Enumerate
2305 trim down the table so it fits.
2309 \begin_layout Enumerate
2310 If something else is wrong with the output, and you didn't try to pull anything
2311 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2314 \begin_layout Standard
2315 If all this doesn't help—well, then
2319 you might have found a bug in \SpecialChar LyX
2324 \begin_layout Chapter
2326 \change_inserted 564990737 1670439508
2330 \begin_layout Section
2332 \change_inserted 564990737 1670439533
2333 \begin_inset CommandInset label
2335 name "sec:Collections"
2342 \begin_layout Subsection
2343 AMS \SpecialChar LaTeX
2347 \begin_layout Standard
2354 Richard Kimberly Heck
2357 \begin_layout Standard
2358 \begin_inset VSpace bigskip
2364 \begin_layout Standard
2366 The AMS \SpecialChar LaTeX
2367 layouts are set up to conform to suggested styles for mathematical
2368 papers to be submitted to American Mathematical Society publications.
2369 The layouts are not tailored to a specific journal, but easily can be.
2370 You should refer to the AMS documentation for specific instructions for
2371 each journal (usually it will entail only changing a single line in the
2374 That documentation is available on the Web at
2375 \begin_inset Flex URL
2378 \begin_layout Plain Layout
2386 \begin_inset Flex URL
2389 \begin_layout Plain Layout
2391 ftp://ftp.ams.org/pub/tex/amslatex/
2397 These layouts are appropriate, and useful, for any mathematical writing.
2401 \begin_layout Standard
2402 There are two basic AMS \SpecialChar LaTeX
2406 \begin_layout Itemize
2407 amsart: The standard AMS article format.
2410 \begin_layout Itemize
2411 amsbook: the standard AMS book (really, monograph) format.
2415 \begin_layout Standard
2416 The layouts themselves contain only the minimum necessary to use the AMS
2418 They do not, in particular, contain any of the `theorem' environments used
2419 for setting theorems, lemmas, and the like.
2420 These are contained, instead, in the
2421 \begin_inset Flex Code
2424 \begin_layout Plain Layout
2430 module, which is loaded by default when you select one of the AMS classes.
2431 (It can also be used with other classes and can be removed, if you would
2432 rather use something else.) Less commonly used environments are in the
2433 \begin_inset Flex Code
2436 \begin_layout Plain Layout
2437 Theorems (AMS-Extended)
2442 module, which must be loaded manually.
2445 \begin_layout Standard
2446 By default, theorems and the like are numbered consecutively throughout
2447 the document, but this may be modified by loading the module
2448 \begin_inset Flex Code
2451 \begin_layout Plain Layout
2452 Theorems (Order by Section)
2457 or, if you are using
2458 \begin_inset Flex Code
2461 \begin_layout Plain Layout
2468 \begin_inset Flex Code
2471 \begin_layout Plain Layout
2472 Theorems (Order by Chapter)
2478 These will number the results as
2479 \begin_inset Formula $n.m$
2482 , where the first number refers to the section (or chapter) and the second
2483 refers to the total number of results so far in that section (or chapter).
2484 Many environments are also available unnumbered.
2485 These are indicated by an asterisk at the end.
2486 If you happen to want
2490 unnumbered results, the module
2491 \begin_inset Flex Code
2494 \begin_layout Plain Layout
2500 provides that option.
2503 \begin_layout Standard
2504 Note that these modules do not
2508 to be used with the AMS classes.
2509 It is perfectly possible to use the
2510 \begin_inset Flex Code
2513 \begin_layout Plain Layout
2519 module, and the others mentioned, with other classes, such as
2520 \begin_inset Flex Code
2523 \begin_layout Plain Layout
2530 \begin_inset Flex Code
2533 \begin_layout Plain Layout
2540 \begin_inset Flex Code
2543 \begin_layout Plain Layout
2552 \begin_layout Subsubsection
2553 What these layouts provide
2556 \begin_layout Standard
2557 There is a long list of included environments provided by these layouts.
2558 In AMS-\SpecialChar LaTeX
2559 , there is, in fact, an opportunity to define an unlimited variety
2560 of `theorem' environments.
2561 However, the AMS recommends the environments that are available in \SpecialChar LyX
2566 \begin_layout Standard
2567 The following environments—as well as the standard environments, such as
2569 \begin_inset Flex Noun
2572 \begin_layout Plain Layout
2579 \begin_inset Flex Noun
2582 \begin_layout Plain Layout
2589 \begin_inset Flex Noun
2592 \begin_layout Plain Layout
2599 \begin_inset Flex Noun
2602 \begin_layout Plain Layout
2609 \begin_inset Flex Noun
2612 \begin_layout Plain Layout
2619 \begin_inset Flex Code
2622 \begin_layout Plain Layout
2629 \begin_inset Flex Code
2632 \begin_layout Plain Layout
2641 \begin_layout Description
2642 Address This should be the author's permanent address.
2645 \begin_layout Description
2647 \begin_inset space ~
2650 Address This should be the author's temporary address at the time of submission,
2651 if different from the Address.
2654 \begin_layout Description
2655 Email Author's e-mail address
2658 \begin_layout Description
2659 URL Author's Web address, if desired.
2662 \begin_layout Description
2663 Keywords Key words or phrases used to identify specific topics discussed
2667 \begin_layout Description
2668 Subjectclass These refer to the AMS Subject Classifications, published and
2671 Mathematical Reviews
2674 These are also available online at the AMS cites listed above.
2677 \begin_layout Description
2681 \begin_layout Description
2685 \begin_layout Description
2689 \begin_layout Standard
2690 The following environments are provided by both the
2691 \begin_inset Flex Code
2694 \begin_layout Plain Layout
2701 \begin_inset Flex Code
2704 \begin_layout Plain Layout
2710 modules, in the latter case in both starred (unnumbered) and unstarred
2711 (numbered) versions.
2712 These same environments are provided only in the starred versions by the
2714 \begin_inset Flex Code
2717 \begin_layout Plain Layout
2726 \begin_layout Theorem
2727 This is typically used for the statements of major results.
2731 \begin_layout Corollary*
2732 This is used for statements which follow fairly directly from previous statement
2734 Again, these can be major results.
2739 These are smaller results needed to prove other statements.
2742 \begin_layout Proposition
2743 These are less major results which (hopefully) add to the general theory
2747 \begin_layout Conjecture
2748 These are statements provided without justification, which the author does
2749 not know how to prove, but which seem to be true (to the author, at least).
2752 \begin_layout Definition*
2753 Guess what this is for.
2754 The font is different for this environment than for the previous ones.
2758 \begin_layout Example*
2759 Used for examples illustrating proven results.
2762 \begin_layout Problem
2763 It's not really known what this is for.
2764 You should figure it out.
2767 \begin_layout Exercise*
2768 Write a description for this one.
2771 \begin_layout Remark
2772 This environment is also a type of theorem, usually a lesser sort of observation.
2775 \begin_layout Claim*
2776 Often used in the course of giving a proof of a larger result.
2780 Generally, these are used to break up long arguments, using specific instances
2786 The numbering scheme for cases is on its own, not together with other numbered
2792 At the end of this environment, a QED symbol (usually a square, but it can
2793 vary with different styles) is placed.
2794 If you want to have other environments within this one—for example, Case
2795 environments—and have the QED symbol appear only after them, then the other
2796 environments need to be nested within the proof environment.
2799 Nesting Environments
2805 for information on nesting.
2808 \begin_layout Standard
2809 And these environments are provided by
2810 \begin_inset Flex Code
2813 \begin_layout Plain Layout
2814 Theorems (AMS-Extended)
2822 \begin_layout Criterion*
2823 A required condition.
2826 \begin_layout Algorithm*
2827 A general procedure to be used.
2830 \begin_layout Axiom*
2831 This is a property or statement taken as true within the system being discussed.
2834 \begin_layout Condition*
2835 Sometimes used to state a condition assumed within the present context of
2840 Similar to a Remark.
2843 \begin_layout Notation*
2844 Used for the explanation of, yes, notation.
2847 \begin_layout Summary
2848 Do we really need to tell you?
2851 \begin_layout Acknowledgement*
2855 \begin_layout Conclusion*
2856 Sometimes used at the end of a long train of argument.
2860 Used in a way similar to Proposition, though perhaps lower on the scale.
2863 \begin_layout Standard
2864 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
2867 They need to be available on your system in order to use these environments.
2870 \begin_layout Subsection
2874 \begin_layout Standard
2880 \begin_layout Subsubsection
2884 \begin_layout Standard
2885 The \SpecialChar LyX
2888 article (koma-script)
2892 report (koma-script)
2910 correspond to the \SpecialChar LaTeX
2928 \begin_inset space ~
2931 of the Koma-Script family.
2932 They are replacements for the standard document classes
2948 , resp., and fit better to European typography conventions in a number of
2952 \begin_layout Itemize
2953 Standard character size is 11pt in
2955 article (koma-script)
2959 report (koma-script)
2967 letter (koma-script)
2972 \begin_layout Itemize
2973 Headings, labels of the description environment, and a number of elements
2976 letter (koma-script)
2978 document class are set in a bold sans serif font.
2982 \begin_layout Plain Layout
2983 There is a big difference between the bold sans serif old cm fonts and new
2984 ec fonts, especially in the appearance of headings.
2985 In comparison, the ec bold sans serif fonts look a bit thin.
2986 Here the \SpecialChar LaTeX
2995 helps to produce the
2996 \begin_inset Quotes eld
3000 \begin_inset Quotes erd
3003 appearance when using the ec fonts.
3008 The numbering of chapter headings is made in the same way as the numbering
3009 of section headings, that is without the extra line
3010 \begin_inset Quotes eld
3013 Chapter\SpecialChar ldots
3015 \begin_inset Quotes erd
3019 In addition, the appearance of the headings can be modified by using a
3020 number of options (in \SpecialChar LyX
3021 to be entered in the field
3024 \begin_inset space ~
3031 Layout\SpecialChar menuseparator
3038 \begin_layout Itemize
3039 The main means in the Koma-Script document classes to design the type area
3048 (in \SpecialChar LyX
3049 to be entered in the extra class options field in the dialog
3051 Document\SpecialChar menuseparator
3055 They make a clearer modification of page margins possible as do the options
3058 Document\SpecialChar menuseparator
3065 \begin_layout Itemize
3066 The \SpecialChar LaTeX
3067 document classes of the Koma-Script family define a number of additional
3069 Those part of it which makes sense in \SpecialChar LyX
3070 is implemented in corresponding
3074 \begin_layout Standard
3075 Detailed descriptions of the \SpecialChar LaTeX
3076 document classes of the Koma-Script family
3077 can be found in the Koma-Script documentation
3088 \begin_layout Subsubsection
3089 article (koma-script), report (koma-script), and book (koma-script)
3092 \begin_layout Standard
3093 The document classes
3095 article (koma-script)
3099 report (koma-script)
3109 are implemented in the layout files
3122 They contain all the paragraph types of the corresponding standard document
3135 , resp., partly modified, with the exception of the \SpecialChar LyX
3140 -type, which is replaced by the new
3144 -type having the same functionality.
3149 -Type there is a number of new paragraph types added.
3156 letter (koma-script)
3161 \begin_layout Itemize
3170 : are equivalents to
3178 , resp., additionally inserting an entry in the table of contents.
3187 are not contained in
3189 article (koma-script)
3194 \begin_layout Itemize
3211 , resp., additionally clearing running heads.
3218 article (koma-script)
3224 \begin_layout Plain Layout
3237 report (koma-script)
3239 , but since this is identical to
3243 , is has not been implemented in \SpecialChar LyX
3252 \begin_layout Itemize
3257 : generates a heading directly above the following paragraph in the standard
3258 character size without affecting the structure of the document.
3261 \begin_layout Itemize
3270 are special captions which respect the different space settings needed
3271 for captions placed above or below an element (if you follow strict typographic
3272 rules, you might want to place table captions always above the table).
3273 You can also use the class option
3290 You need at least Koma-Script version 2.8q to use this.
3293 \begin_layout Itemize
3298 : can be used to set a bonmot, e.
3299 \begin_inset space \thinspace{}
3303 \begin_inset space \space{}
3306 at the beginning of a chapter.
3307 If you use the optional argument (
3309 Insert\SpecialChar menuseparator
3311 \begin_inset space ~
3316 ), you can insert the dictum's author there.
3317 Dictum and author are separated by a line.
3318 You need at least Koma-Script version 2.8q to use this.
3325 article (koma-script)
3330 \begin_layout Standard
3331 The following types, together with the standard types
3343 , form the title area of the document.
3344 They must be entered ahead of the first
3345 \begin_inset Quotes eld
3349 \begin_inset Quotes erd
3356 \begin_layout Plain Layout
3357 The corresponding \SpecialChar LaTeX
3358 commands must appear before the
3369 When such a type is used more than once, the latter usage overwrites the
3370 former one, that means, for every type only the latest usage is valid.
3371 The order of the different types however has, like
3383 , no effect on the appearance of the produced document.
3386 \begin_layout Itemize
3391 : produces a centered paragraph above the ordinary title (
3403 ) for the subject of the document.
3406 \begin_layout Itemize
3411 : produces a centered paragraph below the ordinary title (
3423 ) for the publishers' name.
3426 \begin_layout Itemize
3433 report (koma-script)
3439 produces a centered paragraph on its own page behind the title page, or
3442 article (koma-script)
3444 produces a centered paragraph below the ordinary title (
3463 \begin_layout Itemize
3468 : produces a left aligned paragraph above the ordinary title (
3484 ) for a document`s head.
3487 \begin_layout Itemize
3492 : produces in a double-sided print in
3494 report (koma-script)
3500 a left-aligned paragraph at the top of the title page`s back or has no
3501 effect in a single-sided print or in
3503 article (koma-script)
3508 \begin_layout Itemize
3513 : produces in a double-sided print in
3515 report (koma-script)
3521 a left-aligned paragraph at the bottom of the title page`s back or has
3522 no effect in a single-sided print or in
3524 article (koma-script)
3529 \begin_layout Itemize
3534 : produces a special
3535 \begin_inset Quotes eld
3539 \begin_inset Quotes erd
3542 page ahead of the actual document containing a paragraph without special
3546 \begin_layout Standard
3547 The layout files for the document classes
3549 article (koma-script)
3553 report (koma-script)
3564 This is thought of as a place to define your own types.
3569 in your personal layout directory and edit the file!
3572 \begin_layout Subsubsection
3573 letter (koma-script)
3576 \begin_layout Description
3577 Note: This section discusses the obsolete
3579 KOMA-Script-Letter (v.
3580 \begin_inset space ~
3585 , which is not even included anymore in recent KOMA releases.
3586 Please refer to the next section for the current KOMA-Script-Letter class
3588 \begin_inset space ~
3594 \begin_layout Standard
3598 letter (koma-script)
3600 is implemented in the layout file
3605 It contains all the paragraph types of the corresponding standard document
3610 , partly modified, with the exception of the \SpecialChar LyX
3624 type, which is replaced by the new
3629 In addition, it contains, in contrast to the standard document class, the
3648 Furthermore, there are a number of new letter specific types.
3651 \begin_layout Standard
3652 The appearance of the letter produced by this document class can be controlled
3653 by a number of \SpecialChar LaTeX
3654 commands, which you can put in the \SpecialChar LaTeX
3659 \begin_layout Plain Layout
3660 For example, the standard appearance of the letter`s heading, consisting
3661 of name and address, is quite self-willed.
3663 \begin_inset Quotes eld
3667 \begin_inset Quotes erd
3670 heading is produced by the following \SpecialChar LaTeX
3671 commands in the preamble:
3674 \begin_layout LyX-Code
3684 \begin_layout LyX-Code
3700 \begin_layout LyX-Code
3710 \begin_layout LyX-Code
3730 A detailed German description of such \SpecialChar LaTeX
3731 commands can be found in the Koma-Script
3737 With it, the letter's author can produce his personal letter layout.
3740 \begin_layout Standard
3749 define the beginning of the letter and must be used in every letter.
3750 To emphasize them in the \SpecialChar LyX
3751 document class, they are marked with the letter
3761 \begin_inset space ~
3765 It is possible to write any number of letters in one file.
3770 type produces a new letter using the same addressee and a
3774 type produces a new addressee.
3791 are ordinary paragraph types and can also be used several times in one
3792 and the same letter.
3795 \begin_layout Itemize
3800 : produces a paragraph for the addressee and implicitly defines the beginning
3804 \begin_layout Itemize
3809 : produces a paragraph for the form of address and implicitly produces a
3813 \begin_layout Itemize
3818 : produces a paragraph for a close.
3821 \begin_layout Itemize
3826 : produces a paragraph for a postscript.
3829 \begin_layout Itemize
3834 : produces a paragraph for a distribution list.
3837 \begin_layout Itemize
3842 : produces a paragraph for enclosures.
3845 \begin_layout Standard
3886 are input types provided with a label to enter information, which will
3887 be processed by the document class.
3891 \begin_layout Plain Layout
3892 It could be seen as a matter of inconsequence, that the types
3900 described above are not such input types as well.
3901 Because of the special meaning of those types, however, I have implemented
3902 them as ordinary paragraph types with a one letter mark in the left margin.
3903 Moreover, it would affect my feeling of symmetry, if the
3911 type had such a serious different appearance.
3916 The types must be used ahead of the corresponding
3923 \begin_layout Standard
3924 An implementation of these types in a WYSIWYG fashion does not seem to make
3925 sense, because the real appearance of the produced letter does not only
3926 depend on the usage of the particular type, but also on other factors.
3927 For example, a signature entered in the
3931 type will in the standard behavior appear in the produced letter only,
3932 when in the same letter also a
3937 The entered value of the
3941 type will in the standard behavior not appear in the produced letter at
3943 The possibility to design the letter`s heading freely is already indicated
3944 in a footnote above.
3947 \begin_layout Standard
3948 The input types can also be used as empty paragraphs.
3950 \begin_inset space \thinspace{}
3954 \begin_inset space \space{}
3966 type is not used at all, in the standard behavior the value of the
3970 type is used as signature, whereas if an empty
3974 type is used, no signature value is defined.
3977 \begin_layout Standard
3978 By using the input types it is possible to write a letter template, containing
3979 filled input types with your personal dates (name, address, etc.) and empty
3980 input types for other dates you want to enter.
3983 \begin_layout Itemize
3988 : sender's name, in the standard behavior appears as a centered paragraph
3989 in small caps in the letter`s heading.
3992 \begin_layout Itemize
3997 : sender's signature, in the standard behavior appears below the
4006 type is used, the value of the
4010 type appears instead.
4013 \begin_layout Itemize
4018 : sender's address, in the standard behavior appears in a centered paragraph
4019 in the letter`s heading below the sender's name.
4022 \begin_layout Itemize
4027 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
4038 \begin_layout Itemize
4043 : place of the letter`s making.
4046 \begin_layout Itemize
4051 : date of the letter`s making.
4060 , in the standard behavior, produce the place and the date in a right-aligned
4061 line below the addressee's field.
4066 type is used, neither place nor date appear, independent of the value of
4076 type is used, the date of the letter `s production is used.
4079 \begin_layout Itemize
4084 : sender`s back address, in the standard behavior appears above the addressee's
4085 field in a small sans serif font.
4088 \begin_layout Itemize
4093 : special mail information, in the standard behavior appears underlined
4094 above the addressee's field below the back address.
4097 \begin_layout Itemize
4102 : additional information, in the standard behavior appears on right side
4103 below the addressee`s field.
4106 \begin_layout Itemize
4111 : the letter's title, in the standard behavior appears in a big, bold, sans
4112 serif font above the subject.
4115 \begin_layout Itemize
4120 : the letter's subject, in the standard behavior appears in a bold font
4128 \begin_layout Standard
4149 produce a business letter like line above the
4153 line containing the fields
4154 \begin_inset Quotes eld
4158 \begin_inset Quotes erd
4162 \begin_inset Quotes eld
4166 \begin_inset Quotes erd
4170 \begin_inset Quotes eld
4174 \begin_inset Quotes erd
4178 \begin_inset Quotes eld
4182 \begin_inset Quotes erd
4186 \begin_inset Quotes eld
4190 \begin_inset Quotes erd
4194 \begin_inset Quotes eld
4198 \begin_inset Quotes erd
4202 For the date field, the value of the
4208 \begin_inset Quotes eld
4211 business letter types
4212 \begin_inset Quotes erd
4215 is used, the value of the
4219 type however does not appear, but only the \SpecialChar LaTeX
4227 The ordinary output of place and date in a right-aligned line below the
4228 addressee`s field is suppressed.
4229 The types are implemented as input types provided with a label and must
4230 be used ahead of the corresponding
4237 \begin_layout Itemize
4245 \begin_layout Itemize
4253 \begin_layout Itemize
4261 \begin_layout Itemize
4269 \begin_layout Itemize
4277 \begin_layout Subsubsection
4278 The new letter class: letter (koma-script v.2)
4281 \begin_layout Standard
4287 \begin_layout Standard
4288 \begin_inset VSpace medskip
4294 \begin_layout Standard
4296 Koma-Script version 2.8 has introduced a new letter class
4300 which supersedes the now unsupported
4305 It has — on the \SpecialChar LaTeX
4306 side — a completely new interface and is not compatible
4308 Therefore, \SpecialChar LyX
4309 supports both, though it is recommended you use the new class.
4312 \begin_layout Standard
4313 This class covers the same functionality as
4315 letter (koma-script),
4322 (receiver's address, same as
4339 will start a new letter (i.
4340 \begin_inset space \thinspace{}
4344 \begin_inset space \space{}
4347 you can write several letters per document).
4348 New elements are sender's
4364 and the possibility to use a
4370 Insert\SpecialChar menuseparator
4376 \begin_layout Standard
4377 The biggest improvement is, though, that the letter's layout is configurable
4378 to meet almost any needs.
4379 This can be done via the preamble or with a special style file (Letter
4380 Class Option, extension
4384 ), that will be read in as a class option.
4388 \begin_layout Plain Layout
4389 The KOMA package comes with some default
4394 There is, for instance, a
4398 file that follows german typesetting rules, or a
4402 that provides the default layout of the old
4407 The latter can be loaded with the class option
4413 Layout\SpecialChar menuseparator
4414 Document\SpecialChar menuseparator
4426 template that is included in \SpecialChar LyX
4428 A detailed description is to be found in the Koma-Script documentation
4436 \begin_layout Subsubsection
4440 \begin_layout Standard
4441 Visualizing the Koma-Script document classes in \SpecialChar LyX
4442 , the \SpecialChar LyX
4443 internals cause some
4447 \begin_layout Itemize
4448 The chapter number of a
4452 type appears on a line of its own above the chapter heading instead of
4453 appearing in the same line ahead of it.
4454 The cause for that is the \SpecialChar LyX
4455 internal behavior for the labeltype
4462 \begin_layout Itemize
4463 The headings of the types
4472 \begin_inset Quotes eld
4476 \begin_inset Quotes erd
4480 table of contents, but not in the \SpecialChar LyX
4483 Document\SpecialChar menuseparator
4485 \begin_inset space ~
4489 \begin_inset space ~
4497 \begin_layout Itemize
4502 document class appear in a skip separation mode, not indented.
4503 This is the standard behavior, no special \SpecialChar LaTeX
4504 commands are needed for that.
4507 Document\SpecialChar menuseparator
4510 dialog the corresponding radio button indicates
4519 value always has the effect that extra \SpecialChar LaTeX
4520 commands are inserted in the document
4521 to produce the gap, which is not what is wanted in this case.
4524 \begin_layout Subsection
4526 \change_inserted 564990737 1670924924
4528 \begin_inset space \thinspace{}
4532 \begin_inset space \space{}
4536 \change_deleted 564990737 1670924933
4537 Article (mwart), book (mwbk) and report (mwrep)
4538 \begin_inset Argument status
4541 \begin_layout Plain Layout
4556 \begin_layout Standard
4562 \begin_layout Standard
4563 The \SpecialChar LyX
4580 correspond to the \SpecialChar LaTeX
4594 They are replacements for the standard document classes
4606 , resp., and fit better to Polish typography conventions in a number of points.
4610 \begin_layout Standard
4614 \begin_layout Itemize
4615 Unnumbered titles (with star, e.
4616 \begin_inset space \thinspace{}
4620 \begin_inset space \space{}
4627 ) are added into table of contents,
4630 \begin_layout Itemize
4631 Additional page styles:
4635 \begin_layout Description
4636 uheadings header with separated lines,
4639 \begin_layout Description
4640 myheadings custom header, contents headers via commands:
4655 \begin_layout Description
4656 myuheadings custom header with separated lines,
4659 \begin_layout Description
4660 outer page number is placed on outer side of page
4664 \begin_layout Itemize
4669 \begin_layout Description
4670 rmheadings serif titles — default,
4673 \begin_layout Description
4674 sfheadings sansserif titles,
4677 \begin_layout Description
4678 authortitle on title page first placed is author next title — default,
4681 \begin_layout Description
4682 titleauthor on title page first placed is title next author,
4685 \begin_layout Description
4686 withmarginpar reserve place on page for margins.
4690 \begin_layout Section
4692 \change_inserted 564990737 1670439534
4696 \begin_layout Standard
4698 \change_inserted 564990737 1670794710
4699 See also the document classes in the Collections (section
4700 \begin_inset space ~
4704 \begin_inset CommandInset ref
4706 reference "sec:Collections"
4713 \begin_layout Subsection
4715 \change_inserted 564990737 1670794716
4721 \begin_layout Standard
4723 \change_inserted 564990737 1670794716
4730 ; updated by the \SpecialChar LyX
4734 \begin_layout Subsubsection
4736 \change_inserted 564990737 1670794716
4742 \begin_layout Standard
4744 \change_inserted 564990737 1670794716
4747 This section describes how \SpecialChar LyX
4748 can be used to write articles for submission
4749 to the scientific journal
4751 Astronomy and Astrophysics
4754 \begin_inset CommandInset href
4757 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
4762 ) using Version 9.1 of the document class
4766 ; information about it is available at
4767 \begin_inset Flex URL
4770 \begin_layout Plain Layout
4772 \change_inserted 564990737 1670794716
4774 https://www.aanda.org/for-authors/latex-issues/texnical-background-information
4784 \begin_layout Standard
4786 \change_inserted 564990737 1670794716
4789 A manual comes together with the package and should be consulted before
4790 installing this document class as described in the
4792 Installing New Document Classe
4802 \begin_layout Standard
4804 \change_inserted 564990737 1670794716
4807 \begin_inset Note Greyedout
4810 \begin_layout Plain Layout
4812 \change_inserted 564990737 1670794716
4815 Please note that the publisher of the journal was changed from Springer
4816 to EDP Sciences starting January 1, 2001.
4817 That change also involved some slight changes to the style files, namely
4818 the removal of the thesaurus command.
4819 If you have an older version installed, please upgrade.
4820 For information about compatibility with the old (version 4) layout, please
4821 refer to the comments in
4824 Dir/layouts/aapaper.layout
4834 \begin_layout Subsubsection
4836 \change_inserted 564990737 1670794716
4842 \begin_layout Standard
4844 \change_inserted 564990737 1670794716
4847 It is recommended you start from the template
4856 ile\SpecialChar menuseparator
4858 \begin_inset space ~
4866 \begin_inset space ~
4872 If you are not using the template, note the following settings:
4875 \begin_layout Itemize
4877 \change_inserted 564990737 1670794716
4889 ocument\SpecialChar menuseparator
4894 ettings\SpecialChar menuseparator
4896 \begin_inset space ~
4901 dialog (OK, that one was obvious).
4904 \begin_layout Itemize
4906 \change_inserted 564990737 1670794716
4912 \begin_inset space ~
4924 \begin_inset space ~
4929 dialog: leave it set to
4934 The whole layout is done by the macros, you shouldn't change anything.
4937 \begin_layout Subsubsection
4939 \change_inserted 564990737 1670794716
4945 \begin_layout Standard
4947 \change_inserted 564990737 1670794716
4950 First thing to enter is the header information.
4951 It consists of five entries, of which one is optional.
4955 \begin_layout Itemize
4957 \change_inserted 564990737 1670794716
4966 \begin_layout Itemize
4968 \change_inserted 564990737 1670794716
4977 \begin_layout Itemize
4979 \change_inserted 564990737 1670794716
4988 \begin_layout Itemize
4990 \change_inserted 564990737 1670794716
4999 \begin_layout Itemize
5001 \change_inserted 564990737 1670794716
5010 Received: <date>; Accepted <date>
5013 \begin_layout Standard
5015 \change_inserted 564990737 1670794716
5018 Although the order of the single header entries doesn't matter it is advised
5019 to keep the above sequence, just to get the best optics and meets the layout
5020 of the real document.
5023 \begin_layout Standard
5025 \change_inserted 564990737 1670794716
5028 If you want to place footnotes in the header block, e.
5029 \begin_inset space \thinspace{}
5033 \begin_inset space \space{}
5036 to state your present address, just use the standard footnote via the menu
5042 nsert\SpecialChar menuseparator
5051 will automagically use the term
5060 \begin_layout Standard
5062 \change_inserted 564990737 1670794716
5065 In addition to these topics, the macros use three additional \SpecialChar LaTeX
5067 have no counterpart in \SpecialChar LyX
5071 \begin_layout Itemize
5073 \change_inserted 564990737 1670794716
5081 to separate different names for more than one author and institute, respectivel
5085 \begin_layout Itemize
5087 \change_inserted 564990737 1670794716
5095 to mark corresponding author/institute pairs.
5096 The institutes are numbered sequentially as they appear in the
5100 field, so you have to put a marker to each author.
5103 \begin_layout Itemize
5105 \change_inserted 564990737 1670794716
5113 to supply an email address for fast contact.
5116 \begin_layout Standard
5118 \change_inserted 564990737 1670794716
5121 In all cases, the appropriate command has to be entered as \SpecialChar TeX
5122 code in \SpecialChar LyX
5124 See the examples in the template and in the file
5136 \begin_layout Subsubsection
5138 \change_inserted 564990737 1670794716
5144 \begin_layout Standard
5146 \change_inserted 564990737 1670794716
5149 The abstract should immediately follow the header block and must contain
5159 \begin_layout Enumerate
5161 \change_inserted 564990737 1670794716
5167 (optional) {} leave it empty if necessary
5170 \begin_layout Enumerate
5172 \change_inserted 564990737 1670794716
5181 \begin_layout Enumerate
5183 \change_inserted 564990737 1670794716
5192 \begin_layout Enumerate
5194 \change_inserted 564990737 1670794716
5203 \begin_layout Enumerate
5205 \change_inserted 564990737 1670794716
5211 (optional) {} leave it empty if necessary
5214 \begin_layout Standard
5216 \change_inserted 564990737 1670794716
5220 This structure not shown in
5227 \begin_layout Subsubsection
5229 \change_inserted 564990737 1670794716
5232 Supported environments
5235 \begin_layout Standard
5237 \change_inserted 564990737 1670794716
5240 The A&A paper layout supports the following environments for structuring
5244 \begin_layout Itemize
5246 \change_inserted 564990737 1670794716
5253 \begin_layout Itemize
5255 \change_inserted 564990737 1670794716
5262 \begin_layout Itemize
5264 \change_inserted 564990737 1670794716
5271 \begin_layout Itemize
5273 \change_inserted 564990737 1670794716
5280 \begin_layout Itemize
5282 \change_inserted 564990737 1670794716
5289 \begin_layout Itemize
5291 \change_inserted 564990737 1670794716
5298 \begin_layout Itemize
5300 \change_inserted 564990737 1670794716
5307 \begin_layout Itemize
5309 \change_inserted 564990737 1670794716
5316 \begin_layout Itemize
5318 \change_inserted 564990737 1670794716
5325 \begin_layout Itemize
5327 \change_inserted 564990737 1670794716
5334 \begin_layout Itemize
5336 \change_inserted 564990737 1670794716
5343 \begin_layout Itemize
5345 \change_inserted 564990737 1670794716
5353 \begin_layout Subsubsection
5355 \change_inserted 564990737 1670794716
5358 Commands not supported by \SpecialChar LyX
5362 \begin_layout Standard
5364 \change_inserted 564990737 1670794716
5367 Some commands are not yet supported by the
5371 layout for \SpecialChar LyX
5373 Some have already been mentioned.
5374 For the sake of completeness, they are listed all together here:
5377 \begin_layout Itemize
5379 \change_inserted 564990737 1670794716
5388 \begin_layout Itemize
5390 \change_inserted 564990737 1670794716
5399 \begin_layout Itemize
5401 \change_inserted 564990737 1670794716
5410 \begin_layout Itemize
5412 \change_inserted 564990737 1670794716
5421 \begin_layout Itemize
5423 \change_inserted 564990737 1670794716
5432 \begin_layout Standard
5434 \change_inserted 564990737 1670794716
5437 If you want to use any of these commands, you have to enter them yourself.
5440 Do not forget to use
5446 nsert\SpecialChar menuseparator
5449 \begin_inset space ~
5458 \begin_layout Subsubsection
5460 \change_inserted 564990737 1670794716
5463 Figure and Table Floats
5466 \begin_layout Standard
5468 \change_inserted 564990737 1670794716
5472 provides support for the necessary float environments
5474 figure, figure*, table
5480 , therefore we won't tell much about it here.
5484 \begin_inset space ~
5490 Just remember that tables should be left-aligned.
5491 For that, select the table and change the alignment in
5496 dit\SpecialChar menuseparator
5502 \begin_inset space ~
5508 \begin_layout Standard
5510 \change_inserted 564990737 1670794716
5513 There is only one special thing: the figures with a caption beside the figure.
5514 To create such a figure, you have to do the following:
5517 \begin_layout Enumerate
5519 \change_inserted 564990737 1670794716
5522 Create a wide figure float:
5527 nsert\SpecialChar menuseparator
5532 t\SpecialChar menuseparator
5535 , then, from within the float, use the menu
5540 dit\SpecialChar menuseparator
5546 \begin_inset space ~
5557 \begin_inset space ~
5569 \begin_layout Enumerate
5571 \change_inserted 564990737 1670794716
5574 Enter your caption text.
5577 \begin_layout Enumerate
5579 \change_inserted 564990737 1670794716
5586 to move the cursor above the caption.
5589 \begin_layout Enumerate
5591 \change_inserted 564990737 1670794716
5597 \begin_layout Enumerate
5599 \change_inserted 564990737 1670794716
5602 Position the cursor after the figure and insert a horizontal fill by using
5608 nsert\SpecialChar menuseparator
5613 rmatting\SpecialChar menuseparator
5619 \begin_inset space ~
5628 dialog and select the
5642 \begin_layout Enumerate
5644 \change_inserted 564990737 1670794716
5647 Switch to \SpecialChar LaTeX
5651 \begin_inset space ~
5659 \begin_layout Enumerate
5661 \change_inserted 564990737 1670794716
5672 Do not close the brace!
5675 \begin_layout Enumerate
5677 \change_inserted 564990737 1670794716
5680 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
5685 \begin_inset space ~
5697 \begin_layout Standard
5699 \change_inserted 564990737 1670794716
5702 Also, refer to the figures in the file
5713 \begin_layout Subsubsection
5715 \change_inserted 564990737 1670794716
5721 \begin_layout Standard
5723 \change_inserted 564990737 1670794716
5726 For submission, the paper has to be formatted in a special double-spacing
5728 For this purpose, you have to add the option
5739 \begin_inset space ~
5749 ocument\SpecialChar menuseparator
5754 ettings\SpecialChar menuseparator
5756 \begin_inset space ~
5765 \begin_layout Subsubsection
5767 \change_inserted 564990737 1670794716
5773 \begin_layout Standard
5775 \change_inserted 564990737 1670794716
5782 was written with \SpecialChar LyX
5784 It is the example paper from the original macro package,
5789 \begin_inset CommandInset href
5792 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
5797 , but translated to \SpecialChar LyX
5798 using the older unstructured abstract type.
5799 Use it for inspiration, and compare the \SpecialChar LaTeX
5804 with the \SpecialChar LyX
5808 \begin_layout Subsection
5813 \begin_layout Standard
5819 \begin_layout Subsubsection
5823 \begin_layout Standard
5825 is a set of macros produced by the American Astronomical Society to
5826 facilitate electronic manuscript submission to the three journals they
5827 publish: the Astrophysical Journal (including the Letters and Supplement),
5828 the Astronomical Journal, and the Publications of the Astronomical Society
5831 has proven to be an excellent tool for generating these documents, especially
5832 given its equation, citation, and figure handling capabilities.
5834 requires version 5.0 (or higher) of these macros; preferably 6.0, which
5835 is the version described here, or higher.
5836 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
5837 2.09 and are fundamentally
5838 incompatible with \SpecialChar LyX
5840 The AAS\SpecialChar TeX
5841 package may be downloaded from the AAS\SpecialChar TeX
5845 \begin_layout Standard
5846 \begin_inset VSpace medskip
5852 \begin_layout Standard
5854 \begin_inset Flex URL
5857 \begin_layout Plain Layout
5859 https://aas.org/aastex/aastex-downloads
5867 \begin_layout Standard
5868 \begin_inset VSpace medskip
5874 \begin_layout Standard
5875 A complete user guide is contained in that package and you should familiarize
5876 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
5879 will not reduce the need to figure out all the AAS\SpecialChar TeX
5880 commands, it will only
5881 reduce the drudgery of typing everything in.
5882 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
5884 completely to the requirements of the journal to which you are submitting
5888 \begin_layout Subsubsection
5889 Starting a New Paper
5892 \begin_layout Standard
5893 I strongly suggest that you start with the AAS\SpecialChar TeX
5897 File\SpecialChar menuseparator
5904 , enter the new file name, then choose the
5909 This will show the most common fields found in a manuscript.
5910 Simply overwrite the existing text (including the brackets,
5914 ) with the correct information.
5915 Many of the AAS\SpecialChar TeX
5916 commands and environments can be implemented directly in
5919 For commands such as these, the \SpecialChar LaTeX
5920 code must be entered directly and marked
5922 Such commands are referred to as \SpecialChar TeX
5923 code, or Evil Red Text.
5924 I tried to minimize the amount of \SpecialChar TeX
5925 code needed in an AAS\SpecialChar TeX
5929 \begin_layout Subsubsection
5930 Finishing Your Paper
5933 \begin_layout Standard
5934 When the paper is finished to your satisfaction and previews/prints correctly,
5936 \begin_inset Quotes eld
5940 \begin_inset Quotes erd
5943 actions which need to be done before you submit it to the journals.
5947 \begin_layout Enumerate
5948 Export your paper as a \SpecialChar LaTeX
5951 File\SpecialChar menuseparator
5952 Export\SpecialChar menuseparator
5960 \begin_layout Enumerate
5965 file with your favorite text editor
5969 \begin_layout Enumerate
5970 remove the comment lines before the
5979 \begin_layout Enumerate
5984 usepackage...{fontenc}
5986 line if it appears (usually just after
6001 \begin_layout Enumerate
6002 remove everything between (and including) the
6014 commands, except for any commands you specifically put into the \SpecialChar LaTeX
6016 (which should appear immediately after the
6017 \begin_inset Quotes eld
6020 User specified \SpecialChar LaTeX
6022 \begin_inset Quotes erd
6033 \begin_layout Enumerate
6034 Run the resulting file through \SpecialChar LaTeX
6035 to make sure it still processes correctly.
6038 \begin_layout Enumerate
6039 Reread the journal requirements to make sure your filenames and formats
6043 \begin_layout Enumerate
6047 \begin_layout Subsubsection
6048 Comments On Specific Commands
6051 \begin_layout Standard
6052 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
6059 ) gives a good description of each.
6060 Thus it's probably easiest for me to go down the list as found in the guide
6061 and offer comments where necessary.
6062 So let's begin \SpecialChar ldots
6066 \begin_layout Paragraph
6067 Things that work as expected
6070 \begin_layout Standard
6071 Because they work as you might expect, I simply list them and the section
6172 begin{thebibliography}
6180 (2.13.2), all the cite commands and their variations (2.13.2), the generic
6181 graphicx figure commands (2.14.1),
6205 (2.15.4, amongst other places),
6232 \begin_layout Standard
6233 The following style options also work correctly:
6254 Simply put them in the
6260 Layout\SpecialChar menuseparator
6266 \begin_layout Paragraph
6267 Things that work, but require more comment
6270 \begin_layout Standard
6271 The following items work, but require a little more discussion:
6274 \begin_layout Itemize
6275 These items are reserved for use by the journal editors, but you can put
6276 them into the \SpecialChar LaTeX
6277 preamble if you feel compelled to do so:
6310 \begin_layout Itemize
6311 These items may be placed in the \SpecialChar LaTeX
6312 preamble, and are included as blanks in
6334 \begin_layout Itemize
6341 (2.3) – can only be used
6342 \begin_inset Quotes eld
6346 \begin_inset Quotes erd
6349 , not in the middle of a paragraph.
6350 Use \SpecialChar TeX
6351 code if you need to embed it.
6354 \begin_layout Itemize
6361 (2.3) – will have extra {} after it.
6362 This should not cause an error.
6365 \begin_layout Itemize
6372 (2.6) – can only be used
6373 \begin_inset Quotes eld
6377 \begin_inset Quotes erd
6380 , not in the middle of a paragraph.
6381 Use \SpecialChar TeX
6382 code if you need to embed it.
6385 \begin_layout Itemize
6392 (2.8) – can't insert a cross-reference tag, you must type the tag name by
6396 \begin_layout Itemize
6410 \begin_layout Itemize
6417 (2.9) – will have extra {} after it.
6418 This should not cause an error.
6421 \begin_layout Itemize
6428 (2.11) – will have extra {} after it.
6429 This should not cause an error.
6432 \begin_layout Itemize
6439 (2.14.2) – you can insert an optional filename argument by placing the cursor
6440 at the beginning of the text and selecting
6442 Insert\SpecialChar menuseparator
6447 \begin_inset Quotes eld
6451 \begin_inset Quotes erd
6454 inserts an optional argument of the type needed by
6461 Hopefully it will be renamed someday.
6464 \begin_layout Itemize
6477 for the catalog ID optional parameter
6480 \begin_layout Itemize
6493 for the catalog ID optional parameter
6496 \begin_layout Paragraph
6497 Things not implemented, use \SpecialChar TeX
6501 \begin_layout Standard
6512 setcounter{equation}
6514 (2.12), Journal name abbreviations (2.13.4),
6550 (2.15.4, insert it as the first element in the lefthand cell after where
6552 Don't use any of \SpecialChar LyX
6553 's rules in the table),
6565 (2.15.5), much of Misc (2.17, except
6616 \begin_layout Paragraph
6617 Things that cannot be implemented
6620 \begin_layout Standard
6622 at least in any meaningful sort of way, so I suggest ignoring them.
6623 They are the references environment (2.13.3), and the deluxetable environment
6625 If you really, really need to use deluxetable, I suggest editing it in
6626 a separate file with a text editor, then using
6628 Insert\SpecialChar menuseparator
6630 \begin_inset space ~
6635 to include it in your \SpecialChar LyX
6641 file to see an example of this.
6644 \begin_layout Subsubsection
6645 FAQs, Tips, Tricks, and Other Ruminations
6648 \begin_layout Paragraph
6649 Getting \SpecialChar LyX
6650 and AAS\SpecialChar TeX
6654 \begin_layout Standard
6655 It can be a bit tricky to get \SpecialChar LyX
6656 to recognize a new layout and document class.
6657 When all else fails, do this:
6660 \begin_layout Enumerate
6661 Make certain that \SpecialChar LaTeX
6662 can find AAS\SpecialChar TeX
6664 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
6666 directory completely unrelated to \SpecialChar LaTeX
6667 or AAS\SpecialChar TeX
6668 and run \SpecialChar LaTeX
6676 \begin_layout Enumerate
6681 appears in \SpecialChar LyX
6689 \begin_layout Enumerate
6692 Tools\SpecialChar menuseparator
6696 , then restart \SpecialChar LyX
6700 \begin_layout Enumerate
6701 Open a regular new file, not from a template.
6702 Does AAS\SpecialChar TeX
6703 appear in the class list in
6705 Document\SpecialChar menuseparator
6711 \begin_layout Standard
6712 If you get a warning from an existing AAS\SpecialChar TeX
6713 document about not being able
6714 to find the AAS\SpecialChar TeX
6715 layout or a message about
6716 \begin_inset Quotes eld
6719 You should not mix title layouts with normal ones
6720 \begin_inset Quotes erd
6723 , things haven't been installed correctly.
6726 \begin_layout Paragraph
6728 error processing a table
6731 \begin_layout Standard
6733 , by default, attempts to center the table caption/title.
6734 This seems to produce a bad interaction in AAS\SpecialChar TeX
6735 so you should click somewhere
6736 in the caption/title, then select
6738 Edit\SpecialChar menuseparator
6740 \begin_inset space ~
6754 This took care of it for me.
6757 \begin_layout Paragraph
6761 \begin_layout Standard
6762 A couple of things: 1) I have noticed some funny spacing in the reference
6763 entries in the text.
6764 When you enter the bibliography item data, make sure their is
6768 space between the last author and the parenthesis setting off the year;
6772 \begin_inset space \thinspace{}
6776 \begin_inset space \space{}
6790 2) Entering the references at all is not obvious.
6791 The easiest thing is to start typing your first reference at the end of
6792 the document, then mark it as type
6797 That will put a small gray box in front of what you just typed.
6798 Click on the box to fill in the rest of the information.
6799 For new references, go to the end of an existing reference and press return.
6800 That will create a new line with its own box, etc.
6803 \begin_layout Paragraph
6807 \begin_layout Standard
6808 Even though AAS\SpecialChar TeX
6809 provides its own figure commands (
6815 , for example), I much prefer \SpecialChar LaTeX
6816 's standard figure commands (with the default
6825 \begin_inset space ~
6828 commands as \SpecialChar TeX
6829 code into a Figure Float box if you desire, but I never have
6830 much luck getting the layout right.
6831 With the standard graphics, \SpecialChar LyX
6836 usepackage{graphicx}
6838 command into the \SpecialChar LaTeX
6839 preamble and handle the figures in the standard \SpecialChar LaTeX2e
6841 interspersing the figures in the text.
6842 I believe ApJ accepts figures exactly this way now; AJ might still use
6844 \begin_inset Quotes eld
6847 stack everything at the end
6848 \begin_inset Quotes erd
6854 \begin_layout Paragraph
6855 Things I could have done, but didn't
6858 \begin_layout Standard
6860 \begin_inset Quotes eld
6864 \begin_inset Quotes erd
6867 things I could have implemented, but chose not to.
6868 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
6870 even though it is double-spaced in the paper manuscript.
6871 Also, I chose not to make separate layouts for the preprint and preprint2
6873 Since I assume you will spend most of your time in the plain manuscript
6874 mode anyway, I decided not to chew up more disk space with this.
6878 \begin_layout Subsubsection
6882 \begin_layout Standard
6883 Your mileage may vary.
6884 I've now had papers published by both ApJ and AJ that have had 98% of the
6885 effort done in \SpecialChar LyX
6886 ; the last 2% was the \SpecialChar LaTeX
6887 post-processing and a few cleanups.
6888 I have had no trouble with the submission process, and I'm sure the journals
6889 were never aware that there might be a difference.
6890 So, go forth and publish!
6893 \begin_layout Subsection
6898 \begin_layout Standard
6904 \begin_layout Standard
6905 \begin_inset VSpace bigskip
6911 \begin_layout Standard
6916 \begin_inset space ~
6921 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
6923 \begin_inset Formula $\beta$
6926 release of May, 1999) class.
6929 \begin_layout Standard
6935 textclass, which works with Rev\SpecialChar TeX
6937 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
6939 That means that it doesn't interact very well with \SpecialChar LyX
6940 , which requires \SpecialChar LaTeX2e
6942 it has been kludged to work.
6943 Since Rev\SpecialChar TeX
6944 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
6951 \begin_inset space ~
6956 textclass should also be pretty easy to use.
6959 \begin_layout Standard
6960 These documents are supposed to be used in
6964 to the Rev\SpecialChar TeX
6965 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
6967 and assume you'll know what to put in the preamble if necessary.
6970 \begin_layout Section
6972 \change_inserted 564990737 1670439560
6976 \begin_layout Standard
6978 \change_inserted 564990737 1670439581
6979 See also the document classes in the Collections (section
6980 \begin_inset space ~
6984 \begin_inset CommandInset ref
6986 reference "sec:Collections"
6993 \begin_layout Subsection
6997 \begin_layout Standard
7003 \begin_layout Subsubsection
7007 \begin_layout Standard
7008 Memoir is a very powerful and constantly evolving class.
7009 It has been designed with regard to fictional and non-fictional literature.
7010 Its aim is to let the user have maximum control over the typesetting of
7012 Memoir is based on the standard book class, but it can also emulate the
7013 article class (see below).
7016 \begin_layout Standard
7017 Peter Wilson, the developer of Memoir, is known as the author of lots of
7018 useful packages in the \SpecialChar LaTeX
7020 Most of them have been merged with Memoir.
7021 Therefore, it is much easier to layout the table of contents, appendices,
7022 chapter designs and such.
7024 , though, does not support all of these goodies natively.
7025 Some of them might be added to forthcoming releases
7029 \begin_layout Plain Layout
7030 You are invited to send suggestions to
7031 \begin_inset Flex URL
7034 \begin_layout Plain Layout
7036 lyx-devel@lists.lyx.org
7046 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
7048 Of course you can still use all features with the help of some native \SpecialChar LaTeX
7050 commands (\SpecialChar TeX
7055 \begin_layout Plain Layout
7060 \begin_layout Plain Layout
7070 \begin_inset space ~
7074 \begin_inset CommandInset ref
7076 reference "sec:Inserting-TeX-Code"
7086 In this section, we can only list those features that are natively supported
7089 For detailed descriptions (and for the rest of features) we recommend you
7090 have a look at the detailed manual of the Memoir class
7094 \begin_layout Plain Layout
7099 \begin_layout Plain Layout
7109 \begin_inset Flex URL
7112 \begin_layout Plain Layout
7114 CTAN:/macros/latex/memoir/memman.pdf
7124 , which is not only a user guide for the class, but also both a comprehensive
7125 description on good typesetting and a superb example for good typesetting
7129 \begin_layout Subsubsection
7130 Basic features and restrictions
7133 \begin_layout Standard
7134 Memoir supports basically all features of the standard book classes.
7135 There are, however, some differences, as follows:
7138 \begin_layout Description
7140 \begin_inset space ~
7143 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
7146 \begin_layout Description
7148 \begin_inset space ~
7151 style: The fancy page style is not supported, due to a command clash between
7152 Memoir and the fancyhdr package (they both define a command with the same
7153 name, which confuses \SpecialChar LaTeX
7155 Instead, Memoir comes with a number of its own page styles (see
7157 Document\SpecialChar menuseparator
7158 Settings\SpecialChar menuseparator
7160 \begin_inset space ~
7166 If you want to use these for the chapter pages, you have to use the command
7173 in the main text or in preamble (e.
7174 \begin_inset space \thinspace{}
7178 \begin_inset space \space{}
7185 chapterstyle{companion}
7190 \begin_layout Description
7191 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
7192 optional argument in the standard classes.
7193 With this, you can specify an alternative version of the title for the
7194 table of contents and the headers (for instance, if the title is too long).
7196 , you can do this via
7198 Insert\SpecialChar menuseparator
7200 \begin_inset space ~
7205 at the beginning of a chapter/section.
7206 Memoir features a second optional argument and thus separates the table
7207 of contents from the header.
7208 You can define three variants of a title with this: one for the main text,
7209 one for the table of contents, and one for the headers.
7211 makes these available in form of specific
7222 \begin_layout Description
7223 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
7224 of contents, the list of figures and the list of table start a new page
7226 Memoir does not follow this route.
7227 You have to insert a page break yourself, if you want to have one.
7230 \begin_layout Description
7231 Titlepage: For some unknown reason, Memoir uses pagination on the title
7232 page (in the standard classes, title pages are
7233 \begin_inset Quotes eld
7237 \begin_inset Quotes erd
7241 If you want an empty title page, type
7245 aliaspagestyle{title}{empty}
7250 \begin_layout Description
7251 Article: With the class option
7257 Document\SpecialChar menuseparator
7258 Settings\SpecialChar menuseparator
7259 Class Settings\SpecialChar menuseparator
7261 \begin_inset space ~
7266 ), you can emulate article style.
7267 That is, counters (footnotes, figures, tables etc.) will not be reset on
7268 new chapters, chapters don't start a new page (but are—in contrary to
7269 \begin_inset Quotes eld
7273 \begin_inset Quotes erd
7276 article classes—still allowed), parts, though, use their own page, as in
7280 \begin_layout Description
7281 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
7282 font commands, which have been used in the old \SpecialChar LaTeX
7284 \begin_inset space \thinspace{}
7288 \begin_inset space \space{}
7304 It produces an error and stops \SpecialChar LaTeX
7305 whenever such a command appears.
7310 reallows the commands and spits out warnings instead (which does at least
7311 not stop \SpecialChar LaTeX
7313 Since a lot of packages and particularly Bib\SpecialChar TeX
7314 style files are still using
7315 those commands, we have decided to use this option by default.
7318 \begin_layout Subsubsection
7322 \begin_layout Standard
7323 We will only describe the features supported by \SpecialChar LyX
7324 (which is not much currently).
7325 Please consult the Memoir manual
7329 \begin_layout Plain Layout
7334 \begin_layout Plain Layout
7344 \begin_inset Flex URL
7347 \begin_layout Plain Layout
7349 CTAN:/macros/latex/memoir/memman.pdf
7362 \begin_layout Description
7363 Abstract: You may wonder why an abstract is an extra feature.
7364 Well, it is in book class.
7365 Usually books don't have abstracts.
7366 Memoir, however, has.
7367 You can use it wherever and how often you like.
7370 \begin_layout Description
7371 Chapterprecis: You may know this older typesetting style: The contents of
7372 a chapter are summarized below the title and also in the table of contents
7374 \begin_inset space \thinspace{}
7378 \begin_inset space \space{}
7383 Our hero arrives in Troia; he loses some friends; he finds others
7386 Chapterprecis does exactly this.
7387 It is therefore only sensible below a chapter.
7390 \begin_layout Description
7391 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
7392 The epigraph environment provides an elegant way of typesetting such a
7394 The motto itself (text) and its (optional) author (source) are divided
7396 The author (source) can be inserted via
7398 Insert\SpecialChar menuseparator
7405 \begin_layout Description
7406 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
7407 complex figurative poems).
7409 can only support a few of them.
7410 One is poemtitle, which is a centered title for poems, which will also
7411 be added to the table of contents (verse is the standard environment for
7413 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
7415 because they have to be nested inside regular verse environments, which
7416 is not possible with \SpecialChar LyX
7420 \begin_layout Description
7421 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
7424 \begin_layout Section
7426 \change_inserted 564990737 1670439605
7430 \begin_layout Section
7432 \change_inserted 564990737 1670439627
7436 \begin_layout Section
7438 \change_inserted 564990737 1670439660
7442 \begin_layout Subsection
7445 Foil\SpecialChar TeX
7449 \begin_inset CommandInset label
7458 \begin_layout Standard
7464 \begin_layout Subsubsection
7468 \begin_layout Standard
7469 This section describes how to use \SpecialChar LyX
7470 to make slides for overhead projectors.
7471 There are two document classes that can do this: the default slides class
7474 Foil\SpecialChar TeX
7478 This section documents the latter.
7481 \begin_layout Standard
7482 I'm going to say this again, nice and clear, so that there's no misunderstanding
7486 \begin_layout Standard
7487 \begin_inset VSpace bigskip
7493 \begin_layout Standard
7497 This section documents the class
7498 \begin_inset Quotes eld
7506 \begin_inset Quotes erd
7514 \begin_layout Standard
7515 \begin_inset VSpace bigskip
7521 \begin_layout Standard
7522 If you're looking for the documentation for
7523 \begin_inset Quotes eld
7531 \begin_inset Quotes erd
7535 \begin_inset space ~
7539 \begin_inset CommandInset ref
7541 reference "sec:slitex"
7546 If your machine doesn't have the
7554 installed, you'll probably have to use the default
7558 class, which isn't quite as good as
7563 \begin_layout Standard
7568 class is designed for use with version
7569 \begin_inset space ~
7577 class file which is now an integral part of \SpecialChar LaTeX2e
7581 \begin_layout Subsubsection
7585 \begin_layout Standard
7586 Obviously, to use this document class, you need to select
7597 \begin_inset space ~
7603 There are some settings in the
7606 \begin_inset space ~
7611 dialog that you should know about that are specific to this class:
7614 \begin_layout Itemize
7615 Don't change the options
7626 \begin_inset space ~
7632 They're ignored by the
7639 \begin_layout Itemize
7640 The default font size is 20
7641 \begin_inset space \thinspace{}
7644 pt with the other options being 17
7645 \begin_inset space \thinspace{}
7649 \begin_inset space \thinspace{}
7653 \begin_inset space \thinspace{}
7659 \begin_layout Itemize
7668 but all math equations are still typeset in the usual roman font.
7671 \begin_layout Itemize
7674 Foil\SpecialChar TeX
7677 supports A4 and Letter paper sizes as well as a special size for working
7679 \begin_inset space \thinspace{}
7683 It doesn't support A5, B5, legal or executive paper sizes.
7686 \begin_layout Itemize
7687 Don't bother changing the
7691 settings because they are ignored anyway.
7692 All floats appear where they are defined in the text.
7695 \begin_layout Itemize
7700 setting behaves a bit differently for this class.
7703 Foil\SpecialChar TeX
7706 provides extensive footer and header capabilities including a user-defined
7709 \begin_inset space ~
7713 \begin_inset CommandInset ref
7715 reference "sec:foilfoot"
7720 The title page is treated differently to all other pages in the document
7729 has the logo centered at the bottom of the page (if one is defined).
7730 The possible page style choices and what they do are as follows:
7734 \begin_layout Labeling
7735 \labelwidthstring MMMMMMM
7742 The final output contains no page numbers, or other headers or footers
7743 (except footnotes of course).
7747 \begin_layout Labeling
7748 \labelwidthstring MMMMMMM
7755 The final output contains page numbers centered at the bottom of the page.
7756 No other headings or footers (other than footnotes).
7759 \begin_layout Labeling
7760 \labelwidthstring MMMMMMM
7765 Page numbers in lower right corner.
7766 Additional headers and footers are also shown.
7767 This is also the default.
7770 \begin_layout Labeling
7771 \labelwidthstring MMMMMMM
7776 Gives you access to the
7780 package although its use with
7782 Foil\SpecialChar TeX
7785 is discouraged by the writer of the
7787 Foil\SpecialChar TeX
7790 package because of some potential page layout clashes.
7794 \begin_layout Paragraph
7798 \begin_layout Standard
7799 The following options may be used in the extra class options in the
7801 Document\SpecialChar menuseparator
7807 \begin_layout Labeling
7808 \labelwidthstring MMMMMMx
7813 This sets up the page layout for 7.33
7814 \begin_inset space \thinspace{}
7818 \begin_inset space \thinspace{}
7821 in paper, which is about the same aspect ratio as a 35
7822 \begin_inset space \thinspace{}
7825 mm slide, making it a bit easier to work with this medium.
7828 \begin_layout Labeling
7829 \labelwidthstring MMMMMMx
7834 Places a rule across the page below the header on every page except the
7838 \begin_layout Labeling
7839 \labelwidthstring MMMMMMx
7844 Places a rule across the page above the footer on every page except the
7848 \begin_layout Labeling
7849 \labelwidthstring MMMMMMx
7854 This is automatically set each time you create a new
7861 Foil\SpecialChar TeX
7864 to use the dvips driver to rotate those pages that are set as landscape
7868 \begin_layout Labeling
7869 \labelwidthstring MMMMMMx
7874 Simply changes the page dimensions to those of a landscape page but doesn't
7876 Thus if you use this option you need to use an external program to rotate
7877 each page or feed your paper through your printer as landscape.
7878 Note that this option effectively reverses the roles of the
7886 environments (don't worry these are described in the next section).
7889 \begin_layout Labeling
7890 \labelwidthstring MMMMMMx
7895 Equation numbers on the left.
7898 \begin_layout Labeling
7899 \labelwidthstring MMMMMMx
7904 Flush-left equations.
7907 \begin_layout Subsubsection
7908 Supported Environments
7911 \begin_layout Standard
7912 Most of the environments commonly supported in other classes are also supported
7918 There are several additional environments provided by
7920 Foil\SpecialChar TeX
7923 as well as a couple added by \SpecialChar LyX
7925 The following environments are shared with other classes:
7928 \begin_layout Standard
7929 \begin_inset Flex Multiple Columns
7932 \begin_layout Itemize
7938 \begin_layout Itemize
7944 \begin_layout Itemize
7950 \begin_layout Itemize
7956 \begin_layout Itemize
7962 \begin_layout Itemize
7969 \begin_layout Itemize
7975 \begin_layout Itemize
7981 \begin_layout Itemize
7987 \begin_layout Itemize
7993 \begin_layout Itemize
7999 \begin_layout Itemize
8005 \begin_layout Itemize
8011 \begin_layout Itemize
8017 \begin_layout Itemize
8028 \begin_layout Standard
8029 That is, all the major environments apart from the sectioning environments.
8030 Since foils are essentially self-contained sections, with a title and body,
8033 Foil\SpecialChar TeX
8036 provides specific commands for starting new foils and these are:
8039 \begin_layout Itemize
8045 \begin_layout Itemize
8051 \begin_layout Standard
8053 also provides slightly modified versions of these two environments called:
8056 \begin_layout Itemize
8062 \begin_layout Itemize
8068 \begin_layout Standard
8069 and the differences will be explained in the next section.
8072 \begin_layout Standard
8073 Since foils are often used in presenting ideas or new theorems and such
8076 Foil\SpecialChar TeX
8079 also provides a comprehensive box of goodies for presenting them:
8082 \begin_layout Standard
8083 \begin_inset Flex Multiple Columns
8086 \begin_layout Itemize
8092 \begin_layout Itemize
8098 \begin_layout Itemize
8104 \begin_layout Itemize
8110 \begin_layout Itemize
8116 \begin_layout Itemize
8122 \begin_layout Itemize
8128 \begin_layout Itemize
8134 \begin_layout Itemize
8140 \begin_layout Itemize
8146 \begin_layout Itemize
8157 \begin_layout Standard
8158 The starred versions are unnumbered while the unstarred versions are numbered.
8159 There are also two list environments added by \SpecialChar LyX
8163 \begin_layout Itemize
8169 \begin_layout Itemize
8175 \begin_layout Standard
8178 Foil\SpecialChar TeX
8181 provides some powerful header and footer capabilities that are best set
8182 in the preamble although they may be set at any point in a document.
8183 If you want to change these settings in your document the best place to
8184 do so is at the very top of a foil, i.
8185 \begin_inset space \thinspace{}
8191 \begin_inset space \space{}
8196 straight after the foilhead.
8199 \begin_layout Standard
8200 For this purpose, the following command styles are provided [
8207 \begin_layout Standard
8208 \begin_inset Flex Multiple Columns
8211 \begin_layout Itemize
8215 \begin_inset space ~
8221 \begin_layout Itemize
8227 \begin_layout Itemize
8231 \begin_inset space ~
8237 \begin_layout Itemize
8241 \begin_inset space ~
8247 \begin_layout Itemize
8251 \begin_inset space ~
8258 \begin_layout Plain Layout
8259 \begin_inset space ~
8271 \begin_layout Standard
8272 There are also a few commands provided by
8274 Foil\SpecialChar TeX
8277 that aren't directly supported by \SpecialChar LyX
8278 but I'll tell you what they do and how
8279 to use them in section
8280 \begin_inset space ~
8284 \begin_inset CommandInset ref
8286 reference "sec:unsuppfoils"
8293 \begin_layout Subsubsection
8294 Building a Set of Foils
8297 \begin_layout Standard
8298 This section will give a simple introduction to using the different environments
8299 to build a set of foils.
8300 If you want to see an example set of foils, take a look at the
8304 file you find in \SpecialChar LyX
8312 \begin_layout Paragraph
8313 Give It a Title Page
8316 \begin_layout Standard
8317 Unlike other classes that provide
8337 creates the title on a page of its own.
8338 If you leave out the
8342 environment \SpecialChar LaTeX
8343 will substitute the current date (every time you regenerate
8347 \begin_layout Paragraph
8351 \begin_layout Standard
8352 As I mentioned earlier, there are four ways of starting a new foil.
8353 For portrait foils you should use
8362 The difference between these two environments is the amount of space between
8363 the title of the foil (the foilhead) and the body of the foil.
8366 \begin_layout Standard
8367 Landscape foils are generated using the
8376 Again the only difference is the spacing between foilhead and body.
8377 Both of the short versions have 0.5
8378 \begin_inset space ~
8381 inches less separation between the foilhead and the body.
8385 \begin_layout Standard
8386 One problem with the support for landscape foils is the requirement that
8391 driver to generate the PostScript output otherwise the foils won't be rotated.
8392 It is possible to get landscape foils even if you haven't got the
8396 driver provided you can feed your foils sideways through your printer ;-)
8399 \begin_layout Paragraph
8400 Theorems, Lemmas, Proofs and more
8403 \begin_layout Standard
8404 You can't have two of the same type of these environments directly following
8406 If you use a normal paragraph break, , you will just be extending the previous
8407 environment as if you had merged the two environments together.
8408 Rather than that, you need to insert a so-called separator.
8409 Please refer to the section entitled
8420 \begin_layout Paragraph
8424 \begin_layout Standard
8425 You get all the commonly supported list styles found in other classes as
8426 well as two new ones.
8427 I'll only describe the new ones here.
8428 If you want to find out more about the other list environments check out
8434 If you intend to use itemized lists you might also want to read about the
8438 \begin_inset space ~
8442 \begin_inset space ~
8447 dialog described above in section
8448 \begin_inset space ~
8452 \begin_inset CommandInset ref
8454 reference "sec:bullet"
8461 \begin_layout Standard
8462 The two new list styles,
8470 , are designed to make it easier for you to create lists of do's and don'ts
8471 or right and wrong by providing dedicated environments that use a tick
8472 or a cross as the label of the list.
8473 These lists are in fact dedicated variants of the
8478 They do however require that you have the
8485 \begin_layout Paragraph
8489 \begin_layout Standard
8492 Foil\SpecialChar TeX
8495 redefines the floating tables and figures so that they appear exactly where
8496 they are in the text rather than pushing them to the top of the page or
8497 to some user specified location.
8498 In fact if you change the float placement settings they are simply ignored.
8501 \begin_layout Paragraph
8502 Page Headers and Footers
8503 \begin_inset CommandInset label
8512 \begin_layout Standard
8516 \begin_inset space ~
8525 are two commands used to control the left-footer text string.
8526 The first is meant to allow you to include a graphic logo on your foils
8528 \begin_inset Quotes eld
8533 Foil\SpecialChar TeX
8537 \begin_inset Quotes erd
8541 While the second is meant to provide a classification for the audience,
8545 \begin_inset space \thinspace{}
8551 \begin_inset space \space{}
8555 It is empty by default.
8558 \begin_layout Standard
8559 The remaining page corners can be filled by
8562 \begin_inset space ~
8567 (which defaults to page numbers),
8570 \begin_inset space ~
8578 \begin_inset space ~
8586 \begin_layout Subsubsection
8589 Foil\SpecialChar TeX
8593 \begin_inset CommandInset label
8595 name "sec:unsuppfoils"
8602 \begin_layout Standard
8603 All the commands mentioned below need to be set in a
8613 within another environment.
8616 \begin_layout Paragraph
8620 \begin_layout Standard
8621 All lengths are adjusted using the
8644 should be replaced by the name given to the length you want to change and
8649 is the length value.
8650 All lengths should be specified in units of length such as inches (
8662 ) or relative to some document or font-based length such as
8672 \begin_layout Standard
8673 It's possible to change the spacing between a foilhead and the body of the
8674 foil by adjusting the length specified by
8681 For example, to make
8686 \begin_inset space \space{}
8689 in closer to their bodies put the following in the preamble:
8695 foilheadskip}{-0.5in}
8698 \begin_layout Standard
8699 The spacings around floats can be adjusted by setting these lengths:
8702 \begin_layout Labeling
8703 \labelwidthstring MMMMMMMMMMM
8710 Separation between the text and the top of the float
8713 \begin_layout Labeling
8714 \labelwidthstring MMMMMMMMMMM
8721 Separation between the float and the caption
8724 \begin_layout Labeling
8725 \labelwidthstring MMMMMMMMMMM
8732 Separation between the caption and the following text
8735 \begin_layout Labeling
8736 \labelwidthstring MMMMMMMMMMM
8743 You can make the captions narrower than the surrounding text by adjusting
8745 Best done relative to
8754 \begin_layout Standard
8755 There are also several title page related lengths that you may find useful
8756 if you have a long title or several authors:
8759 \begin_layout Labeling
8760 \labelwidthstring MMMMMMMMMMM
8767 Separation from headers to
8772 \begin_layout Labeling
8773 \labelwidthstring MMMMMMMMMMM
8791 \begin_layout Labeling
8792 \labelwidthstring MMMMMMMMMMM
8806 \begin_layout Labeling
8807 \labelwidthstring MMMMMMMMMMM
8823 \begin_layout Labeling
8824 \labelwidthstring MMMMMMMMMMM
8840 \begin_layout Standard
8841 The last length related command affects all the list environments.
8852 a list environment then all the vertical spacing between the list items
8854 Note that this is a command not a length so it doesn't require
8860 like the stuff mentioned above.
8863 \begin_layout Paragraph
8867 \begin_layout Standard
8880 commands control whether the logo in the
8884 definition appear on a given page.
8891 in the preamble then none of the foils will have the logo on them.
8892 If you don't want the logo on a particular page place the
8898 directly after the foilhead of that page and the
8904 directly after the next foilhead.
8907 \begin_layout Standard
8908 If you decide to use the
8912 page style setting in the
8915 \begin_inset space ~
8920 dialog you should probably add
8930 to your preamble so headers and footers on landscape pages are correctly
8931 placed when rotated.
8932 This is due to some clashes between the page layouts provided by the
8943 \begin_layout Section
8945 \change_inserted 564990737 1670439661
8949 \begin_layout Subsection
8951 \change_inserted 564990737 1670439661
8955 \begin_layout Standard
8957 \change_inserted 564990737 1670439661
8966 document class for preparing reports.
8971 document class, this provides parts, chapters and sections but does not
8972 provide the paragraph styles needed for a book; like the
8976 document class, it provides the abstract paragraph style.
8977 In two-sided mode, it does not start a new chapter on the right hand page.
8980 \begin_layout Standard
8982 \change_inserted 564990737 1670439674
8987 document classes are described in the Collections (section
8988 \begin_inset space ~
8992 \begin_inset CommandInset ref
8994 reference "sec:Collections"
9001 \begin_layout Section
9003 \change_inserted 564990737 1670439674
9007 \begin_layout Subsection
9011 \begin_layout Standard
9017 \begin_layout Subsubsection
9021 \begin_layout Standard
9022 Broadway is for writing plays.
9023 The format is more decorative than Hollywood, and much less standardized.
9024 This format should be suitable for workshops.
9027 \begin_layout Subsubsection
9031 \begin_layout Standard
9032 The same as in Hollywood.
9035 \begin_layout Subsubsection
9039 \begin_layout Standard
9044 names as labels then cross-reference the label to insert the name.
9045 The cross-reference dialog will show the current cast of characters.
9048 \begin_layout Subsubsection
9049 Paper size and Margins
9052 \begin_layout Standard
9053 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
9056 \begin_layout Subsubsection
9060 \begin_layout Standard
9061 The following environments are available.
9062 You can use broadway.bind to get the bind keys shown at the right.
9065 \begin_layout Itemize
9069 \begin_inset Newline newline
9074 You should not have to use this, but it is here for anything that does not
9078 \begin_layout Itemize
9082 \begin_inset space \hfill{}
9086 \begin_inset Newline newline
9091 Used to describe stage setting and the action.
9092 First use of speaker names in all CAPs.
9095 \begin_layout Itemize
9099 \begin_inset space \hfill{}
9103 \begin_inset Newline newline
9108 Automatically numbered.
9109 On screen it will be arabic, but will print as Roman.
9112 \begin_layout Itemize
9116 \begin_inset space \hfill{}
9120 \begin_inset Newline newline
9130 It is just centered text.
9133 \begin_layout Itemize
9137 \begin_inset space \hfill{}
9141 \begin_inset Newline newline
9146 Not automatically numbered.
9147 You supply the number.
9148 This is because I couldn't figure out how.
9151 \begin_layout Itemize
9155 \begin_inset space \hfill{}
9159 \begin_inset Newline newline
9164 A special case of Narrative to describe the setting and action as the curtain
9168 \begin_layout Itemize
9172 \begin_inset space \hfill{}
9176 \begin_inset Newline newline
9181 The speaker's (actor's) title, centered in all CAPS.
9184 \begin_layout Itemize
9188 \begin_inset space \hfill{}
9192 \begin_inset Newline newline
9197 Instructions to the speaker.
9198 The parentheses are automatically inserted.
9199 The ( will appear on screen, but both will be in the printed play.
9200 This environment is only used within
9207 \begin_layout Itemize
9211 \begin_inset space \hfill{}
9215 \begin_inset Newline newline
9220 What the Speaker says.
9223 \begin_layout Itemize
9227 \begin_inset space \hfill{}
9231 \begin_inset Newline newline
9236 The curtain comes down.
9239 \begin_layout Itemize
9243 \begin_inset space \hfill{}
9249 \begin_layout Itemize
9253 \begin_inset space \hfill{}
9259 \begin_layout Itemize
9263 \begin_inset space \hfill{}
9269 \begin_layout Standard
9273 \begin_layout Subsection
9274 Hollywood (Hollywood spec scripts)
9277 \begin_layout Standard
9283 \begin_layout Subsubsection
9287 \begin_layout Standard
9288 Getting the format of a Hollywood script right is a
9289 \begin_inset Quotes eld
9293 \begin_inset Quotes erd
9296 It is designed to make the readers focus on content and to be easy and
9297 familiar for the actors to read.
9298 Each page of a script should be one minute of film.
9299 Nothing goes in a script that you cannot see or hear on screen.
9300 The courier 12 pt font should be used throughout.
9304 \begin_layout Subsubsection
9308 \begin_layout Standard
9309 Speakers' lines should NEVER break in mid-sentence.
9310 If a speaker's lines continue over a page break, repeat the
9314 title followed by (Cont'd).
9317 \begin_layout Subsubsection
9321 \begin_layout Standard
9326 names as labels then cross-reference the label to insert the name.
9327 The cross-reference dialog will show the current cast of characters.
9328 You can use this to insert the speaker name in narratives also.
9331 \begin_layout Subsubsection
9332 Paper size and Margins
9335 \begin_layout Standard
9336 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
9339 \begin_layout Subsubsection
9343 \begin_layout Standard
9344 The following environments are available.
9345 You can use hollywood.bind to get the bind keys shown at the right.
9348 \begin_layout Itemize
9352 \begin_inset Newline newline
9357 Used where nothing else works.
9361 \begin_layout Itemize
9367 \begin_inset space \hfill{}
9375 \begin_inset Newline newline
9378 Usually followed by something like
9379 \begin_inset Quotes eld
9383 \begin_inset Quotes erd
9389 \begin_layout Itemize
9393 \begin_inset space \hfill{}
9397 \begin_inset Newline newline
9402 Introduces a new INTERIOR camera set-up.
9403 Always followed by DAY or NIGHT, or something similar to define the lighting
9405 Everthing on this line in CAPS.
9408 \begin_layout Itemize
9412 \begin_inset space \hfill{}
9416 \begin_inset Newline newline
9421 Introduces a new EXTERIOR camera set-up.
9422 Everthing on this line in CAPS.
9425 \begin_layout Itemize
9429 \begin_inset space \hfill{}
9433 \begin_inset Newline newline
9438 The character speaking.
9441 \begin_layout Itemize
9445 \begin_inset space \hfill{}
9449 \begin_inset Newline newline
9454 Instructions to the speaker.
9455 The () are automatically inserted.
9458 \begin_layout Itemize
9462 \begin_inset space \hfill{}
9466 \begin_inset Newline newline
9478 \begin_layout Itemize
9482 \begin_inset space \hfill{}
9486 \begin_inset Newline newline
9491 Camera movement instruction.
9493 \begin_inset space \thinspace{}
9497 \begin_inset space \space{}
9503 \begin_layout Itemize
9507 \begin_inset space \hfill{}
9513 \begin_layout Itemize
9517 \begin_inset space \hfill{}
9523 \begin_layout Itemize
9527 \begin_inset space \hfill{}
9533 \begin_layout Itemize
9537 \begin_inset space \hfill{}
9543 \begin_layout Subsubsection
9547 \begin_layout Itemize
9551 \begin_layout Itemize
9555 \begin_layout Itemize
9557 \begin_inset space \thinspace{}
9564 \begin_layout Itemize
9569 \begin_layout Itemize
9570 PAN — camera movement
9573 \begin_layout Itemize
9574 INSERT — cut to close-up of
9577 \begin_layout Chapter
9581 \begin_layout Standard
9582 All you need to do is install Rev\SpecialChar TeX
9583 4, as described in the package's README
9585 The package can be found at The Rev\SpecialChar TeX
9587 \begin_inset Flex URL
9590 \begin_layout Plain Layout
9592 http://publish.aps.org/revtex4/
9598 Install it somewhere that \SpecialChar LaTeX
9600 Test it by trying to \SpecialChar LaTeX
9601 a short Rev\SpecialChar TeX
9602 4 document in some random directory (i.
9603 \begin_inset space \thinspace{}
9607 \begin_inset space \space{}
9610 not the directory where you installed the class file.) Then, if you reconfigure
9612 , it will find the class file and let you use the Rev\SpecialChar TeX
9616 \begin_layout Standard
9617 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
9626 \begin_inset space ~
9631 template, found in the templates directory.
9634 \begin_layout Chapter
9638 \begin_layout Standard
9639 Optional arguments to
9646 \begin_inset Quotes eld
9650 \begin_inset Quotes erd
9654 \begin_inset Quotes eld
9658 \begin_inset Quotes erd
9664 \begin_inset space ~
9672 \begin_inset space ~
9678 Remember that in Rev\SpecialChar TeX
9679 , at least one optional argument is required!
9682 \begin_layout Standard
9683 Other preamble matter, like
9690 \begin_inset space ~
9697 \begin_inset space ~
9702 dialog, also as usual.
9705 \begin_layout Chapter
9709 \begin_layout Standard
9710 The layouts basically correspond to the commands in Rev\SpecialChar TeX
9712 For example, the Email layout corresponds to
9719 Note that (at least as of Rev\SpecialChar TeX
9728 layouts are exactly equivalent, so you shouldn't need to use both.
9732 \begin_layout Plain Layout
9733 In case you're curious, both were included so that
9737 would be able to translate both
9757 \begin_layout Chapter
9761 \begin_layout Standard
9762 There are a couple of important unique aspects of Rev\SpecialChar TeX
9764 bugs that will be even more confusing in \SpecialChar LyX
9768 \begin_layout Standard
9769 In Rev\SpecialChar TeX
9787 The \SpecialChar LyX
9788 equivalent is that there is a separate Thanks layout.
9793 write footnotes in the
9797 layout, or weird things may happen.
9798 See the Rev\SpecialChar TeX
9799 4 documentation for more details.
9802 \begin_layout Standard
9806 \begin_inset space ~
9814 \begin_inset space ~
9823 layouts must be placed
9831 layout and the corresponding
9848 , the \SpecialChar LaTeX
9852 \begin_layout Chapter
9856 \begin_layout Section
9857 Customizing Bibliographies with Bib\SpecialChar TeX
9861 \begin_layout Standard
9862 The most basic information about how to use Bib\SpecialChar TeX
9867 with \SpecialChar LyX
9868 is contained in the section
9870 Bibliography databases
9877 The following subsections explain special bibliography features supported
9882 \begin_layout Subsection
9883 Alternative Citation Styles
9886 \begin_layout Standard
9887 Standard Bib\SpecialChar TeX
9889 \begin_inset space \thinspace{}
9893 \begin_inset space \space{}
9897 \begin_inset Quotes eld
9901 \begin_inset Quotes erd
9904 ) to refer to a cited work.
9905 However, in many scientific disciplines, other citation styles are in use.
9906 The most common one is the author-year style (e.
9907 \begin_inset space \thinspace{}
9911 \begin_inset space \space{}
9915 \begin_inset Quotes eld
9919 \begin_inset Quotes erd
9924 supports three packages that provide this style,
9925 \begin_inset Flex Code
9928 \begin_layout Plain Layout
9935 \begin_inset Flex Code
9938 \begin_layout Plain Layout
9945 \begin_inset Flex Code
9948 \begin_layout Plain Layout
9955 Each of these packages has their pros and cons, which cannot be listed
9957 If you only want to have simple author-year (or author-numerical) style,
9958 or if you want to use one of the countless style files for
9959 \begin_inset Flex Code
9962 \begin_layout Plain Layout
9968 , then the established
9969 \begin_inset Flex Code
9972 \begin_layout Plain Layout
9978 package is probably your choice.
9979 If you look for specific citation styles common in law studies, you might
9981 \begin_inset Flex Code
9984 \begin_layout Plain Layout
9991 If you want to have full control over the formatting or look for advanced
9992 features such as ibidem, footnote citations, full title citations, advanced
9993 date formats (such as 400 BC) or full localization to other languages than
9994 English, you should definitely consider
9995 \begin_inset Flex Code
9998 \begin_layout Plain Layout
10004 , which exceeds all other packages in terms of features, but is also quite
10005 heavy and more resource-hungry.
10008 \begin_layout Standard
10009 The handling of these packages in \SpecialChar LyX
10010 is basically the same.
10012 \begin_inset Flex Noun
10015 \begin_layout Plain Layout
10016 Document\SpecialChar menuseparator
10023 \begin_inset Flex Noun
10026 \begin_layout Plain Layout
10033 \begin_inset Flex Noun
10036 \begin_layout Plain Layout
10043 \begin_inset Flex Noun
10046 \begin_layout Plain Layout
10053 \begin_inset Flex Noun
10056 \begin_layout Plain Layout
10063 \begin_inset Flex Noun
10066 \begin_layout Plain Layout
10067 Biblatex (Natbib mode)
10073 \begin_inset Flex Noun
10076 \begin_layout Plain Layout
10083 \begin_inset Flex Noun
10086 \begin_layout Plain Layout
10093 \begin_inset space ~
10096 6.5.3 in the User's Guide for more information on these choices).
10097 With all these packages, you will get some extra features in the citation
10098 dialog and you can select the style of the reference (
10099 \begin_inset Quotes eld
10103 \begin_inset Quotes erd
10107 \begin_inset Quotes eld
10111 \begin_inset Quotes erd
10115 \begin_inset Quotes eld
10119 \begin_inset Quotes erd
10123 \begin_inset Quotes eld
10127 \begin_inset Quotes erd
10131 Note that either package needs specifically designed style files.
10132 They all ship their own, but there are lots of additional style files,
10133 and there is even an interactive style file builder
10137 \begin_layout Plain Layout
10139 \begin_inset Flex URL
10142 \begin_layout Plain Layout
10144 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
10155 \begin_inset Flex Code
10158 \begin_layout Plain Layout
10167 \begin_layout Subsection
10168 Subdivided Bibliographies
10171 \begin_layout Standard
10172 Sometimes you might need to divide your bibliography into several sections.
10173 If you are for instance a historian, the possibility to separate sources
10174 and scientific works is most likely a
10175 \begin_inset Quotes eld
10179 \begin_inset Quotes erd
10183 Unfortunately, Bib\SpecialChar TeX
10184 itself does not allow you to do this.
10185 But with the help of some \SpecialChar LaTeX
10186 packages, Bib\SpecialChar TeX
10187 can be extended to fit your needs.
10190 \begin_layout Standard
10192 provides native support for one of these packages,
10200 \begin_layout Plain Layout
10202 \begin_inset Flex URL
10205 \begin_layout Plain Layout
10207 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
10217 The advantage of this package (compared to other packages such as
10221 ) is that you don't need to define new citation commands.
10222 Instead, you need to prepare different bibliographic databases which include
10223 the entries for the different sections of the bibliography.
10224 For example: If you want to divide your bibliography into the sections
10226 \begin_inset Quotes eld
10230 \begin_inset Quotes erd
10234 \begin_inset Quotes eld
10238 \begin_inset Quotes erd
10241 , you first need to create two bibliographic databases, e.
10242 \begin_inset space \thinspace{}
10246 \begin_inset space \space{}
10250 \begin_inset Flex Code
10253 \begin_layout Plain Layout
10260 \begin_inset Flex Code
10263 \begin_layout Plain Layout
10273 \begin_layout Standard
10275 \begin_inset Flex Noun
10278 \begin_layout Plain Layout
10279 Document\SpecialChar menuseparator
10286 \begin_inset Flex Noun
10289 \begin_layout Plain Layout
10296 \begin_inset Flex Noun
10299 \begin_layout Plain Layout
10300 Subdivided bibliography
10306 Now you can insert multiple Bib\SpecialChar TeX
10307 bibliographies, one for each section of
10309 Returning to our example: Insert the Bib\SpecialChar TeX
10311 \begin_inset Flex Code
10314 \begin_layout Plain Layout
10320 and a second one for the database
10321 \begin_inset Flex Code
10324 \begin_layout Plain Layout
10331 You are free to use the same or different styles for each section.
10332 Additionally, you can choose if the bibliography section should contain
10334 \begin_inset Quotes eld
10337 all cited references
10338 \begin_inset Quotes erd
10341 of the specified database(s) (which is the default),
10342 \begin_inset Quotes eld
10345 all uncited references
10346 \begin_inset Quotes erd
10350 \begin_inset Quotes eld
10354 \begin_inset Quotes erd
10358 This might be useful if you would like to separate your bibliography into
10360 \begin_inset Quotes eld
10364 \begin_inset Quotes erd
10368 \begin_inset Quotes eld
10372 \begin_inset Quotes erd
10376 \begin_inset Quotes eld
10380 \begin_inset Quotes erd
10384 The titles for the sections can be added as ordinary sections or subsections.
10386 \begin_inset Flex Code
10389 \begin_layout Plain Layout
10395 removes the bibliography title, you have to manually re-add that, too (as
10396 a chapter* or section*, for instance).
10399 \begin_layout Standard
10404 , the procedure is a bit different.
10413 , the aforementioned
10414 \begin_inset Flex Noun
10417 \begin_layout Plain Layout
10418 Subdivided bibliography
10423 option is disabled if you use
10432 provides its own means to generate subdivided bibliographies.
10433 You can either add keywords to bibliography entries via the
10434 \begin_inset Flex Code
10437 \begin_layout Plain Layout
10443 entry option and then filter bibliography sections by keyword (by adding
10445 \begin_inset Flex Code
10448 \begin_layout Plain Layout
10455 \begin_inset Flex Noun
10458 \begin_layout Plain Layout
10464 field of the dialog that opens if you left-click on the
10465 \begin_inset Flex Noun
10468 \begin_layout Plain Layout
10469 Biblatex Generated Bibliography
10474 button), or you can filter by entry types (such as
10483 \begin_inset space \thinspace{}
10488 \begin_inset Flex Code
10491 \begin_layout Plain Layout
10498 \begin_inset Flex Code
10501 \begin_layout Plain Layout
10508 \begin_inset Flex Noun
10511 \begin_layout Plain Layout
10517 field, or you can create so-called
10518 \begin_inset Quotes eld
10521 Bibliography Categories
10522 \begin_inset Quotes erd
10525 to which you can assign individual entries.
10526 Please refer to the Biblatex manual, section
10528 Subdivided Bibliographies
10533 \begin_layout Subsection
10534 Multiple Bibliographies
10535 \begin_inset CommandInset label
10537 name "subsec:Multiple-Bibliographies"
10544 \begin_layout Standard
10545 Multiple bibliographies, e.
10546 \begin_inset space \thinspace{}
10550 \begin_inset space \space{}
10553 a bibliography for each part, chapter, section, subsection or child (sub-documen
10554 t) of the document, are also supported by \SpecialChar LyX
10556 In order to enable it, go to
10557 \begin_inset Flex Noun
10560 \begin_layout Plain Layout
10561 Document\SpecialChar menuseparator
10562 Settings\SpecialChar menuseparator
10568 and select the relevant unit (e.
10569 \begin_inset space \thinspace{}
10573 \begin_inset Quotes eld
10577 \begin_inset Quotes erd
10581 \begin_inset Flex Noun
10584 \begin_layout Plain Layout
10585 Multiple Bibliographies
10591 Then add a Bib(la)\SpecialChar TeX
10592 bibliography to each unit (e.
10593 \begin_inset space \thinspace{}
10596 g., section) of your document.
10597 In the output, a separate bibliography, containing only the references
10598 done in the current unit is generated.
10601 \begin_layout Standard
10602 If you use Bib\SpecialChar TeX
10604 \begin_inset Flex Code
10607 \begin_layout Plain Layout
10614 \begin_inset Flex Code
10617 \begin_layout Plain Layout
10623 package is used to create multiple bibliographies.
10624 The former package is used if you select
10625 \begin_inset Quotes eld
10629 \begin_inset Quotes erd
10637 \begin_inset Flex Noun
10640 \begin_layout Plain Layout
10641 Sectioned Bibliography
10647 In all other cases,
10648 \begin_inset Flex Code
10651 \begin_layout Plain Layout
10661 \begin_layout Plain Layout
10662 An alternative approach, if you are willing to use some
10663 \begin_inset Flex Noun
10666 \begin_layout Plain Layout
10674 \begin_inset space ~
10678 \begin_inset CommandInset ref
10680 reference "sec:Inserting-TeX-Code"
10685 \begin_inset Flex Code
10688 \begin_layout Plain Layout
10700 \begin_inset Flex Code
10703 \begin_layout Plain Layout
10709 is used, \SpecialChar LyX
10710 encloses the specified units in
10711 \begin_inset Flex Code
10714 \begin_layout Plain Layout
10721 \begin_inset Flex Code
10724 \begin_layout Plain Layout
10733 \begin_inset Flex Code
10736 \begin_layout Plain Layout
10744 in order to create the units.
10745 Note that this approach has some limitations.
10746 First, every citation reference has to be inside some
10747 \begin_inset Flex Code
10750 \begin_layout Plain Layout
10757 So citations outside a defined unit (e.
10758 \begin_inset space \thinspace{}
10761 g., before the first section if you use
10762 \begin_inset Quotes eld
10766 \begin_inset Quotes erd
10770 \begin_inset Quotes eld
10774 \begin_inset Quotes erd
10778 You can also create your own units by entering
10779 \begin_inset Flex Code
10782 \begin_layout Plain Layout
10791 \begin_inset Flex Code
10794 \begin_layout Plain Layout
10802 as \SpecialChar TeX
10803 code (for instance to work around the mentioned limitation).
10805 \begin_inset Flex Code
10808 \begin_layout Plain Layout
10814 s cannot be nested.
10815 A second limitation is that
10816 \begin_inset Flex Code
10819 \begin_layout Plain Layout
10825 always processes all references of a bibliography database, even if they
10827 This can result in odd labels (e.
10828 \begin_inset space \thinspace{}
10833 \begin_inset Quotes eld
10837 \begin_inset Quotes erd
10840 if two works of this author from 2014 are in the database, even if only
10844 \begin_layout Standard
10850 \begin_inset Flex Code
10853 \begin_layout Plain Layout
10859 option is used instead.
10860 If you need specific units, you can start them with the \SpecialChar TeX
10862 \begin_inset Flex Code
10865 \begin_layout Plain Layout
10874 \begin_inset Flex Code
10877 \begin_layout Plain Layout
10886 If you also want to control the end of the unit, use the environment
10887 \begin_inset Flex Code
10890 \begin_layout Plain Layout
10900 \begin_inset Flex Code
10903 \begin_layout Plain Layout
10913 \begin_inset Flex Code
10916 \begin_layout Plain Layout
10922 s cannot be nested.
10923 In addition to the individual bibliography of the current unit,
10927 also provides an easy way to output all bibliographies, subsequently, at
10929 \begin_inset space \thinspace{}
10932 g., at the end of the document).
10934 \begin_inset Quotes eld
10937 all reference units
10938 \begin_inset Quotes erd
10941 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve
10943 Please refer to the
10947 manual for more information on this topic.
10950 \begin_layout Section
10951 Multipart Documents
10954 \begin_layout Subsection
10958 \begin_layout Standard
10959 When you are working on a large file with many sections, it is often convenient
10960 to break up the document into several files, or perhaps you have something
10961 where a table may change from time to time, but the preceding text does
10963 In these cases, you should seriously consider using multipart documents.
10964 For example, scientific papers often have five major sections: the introduction
10965 , observations, results, discussion, and conclusion.
10966 Each of these could be its own separate \SpecialChar LyX
10968 \begin_inset Quotes eld
10972 \begin_inset Quotes erd
10975 file which contains the title, authors, abstract, references, etc., plus
10976 the five included files.
10977 It is important to note that each of these files is a full \SpecialChar LyX
10979 can be formatted and printed on its own, as well as included in a master
10981 Each of these files must have the same document class, however—don't attempt
10982 to mix book classes with article classes.
10983 You may also include \SpecialChar LaTeX
10984 files; however, these files must not have their own
10986 \begin_inset space \thinspace{}
10990 \begin_inset space \space{}
10993 everything up to and including the
10994 \begin_inset Flex Code
10997 \begin_layout Plain Layout
11005 line as well as the
11006 \begin_inset Flex Code
11009 \begin_layout Plain Layout
11017 line must be deleted) or else errors will be generated when you try to
11021 \begin_layout Standard
11023 allows you to include files quite easily with
11024 \begin_inset Flex Noun
11027 \begin_layout Plain Layout
11028 Insert\SpecialChar menuseparator
11030 \begin_inset space ~
11039 When you click on this selection a small box is inserted into the file
11040 at the current cursor location.
11041 Clicking on the box raises a dialog which allows you to select the file
11042 to be included, and the method of its inclusion.
11046 \begin_layout Standard
11047 The file selection box should by now be obvious.
11048 The three inclusion methods are
11049 \begin_inset Quotes eld
11053 \begin_inset Quotes erd
11057 \begin_inset Quotes eld
11061 \begin_inset Quotes erd
11065 \begin_inset Quotes eld
11069 \begin_inset Quotes erd
11074 \begin_inset Quotes eld
11078 \begin_inset Quotes erd
11082 \begin_inset Quotes eld
11086 \begin_inset Quotes erd
11089 are similar in many ways, but there are also some notable differences:
11092 \begin_layout Enumerate
11094 \begin_inset Quotes eld
11098 \begin_inset Quotes erd
11101 are typeset beginning on a new page, while files that are
11102 \begin_inset Quotes eld
11106 \begin_inset Quotes erd
11109 are typeset starting on the current page.
11112 \begin_layout Enumerate
11113 \begin_inset Quotes eld
11117 \begin_inset Quotes erd
11120 files cannot themselves
11121 \begin_inset Quotes eld
11125 \begin_inset Quotes erd
11129 \begin_inset Quotes eld
11133 \begin_inset Quotes erd
11138 \begin_inset Quotes eld
11142 \begin_inset Quotes erd
11145 , on the other hand, infinite sub-inputting is possible.
11148 \begin_layout Enumerate
11149 \begin_inset Quotes eld
11153 \begin_inset Quotes erd
11156 allow for the output of only selected
11157 \begin_inset Quotes eld
11161 \begin_inset Quotes erd
11164 files, while maintaining the actual counters (pagination etc.) and references
11165 (please refer to the section
11168 \begin_inset space ~
11176 \begin_inset space ~
11181 manual for details).
11184 \begin_layout Standard
11186 \begin_inset Quotes eld
11190 \begin_inset Quotes erd
11193 is the preferred method for chapters that are outsourced to child documents,
11195 \begin_inset Quotes eld
11199 \begin_inset Quotes erd
11202 is more suitable for arbitrary file inheritance.
11205 \begin_layout Standard
11207 \begin_inset Quotes eld
11211 \begin_inset Quotes erd
11214 included file allows you to include a file typeset exactly as it appears
11216 \begin_inset space \thinspace{}
11220 \begin_inset space \space{}
11224 \begin_inset Flex Code
11227 \begin_layout Plain Layout
11233 mode, with the characters set in a fixed-width typewriter font.
11234 Normally, spaces in this file are invisible, though two consecutive spaces
11235 are conserved, unlike \SpecialChar LyX
11236 's normal treatment of spaces.
11237 However, setting the
11238 \begin_inset Flex Noun
11241 \begin_layout Plain Layout
11243 \begin_inset space ~
11247 \begin_inset space ~
11251 \begin_inset space ~
11259 checkbox typesets a mark to unambiguously define the presence of a space.
11263 \begin_layout Standard
11264 Generally, the master file is converted into a full \SpecialChar LaTeX
11265 file before typesetting,
11266 while the included files are converted to \SpecialChar LaTeX
11267 files that do not have all the
11268 preamble information.
11271 \begin_layout Subsection
11272 Cross-References Between Files
11275 \begin_layout Standard
11276 \begin_inset Box Shadowbox
11286 height_special "totalheight"
11291 backgroundcolor "none"
11294 \begin_layout Plain Layout
11295 This section is somewhat out of date.
11296 Need to describe default master documents and how children are opened when
11306 \begin_layout Standard
11307 It is possible to set up cross-references between the different files.
11308 First, open all the files in question: let's call them A and B in a two
11309 file example, where B is included in A.
11310 Let's say you insert a label in A, then want to reference it in B.
11311 Open the cross-reference dialog whilst in document B, and you can select
11313 \begin_inset Quotes eld
11317 \begin_inset Quotes erd
11323 \begin_layout Subsection
11324 Bibliography Lists in all Subdocuments
11327 \begin_layout Standard
11328 If you work with child documents, you might want to have only one main bibliogra
11329 phy at the end, but still be able to have a selected bibliography for the
11330 child if you output it on its own.
11331 Here is how to achieve this.
11334 \begin_layout Standard
11335 For the main document, you just insert a bibliography inset at the place
11336 where the main bibliography has to appear (within the master file or within
11338 If the bibliography inset is in the master file, the references will be
11339 inherited by all children, so they are available in the citation dialog
11343 \begin_layout Standard
11344 For child-specific bibliographies, insert bibliography insets within the
11345 child documents, at the place where the bibliography should appear when
11346 the child is compiled separately.
11347 However, the trick is to insert them into a branch (
11349 Insert\SpecialChar menuseparator
11350 Branch\SpecialChar menuseparator
11351 Insert New Branch...
11354 \begin_inset space \thinspace{}
11359 \begin_inset Quotes eld
11363 \begin_inset Quotes erd
11367 Within the children, activate the branch (
11369 Document\SpecialChar menuseparator
11370 Settings...\SpecialChar menuseparator
11374 Within the master, deactivate the branch (
11376 Document\SpecialChar menuseparator
11377 Settings...\SpecialChar menuseparator
11381 Now the child's bibliography will be ignored by the master, but considered
11385 \begin_layout Standard
11386 If you need multiple bibliographies (e.
11387 \begin_inset space \thinspace{}
11390 g., one per child in the
11394 ), please refer to sec.
11395 \begin_inset space ~
11399 \begin_inset CommandInset ref
11401 reference "subsec:Multiple-Bibliographies"
11408 \begin_layout Section
11413 \begin_layout Standard
11414 Users sometimes need to be able to
11415 \begin_inset Quotes eld
11419 \begin_inset Quotes erd
11423 file together with all the images (and other files) on which it depends,
11424 either for sending to a publisher or for sharing with a co-author.
11426 includes a Python script (
11427 \begin_inset Flex Code
11430 \begin_layout Plain Layout
11436 ) that automates this process.
11437 To use it, you must have either the
11438 \begin_inset Flex Code
11441 \begin_layout Plain Layout
11448 \begin_inset Flex Code
11451 \begin_layout Plain Layout
11457 python modules installed on your system.
11458 By default, the script prefers the
11459 \begin_inset Flex Code
11462 \begin_layout Plain Layout
11469 \begin_inset Flex Code
11472 \begin_layout Plain Layout
11478 format on Unix-like systems and the
11479 \begin_inset Flex Code
11482 \begin_layout Plain Layout
11491 \begin_layout Standard
11493 's configuration process will set the script up to export a `\SpecialChar LyX
11495 and this format will then be available under
11496 \begin_inset Flex Code
11499 \begin_layout Plain Layout
11500 File\SpecialChar menuseparator
11509 \begin_layout Standard
11510 Independently of the platform, the generation of a particular archive format
11511 can be forced by adding either the
11512 \begin_inset Flex Code
11515 \begin_layout Plain Layout
11522 \begin_inset Flex Code
11525 \begin_layout Plain Layout
11532 \begin_inset Flex Code
11535 \begin_layout Plain Layout
11542 \begin_inset Flex Code
11545 \begin_layout Plain Layout
11551 format) switch to the
11552 \begin_inset Flex Code
11555 \begin_layout Plain Layout
11557 \SpecialChar menuseparator
11565 \begin_inset Flex Code
11568 \begin_layout Plain Layout
11569 Tools\SpecialChar menuseparator
11570 Preferences\SpecialChar menuseparator
11571 File Handling\SpecialChar menuseparator
11578 (Make sure you add the switch after the script name, not before it.)
11581 \begin_layout Section
11582 Fancy Headers and Footers
11585 \begin_layout Standard
11586 The default page layout is rather plain; for an
11587 \begin_inset Flex Code
11590 \begin_layout Plain Layout
11596 document class, all you get is a centered page number at the bottom of
11598 This document uses KOMA-script's book class, so it appears to be a bit
11600 But to really put on a show, you need to set the document page style to
11602 \begin_inset Quotes eld
11606 \begin_inset Quotes erd
11609 , as mentioned in the
11614 This section describes the \SpecialChar LaTeX
11615 code you need to insert in your \SpecialChar LaTeX
11617 order to get the desired effects.
11620 \begin_layout Standard
11621 For more information on fancy headers, see the
11622 \begin_inset Flex Code
11625 \begin_layout Plain Layout
11631 package documentation.
11633 \begin_inset Flex URL
11636 \begin_layout Plain Layout
11638 https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
11646 \begin_layout Standard
11647 The page header is divided into three fields, not surprisingly labeled
11648 \begin_inset Quotes eld
11652 \begin_inset Quotes erd
11656 \begin_inset Quotes eld
11660 \begin_inset Quotes erd
11664 \begin_inset Quotes eld
11668 \begin_inset Quotes erd
11672 The footer is also divided into these three fields.
11673 The \SpecialChar LaTeX
11674 commands to set these fields in the simplest manner are
11675 \begin_inset Flex Code
11678 \begin_layout Plain Layout
11687 \begin_inset Flex Code
11690 \begin_layout Plain Layout
11699 \begin_inset Flex Code
11702 \begin_layout Plain Layout
11711 \begin_inset Flex Code
11714 \begin_layout Plain Layout
11723 Suppose you wish to put your name in the upper left hand corner of each
11725 Simply insert the following command in the preamble:
11728 \begin_layout Standard
11737 \begin_layout Standard
11738 You will now see your name in the upper left.
11739 If a field has a default entry that you would like to get rid of (often
11740 the page number appears in the central footer) simply include a command
11741 with a blank argument, e.
11742 \begin_inset space \thinspace{}
11748 \begin_layout Standard
11756 \begin_layout Standard
11757 Let's get really fancy: lets put the section number with the word
11758 \begin_inset Quotes eld
11762 \begin_inset Quotes erd
11766 \begin_inset space \thinspace{}
11770 \begin_inset space \space{}
11773 Section 3) in the upper left, the page number (e.
11774 \begin_inset space \thinspace{}
11778 \begin_inset space \space{}
11781 Page 4) in the upper right, your name in the lower left, and the date in
11783 The following commands should now appear in the preamble:
11786 \begin_layout Standard
11796 \begin_layout Standard
11804 \begin_layout Standard
11814 \begin_layout Standard
11823 \begin_layout Standard
11831 \begin_layout Standard
11841 \begin_layout Standard
11843 \begin_inset Flex Code
11846 \begin_layout Plain Layout
11855 \begin_inset Flex Code
11858 \begin_layout Plain Layout
11866 access \SpecialChar LaTeX
11867 's section and page counters, and so print out the current section
11870 \begin_inset Flex Code
11873 \begin_layout Plain Layout
11881 simply prints out today's date.
11884 \begin_layout Standard
11885 The thicknesses of the horizontal rules drawn beneath the header and above
11886 the footer can also be modified.
11887 If you don't want one of the rules, set its thickness to 0.
11888 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
11894 \begin_inset Flex Code
11897 \begin_layout Plain Layout
11902 headrulewidth}{0.4pt}
11908 \begin_inset Flex Code
11911 \begin_layout Plain Layout
11916 footrulewidth}{0.4pt}
11921 to set the thicknesses.
11924 \begin_layout Standard
11925 You can switch the header/footer settings on and off for individual pages
11926 using commands like
11927 \begin_inset Flex Code
11930 \begin_layout Plain Layout
11933 thispagestyle{empty}
11939 \begin_inset Flex Code
11942 \begin_layout Plain Layout
11945 thispagestyle{plain}
11951 \begin_inset Flex Code
11954 \begin_layout Plain Layout
11957 thispagestyle{fancy}
11963 Simply insert them in the text on the page you want changed and mark them
11964 as \SpecialChar TeX
11966 In fact, title pages are marked as plain by default, while following pages
11967 are marked fancy when using the global fancy setting.
11970 \begin_layout Standard
11971 As a final example, it is possible to include an image in the header or
11973 Suppose you want to put a company logo in the upper lefthand corner.
11974 You might try something like
11977 \begin_layout Standard
11986 includegraphics{logo.eps}}}
11989 \begin_layout Standard
11991 (you may need to preface this with
11992 \begin_inset Flex Code
11995 \begin_layout Plain Layout
11998 usepackage{graphics}
12003 if you don't include graphics elsewhere in your document).
12006 \begin_layout Section
12007 Itemize Bullet Selection
12008 \begin_inset CommandInset label
12017 \begin_layout Standard
12023 \begin_layout Subsection
12027 \begin_layout Standard
12029 provides 216 bullet shapes that can be accessed from a simple dialog.
12030 Using this dialog you can easily specify what bullet shape to use at each
12031 level of an itemized list.
12032 These settings are document-wide so you won't be able to specify different
12033 sets of bullets for different paragraphs.
12037 \begin_layout Plain Layout
12038 Well, actually you can but you'll have to do it by hand.
12046 \begin_layout Subsection
12050 \begin_layout Standard
12051 Open the dialog by selecting the
12052 \begin_inset Flex Noun
12055 \begin_layout Plain Layout
12056 Document\SpecialChar menuseparator
12062 menu item and then select the
12063 \begin_inset Flex Noun
12066 \begin_layout Plain Layout
12075 \begin_layout Standard
12076 The dialog provides you with a table of bullet shapes.
12077 A column of buttons on the left of the table provides access to the six
12078 different panels of bullet shapes.
12079 The row of buttons across the top is used to select which bullet depth
12082 \change_deleted 244031559 1603875981
12083 A text entry under the table shows the currently selected bullet shape's
12085 equivalent and this can be edited if desired.
12086 If you do modify the text you will also need to specify any needed packages
12087 in the \SpecialChar LaTeX
12093 \begin_layout Standard
12094 The six panels are divided up by the packages they require.
12095 The following table shows the mappings from button name to \SpecialChar LaTeX
12099 \begin_layout Standard
12101 \begin_inset Tabular
12102 <lyxtabular version="3" rows="7" columns="2">
12103 <features tabularvalignment="middle">
12104 <column alignment="center" valignment="top" width="0pt">
12105 <column alignment="center" valignment="top" width="0pt">
12107 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
12110 \begin_layout Plain Layout
12125 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
12128 \begin_layout Plain Layout
12145 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
12148 \begin_layout Plain Layout
12163 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
12166 \begin_layout Plain Layout
12175 base \SpecialChar LaTeX
12183 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
12186 \begin_layout Plain Layout
12201 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
12204 \begin_layout Plain Layout
12221 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
12224 \begin_layout Plain Layout
12239 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
12242 \begin_layout Plain Layout
12259 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
12262 \begin_layout Plain Layout
12277 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
12280 \begin_layout Plain Layout
12297 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
12300 \begin_layout Plain Layout
12315 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
12318 \begin_layout Plain Layout
12335 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
12338 \begin_layout Plain Layout
12353 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
12356 \begin_layout Plain Layout
12379 \begin_layout Standard
12381 doesn't stop you using bullets from packages you don't have.
12382 If you get errors from \SpecialChar LaTeX
12383 when you try to view or print the file, then it
12384 is likely you are missing a package.
12388 \begin_layout Plain Layout
12390 doesn't restrict your use since you may be editing locally and exporting
12399 \begin_layout Subsection
12403 \begin_layout Standard
12404 Select which bullet depth you want to change then select the bullet shape
12406 Any changes will not be visible in \SpecialChar LyX
12407 , but are visible when viewing the document.
12410 \begin_layout Standard
12411 You can reset a bullet shape to the default simply by clicking your right
12412 mouse button on the appropriate bullet depth button.
12416 \begin_layout Plain Layout
12421 want to have multiple sets of paragraphs with different sets of bullets
12422 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
12424 The bullet selection dialog can help though because it provides you with
12425 the \SpecialChar LaTeX
12426 code for a wide range of bullet shapes.
12427 To make your own custom paragraphs you have the following options:
12430 \begin_layout Plain Layout
12434 \begin_layout Plain Layout
12450 \begin_layout Plain Layout
12454 \begin_layout Plain Layout
12476 \begin_layout Itemize
12477 Use the \SpecialChar LaTeX
12479 \begin_inset Flex Code
12482 \begin_layout Plain Layout
12490 to specify a new bullet shape for a given depth.
12491 You'll also need to save the current bullet shape so you can restore it
12493 In this itemized list the following \SpecialChar LaTeX
12494 code was used to change the bullet
12495 used for the first depth.
12499 \begin_layout LyX-Code
12509 \begin_layout LyX-Code
12526 \begin_layout Itemize
12527 Note that the itemize depth is specified in Roman numerals as part of the
12537 \begin_layout Itemize
12538 \begin_inset Argument item:1
12541 \begin_layout Plain Layout
12545 \begin_layout Plain Layout
12563 Specify each individual entry by starting each item with the bullet shape
12565 \begin_inset Quotes eld
12569 \begin_inset Quotes erd
12572 inset (available at
12574 Insert\SpecialChar menuseparator
12578 \begin_inset Flex Noun
12581 \begin_layout Plain Layout
12589 For example, this item was started with
12590 \begin_inset Flex Code
12593 \begin_layout Plain Layout
12608 \begin_layout Plain Layout
12612 \begin_layout Plain Layout
12628 \begin_layout Plain Layout
12629 You'll also need to revert the labelitem back to its previous setting for
12630 the global bullet shape settings to remain in effect.
12631 The way used here was:
12634 \begin_layout LyX-Code
12649 \begin_layout Chapter
12651 and the World Wide Web
12654 \begin_layout Standard
12656 has long supported the export of documents to various web-friendly formats,
12658 Before version 2.0, however, HTML export was always accomplished by the
12659 use of external converters.
12663 \begin_layout Plain Layout
12664 For details on the use of external converters with \SpecialChar LyX
12669 section of the Customization manual.
12674 These fall into two large groups: there are converters that use \SpecialChar LaTeX
12676 intermediate format, such as
12677 \begin_inset Flex Code
12680 \begin_layout Plain Layout
12687 \begin_inset Flex Code
12690 \begin_layout Plain Layout
12697 \begin_inset Flex Code
12700 \begin_layout Plain Layout
12706 , relying upon \SpecialChar LyX
12707 to produce the \SpecialChar LaTeX
12708 ; and there is a converter that works directly
12709 on \SpecialChar LyX
12711 \begin_inset Flex Code
12714 \begin_layout Plain Layout
12722 All of these have different advantages and disadvantages.
12726 \begin_layout Standard
12727 The \SpecialChar LaTeX
12728 -based converters have the advantage that, in principle, they know everythin
12729 g about the exported document that \SpecialChar LaTeX
12731 Such converters do not care, for example, if a certain block of code was
12732 produced by \SpecialChar LyX
12733 or was Evil Red Text.
12734 These converters know about
12735 \begin_inset Flex Code
12738 \begin_layout Plain Layout
12744 files, counters, and references, and can often make use of the
12745 \begin_inset Flex Code
12748 \begin_layout Plain Layout
12754 files generated by Bib\SpecialChar TeX
12756 On the other hand, \SpecialChar LaTeX
12757 is a very hard language to parse—it is sometimes said
12758 that only \SpecialChar TeX
12759 itself understands \SpecialChar TeX
12760 —and \SpecialChar LaTeX
12761 -based converters will often choke on
12762 what seem to be quite simple constructs; complex ones can throw them completely
12763 , and as of this writing, for example, the
12767 manual will not export with
12768 \begin_inset Flex Code
12771 \begin_layout Plain Layout
12777 , though the others will.
12778 The other issue concerns how math is handled.
12779 These converters typically convert the formulae into little pictures that
12780 are then linked from the HTML document.
12781 Since these are actually generated by \SpecialChar LaTeX
12782 , they are accurate.
12783 But they do not scale well, and just getting them to look as if they are
12784 actually meant to be in your document—so that the font sizes seem to be
12785 roughly the same—can be a challenge.
12788 \begin_layout Standard
12790 \begin_inset Flex Code
12793 \begin_layout Plain Layout
12801 \begin_inset CommandInset href
12803 name "http://pinchito.es/elyxer/"
12804 target "http://pinchito.es/elyxer/"
12809 ) solves some of these problems.
12810 In particular, the formulae it produces scale perfectly, since it renders
12811 math using a combination of HTML and CSS rather than converting the formulae
12813 But even moderately complex formula are rendered less well than with
12814 \begin_inset Flex Code
12817 \begin_layout Plain Layout
12823 ; this reflects the limitations of HTML.
12827 \begin_layout Plain Layout
12829 \begin_inset Flex Code
12832 \begin_layout Plain Layout
12839 can also use jsMath and MathJax for equations, but this setting is only
12840 available globally and requires one to have access to a server that runs
12846 More importantly (as of version 1.1.1, at least),
12847 \begin_inset Flex Code
12850 \begin_layout Plain Layout
12857 has limited support for math macros and no support for user-defined paragraph
12858 or character styles.
12859 These limitations make
12860 \begin_inset Flex Code
12863 \begin_layout Plain Layout
12870 unsuitable for many of the documents \SpecialChar LyX
12872 In principle, of course, these problems could be solved, but the \SpecialChar LyX
12874 have decided to follow a different path and have made \SpecialChar LyX
12876 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
12877 , DocBook, and plaintext.
12880 \begin_layout Standard
12881 As of this writing, XHTML output remains under development and should probably
12883 \begin_inset Quotes eld
12887 \begin_inset Quotes erd
12894 \begin_layout Plain Layout
12896 \begin_inset Flex Code
12899 \begin_layout Plain Layout
12900 development/HTML/HTML.notes
12905 , which can be found in the \SpecialChar LyX
12907 \begin_inset CommandInset href
12909 name "accessed online"
12910 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
12915 , usually contains up-to-date information about the state of XHTML output.
12916 See also the list of XHTML bugs on
12917 \begin_inset CommandInset href
12919 name "the bug tracker"
12920 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"
12930 Still, the developers have chosen this approach because it has several
12931 potential advantages over the other two.
12934 \begin_layout Standard
12935 These advantages are primarily due to the fact that the XHTML output routines,
12936 since they are part of \SpecialChar LyX
12937 , know everything \SpecialChar LyX
12938 knows about the document being
12943 \begin_layout Plain Layout
12944 Another advantage is that, since these routines are internal to \SpecialChar LyX
12946 immune to changes in \SpecialChar LyX
12947 's file format, or to changes in the semantics of
12953 So they know about the table of contents (as displayed in the outline),
12954 about the counters associated with different paragraph styles, and about
12955 user-defined styles.
12956 The XHTML output routines know what \SpecialChar LyX
12957 knows about internationalization,
12958 too, so they will output
12959 \begin_inset Quotes eld
12963 \begin_inset Quotes erd
12967 \begin_inset Quotes eld
12975 \begin_inset Quotes erd
12978 , depending upon the language in effect at the time.
12982 \begin_layout Standard
12983 Quite generally, the output routines know what \SpecialChar LyX
12984 knows about document layout,
12985 that is, about how the document is to be rendered on screen.
12986 We use this information when we output the document as XHTML.
12987 In particular, \SpecialChar LyX
12992 generates CSS style information corresponding to the layout information
12993 it uses to render the document on screen: if section headings are supposed
12994 to be sans-serif and bold as seen in \SpecialChar LyX
12995 , then (by default) they will be sans-seri
12996 f and bold when viewed in a web browser, too.
12997 And this is true not just for pre-defined styles, like Section, but for
12998 any style, including user-defined styles.
12999 Indeed, the XHTML output routines make no distinction between user-defined
13001 \change_deleted 244031559 1603876931
13003 \change_inserted 244031559 1603876940
13006 styles and \SpecialChar LyX
13007 's own pre-defined styles: in each case, everything \SpecialChar LyX
13009 the styles is contained in the layout files.
13010 And much the same is true as regards pre-defined textual insets, such as
13011 footnotes, and various custom insets.
13015 \begin_layout Standard
13016 The result is that XHTML output can be customized and extended in exactly
13017 the same way \SpecialChar LaTeX
13018 output can be customized and extended: through layout files
13020 See chapter five of the
13024 manual for the details.
13027 \begin_layout Standard
13028 The remainder of this chapter contains more detailed information on XHTML
13029 output, its limitations, and ways to work around those limitations.
13032 \begin_layout Section
13033 Math Output in XHTML
13036 \begin_layout Standard
13038 offers four choices for how math is rendered.
13039 These have various advantages and disadvantages:
13042 \begin_layout Itemize
13044 \begin_inset Newline newline
13047 MathML is a dialect of XML designed specifically for mathematics on the
13048 web, and it typically renders very well in browsers that support it.
13049 The disadvantage is that not all browsers support MathML, and support is
13050 not complete even in the Gecko-based browsers, such as Firefox.
13051 \begin_inset Newline newline
13054 If \SpecialChar LyX
13055 is unable to render a formula as MathML—for example, if the formula
13057 \begin_inset Flex Code
13060 \begin_layout Plain Layout
13066 package or ERT—then it will instead output the formula as an image.
13070 \begin_layout Itemize
13072 \begin_inset Newline newline
13075 As mentioned above,
13076 \begin_inset Flex Code
13079 \begin_layout Plain Layout
13085 outputs math as HTML, styled by CSS.
13089 \begin_layout Plain Layout
13091 has borrowed some of the CSS for its HTML output from
13092 \begin_inset Flex Code
13095 \begin_layout Plain Layout
13106 For simple formulae, this can work quite well, though with more complicated
13107 formulae it tends to break down.
13108 Still, this method has the advantage that it is very widely supported and
13109 so it may be appropriate for documents that contain only a little, fairly
13111 \begin_inset Newline newline
13114 If Lyx is unable to render a formula as HTML—for example, if the formula
13116 \begin_inset Flex Code
13119 \begin_layout Plain Layout
13125 package or ERT—then it will instead output the formula as an image.
13129 \begin_layout Itemize
13131 \begin_inset Newline newline
13135 \begin_inset Flex Code
13138 \begin_layout Plain Layout
13145 will output formulae as images, the very same images, in fact, that are
13146 used for instant preview.
13150 \begin_layout Plain Layout
13151 Instant preview does
13155 have to be on for images to be output, however.
13160 The advantage to this method is that the images are simply generated by
13162 , so they are very accurate.
13163 The disadvantage, as mentioned earlier, is that these are bitmapped images,
13164 so they do not scale terribly well, and one cannot copy them, etc.
13165 \begin_inset Newline newline
13168 The size of the images can be controlled by setting the
13169 \begin_inset Quotes eld
13172 Math Images Scaling
13173 \begin_inset Quotes erd
13177 \begin_inset Flex Noun
13180 \begin_layout Plain Layout
13181 Document\SpecialChar menuseparator
13182 Settings\SpecialChar menuseparator
13192 \begin_layout Plain Layout
13193 For those who want to know, this controls the resolution of the image in
13194 dots per inch and is based upon a default of 75 dpi.
13200 \begin_inset Newline newline
13203 If \SpecialChar LyX
13204 for some reason fails to create an image for a formula (e.g., if a required
13206 package is not installed), then it will fall back to outputing the raw
13211 \begin_layout Itemize
13214 \begin_inset Newline newline
13217 Finally, \SpecialChar LyX
13218 will happily output math as \SpecialChar LaTeX
13220 As well as being the output of last resort, this method can be used with
13222 \begin_inset CommandInset href
13225 target "http://www.math.union.edu/~dpvc/jsMath/"
13230 , which uses JavaScript to render \SpecialChar LaTeX
13231 embedded in HTML documents.
13233 wraps the \SpecialChar LaTeX
13235 \begin_inset Flex Code
13238 \begin_layout Plain Layout
13244 (for inline formulas) or
13245 \begin_inset Flex Code
13248 \begin_layout Plain Layout
13254 (for displayed formulas) with
13255 \begin_inset Flex Code
13258 \begin_layout Plain Layout
13264 , as is required for jsMath.
13267 \begin_layout Standard
13268 One of these output methods must be selected under
13269 \begin_inset Flex Noun
13272 \begin_layout Plain Layout
13273 Document\SpecialChar menuseparator
13274 Settings\SpecialChar menuseparator
13281 By default, \SpecialChar LyX
13283 This is a document-wide setting, therefore.
13286 \begin_layout Standard
13287 Eventually, \SpecialChar LyX
13288 will offer the user the option to select an alternate output
13289 method for a particular inset, say, one that isn't being rendered very
13294 \begin_layout Plain Layout
13295 That said, since \SpecialChar LyX
13296 falls back to images if the inset contains ERT, then one
13297 can force output as an image by putting some harmless ERT into the math,
13299 \begin_inset Formula $a=b\relax$
13310 \begin_layout Section
13311 Bibliography and Citations
13314 \begin_layout Standard
13315 XHTML output fully supports bibliographies and citations.
13319 \begin_layout Standard
13320 Citation labels are generated by the same machinery that generates \SpecialChar LyX
13322 labels, so the labels will look in the output much as they do in \SpecialChar LyX
13325 If you are using numerical citations, then \SpecialChar LyX
13326 will output numerical labels,
13327 such as [1] or [17], rather than simply showing the citation key in square
13328 brackets, as it does on-screen.
13329 If you are using author-year citations, then \SpecialChar LyX
13330 will add lowercase letters
13331 to the years, just as Bib\SpecialChar TeX
13332 does, if it finds more than one citation for
13333 a given author-year combination.
13334 The labels will be printed with the bibliography entries.
13335 Note that there is, at present, no way to customize the appearance of the
13336 labels, for example, to choose between square brackets and parentheses.
13339 \begin_layout Standard
13340 Bibliography output is handled by the same machinery that handles the presentati
13341 on of reference information in the citation dialog, so you will see in the
13342 XHTML output pretty much what you would see if you were to look at a given
13343 entry in the citation dialog.
13344 The formatting can be customized in your layout file or, preferably, in
13350 manual for the details.
13353 \begin_layout Standard
13354 The main defect at present is that cross-referenced information is printed
13355 with every entry with which it is associated.
13356 So you can see things like this:
13359 \begin_layout Quote
13361 \begin_inset Quotes eld
13364 Context and Logical Form
13365 \begin_inset Quotes erd
13370 Language in Context: Selected Essays
13372 (Oxford: Oxford University Press, 2007), pp.
13376 \begin_layout Quote
13378 \begin_inset Quotes eld
13381 Semantics in Context
13382 \begin_inset Quotes erd
13387 Language in Context: Selected Essays
13389 (Oxford: Oxford University Press, 2007), pp.
13393 \begin_layout Standard
13394 This should be fixed before long.
13397 \begin_layout Standard
13398 There is no support at present for sectioned bibliographies.
13399 If you have multiple bibliographies, then \SpecialChar LyX
13400 will print the same bibliography
13404 \begin_layout Section
13408 \begin_layout Standard
13410 will happily export indexes as XHTML, but with certain limitations at the
13414 \begin_layout Standard
13415 Index export will be most reliable when you do not attempt to use the fancy
13416 constructs that are described in the section on indexes in the
13424 \begin_layout Plain Layout
13425 The main issue here is that \SpecialChar LyX
13426 itself does not really handle these.
13427 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
13433 We'll describe how they are handled using the subsection headings from
13437 \begin_layout Itemize
13438 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
13439 makes an effort to support these,
13440 but the entries must be separated by
13441 \begin_inset Quotes eld
13445 \begin_inset Quotes erd
13448 , that is, there must be spaces around the exclamation point.
13449 This is because it is otherwise too difficult to check for escaped exclamation
13450 points, ones in math, and so forth.
13453 \begin_layout Itemize
13454 Page Ranges: There is no support at all for page ranges, since these make
13455 no sense with XHMTL.
13456 Instead, you will just get two index entries, one at either end.
13459 \begin_layout Itemize
13460 Cross-referencing: There is no support for cross-referencing.
13461 If \SpecialChar LyX
13462 finds an entry containing the
13463 \begin_inset Quotes eld
13466 |see\SpecialChar ldots
13468 \begin_inset Quotes erd
13471 construct, it is just dropped, and the rest is treated as an ordinary index
13475 \begin_layout Itemize
13476 Index Entry Order: \SpecialChar LyX
13477 does support attempts to fix the sorting order.
13478 It will take what is before the first `@' it finds and use that for sorting,
13479 taking what follows the first `@' to be the actual entry.
13480 At present, \SpecialChar LyX
13481 does not check for escaped `@', so do not try to index email
13485 \begin_layout Itemize
13486 Index Entry Layout: You can format entries by using the text style dialog,
13487 or by using any other method available within \SpecialChar LyX
13489 There is no support for constructs like:
13490 \begin_inset Quotes eld
13494 \begin_inset Quotes erd
13498 Indeed, if \SpecialChar LyX
13499 finds a pipe symbol, `|', in an entry, it will delete it and
13500 everything that follows it.
13503 \begin_layout Itemize
13504 Multiple Indexes: There is no support for multiple indexes.
13505 Rather, all index entries will be printed as one large index.
13506 To avoid our printing several versions of the index, we print only the
13507 main index, so make sure you have one.
13510 \begin_layout Section
13511 Nomenclature and Glossary
13514 \begin_layout Standard
13515 There is at present no support for glossaries.
13516 Adding it would be fairly trivial, and welcome.
13519 \begin_layout Chapter
13521 \change_inserted 1075283030 1616534180
13525 \begin_layout Standard
13527 \change_inserted 1075283030 1616534386
13528 Apart from HTML, \SpecialChar LyX
13529 can generate documents in the DocBook XML vocabulary.
13530 With versions 2.3 and before, only select templates could be used to generate
13531 DocBook documents (only version 4).
13532 Starting with \SpecialChar LyX
13533 2.4, most \SpecialChar LyX
13534 layouts can generate valid DocBook documents (only
13536 This feature is built into \SpecialChar LyX
13537 and does not require the use of external tools.
13540 \begin_layout Standard
13542 \change_inserted 1075283030 1616534437
13543 The result is that the DocBook output can be customized and extended in
13544 exactly the same way \SpecialChar LaTeX
13545 output can be customized and extended: through layout
13547 See chapter five of the
13551 manual for the details.
13554 \begin_layout Standard
13556 \change_inserted 1075283030 1616534475
13557 Most \SpecialChar LyX
13558 features are supported with DocBook, like math output.
13561 \begin_layout Itemize
13563 \change_inserted 1075283030 1616534741
13564 Math output is performed mostly in MathML (the major exception being constructio
13565 ns not supported by \SpecialChar LyX
13568 All formulae are also available in raw \SpecialChar TeX
13569 in the DocBook output for further
13573 \begin_layout Itemize
13575 \change_inserted 1075283030 1616534852
13576 Bibliographies and citations are implemented, including with an external
13578 Bibliography entries are not prerendered when the detailed information
13579 are available, but rather output with the standard DocBook constructs.
13580 The external DocBook processor is expected to handle the rendering of entries.
13583 \begin_layout Itemize
13585 \change_inserted 1075283030 1616534863
13586 Indexes are supported, including multiple indices.
13591 ), page ranges, and cross-references (
13595 ) are supported, with the exception of the same symbols escaped.
13604 ) are not supported.
13605 There is no support for escaping of index entries.
13608 \begin_layout Itemize
13610 \change_inserted 1075283030 1616534884
13611 Glossaries are implemented.
13614 \begin_layout Standard
13616 \change_inserted 1075283030 1616534894
13617 Two major parameters can be set at the document level.
13620 \begin_layout Itemize
13622 \change_inserted 1075283030 1616534948
13623 Format for tables: \SpecialChar LyX
13624 can generate tables either as HTML (default value) or
13625 CALS, depending on the user's requirements.
13626 Most DocBook processors accept both formats.
13629 \begin_layout Itemize
13631 \change_inserted 1075283030 1616535006
13632 MathML prefix: in DocBook, MathML is included within its own name space,
13634 The implication is that there must be an indication of the tags belonging
13635 to the MathML standard.
13636 Three choices are offered:
13640 \begin_layout Itemize
13642 \change_inserted 1075283030 1616535044
13643 Inline: the MathML name space is defined for each formula (using the
13647 attribute on each formula)
13650 \begin_layout Itemize
13652 \change_inserted 1075283030 1616535090
13657 prefix (default): the MathML name space is defined at the document level
13662 attribute on the root element).
13663 Each MathML is prefixed with
13672 \begin_layout Itemize
13674 \change_inserted 1075283030 1616620405
13679 prefix: similar to the
13688 \begin_layout Standard
13690 \change_inserted 1075283030 1616620470
13691 This option is especially useful if you want \SpecialChar LyX
13692 to match your personal style
13693 or to work with buggy software that only accepts one prefix for MathML.
13699 \begin_layout Chapter
13700 The \SpecialChar LyX
13704 \begin_layout Section
13708 \begin_layout Standard
13709 The `\SpecialChar LyX
13710 server' allows other programs to talk to \SpecialChar LyX
13711 , invoke \SpecialChar LyX
13712 commands, and retrieve
13713 information about the \SpecialChar LyX
13715 This is only intended for advanced users, but they should find it useful.
13716 It is by writing to the \SpecialChar LyX
13717 server, for example, that bibliography managers,
13718 such as JabRef, are able to
13719 \begin_inset Quotes eld
13723 \begin_inset Quotes erd
13726 citations to \SpecialChar LyX
13730 \begin_layout Section
13731 Starting the \SpecialChar LyX
13733 \begin_inset CommandInset label
13735 name "sec:Starting-the-Server"
13742 \begin_layout Standard
13743 The \SpecialChar LyX
13744 server works through the use of a pair of named pipes.
13745 These are usually located in
13746 \begin_inset Flex Code
13749 \begin_layout Plain Layout
13755 , (except on Windows, where
13759 named pipes are special objects located in
13760 \begin_inset Flex Code
13763 \begin_layout Plain Layout
13775 ) and have the names
13776 \begin_inset Quotes eld
13780 \begin_inset Flex Code
13783 \begin_layout Plain Layout
13790 \begin_inset Quotes erd
13794 \begin_inset Quotes eld
13798 \begin_inset Flex Code
13801 \begin_layout Plain Layout
13808 \begin_inset Quotes erd
13812 External programs write into
13813 \begin_inset Flex Code
13816 \begin_layout Plain Layout
13822 and read back data from
13823 \begin_inset Flex Code
13826 \begin_layout Plain Layout
13833 The stem of the pipe names can be defined in the
13834 \begin_inset Flex Noun
13837 \begin_layout Plain Layout
13838 Tools\SpecialChar menuseparator
13844 dialog, for example
13845 \begin_inset Flex Code
13848 \begin_layout Plain Layout
13849 "/home/myhome/lyxpipe"
13855 \begin_inset Flex Code
13858 \begin_layout Plain Layout
13872 on Windows (where any working path instead of lyxpipe can be used, for
13874 \begin_inset Flex Code
13877 \begin_layout Plain Layout
13900 configure this manually in order for the server to start.
13903 \begin_layout Standard
13906 \begin_inset Flex Code
13909 \begin_layout Plain Layout
13916 \begin_inset Flex Code
13919 \begin_layout Plain Layout
13925 ' to create the pipes.
13926 If one of the pipes already exists, \SpecialChar LyX
13927 will assume that another \SpecialChar LyX
13929 is already running and will not start the server.
13930 On POSIX (Unix like) systems, if for some other reason, an unused
13931 \begin_inset Quotes eld
13935 \begin_inset Quotes erd
13938 pipe is left in existence when \SpecialChar LyX
13939 closes, then \SpecialChar LyX
13940 will try to delete it.
13941 If this fails for some reason, you will need to delete the pipes manually
13942 and then restart \SpecialChar LyX
13944 On Windows, pipes are deleted by the OS on program termination or crash,
13946 \begin_inset Quotes eld
13950 \begin_inset Quotes erd
13953 pipes should not be possible.
13956 \begin_layout Standard
13957 To have several \SpecialChar LyX
13958 processes with servers at the same time, you have to use
13959 different configurations, perhaps by using separate user directories, each
13961 \begin_inset Flex Code
13964 \begin_layout Plain Layout
13970 file, for each process.
13973 \begin_layout Standard
13974 If you are developing a client program, you might find it useful to enable
13975 debugging information from the \SpecialChar LyX
13977 Do this by starting \SpecialChar LyX
13979 \begin_inset Flex Code
13982 \begin_layout Plain Layout
13991 \begin_layout Standard
13992 You can find a complete example client written in C++ in the source distribution
13994 \begin_inset Flex Code
13997 \begin_layout Plain Layout
13998 development/lyxserver/server_monitor.cpp
14006 \begin_layout Standard
14007 Another useful tool is the command-line based client found in
14008 \begin_inset Flex Code
14011 \begin_layout Plain Layout
14012 src/client/lyxclient
14020 \begin_layout Section
14021 Normal communication
14024 \begin_layout Standard
14025 To issue a \SpecialChar LyX
14026 call, the client writes a line of ASCII text into the input
14028 This line has the following format:
14031 \begin_layout Quote
14045 \begin_layout Description
14046 clientname is a name that the client can choose arbitrarily.
14047 Its only use is that \SpecialChar LyX
14048 will echo it if it sends an answer—so a client can
14049 dispatch results from different requesters.
14052 \begin_layout Description
14053 function is the function you want \SpecialChar LyX
14055 It is the same as the commands you'd use in the minibuffer.
14058 \begin_layout Description
14059 argument is an optional argument which is meaningful only to some functions
14061 \begin_inset Quotes eld
14065 \begin_inset Quotes erd
14068 LFUN will insert the argument as text at the cursor position).
14071 \begin_layout Standard
14072 The answer from \SpecialChar LyX
14073 will arrive in the output pipe and be of the form
14076 \begin_layout Quote
14090 \begin_layout Standard
14099 are just echoed from the command request, while
14103 is more or less useful information filled according to how the command
14104 execution worked out.
14105 Some commands, such as
14106 \begin_inset Quotes eld
14110 \begin_inset Quotes erd
14113 , will return information about the internal state of \SpecialChar LyX
14115 return an empty data-response.
14116 This means that the command execution went fine.
14119 \begin_layout Standard
14120 In case of errors, the response from \SpecialChar LyX
14121 will have this form
14124 \begin_layout Quote
14138 \begin_layout Standard
14143 should contain an explanation of why the command failed.
14146 \begin_layout Standard
14150 \begin_layout LyX-Code
14151 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
14152 \begin_inset Newline newline
14155 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
14156 \begin_inset Newline newline
14159 read a <~/.lyxpipe.out
14160 \begin_inset Newline newline
14166 \begin_layout Subsection
14167 AppleScript (Mac OS X)
14170 \begin_layout Standard
14171 Since \SpecialChar LyX
14172 2.1, \SpecialChar LyX
14173 supports basic interactions with AppleScript for normal communicatio
14174 n through the command run.
14175 This command takes a direct argument (the
14179 to perform) and an optional argument.
14180 It either returns the output of the function or triggers an error with
14181 the error message and code.
14184 \begin_layout Standard
14188 \begin_layout LyX-Code
14189 tell application "\SpecialChar LyX
14193 \begin_layout LyX-Code
14197 \begin_layout LyX-Code
14198 -- Stores the current file name into f
14201 \begin_layout LyX-Code
14202 set f to (run "server-get-filename" with argument "")
14205 \begin_layout LyX-Code
14206 on error the error_message number the error_number
14209 \begin_layout LyX-Code
14210 display dialog "Error: " & the error_number & ".
14214 \begin_layout LyX-Code
14215 & the error_message buttons {"OK"} default button 1
14218 \begin_layout LyX-Code
14222 \begin_layout LyX-Code
14226 \begin_layout Section
14230 \begin_layout Standard
14232 can notify clients of events going on asynchronously.
14233 Currently it will only do this if the user binds a key sequence with the
14235 \begin_inset Quotes eld
14239 \begin_inset Quotes erd
14243 The format of the string \SpecialChar LyX
14244 sends is as follows:
14247 \begin_layout Quote
14248 \begin_inset Flex Code
14251 \begin_layout Plain Layout
14262 \begin_layout Standard
14267 is the printed representation of the key sequence that was actually typed
14271 \begin_layout Standard
14272 This mechanism can be used to extend \SpecialChar LyX
14273 's command set and implement macros.
14274 Bind some key sequence to
14275 \begin_inset Quotes eld
14279 \begin_inset Quotes erd
14283 Then start a client that listens on the output pipe, dispatches the command
14284 according to the sequence, and starts a function that may use \SpecialChar LyX
14287 requests to issue a command or a series of commands to \SpecialChar LyX
14291 \begin_layout Section
14292 The simple \SpecialChar LyX
14296 \begin_layout Standard
14298 implements a simple protocol that can be used for session management.
14299 All messages are of the form
14302 \begin_layout Quote
14312 \begin_layout Standard
14318 \begin_inset Quotes eld
14322 \begin_inset Quotes erd
14326 \begin_inset Quotes eld
14330 \begin_inset Quotes erd
14335 \begin_inset Quotes eld
14339 \begin_inset Quotes erd
14342 is received from a client, \SpecialChar LyX
14343 will report back to inform the client that
14344 it's listening to it's messages, while
14345 \begin_inset Quotes eld
14349 \begin_inset Quotes erd
14352 sent from \SpecialChar LyX
14353 will inform clients that \SpecialChar LyX
14357 \begin_layout Section
14358 Reverse DVI/PDF search
14361 \begin_layout Standard
14362 Some DVI/PDF viewers
14366 \begin_layout Plain Layout
14367 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
14368 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
14377 facility (also called
14382 This means that you can tell \SpecialChar LyX
14383 to put the cursor to a specific line in the
14384 document by clicking at the respective position in the DVI/PDF output.
14385 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
14387 This is done via the \SpecialChar LyX
14388 server either by using the named pipe (
14392 ), or the UNIX domain socket (
14396 ) that \SpecialChar LyX
14397 creates in its temporary directory (this is the way the
14398 \begin_inset Flex Code
14401 \begin_layout Plain Layout
14407 program communicates with \SpecialChar LyX
14409 In some cases, you need a helper script that mediates between the viewer
14410 and \SpecialChar LyX
14411 , in others, the viewer can communicate with \SpecialChar LyX
14413 This depends on the selected viewer and on your operating system.
14414 The same applies to the way viewers need to be configured and the way the
14415 reverse search is actually performed.
14416 In what follows, we will thus describe how to setup reverse search for
14418 Before we turn to this, though, we will explain what needs to be done generally
14419 to enable reverse search in the DVI/PDF output.
14422 \begin_layout Subsection
14424 \begin_inset CommandInset label
14426 name "subsec:rev-search"
14433 \begin_layout Standard
14434 In most cases \SpecialChar LyX
14435 will do the work for you by pressing the following button
14439 arg "buffer-toggle-output-sync"
14443 Alternatively, you can also enable the feature by checking
14445 Synchronize with Output
14448 \begin_inset Flex Noun
14451 \begin_layout Plain Layout
14452 Document\SpecialChar menuseparator
14453 Settings\SpecialChar menuseparator
14460 In such a case \SpecialChar LyX
14461 will automatically insert the necessary Sync\SpecialChar TeX
14463 PDF) or load the srcltx package (for DVI) respectively.
14464 This option can be easily reached also on
14465 \begin_inset Flex Code
14468 \begin_layout Plain Layout
14477 \begin_layout Standard
14478 If you need a different setting, you can select or input a custom macro
14479 from the drop down box just below
14480 \begin_inset Flex Noun
14483 \begin_layout Plain Layout
14484 Document\SpecialChar menuseparator
14485 Settings\SpecialChar menuseparator
14486 Output\SpecialChar menuseparator
14487 Synchronize with Output
14495 \begin_layout Standard
14496 Note that the method
14497 \begin_inset Flex Code
14500 \begin_layout Plain Layout
14508 enables gzip compression.
14509 If your viewer does not support it, you should instead use
14510 \begin_inset Flex Code
14513 \begin_layout Plain Layout
14524 \begin_layout Standard
14525 Please also note that including the
14526 \begin_inset Flex Code
14529 \begin_layout Plain Layout
14536 \begin_inset Flex Code
14539 \begin_layout Plain Layout
14545 sometimes has an undesired impact on the typesetting.
14546 Thus, you should switch output synchronization off for the final typesetting
14548 \begin_inset Flex Code
14551 \begin_layout Plain Layout
14558 \begin_inset Flex Code
14561 \begin_layout Plain Layout
14571 \begin_layout Standard
14572 In case you need some more special settings that are not covered by the
14573 automatic settings, read the next section about how to set up output synchroniz
14575 If the automatic setup suits your needs, you can readily jump to section
14576 \begin_inset space ~
14580 \begin_inset CommandInset ref
14582 reference "subsec:configuring-viewers"
14586 , where the necessary configuration steps in your viewer – needed both with
14587 the automatic and the manual setup – are described.
14590 \begin_layout Subsection
14594 \begin_layout Standard
14596 provides several different methods for reverse search.
14597 Some are built-in in the
14598 \begin_inset Flex Code
14601 \begin_layout Plain Layout
14607 program, some are provided by external packages.
14608 Your choice depends on whether your \SpecialChar LaTeX
14609 distribution already provides a given
14610 method (the built-in methods are rather new) and whether your viewer can
14612 The available methods are described in the following.
14615 \begin_layout Subsubsection*
14616 Built-in DVI-search via src-specials (DVI only)
14619 \begin_layout Standard
14620 This method provides the DVI file with the necessary information for reverse
14622 It is available in \SpecialChar LaTeX
14623 since quite some time (any somewhat recent \SpecialChar LaTeX
14625 should include it), and it works reliably.
14626 To enable it, change the
14627 \begin_inset Flex Noun
14630 \begin_layout Plain Layout
14641 \begin_inset Flex Noun
14644 \begin_layout Plain Layout
14655 \begin_inset Flex Noun
14658 \begin_layout Plain Layout
14659 Preferences\SpecialChar menuseparator
14660 File Handling\SpecialChar menuseparator
14667 \begin_inset Flex Code
14670 \begin_layout Plain Layout
14671 latex -src-specials $$i
14677 If this doesn't work, check if your \SpecialChar TeX
14678 engine needs different options (the
14679 syntax might differ in some distributions).
14682 \begin_layout Subsubsection*
14683 External Packages (PDFSync and scrltx)
14686 \begin_layout Standard
14695 provide reverse search facility for PDF output (via pdflatex) and DVI output,
14697 In order to enable it, load the packages in the \SpecialChar LyX
14701 \begin_layout Itemize
14702 \begin_inset Flex Code
14705 \begin_layout Plain Layout
14708 usepackage{pdfsync}
14713 for reverse PDF search,
14716 \begin_layout Itemize
14717 \begin_inset Flex Code
14720 \begin_layout Plain Layout
14723 usepackage[active]{srcltx}
14728 for reverse DVI search.
14731 \begin_layout Standard
14732 If you want to be able to perform both DVI and PDF reverse searches, you
14733 can also insert in the preamble the following lines
14736 \begin_layout LyX-Code
14740 \begin_inset Newline newline
14746 \begin_inset Newline newline
14751 usepackage{pdfsync}
14752 \begin_inset Newline newline
14758 \begin_inset Newline newline
14763 usepackage[active]{srcltx}
14764 \begin_inset Newline newline
14772 \begin_layout Standard
14773 This way, you can preview the file as either DVI or PDF (pdflatex) and the
14774 right package will be used.
14777 \begin_layout Standard
14778 Note that PDFSync might affect the output layout of your document.
14779 It is therefore advised to disable PDFsync for final documents.
14782 \begin_layout Subsubsection*
14783 Built-in reverse search via Sync\SpecialChar TeX
14787 \begin_layout Standard
14789 \begin_inset Flex Code
14792 \begin_layout Plain Layout
14798 have built-in support for both PDF and DVI reverse search.
14801 Sync\SpecialChar TeX
14804 facility is basically the result of the integration of the PDFSync package
14805 to the pdftex program and its merge with the
14810 You need at least \SpecialChar TeX
14811 Live 2008 or a recent Mik\SpecialChar TeX
14812 distribution in order to use
14817 \begin_layout Plain Layout
14818 For some reason, Mik\SpecialChar TeX
14819 does not understand/obey the command \SpecialChar LyX
14821 the preamble when you check the "Enable Forward/Reverse Search" button
14822 in the toolbar and does not generate the necessary info.
14825 \begin_layout Plain Layout
14826 The generation of the required info can be forced by changing the converter
14827 "\SpecialChar LaTeX
14828 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
14829 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
14830 the -synctex=1 switch).
14835 Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
14836 Skim on the Mac, SumatraPDF on Windows; see the next section for details)
14837 already provide Sync\SpecialChar TeX
14841 \begin_layout Standard
14842 To enable Sync\SpecialChar TeX
14843 for DVI output, change the
14844 \begin_inset Flex Noun
14847 \begin_layout Plain Layout
14858 \begin_inset Flex Noun
14861 \begin_layout Plain Layout
14866 (plain) -> DraftDVI
14872 \begin_inset Flex Noun
14875 \begin_layout Plain Layout
14876 Preferences\SpecialChar menuseparator
14877 File Handling\SpecialChar menuseparator
14884 \begin_inset Flex Code
14887 \begin_layout Plain Layout
14888 latex -synctex=1 $$i
14893 , and for PDF output, change the
14894 \begin_inset Flex Noun
14897 \begin_layout Plain Layout
14902 (pdflatex) -> PDF (pdflatex)
14908 \begin_inset Flex Code
14911 \begin_layout Plain Layout
14912 pdflatex -synctex=1 $$i
14918 Should your viewer not be considered in the following description, or in
14919 case of missing success, please check the documentation of your viewer
14920 whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
14925 \begin_layout Plain Layout
14926 Note that the option
14927 \begin_inset Flex Code
14930 \begin_layout Plain Layout
14936 option enables gzip compression.
14937 If your viewer does not support it, you should instead use
14938 \begin_inset Flex Code
14941 \begin_layout Plain Layout
14955 \begin_layout Subsection
14956 Configuring and using specific viewers
14957 \begin_inset CommandInset label
14959 name "subsec:configuring-viewers"
14966 \begin_layout Subsubsection*
14967 Xdvi (all platforms)
14970 \begin_layout Standard
14972 \begin_inset Flex Code
14975 \begin_layout Plain Layout
14981 , you don't need to do anything else for performing a reverse DVI search,
14982 as \SpecialChar LyX
14983 already provides the necessary hooks for automatically using the
14984 \begin_inset Flex Code
14987 \begin_layout Plain Layout
14994 Just setup your document as described above (reverse search is triggered
14995 by Ctrl-click or Alt-click on Mac OSX, respectively).
14998 \begin_layout Standard
14999 However, if for whatever reason you want to use the named pipe instead of
15000 the socket for communicating with \SpecialChar LyX
15001 , simply change the DVI viewer in
15002 \begin_inset Flex Noun
15005 \begin_layout Plain Layout
15006 Preferences\SpecialChar menuseparator
15007 File Handling\SpecialChar menuseparator
15017 \begin_layout Plain Layout
15018 On Mac OSX you have to use
15019 \begin_inset Flex Code
15022 \begin_layout Plain Layout
15023 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
15034 \begin_inset Flex Code
15037 \begin_layout Plain Layout
15038 xdvi -editor "lyxeditor.sh %f %l"
15044 \begin_inset Flex Code
15047 \begin_layout Plain Layout
15053 is a suitable script.
15054 For example, a minimal shell script is the following one:
15057 \begin_layout LyX-Code
15059 \begin_inset Newline newline
15062 LYXPIPE="/path/to/lyxpipe"
15063 \begin_inset Newline newline
15066 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
15067 \begin_inset Newline newline
15070 echo "$COMMAND" > "${LYXPIPE}".in || exit
15071 \begin_inset Newline newline
15074 read TMP < "${LYXPIPE}".out || exit
15077 \begin_layout Standard
15079 \begin_inset Flex Code
15082 \begin_layout Plain Layout
15088 is the LyXServer pipe path specified in
15089 \begin_inset Flex Noun
15092 \begin_layout Plain Layout
15093 Preferences\SpecialChar menuseparator
15103 \begin_layout Plain Layout
15105 \begin_inset Flex Code
15108 \begin_layout Plain Layout
15114 folder of a source distribution you can find a
15115 \begin_inset Flex Code
15118 \begin_layout Plain Layout
15124 script which is able to locate the
15128 based on your preferences.
15136 \begin_layout Subsubsection*
15140 \begin_layout Standard
15142 \begin_inset Flex Code
15145 \begin_layout Plain Layout
15146 /Applications/MacDviX_Folder/calleditor.script
15151 , add the following lines:
15154 \begin_layout LyX-Code
15155 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
15156 \begin_inset Newline newline
15162 \begin_layout Standard
15163 Modify the lines accordingly if you install \SpecialChar LyX
15164 somewhere else than in the
15165 Applications folder.
15168 \begin_layout Standard
15169 Reverse search is triggered by Alt-click (OPTION-click).
15172 \begin_layout Subsubsection*
15176 \begin_layout Standard
15178 \begin_inset Flex Code
15181 \begin_layout Plain Layout
15182 open -a Skim.app $$i
15187 to the viewer setting in
15188 \begin_inset Flex Noun
15191 \begin_layout Plain Layout
15192 Preferences\SpecialChar menuseparator
15193 File Handling\SpecialChar menuseparator
15194 File formats\SpecialChar menuseparator
15201 \begin_inset Flex Noun
15204 \begin_layout Plain Layout
15205 Skim\SpecialChar menuseparator
15206 Preferences\SpecialChar menuseparator
15213 \begin_inset Flex Noun
15216 \begin_layout Plain Layout
15222 preset and enter command
15223 \begin_inset Flex Noun
15226 \begin_layout Plain Layout
15227 /Applications/\SpecialChar LyX
15228 .app/Contents/MacOS/lyxeditor
15236 \begin_layout Standard
15237 Reverse search is triggered by COMMAND-SHIFT-click
15240 \begin_layout Subsubsection*
15244 \begin_layout Standard
15245 Reverse search with evince does not work out of the box, but it can be achieved
15246 by means of some third party helper scripts.
15248 \begin_inset CommandInset href
15250 target "https://wiki.lyx.org/LyX/SyncTeX"
15258 \begin_layout Subsubsection*
15262 \begin_layout Standard
15264 \begin_inset Flex Noun
15267 \begin_layout Plain Layout
15268 Settings\SpecialChar menuseparator
15269 Configure Okular\SpecialChar menuseparator
15276 \begin_inset Quotes erd
15280 This inserts the appropriate command (
15281 \begin_inset Flex Code
15284 \begin_layout Plain Layout
15293 \begin_layout Standard
15294 Reverse search is triggered by SHIFT-click.
15296 \change_inserted -712698321 1578211026
15297 Note that this only works if Okular is in
15298 \begin_inset Quotes eld
15302 \begin_inset Quotes erd
15306 \begin_inset space \thinspace{}
15309 e., the hand symbol is clicked).
15314 \begin_layout Subsubsection*
15318 \begin_layout Standard
15319 Qpdfview supports Sync\SpecialChar TeX
15320 since version 0.3.5.
15322 \begin_inset Flex Noun
15325 \begin_layout Plain Layout
15326 Edit\SpecialChar menuseparator
15327 Settings\SpecialChar menuseparator
15333 , click on the input field of the
15334 \begin_inset Quotes eld
15338 \begin_inset Quotes erd
15341 item and add the command
15342 \begin_inset Flex Code
15345 \begin_layout Plain Layout
15354 \begin_layout Standard
15355 Reverse search is triggered by double-click or, in more recent versions,
15359 \begin_layout Subsubsection*
15363 \begin_layout Standard
15364 Launch yap, choose its
15365 \begin_inset Flex Noun
15368 \begin_layout Plain Layout
15369 View\SpecialChar menuseparator
15375 menu and select the
15376 \begin_inset Quotes eld
15380 \begin_inset Quotes erd
15385 \begin_inset Quotes eld
15388 New\SpecialChar ldots
15390 \begin_inset Quotes erd
15393 button and, in the window that opens, enter
15394 \begin_inset Quotes eld
15399 \begin_inset Quotes erd
15402 (or any other name you like) in the
15403 \begin_inset Quotes eld
15407 \begin_inset Quotes erd
15411 Now click on the button labeled
15412 \begin_inset Quotes eld
15417 \begin_inset Quotes erd
15420 to open a file dialog and navigate to the directory containing the batch
15422 \begin_inset Flex Code
15425 \begin_layout Plain Layout
15433 \begin_inset Flex Code
15436 \begin_layout Plain Layout
15442 and then specify the program arguments as
15443 \begin_inset Flex Code
15446 \begin_layout Plain Layout
15454 \begin_inset Flex Code
15457 \begin_layout Plain Layout
15463 wrapper is used for communicating with \SpecialChar LyX
15471 \begin_layout LyX-Code
15473 \begin_inset Newline newline
15476 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
15485 \begin_inset Newline newline
15499 \begin_layout Standard
15500 Make sure that the \SpecialChar LyX
15501 Server pipe path you specified in \SpecialChar LyX
15503 \begin_inset Flex Code
15506 \begin_layout Plain Layout
15520 , otherwise change the
15521 \begin_inset Flex Code
15524 \begin_layout Plain Layout
15530 wrapper accordingly.
15533 \begin_layout Standard
15534 In yap, reverse search is triggered by double-click.
15537 \begin_layout Subsubsection*
15538 SumatraPDF (Windows)
15541 \begin_layout Standard
15542 In order to use SumatraPDF for inverse search, enter
15543 \begin_inset Flex Code
15546 \begin_layout Plain Layout
15547 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
15552 in the viewer setting in
15553 \begin_inset Flex Noun
15556 \begin_layout Plain Layout
15557 Preferences\SpecialChar menuseparator
15558 File Handling\SpecialChar menuseparator
15559 File formats\SpecialChar menuseparator
15566 \begin_inset Flex Code
15569 \begin_layout Plain Layout
15575 is the previous wrapper.
15576 If SumatraPDF.exe is not in your command PATH, use its full file name.
15579 \begin_layout Standard
15580 Reverse search is triggered by double-click.
15583 \begin_layout Subsubsection*
15587 \begin_layout Standard
15588 First of all, make sure that yap is your default DVI viewer in the Windows
15589 environment, then launch it, choose its
15590 \begin_inset Flex Noun
15593 \begin_layout Plain Layout
15594 View\SpecialChar menuseparator
15600 menu and select the
15601 \begin_inset Quotes eld
15605 \begin_inset Quotes erd
15610 \begin_inset Quotes eld
15613 New\SpecialChar ldots
15615 \begin_inset Quotes erd
15618 button and, in the window that opens, enter
15619 \begin_inset Quotes eld
15624 \begin_inset Quotes erd
15627 (or any other name you like) in the
15628 \begin_inset Quotes eld
15632 \begin_inset Quotes erd
15636 Now click on the button labeled
15637 \begin_inset Quotes eld
15642 \begin_inset Quotes erd
15645 to open a file dialog and navigate to the directory containing the
15646 \begin_inset Flex Code
15649 \begin_layout Plain Layout
15655 program (which is installed by default on Cygwin along with the \SpecialChar LyX
15658 \begin_inset Flex Code
15661 \begin_layout Plain Layout
15667 and then specify the program arguments as
15668 \begin_inset Flex Code
15671 \begin_layout Plain Layout
15678 In this way, you will be using the
15682 for communicating with \SpecialChar LyX
15684 If, for whatever reason, you want to use the
15689 \begin_inset Flex Code
15692 \begin_layout Plain Layout
15698 option and be sure to specify the \SpecialChar LyX
15699 Server pipe path in the \SpecialChar LyX
15703 \begin_layout Standard
15704 In yap, reverse search is triggered by double-click.
15707 \begin_layout Subsubsection*
15708 SumatraPDF (Cygwin)
15711 \begin_layout Standard
15712 In order to use SumatraPDF for inverse search, enter
15713 \begin_inset Flex Code
15716 \begin_layout Plain Layout
15717 SumatraPDF -inverse-search "lyxeditor -g %f %l"
15722 in the viewer setting in
15723 \begin_inset Flex Noun
15726 \begin_layout Plain Layout
15727 Preferences\SpecialChar menuseparator
15728 File Handling\SpecialChar menuseparator
15729 File formats\SpecialChar menuseparator
15736 If SumatraPDF.exe is not in your command PATH, use its full posix path.
15738 \begin_inset Flex Code
15741 \begin_layout Plain Layout
15747 enables communication via the
15753 \begin_inset Flex Code
15756 \begin_layout Plain Layout
15762 option if you want to use the
15766 , and be sure to specify the \SpecialChar LyX
15767 Server pipe path in the \SpecialChar LyX
15771 \begin_layout Standard
15772 Reverse search is triggered by double-click.
15775 \begin_layout Section
15779 \begin_layout Standard
15780 Forward search is, as the name implies, in a sense the
15781 \begin_inset Quotes eld
15785 \begin_inset Quotes erd
15789 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
15791 If forward search is set up (as described in what follows), you can put
15792 the cursor anywhere in your \SpecialChar LyX
15794 \begin_inset Flex Noun
15797 \begin_layout Plain Layout
15798 Navigate\SpecialChar menuseparator
15805 \begin_inset Flex Noun
15808 \begin_layout Plain Layout
15814 in the context menu via right mouse click), and then the viewer will jump
15815 to that position as well.
15816 This implies, of course, that your viewer supports this function.
15819 \begin_layout Standard
15820 To make forward search possible, you first need to provide the generated
15821 output PDF/DVI file with additional information about the \SpecialChar TeX
15823 This can be done via the methods described in the section
15824 \begin_inset CommandInset ref
15826 reference "subsec:rev-search"
15833 \begin_layout Standard
15834 Additionally, you need to configure \SpecialChar LyX
15835 for using your viewers in
15836 \begin_inset Flex Noun
15839 \begin_layout Plain Layout
15840 Tools\SpecialChar menuseparator
15841 Preferences\SpecialChar menuseparator
15842 Output\SpecialChar menuseparator
15849 We provide a range of tested configurations for some viewers, which you
15850 can select from the drop down list.
15851 If none of these configurations suits you, you have to find out and enter
15852 a suitable configuration yourself.
15853 The definition syntax uses the following placeholders:
15856 \begin_layout Itemize
15858 \begin_inset Flex Code
15861 \begin_layout Plain Layout
15870 \begin_layout Itemize
15872 \begin_inset Flex Code
15875 \begin_layout Plain Layout
15881 : name of the (temporary) exported .tex file (without path)
15884 \begin_layout Itemize
15886 \begin_inset Flex Code
15889 \begin_layout Plain Layout
15895 : name of the (temporary) exported .tex file (including path)
15898 \begin_layout Itemize
15900 \begin_inset Flex Code
15903 \begin_layout Plain Layout
15909 : name of the exported output file (either dvi or pdf, depending on which
15910 one exists in the temporary directory)
15913 \begin_layout Standard
15914 Note that only some of the viewers provide full and usable forward search
15915 functionality out of the box, among them yap, xdvi, okular
15919 \begin_layout Plain Layout
15920 You might want to set
15921 \begin_inset Flex Code
15924 \begin_layout Plain Layout
15931 \begin_inset Flex Noun
15934 \begin_layout Plain Layout
15935 Tools\SpecialChar menuseparator
15936 Preferences\SpecialChar menuseparator
15937 File Handling\SpecialChar menuseparator
15939 \begin_inset space ~
15952 , qpdfview, and SumatraPDF
15956 \begin_layout Plain Layout
15957 SumatraPDF can also use DDE commands through the external program CMCDDE
15958 — downloadable from
15959 \begin_inset CommandInset href
15961 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
15972 Others, such as evince
15976 \begin_layout Plain Layout
15977 Forward search with evince can be achieved by means of third party helper
15980 \begin_inset CommandInset href
15982 target "https://wiki.lyx.org/LyX/SyncTeX"
15992 , require some extra tools in order to use forward search.
15993 While many of the widespread PDF viewers (most notably Adobe Reader) do
15994 not support forward search at all, some other viewers – e.
15995 \begin_inset space \thinspace{}
15999 xpdf – allow at least to reload the document and jump to a specific page
16000 of the file, so you can at least navigate
16001 \begin_inset Quotes eld
16005 \begin_inset Quotes erd
16009 This latter functionality is provided by an external call of synctex (see
16010 the predefined example configurations).
16014 \begin_layout Standard
16015 Forward search works both with DVI and PDF output.
16017 simply checks which preview format you have used before (i.
16018 \begin_inset space \thinspace{}
16021 e., which format is already there in the temporary directory) and chooses
16022 the appropriate configuration for the respective format.
16025 \begin_layout Chapter
16026 Special Document Classes
16029 \begin_layout Section
16031 \change_deleted 564990737 1669742044
16035 \begin_layout Standard
16037 \change_deleted 564990737 1669742044
16043 \begin_layout Subsection
16045 \change_deleted 564990737 1669742044
16049 \begin_layout Standard
16051 \change_deleted 564990737 1669742044
16052 This section describes how \SpecialChar LyX
16053 can be used to write articles for submission
16054 to the scientific journal
16056 Astronomy and Astrophysics
16059 \begin_inset Flex URL
16062 \begin_layout Plain Layout
16064 https://www.aanda.org/
16069 ) using Version 5.01 of the document class
16074 This package can be downloaded from the ftp site
16077 \begin_layout Standard
16079 \change_deleted 564990737 1669742044
16080 \begin_inset VSpace medskip
16086 \begin_layout Standard
16089 \change_deleted 564990737 1669742044
16090 \begin_inset Flex URL
16093 \begin_layout Plain Layout
16095 ftp://ftp.edpsciences.org/pub/aa/readme.html
16103 \begin_layout Standard
16105 \change_deleted 564990737 1669742044
16106 \begin_inset VSpace medskip
16112 \begin_layout Standard
16114 \change_deleted 564990737 1669742044
16115 A manual comes together with that package, and this text is not meant to
16116 replace the original manual but is merely a short guide in how to realize
16117 the correct form of your paper.
16121 \begin_layout Standard
16123 \change_deleted 564990737 1669742044
16124 Please note that the publisher of the journal was changed from Springer
16125 to EDP Sciences starting January 1, 2001.
16126 That change involved also some slight changes to the style files, namely
16127 the removal of the thesaurus command.
16128 The \SpecialChar LyX
16129 class aa supports the newest version of these style files, V 5.01.
16130 If you have an older version installed, please upgrade.
16131 For compatibility, the old (version 4) layout has been kept as
16136 Please refer to the comments in
16139 Dir/layouts/aapaper.layout
16144 \begin_layout Subsection
16146 \change_deleted 564990737 1669742044
16150 \begin_layout Standard
16152 \change_deleted 564990737 1669742044
16153 It is recommended you start from the example template distributed with \SpecialChar LyX
16155 If you are not using a template, note the following settings:
16158 \begin_layout Itemize
16160 \change_deleted 564990737 1669742044
16167 Document\SpecialChar menuseparator
16170 dialog (OK, that one was obvious).
16173 \begin_layout Itemize
16175 \change_deleted 564990737 1669742044
16176 Don't change the option
16179 \begin_inset space ~
16189 The whole layout is done by the macros, you shouldn't change anything.
16192 \begin_layout Subsection
16194 \change_deleted 564990737 1669742044
16198 \begin_layout Standard
16200 \change_deleted 564990737 1669742044
16201 First thing to enter is the header information.
16202 It consists of seven entries, of which some are optional.
16206 \begin_layout Itemize
16208 \change_deleted 564990737 1669742044
16216 \begin_layout Itemize
16218 \change_deleted 564990737 1669742044
16226 \begin_layout Itemize
16228 \change_deleted 564990737 1669742044
16236 \begin_layout Itemize
16238 \change_deleted 564990737 1669742044
16246 \begin_layout Itemize
16248 \change_deleted 564990737 1669742044
16253 : [optional] if more than one author: whom to contact for offprint requests.
16256 \begin_layout Itemize
16258 \change_deleted 564990737 1669742044
16263 : [optional] mail address for contacts.
16266 \begin_layout Itemize
16268 \change_deleted 564990737 1669742044
16274 Suggested format is
16276 Received: <date>; Accepted <date>
16279 \begin_layout Standard
16281 \change_deleted 564990737 1669742044
16282 There is no need to issue the
16288 command, this is done automatically by \SpecialChar LyX
16289 when the header is finished.
16290 Although the order of the single header entries doesn't matter it is advised
16291 to keep the above sequence, just to get the best optics and meets the layout
16292 of the real document.
16295 \begin_layout Standard
16297 \change_deleted 564990737 1669742044
16298 If you want to place footnotes in the header block, e.
16299 \begin_inset space \thinspace{}
16303 \begin_inset space \space{}
16306 to state your present address, just use the standard footnote via the menu
16309 Insert\SpecialChar menuseparator
16314 will automagically use the term
16323 \begin_layout Standard
16325 \change_deleted 564990737 1669742044
16328 Edit\SpecialChar menuseparator
16331 , you'll find two insets which are relevant for the titling:
16334 \begin_layout Itemize
16336 \change_deleted 564990737 1669742044
16343 to mark corresponding author\SpecialChar breakableslash
16345 The institutes are numbered sequentially as they appear in the
16349 field, so you have to put a marker to each author.
16352 \begin_layout Itemize
16354 \change_deleted 564990737 1669742044
16359 to supply an email address for fast contact.
16362 \begin_layout Standard
16364 \change_deleted 564990737 1669742044
16365 In addition to these topics, the macros use one additional \SpecialChar LaTeX
16367 has no counterpart in \SpecialChar LyX
16371 \begin_layout Itemize
16373 \change_deleted 564990737 1669742044
16380 to separate different names for more than one author and institute, respectivel
16384 \begin_layout Standard
16386 \change_deleted 564990737 1669742044
16387 The appropriate command has to be entered in \SpecialChar LyX
16388 and marked as \SpecialChar LaTeX
16394 \begin_layout Subsection
16396 \change_deleted 564990737 1669742044
16400 \begin_layout Standard
16402 \change_deleted 564990737 1669742044
16403 The abstract should immediately follow the header block.
16404 With version 5 the abstract environment was changed to a command, and there
16405 is now a restriction to only one paragraph.
16406 In addition, it should contain an entry with the keywords.
16407 This is done via the paragraph style
16412 Refer to the example paper.
16415 \begin_layout Subsection
16417 \change_deleted 564990737 1669742044
16418 Supported environments
16421 \begin_layout Standard
16423 \change_deleted 564990737 1669742044
16424 The A&A paper layout supports the following environments for structuring
16428 \begin_layout Itemize
16430 \change_deleted 564990737 1669742044
16436 \begin_layout Itemize
16438 \change_deleted 564990737 1669742044
16444 \begin_layout Itemize
16446 \change_deleted 564990737 1669742044
16452 \begin_layout Itemize
16454 \change_deleted 564990737 1669742044
16460 \begin_layout Itemize
16462 \change_deleted 564990737 1669742044
16468 \begin_layout Itemize
16470 \change_deleted 564990737 1669742044
16476 \begin_layout Itemize
16478 \change_deleted 564990737 1669742044
16484 \begin_layout Itemize
16486 \change_deleted 564990737 1669742044
16492 \begin_layout Itemize
16494 \change_deleted 564990737 1669742044
16500 \begin_layout Itemize
16502 \change_deleted 564990737 1669742044
16508 \begin_layout Itemize
16510 \change_deleted 564990737 1669742044
16516 \begin_layout Itemize
16518 \change_deleted 564990737 1669742044
16525 \begin_layout Subsection
16527 \change_deleted 564990737 1669742044
16528 Commands not supported by \SpecialChar LyX
16532 \begin_layout Standard
16534 \change_deleted 564990737 1669742044
16535 Some commands are not yet supported by the
16539 layout for \SpecialChar LyX
16541 Some have already been mentioned.
16542 For the sake of completeness, they are listed all together here:
16545 \begin_layout Itemize
16547 \change_deleted 564990737 1669742044
16555 \begin_layout Itemize
16557 \change_deleted 564990737 1669742044
16565 \begin_layout Itemize
16567 \change_deleted 564990737 1669742044
16575 \begin_layout Itemize
16577 \change_deleted 564990737 1669742044
16585 \begin_layout Standard
16587 \change_deleted 564990737 1669742044
16588 If you want to use any of these commands, you have to enter them yourself.
16591 Do not forget to mark them as \SpecialChar LaTeX
16595 \begin_layout Subsection
16597 \change_deleted 564990737 1669742044
16598 Figure and Table Floats
16601 \begin_layout Standard
16603 \change_deleted 564990737 1669742044
16605 provides support for the necessary float environments
16607 figure, figure*, table
16613 , therefore we won't tell much about it here.
16617 \begin_inset space ~
16623 Just remember that tables should be left-aligned.
16624 For that, select the table and change the alignment in
16626 Edit\SpecialChar menuseparator
16628 \begin_inset space ~
16634 \begin_layout Standard
16636 \change_deleted 564990737 1669742044
16637 There is only one special thing: the figures with caption besides the figure.
16638 To create such a figure, you have to do the following:
16641 \begin_layout Enumerate
16643 \change_deleted 564990737 1669742044
16644 Create a wide figure float:
16646 Insert\SpecialChar menuseparator
16647 Float\SpecialChar menuseparator
16650 , then right click in the figure and select
16653 \begin_inset space ~
16661 \begin_layout Enumerate
16663 \change_deleted 564990737 1669742044
16664 Enter your caption text.
16667 \begin_layout Enumerate
16669 \change_deleted 564990737 1669742044
16674 to move the cursor above the caption.
16677 \begin_layout Enumerate
16679 \change_deleted 564990737 1669742044
16683 \begin_layout Enumerate
16685 \change_deleted 564990737 1669742044
16686 Position the cursor behind the figure and insert a horizontal fill:
16688 Insert\SpecialChar menuseparator
16690 \begin_inset space ~
16693 Character\SpecialChar menuseparator
16695 \begin_inset space ~
16703 \begin_layout Enumerate
16705 \change_deleted 564990737 1669742044
16706 Switch to \SpecialChar LaTeX
16710 \begin_inset space ~
16718 \begin_layout Enumerate
16720 \change_deleted 564990737 1669742044
16730 Do not close the brace!
16733 \begin_layout Enumerate
16735 \change_deleted 564990737 1669742044
16736 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
16741 \begin_inset space ~
16753 \begin_layout Standard
16755 \change_deleted 564990737 1669742044
16756 Also, refer to the figures in the example paper.
16759 \begin_layout Subsection
16761 \change_deleted 564990737 1669742044
16765 \begin_layout Standard
16767 \change_deleted 564990737 1669742044
16768 For submission, the paper has to be formated in a special double-spacing
16770 For this purpose, you have to give the option
16774 to the document class.
16775 This must be done using the custom class options field in the
16777 Document\SpecialChar menuseparator
16781 Just enter the string
16788 \begin_layout Subsection
16790 \change_deleted 564990737 1669742044
16794 \begin_layout Standard
16796 \change_deleted 564990737 1669742044
16801 directory contains an example paper written with \SpecialChar LyX
16803 It is the example paper from the original macro package, translated to
16806 Use it for inspiration, and compare the original \SpecialChar LaTeX
16807 code with \SpecialChar LyX
16811 \begin_layout Section
16815 \begin_layout Standard
16820 can be used to type letters according to German conventions.
16821 A template file is included in
16823 .../lyx/share/templates
16825 for you to use as a starting point.
16828 \begin_layout Section
16832 \begin_layout Standard
16833 See the \SpecialChar LyX
16839 It contains all infos you need.
16842 \begin_layout Section
16844 \change_deleted 564990737 1669755802
16848 \begin_layout Standard
16850 \change_deleted 564990737 1669755802
16853 Panayotis Papasotiriou
16856 \begin_layout Subsection
16858 \change_deleted 564990737 1669755802
16862 \begin_layout Standard
16864 \change_deleted 564990737 1669755802
16865 The ijmpc package is a set of macros that facilitates electronic manuscript
16868 International Journal of Modern Physics C
16871 Similarly, the ijmpd package is for creating manuscripts to be submitted
16874 International Journal of Modern Physics D
16877 Both journals are published by World Scientific.
16878 The corresponding document classes are named
16887 These files, together with instructions for the authors, can be downloaded
16889 \begin_inset Flex URL
16892 \begin_layout Plain Layout
16894 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
16900 \begin_inset Flex URL
16903 \begin_layout Plain Layout
16905 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
16911 Both packages are modified versions of the standard
16912 \begin_inset Quotes eld
16916 \begin_inset Quotes erd
16919 package, and they are almost (but not exactly) identical.
16920 Most of their features are supported by \SpecialChar LyX
16922 I have used \SpecialChar LyX
16923 successfully to write articles submitted to both journals
16924 without any problem.
16927 \begin_layout Subsection
16929 \change_deleted 564990737 1669755802
16933 \begin_layout Standard
16935 \change_deleted 564990737 1669755802
16936 As usual, the easiest way to write a paper is to start with a template.
16939 File\SpecialChar menuseparator
16955 This will give an (almost) empty document that includes the most common
16956 fields found in a manuscript.
16957 Simply overwrite the existing text (including the brackets,
16962 You should keep in mind the following remarks.
16965 \begin_layout Enumerate
16967 \change_deleted 564990737 1669755802
16969 won't let you change the font size and the page style of the document,
16970 because such modifications are not allowed by both packages.
16973 \begin_layout Enumerate
16975 \change_deleted 564990737 1669755802
16976 The language of the document should not be changed.
16977 Before previewing your paper, be sure that the babel package is not used.
16978 To do this, click on
16981 arg "dialog-show document"
16986 \SpecialChar menuseparator
16990 \begin_inset Quotes eld
16994 \begin_inset Quotes erd
17004 \begin_layout Enumerate
17006 \change_deleted 564990737 1669755802
17008 \begin_inset Quotes eld
17012 \begin_inset Quotes erd
17015 style must be used to define keywords.
17018 \begin_layout Enumerate
17020 \change_deleted 564990737 1669755802
17021 The ijmpc package provides a style named
17022 \begin_inset Quotes eld
17025 Classification Codes
17026 \begin_inset Quotes erd
17029 , which can be used to define classification codes, such as PACS numbers.
17030 Note that this facility is not supported by the ijmpd package.
17033 \begin_layout Enumerate
17035 \change_deleted 564990737 1669755802
17036 Several new environments are available:
17037 \begin_inset Quotes eld
17041 \begin_inset Quotes erd
17045 \begin_inset Quotes eld
17049 \begin_inset Quotes erd
17053 \begin_inset Quotes eld
17057 \begin_inset Quotes erd
17061 \begin_inset Quotes eld
17065 \begin_inset Quotes erd
17069 \begin_inset Quotes eld
17073 \begin_inset Quotes erd
17077 \begin_inset Quotes eld
17081 \begin_inset Quotes erd
17085 \begin_inset Quotes eld
17089 \begin_inset Quotes erd
17093 \begin_inset Quotes eld
17097 \begin_inset Quotes erd
17101 \begin_inset Quotes eld
17105 \begin_inset Quotes erd
17109 \begin_inset Quotes eld
17113 \begin_inset Quotes erd
17117 \begin_inset Quotes eld
17121 \begin_inset Quotes erd
17125 \begin_inset Quotes eld
17129 \begin_inset Quotes erd
17133 \begin_inset Quotes eld
17137 \begin_inset Quotes erd
17141 \begin_inset Quotes eld
17145 \begin_inset Quotes erd
17149 Their use is more or less obvious.
17151 supports all these environments; it will use the proper label, text style,
17152 and numbering scheme for each of them.
17155 \begin_layout Enumerate
17157 \change_deleted 564990737 1669755802
17158 Both packages use basic citations; the natbib package should not be used.
17159 In \SpecialChar LyX
17160 , citation references are shown as usual; in the output, citations are
17161 shown as superscripts.
17162 If you want to use a citation as normal text, you should use the
17167 \begin_inset space \thinspace{}
17171 \begin_inset space \space{}
17175 \begin_inset Quotes eld
17179 \begin_inset space \space{}
17189 \begin_inset Quotes erd
17195 \begin_layout Enumerate
17197 \change_deleted 564990737 1669755802
17199 \begin_inset Quotes eld
17203 \begin_inset Quotes erd
17206 section in both packages.
17207 To put acknowledgments, just use the
17208 \begin_inset Quotes eld
17212 \begin_inset Quotes erd
17218 \begin_layout Enumerate
17220 \change_deleted 564990737 1669755802
17221 Appendices may be added to the paper,
17225 the Acknowledgments and
17231 provides a special environment, called
17232 \begin_inset Quotes eld
17236 \begin_inset Quotes erd
17239 which marks the beginning of the appendices.
17240 This environment should be left blank; it just sends a \SpecialChar LaTeX
17241 command, but nothing
17243 In \SpecialChar LyX
17245 \begin_inset Quotes eld
17249 \begin_inset Quotes erd
17252 is printed with blue letters, as a signal that all sections after that
17253 point are appendices.
17254 To write an appendix, use the
17255 \begin_inset Quotes eld
17259 \begin_inset Quotes erd
17264 will number each appendix with capital letters, as required by both journals.
17266 \begin_inset Quotes eld
17270 \begin_inset Quotes erd
17277 be present before the first appendix; if not, all appendices will be numbered
17278 as normal sections in the output.
17281 \begin_layout Enumerate
17283 \change_deleted 564990737 1669755802
17284 The ijmpc and the ijmpd packages use the
17288 command to implement table captions.
17289 As a result, a table created by \SpecialChar LyX
17290 is printed correctly, but its caption
17292 However, you can use some \SpecialChar TeX
17293 code to overcome this problem, so that captions
17294 are printed as expected.
17295 To do so, create a float table as usual, remove the caption, and replace
17296 it with the \SpecialChar TeX
17307 (sic); you must also the \SpecialChar TeX
17312 immediately after the tabular material.
17313 Study the example table included in the template files to see how this
17314 trick is implemented.
17315 Alternatively, If you need table captions, you should implement the whole
17320 file, then include this file to the \SpecialChar LyX
17323 Insert\SpecialChar menuseparator
17324 File\SpecialChar menuseparator
17326 \begin_inset space ~
17332 Details on how to create a table float can be found in the files
17340 , included in the corresponding packages.
17343 \begin_layout Subsection
17345 \change_deleted 564990737 1669755802
17346 Preparing a paper for submission
17349 \begin_layout Standard
17351 \change_deleted 564990737 1669755802
17352 Before you submit your paper you must export the \SpecialChar LyX
17353 document as a \SpecialChar LaTeX
17356 File\SpecialChar menuseparator
17357 Export\SpecialChar menuseparator
17365 \begin_layout Plain Layout
17366 Actually you have the choice between \SpecialChar LaTeX
17367 (plain) and pdflatex.
17368 If you intend to use pdflatex to prepare the paper, you should use the
17369 pdflatex option so that included graphics are converted to PDF format,
17370 ready for use by pdflatex.
17375 , then make the following changes to the resulting
17382 \begin_layout Enumerate
17384 \change_deleted 564990737 1669755802
17385 Remove the comment lines before the
17394 \begin_layout Enumerate
17396 \change_deleted 564990737 1669755802
17397 Remove everything between (and including) the
17409 commands, except for any commands you specifically put into the \SpecialChar LaTeX
17413 \begin_layout Standard
17415 \change_deleted 564990737 1669755802
17420 file should be saved and processed through \SpecialChar LaTeX
17421 as many times as necessary.
17422 You may also want to check the resulting
17431 \begin_layout Section
17433 \change_deleted 564990737 1669801478
17437 \begin_layout Standard
17439 \change_deleted 564990737 1669801478
17445 \begin_layout Subsection
17447 \change_deleted 564990737 1669801478
17451 \begin_layout Standard
17453 \change_deleted 564990737 1669801478
17454 The iopart package provides a document class to create electronic manuscript
17455 submission to the journals published by the Institute of Physics.
17456 Instructions for the authors how to create a paper using the iopart class
17457 can be downloaded together with the iopart package from the site
17458 \begin_inset Flex URL
17461 \begin_layout Plain Layout
17463 ftp://ftp.iop.org/pub/journals/latex2e
17471 \begin_layout Subsection
17473 \change_deleted 564990737 1669801478
17477 \begin_layout Standard
17479 \change_deleted 564990737 1669801478
17480 The easiest way to write a paper is to start with the template
17484 that is available via
17486 File\SpecialChar menuseparator
17489 The template explains how to use the special text environments.
17490 Here are the most important advices:
17493 \begin_layout Itemize
17495 \change_deleted 564990737 1669801478
17496 To be able to compile your document to a PDF, PS, or DVI, ensure that the
17497 no AMS packages are loaded in
17499 Document\SpecialChar menuseparator
17500 Settings\SpecialChar menuseparator
17506 \begin_layout Itemize
17508 \change_deleted 564990737 1669801478
17511 The title environment defines the kind of your paper.
17512 So use one of the following environments for the title:
17516 \begin_layout Itemize
17518 \change_deleted 564990737 1669801478
17527 \begin_layout Itemize
17529 \change_deleted 564990737 1669801478
17538 \begin_layout Itemize
17540 \change_deleted 564990737 1669801478
17546 for a Topical review
17549 \begin_layout Itemize
17551 \change_deleted 564990737 1669801478
17560 \begin_layout Itemize
17562 \change_deleted 564990737 1669801478
17571 \begin_layout Itemize
17573 \change_deleted 564990737 1669801478
17579 for a Paper (same as Title)
17582 \begin_layout Itemize
17584 \change_deleted 564990737 1669801478
17590 for a Preliminary communication
17593 \begin_layout Itemize
17595 \change_deleted 564990737 1669801478
17601 for a Rapid communication
17604 \begin_layout Itemize
17606 \change_deleted 564990737 1669801478
17612 for a Letter to the editor
17616 \begin_layout Itemize
17618 \change_deleted 564990737 1669801478
17621 All title environments except of
17625 can have an optional short title.
17628 \begin_layout Itemize
17630 \change_deleted 564990737 1669801478
17631 There is a general title environment
17635 which is not directly supported by \SpecialChar LyX
17637 This can be used as \SpecialChar TeX
17638 code when your document doesn't fit into one of the
17642 \begin_layout Standard
17644 \change_deleted 564990737 1669801478
17645 For more informations like hints for special table and formula formatting,
17646 look at the IOP author guidelines.
17651 \begin_layout Section
17653 \change_deleted 564990737 1670317155
17657 \begin_layout Standard
17659 \change_deleted 564990737 1670317155
17662 Panayotis Papasotiriou
17665 \begin_layout Subsection
17667 \change_deleted 564990737 1670317155
17671 \begin_layout Standard
17673 \change_deleted 564990737 1670317155
17674 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
17675 that facilitates electronic manuscript submission to the journals they
17677 Most known of them (at least in my domain of interest) are
17679 Astrophysics and Space Science
17685 , but there are many others (see a complete list at
17686 \begin_inset Flex URL
17689 \begin_layout Plain Layout
17691 http://www.wkap.nl/jrnllist.htm/JRNLHOME
17697 The Kluwer package may be downloaded from the site
17698 \begin_inset Flex URL
17701 \begin_layout Plain Layout
17703 http://www.wkap.nl/kaphtml.htm/STYLEFILES
17709 A complete user guide is contained in that package (but it can also be
17710 downloaded separately).
17713 \begin_layout Standard
17715 \change_deleted 564990737 1670317155
17717 supports many features of the package but not everything.
17718 However, the \SpecialChar TeX
17719 code needed is reduced to some
17720 \begin_inset Quotes eld
17724 \begin_inset Quotes erd
17727 commands of the package (see
17728 \begin_inset space ~
17732 \begin_inset CommandInset ref
17734 reference "subsec:kluwer_peculiarities"
17739 I have recently used \SpecialChar LyX
17740 to write an article submitted to the
17742 Astrophysics and Space Science
17744 without any problem.
17747 \begin_layout Subsection
17749 \change_deleted 564990737 1670317155
17753 \begin_layout Standard
17755 \change_deleted 564990737 1670317155
17756 The easiest way to write a paper is to start with the Kluwer template file.
17759 File\SpecialChar menuseparator
17771 This will give an (almost) empty document that includes the most common
17772 fields found in a manuscript and a short description of their use.
17773 As in most templates, simply overwrite the existing text (including the
17778 ) with the correct information.
17781 \begin_layout Subsection
17783 \change_deleted 564990737 1670317155
17784 Preparing a paper for submission
17787 \begin_layout Standard
17789 \change_deleted 564990737 1670317155
17790 As in the AAS\SpecialChar TeX
17791 package, before you submit your paper to a journal you must
17793 \begin_inset Quotes eld
17797 \begin_inset Quotes erd
17803 \begin_layout Enumerate
17805 \change_deleted 564990737 1670317155
17806 Export your paper as a \SpecialChar LaTeX
17808 To do this, click on
17810 File\SpecialChar menuseparator
17811 Export\SpecialChar menuseparator
17819 \begin_layout Enumerate
17821 \change_deleted 564990737 1670317155
17826 file with a text editor and make the following changes
17830 \begin_layout Enumerate
17832 \change_deleted 564990737 1670317155
17833 remove the comment lines before the
17842 \begin_layout Enumerate
17844 \change_deleted 564990737 1670317155
17845 remove everything between (and including) the
17857 commands, except for any commands you specifically put into the \SpecialChar LaTeX
17861 \begin_layout Standard
17863 \change_deleted 564990737 1670317155
17872 \begin_layout Enumerate
17874 \change_deleted 564990737 1670317155
17879 file through \SpecialChar LaTeX
17880 as many times as necessary (usually up to three).
17883 \begin_layout Enumerate
17885 \change_deleted 564990737 1670317155
17891 \begin_inset space \thinspace{}
17895 \begin_inset space \space{}
17902 , and check if everything is OK (it should, if you didn't make any mistake).
17905 \begin_layout Subsection
17907 \change_deleted 564990737 1670317155
17908 \begin_inset Quotes eld
17912 \begin_inset Quotes erd
17915 of the Kluwer package
17916 \begin_inset CommandInset label
17918 name "subsec:kluwer_peculiarities"
17925 \begin_layout Standard
17927 \change_deleted 564990737 1670317155
17928 The Kluwer package has the following
17929 \begin_inset Quotes eld
17933 \begin_inset Quotes erd
17939 \begin_layout Enumerate
17941 \change_deleted 564990737 1670317155
17942 It is possible to write multiple articles in the same \SpecialChar LaTeX
17947 \begin_layout Plain Layout
17948 I can't imagine any good reason to do this.
17954 Each article must be included in the environment
17955 \begin_inset Quotes eld
17959 \begin_inset Quotes erd
17963 Unfortunately, this environment cannot be omitted, even if you write just
17965 Therefore, each article starts with the command
17971 and, obviously, ends with the command
17978 Although this can be implemented in \SpecialChar LyX
17979 , I didn't included it, since it looks
17980 ugly and can confuse the novice user.
17981 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
17984 \begin_inset Quotes eld
17989 \begin_inset Quotes erd
17995 \begin_layout Enumerate
17997 \change_deleted 564990737 1670317155
17998 Information given at the beginning of the article (i.
17999 \begin_inset space \thinspace{}
18003 \begin_inset space \space{}
18006 title, subtitle, author, institution, running title, running author, abstract
18007 and keywords) must be included in an environment called
18008 \begin_inset Quotes eld
18012 \begin_inset Quotes erd
18016 This is not implemented in \SpecialChar LyX
18017 , so you must enter title, subtitle etc.
18018 \begin_inset space ~
18021 between two \SpecialChar TeX
18037 \begin_layout Enumerate
18039 \change_deleted 564990737 1670317155
18040 According to the user manual, the label of each bibliography item must be
18064 \begin_layout Standard
18066 \change_deleted 564990737 1670317155
18071 template takes care of all these
18072 \begin_inset Quotes eld
18076 \begin_inset Quotes erd
18080 If you start a new paper using this template you don't need to do anything
18085 \begin_layout Enumerate
18087 \change_deleted 564990737 1670317155
18088 don't delete the \SpecialChar TeX
18089 code included in the template, and
18092 \begin_layout Enumerate
18094 \change_deleted 564990737 1670317155
18095 copy the example bibliography item included in the template and modify it
18096 as necessary to enter new bibliography items.
18099 \begin_layout Section
18103 \begin_layout Standard
18108 provides an alternative to the standard
18113 It provides similar functionality, but you might prefer this layout with
18114 sans serif sections, headings, and more.
18117 \begin_layout Section
18118 Springer Journals (
18125 \begin_layout Standard
18131 \begin_layout Subsection
18135 \begin_layout Standard
18136 These are the layout files for some of the journal formats used by Springer
18137 Verlag and listed on
18138 \begin_inset Flex URL
18141 \begin_layout Plain Layout
18143 http://www.springer.de/author/tex/help-journals.html
18148 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
18150 It is a modular system: the things common to all journals are implemented
18155 , which journal-specific layout files (such as, e.
18156 \begin_inset space \thinspace{}
18160 \begin_inset space \space{}
18167 for Journal of Geodesy) can include.
18170 \begin_layout Standard
18171 This means that implementing support for any other Springer journal on this
18172 list is as simple as writing your own
18180 file following the outline given in
18188 \begin_layout Standard
18189 It is reasonably well tested only for the Journal of Geodesy.
18198 come with the standard \SpecialChar LyX
18200 Install the relevant class file (downloaded from Springer) in a proper
18201 directory, reconfigure \SpecialChar LaTeX
18202 (in the te\SpecialChar TeX
18207 , as root if necessary — doesn't \SpecialChar LyX
18208 take care of this?), reconfigure \SpecialChar LyX
18213 \begin_layout Subsection
18217 \begin_layout Standard
18218 A large number of theorem-like styles —
18230 \begin_layout Standard
18233 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
18234 _Title, Author_Running, Institute,
18235 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
18238 See the Springer class file documentation for details.
18241 \begin_layout Subsection
18245 \begin_layout Itemize
18257 \begin_layout Itemize
18260 Probability Theory and Related Fields
18266 — Jean-Marc Lasgouttes
18269 \begin_layout Standard
18270 Add your own, it isn't so hard!
18273 \begin_layout Subsection
18277 \begin_layout Standard
18278 These files are partly based on the older
18282 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
18284 file from Springer.
18289 layout, are now defunct.
18290 Jean-Marc Lasgouttes helped out big in making me find my way around the
18292 layout file mechanism.
18295 \begin_layout Subsection
18299 \begin_layout Standard
18301 But probably less than in the old hacked-\SpecialChar LaTeX
18309 \begin_layout Section
18312 Sli\SpecialChar TeX
18316 \begin_inset CommandInset label
18325 \begin_layout Standard
18333 \begin_layout Subsection
18337 \begin_layout Standard
18338 This section describes how to use \SpecialChar LyX
18339 to make slides for overhead projectors.
18340 There are two document classes that can do this: the default slides class
18343 Foil\SpecialChar TeX
18347 This section documents the former.
18350 \begin_layout Standard
18351 I'm going to say this again, nice and clear, so that there's no misunderstanding
18355 \begin_layout Standard
18356 \begin_inset VSpace bigskip
18362 \begin_layout Standard
18366 This section documents the class
18367 \begin_inset Quotes eld
18375 \begin_inset Quotes erd
18383 \begin_layout Standard
18384 \begin_inset VSpace bigskip
18390 \begin_layout Standard
18391 If you're looking for the documentation for
18392 \begin_inset Quotes eld
18397 slides (Foil\SpecialChar TeX
18401 \begin_inset Quotes erd
18404 , check out section
18405 \begin_inset space ~
18409 \begin_inset CommandInset ref
18411 reference "sec:foiltex"
18421 \begin_inset Quotes eld
18426 slides (Foil\SpecialChar TeX
18430 \begin_inset Quotes erd
18433 ] is actually somewhat better than the default
18441 \begin_layout Plain Layout
18443 or so I've been told repeatedly by its advocates.
18444 Having never used it, I have no idea if this claim is true or not.
18449 which this section documents.
18452 \begin_layout Standard
18453 This class is the \SpecialChar LaTeX2e
18454 improvement of the old
18456 Sli\SpecialChar TeX
18460 Every \SpecialChar LaTeX2e
18461 distribution includes this class [which I'll just refer to as
18462 \begin_inset Quotes eld
18470 \begin_inset Quotes erd
18473 from now on], so you're bound to have it.
18474 As I noted earlier, there are other classes, such as
18478 , which also produce slides for overhead projectors and do a better job
18480 However, there are some things which
18484 can do which the others can't, such as generate overlays.
18485 Read on to learn more!
18488 \begin_layout Subsection
18490 \begin_inset CommandInset label
18492 name "sec:slidesetup"
18499 \begin_layout Standard
18500 Obviously, to use this document class, you need to select
18501 \begin_inset Quotes eld
18509 \begin_inset Quotes erd
18512 from the class list in the
18514 Document\SpecialChar menuseparator
18518 There are some other special things you should know about this class:
18521 \begin_layout Itemize
18522 Don't bother changing the options
18527 They're not supported by the
18534 \begin_layout Itemize
18538 \begin_inset space ~
18543 behaves a bit differently for this class.
18544 The possible choices and what they do are as follows:
18548 \begin_layout Description
18553 The final output contains page numbers in the lower right corner.
18556 \begin_layout Description
18565 , but also prints out any time markers you've put in.
18566 This is the default.
18569 \begin_layout Description
18574 The final output contains no page numbers, time markers, or alignment markers.
18578 \begin_layout Itemize
18583 class has an extra option:
18589 \begin_inset Quotes eld
18597 \begin_inset Quotes erd
18600 in the extra class options.
18604 \begin_layout Standard
18605 Using this options allows you to add time markers to
18611 \begin_inset space ~
18615 \begin_inset CommandInset ref
18617 reference "sec:slideNote"
18625 \begin_layout Standard
18626 You can also use the template file
18627 \begin_inset Quotes eld
18635 \begin_inset Quotes erd
18638 to automatically set up a document to use the
18644 File\SpecialChar menuseparator
18646 \begin_inset space ~
18650 \begin_inset space ~
18655 to open your new document].
18656 The template file also contains some examples of the special paragraph
18657 environments used by this class.
18658 I'll describe those next.
18661 \begin_layout Subsection
18662 Paragraph Environments
18665 \begin_layout Subsubsection
18666 Supported Environments
18669 \begin_layout Standard
18670 The first thing you'll notice when you start up a new
18674 document is the font size and type: it's the equivalent of the size
18675 \begin_inset Quotes eld
18683 \begin_inset Quotes erd
18689 \begin_inset space ~
18695 This is also what's used in the output.
18697 \begin_inset Quotes eld
18701 \begin_inset Quotes erd
18704 to remind you that this is a slide.
18705 Your final slides will use a larger font; ergo, you'll have less space.
18706 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
18709 \begin_layout Standard
18710 The next thing that becomes obvious is the changes to the paragraph environment
18711 pull-down box [at the far-left end of the toolbar].
18712 Most of the paragraph environments you're used to seeing are missing.
18713 There are also five new ones.
18718 class itself only supports certain paragraph environments:
18721 \begin_layout Itemize
18727 \begin_layout Itemize
18733 \begin_layout Itemize
18739 \begin_layout Itemize
18745 \begin_layout Itemize
18751 \begin_layout Itemize
18757 \begin_layout Itemize
18763 \begin_layout Itemize
18769 \begin_layout Itemize
18775 \begin_layout Itemize
18782 \begin_layout Standard
18783 All of the other standard environments, including the section-heading environmen
18784 ts, aren't used in the
18791 \begin_layout Standard
18792 On the other hand, you'll notice the following new environments:
18795 \begin_layout Itemize
18801 \begin_layout Itemize
18807 \begin_layout Itemize
18813 \begin_layout Itemize
18819 \begin_layout Itemize
18825 \begin_layout Standard
18826 These five are kind of quirky, due to a
18827 \begin_inset Quotes eld
18831 \begin_inset Quotes erd
18834 in \SpecialChar LyX
18836 You see, \SpecialChar LyX
18837 doesn't permit you to nest any other paragraph environment into
18838 an empty environment.
18839 Now, that's fine and dandy, but it means that you wouldn't be able to start
18840 a slide with anything except plain text.
18841 To deal with this, I've performed a little
18842 \begin_inset Quotes eld
18847 \begin_inset Quotes erd
18853 \begin_layout Subsubsection
18854 Quirks of the New Environments
18855 \begin_inset CommandInset label
18857 name "sec:slideQuirk"
18864 \begin_layout Standard
18865 All five of the new paragraph environments are somewhat quirky due to inherent
18866 limitiations in the current version of \SpecialChar LyX
18868 As I just mentioned, \SpecialChar LyX
18869 forbids environments that begin with another environment.
18870 To get around this, the
18874 environment isn't a paragraph environment as described in the
18882 \begin_layout Standard
18883 You should consider
18896 \begin_inset Quotes eld
18899 pseudo-environments.
18900 \begin_inset Quotes erd
18903 They look like a section heading or a
18904 \begin_inset Quotes eld
18912 \begin_inset Quotes erd
18915 but really begin a [and, if necessary, end the previous] paragraph environment.
18925 \begin_inset Quotes eld
18929 \begin_inset Quotes erd
18932 These two perform some action.
18935 \begin_layout Standard
18936 A common feature of all five environments,
18956 , is a rather long-ish label.
18957 The text following this label — ordinarily the contents of the paragraph
18958 environment — is utterly irrelevant for
18980 completely ignores it.
18981 In fact, you can leave these five environments completely empty.
18985 \begin_layout Standard
18990 to put any text after the rather long-ish label, you might want to.
18991 This could be a short description of the contents of the
18996 In that case, enter your descriptive comment and hit
19000 as you normally would.
19003 \begin_layout Standard
19004 If, on the other hand, you don't want to enter any descriptive text, you'll
19005 hit another \SpecialChar LyX
19008 , like nature, abhors a vacuum, and will not let you start a new paragraph
19009 environment until you put something in the old one.
19013 \begin_layout Itemize
19014 Start entering the text that will
19042 \begin_layout Itemize
19043 Now move to the beginning of that paragraph.
19047 \begin_layout Itemize
19056 \begin_layout Itemize
19057 Finally, change this new, empty paragraph to a
19081 \begin_layout Standard
19082 Some future version of \SpecialChar LyX
19083 will, hopefully, resolve this quirkiness\SpecialChar ldots
19087 \begin_layout Subsection
19088 Making a Presentation with
19101 \begin_layout Subsubsection
19109 \begin_layout Standard
19110 If you're expecting this section to teach you how to actually make a presentatio
19111 n, you'll be sorely disappointed.
19112 Naturally, I'll describe all of the ways the
19116 class can assist you in preparing the materials for a presentation.
19117 Filling in the contents, however, is up to you.
19122 the \SpecialChar LyX
19126 \begin_layout Standard
19131 environment [in the manner described in section
19132 \begin_inset space ~
19136 \begin_inset CommandInset ref
19138 reference "sec:slideQuirk"
19142 ] tells \SpecialChar LyX
19143 to begin a new slide [duh].
19144 The label for this environment/
19145 \begin_inset Quotes erd
19149 \begin_inset Quotes erd
19153 \begin_inset Quotes eld
19157 \begin_inset Quotes erd
19160 in cool blue, followed by the label,
19161 \begin_inset Quotes eld
19165 \begin_inset Quotes erd
19169 Any text or paragraph environments that follow this one go on the new slide.
19173 \begin_layout Standard
19174 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
19176 (this can be specified in the
19181 In fact, you'll want to, once you finish entering the contents of one slide.
19182 If you've entered more text than can physically fit on a slide, the extra
19183 overflows onto a new slide.
19184 I don't recommend doing this, however, since the overflow slide won't have
19185 any page number on it.
19186 Furthermore, it may interfere with any
19190 you've made to accompany the oversized
19197 \begin_layout Standard
19206 environments work the same way as the
19211 They both create an
19212 \begin_inset Quotes eld
19216 \begin_inset Quotes erd
19219 followed by a label [
19220 \begin_inset Quotes eld
19224 \begin_inset Quotes erd
19228 \begin_inset Quotes eld
19232 \begin_inset Quotes erd
19236 The color is a stunning magenta instead of blue, and the
19237 \begin_inset Quotes eld
19241 \begin_inset Quotes erd
19244 will look different, in style and in length.
19245 The label fonts of all three also differ from one another.
19248 \begin_layout Standard
19253 , if the contents of a
19261 exceed the physical size of a slide or sheet of paper, the extra will overflow
19263 Again, you should avoid this.
19264 It defeats the whole purpose of
19275 \begin_layout Subsubsection
19285 \begin_layout Standard
19290 is a slide that sits atop another slide.
19291 Perhaps you wish to discuss a figure on the main
19295 before displaying the text associated with it.
19296 One way to accomplish this is tape a flap of dark paper over the part of
19301 you want to display later.
19302 This method fails, however, if you wish to overlap one graph with another,
19304 You would then have to fumble while speaking to align the two separate,
19309 s to align the two graphs.
19314 environment in both cases makes life much easier.
19317 \begin_layout Standard
19322 receives the page number of its
19323 \begin_inset Quotes eld
19327 \begin_inset Quotes erd
19335 \begin_inset Quotes eld
19343 \begin_inset Quotes erd
19350 \begin_layout Plain Layout
19351 Presumably, mutliple
19356 \begin_inset Quotes eld
19364 \begin_inset Quotes erd
19368 \begin_inset Quotes eld
19376 \begin_inset Quotes erd
19380 \begin_inset Quotes eld
19388 \begin_inset Quotes erd
19392 \begin_inset space ~
19395 appended to the page number of the parent
19405 Clearly, you want the contents of both the
19413 to each fit on a single physical slide! You should probably consider an
19419 \begin_inset Quotes eld
19423 \begin_inset Quotes erd
19431 Indeed, the \SpecialChar LyX
19436 class provides a visual cue for this: the label at the start of an
19440 is shorter than that at the start of a
19445 Lastly, when you generate printable output, you'll find alignment markers
19446 in all four corners of both the
19450 page and its parent
19455 These will assist you in lining up the two physical slides.
19458 \begin_layout Standard
19459 The major problem in overlaying two slides is aligning the contents of the
19460 two transparencies.
19461 How much space should you leave for that graph on the second slide? Worse
19462 still, what if you want a graph and a sentence on second slide, but there
19463 is text on the main transparency that goes in between them? You could try
19464 and insert vertical space of the right size.
19465 The better way is to use
19476 \begin_layout Standard
19477 As their names imply,
19485 are two command-like paragraph environments that make all subsequent text
19486 invisible and visible, respectively.
19488 \begin_inset space ~
19492 \begin_inset CommandInset ref
19494 reference "sec:slideQuirk"
19498 that you don't place anything
19502 these two environments, however.
19507 , it inserts a centered, sky-blue label into the page reading
19508 \begin_inset Quotes eld
19511 <Invisible Text Follows>
19512 \begin_inset Quotes erd
19516 For paragraphs following this label, the parts of the
19524 ; it doesn't matter which] where they would be contain instead blank space.
19528 \begin_layout Standard
19533 , the corresponding centered label is
19534 \begin_inset Quotes eld
19537 <Visible Text Follows>
19538 \begin_inset Quotes erd
19542 Paragraphs following this label behave normally.
19543 Note that the beginning of a new
19555 automatically shuts off an
19560 It's therefore not necessary to use
19571 \begin_layout Standard
19572 By now, it should be obvious how to create overlay transparencies using
19573 the proper combination of
19592 \begin_layout Enumerate
19597 , including everything that will appear on it, whether on the main slide
19605 \begin_layout Enumerate
19606 Before each figure or paragraph that will appear only on the
19615 If necessary, insert a
19619 environment after the
19626 \begin_layout Enumerate
19631 immediately following the
19638 \begin_layout Enumerate
19639 Copy the contents of this
19650 \begin_layout Enumerate
19655 , change all of the
19666 \begin_layout Standard
19668 You've just made an
19675 \begin_layout Standard
19676 There's one problem with the way I've designed the \SpecialChar LyX
19681 class: you can't make text in the middle of a paragraph invisible, nor
19682 make text in the middle of an invisible paragraph visible again.
19683 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
19688 \begin_layout Plain Layout
19689 The commands of interest are:
19692 \begin_layout Itemize
19697 invisible \SpecialChar ldots
19701 \begin_layout Itemize
19706 visible \SpecialChar ldots
19710 \begin_layout Plain Layout
19712 and need to be marked as \SpecialChar TeX
19715 \begin_inset Quotes eld
19719 \begin_inset Quotes erd
19722 you wish to change goes in between the brackets [and after the
19735 If you don't know how to mark text as \SpecialChar TeX
19736 , see the appropriate section of
19749 \begin_layout Subsubsection
19759 \begin_inset CommandInset label
19761 name "sec:slideNote"
19768 \begin_layout Standard
19777 is associated with a
19778 \begin_inset Quotes eld
19782 \begin_inset Quotes erd
19790 Here, too, the \SpecialChar LyX
19795 class provides visual cues.
19800 is shorter than that of a
19804 [yet longer than that of an
19808 ] and, like the label of an
19812 is shockingly magenta.
19813 Additionally, the printed
19817 has the page number of its
19818 \begin_inset Quotes eld
19822 \begin_inset Quotes erd
19830 \begin_inset Quotes eld
19838 \begin_inset Quotes erd
19842 \begin_inset Quotes eld
19850 \begin_inset Quotes erd
19854 \begin_inset Quotes eld
19862 \begin_inset Quotes erd
19866 You can have multiple
19870 s associated with a single
19882 , you'll probably want to break up long
19886 s so that they fit on a single sheet of paper.
19889 \begin_layout Standard
19894 is obvious: it contains anything additional you might want to say about
19900 It could also be used as a sheet of reminders for a particular
19905 In the case of the latter, you might want to make use of time markers.
19906 Currently, the \SpecialChar LyX
19912 \begin_inset Quotes eld
19916 \begin_inset Quotes erd
19919 support for time markers, a
19921 Sli\SpecialChar TeX
19925 So, you'll have to resort to using the \SpecialChar LaTeX
19929 \begin_layout Standard
19930 To use time markers, you'll need to specify the extra class option
19931 \begin_inset Quotes eld
19939 \begin_inset Quotes erd
19943 \begin_inset space ~
19947 \begin_inset CommandInset ref
19949 reference "sec:slidesetup"
19954 This option turns on timing marks, which will appear in the lower-left-hand
19960 To set what appears in the time marker, you use the \SpecialChar LaTeX
19962 \begin_inset Quotes eld
19972 \begin_inset Quotes erd
19976 \begin_inset Quotes eld
19986 \begin_inset Quotes erd
19990 The arguments of both commands are time measured in seconds.
19992 \begin_inset Quotes eld
20002 \begin_inset Quotes erd
20005 sets the time marker to a given time.
20007 \begin_inset Quotes eld
20017 \begin_inset Quotes erd
20020 increments the time marker by the specified amount.
20021 Using time markers and
20025 s in this fashion, you can remind yourself how much time to spend on a particula
20033 \begin_layout Standard
20034 There's one last feature to describe.
20035 Clearly, you'd like to print out all of your
20043 s on transparencies while printing all of your
20060 with which it is associated.
20061 What's a person to do?
20064 \begin_layout Standard
20065 Luckily, there are two \SpecialChar LaTeX
20066 commands that allow you to select what to print
20068 Both must be placed into the preamble of your document.
20070 \begin_inset Quotes eld
20082 \begin_inset Quotes erd
20085 will cause the output to contain only the
20094 Correspondingly, the command
20095 \begin_inset Quotes eld
20107 \begin_inset Quotes erd
20110 prevents the output of anything but
20115 I'd advise placing both commands in the preamble and initially comment
20117 You can then preview your entire presentation as you write.
20118 When you're done writing, you can then uncomment one of the two to select
20119 what you want to print.
20120 I like to uncomment
20121 \begin_inset Quotes eld
20133 \begin_inset Quotes erd
20136 , print to a file with
20137 \begin_inset Quotes eld
20145 \begin_inset Quotes erd
20148 in its name, comment it back out, then uncomment
20149 \begin_inset Quotes eld
20161 \begin_inset Quotes erd
20165 \begin_inset Quotes eld
20173 \begin_inset Quotes erd
20177 I can then send either file to a printer, loading transparencies or plain
20178 paper as appropriate.
20181 \begin_layout Standard
20182 You can also provide other arguments to the
20183 \begin_inset Quotes eld
20193 \begin_inset Quotes erd
20197 \begin_inset Quotes eld
20207 \begin_inset Quotes erd
20211 See a good \SpecialChar LaTeX
20215 \begin_layout Subsection
20220 Class Template File
20223 \begin_layout Standard
20224 I have also provided a template file,
20225 \begin_inset Quotes eld
20233 \begin_inset Quotes erd
20241 To use it, begin your new presentation with
20243 File\SpecialChar menuseparator
20245 \begin_inset space ~
20249 \begin_inset space ~
20255 Your new \SpecialChar LyX
20256 presentation file will contain an example
20277 additionally contain an example of the use of
20286 Lastly, the preamble will contain:
20289 \begin_layout LyX-Code
20290 % Uncomment to print out only slides and overlays
20293 \begin_layout LyX-Code
20297 \begin_layout LyX-Code
20303 \begin_inset Newline newline
20309 \begin_layout LyX-Code
20310 % Uncomment to print out only notes
20313 \begin_layout LyX-Code
20317 \begin_layout LyX-Code
20325 \begin_layout Standard
20326 One final thing: I created this class to support the \SpecialChar LaTeX2e
20328 \begin_inset Quotes eld
20333 Sli\SpecialChar TeX
20337 \begin_inset Quotes erd
20340 class, one of the built-in \SpecialChar LaTeX2e
20342 Neither I nor the rest of the \SpecialChar LyX
20343 Team endorse or oppose the use of this built-in
20345 It's here if you want it or need it.
20346 There exist other \SpecialChar LaTeX2e
20347 classes for creating presentations, such as the
20352 \begin_inset space ~
20356 \begin_inset CommandInset ref
20358 reference "sec:foiltex"
20363 \begin_inset Quotes eld
20371 \begin_inset Quotes erd
20374 package [present on some \SpecialChar TeX
20376 The latter is not yet supported under \SpecialChar LyX
20381 \begin_layout Plain Layout
20382 Perhaps you can take on the task\SpecialChar ldots
20388 I know nothing about these other classes.
20389 Try them out to see what sort of alternative they provide.
20392 \begin_layout Chapter
20394 Features needing Extra Software
20397 \begin_layout Section
20398 Checking \SpecialChar TeX
20402 \begin_layout Standard
20408 \begin_layout Subsection
20412 \begin_layout Standard
20421 \begin_layout Plain Layout
20426 is not yet available when you are using the \SpecialChar LaTeX
20427 distribution MiK\SpecialChar TeX
20433 , you'll find in the
20440 \begin_inset space ~
20451 \begin_inset Newline newline
20455 \begin_inset CommandInset href
20457 target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
20465 \begin_layout Standard
20468 Chk\SpecialChar TeX
20471 package is a program that was written by
20472 \begin_inset Flex Noun
20475 \begin_layout Plain Layout
20477 \begin_inset space ~
20485 in frustration because some constructs in \SpecialChar LaTeX
20486 are sometimes non-intuitive,
20487 and easy to forget.
20488 The program runs over your \SpecialChar LaTeX
20489 file, checks the integrity of the file, and
20490 flags some common errors.
20491 In other technical words, it is
20495 for \SpecialChar LaTeX
20499 \begin_layout Standard
20500 Well, what is a syntax checker doing in \SpecialChar LyX
20501 which is supposed to produce correct
20503 anyways? The answer is simple: Just as
20507 not only checks the
20511 of C programs, but also does
20515 checks for type-errors,
20517 Chk\SpecialChar TeX
20520 catches some common
20524 errors, in addition to the syntactical ones.
20527 Chk\SpecialChar TeX
20530 is capable of detecting several common errors, such as
20533 \begin_layout Itemize
20534 Ellipsis detection:
20535 \begin_inset Newline newline
20538 Use \SpecialChar ldots
20542 \begin_layout Itemize
20543 No space in front of/after parenthesis:
20544 \begin_inset Newline newline
20550 \begin_layout Itemize
20551 Enforcement of normal space after common abbreviations:
20552 \begin_inset Newline newline
20556 \begin_inset space \thinspace{}
20560 \begin_inset space \space{}
20563 is too wide spacing.
20566 \begin_layout Itemize
20567 Enforcement of end-of-sentence space when the last sentence ends with a
20569 \begin_inset Newline newline
20573 And this is wrong spacing.
20576 \begin_layout Itemize
20577 Space in front of labels and similar commands:
20578 \begin_inset Newline newline
20581 The label should stick right up to the text to avoid falling to a wrong
20584 \begin_inset CommandInset label
20594 \begin_layout Plain Layout
20595 This footnote is in danger of falling off to a wrong page
20600 The label is separated too much.
20603 \begin_layout Itemize
20604 Space in front of references, instead of hard spaces:
20605 \begin_inset Newline newline
20608 If you have bad luck, the text will break right between the referenced text
20609 and reference number, and that's a pity.
20611 \begin_inset CommandInset ref
20613 reference "sec:chktex"
20620 \begin_layout Itemize
20622 \begin_inset Quotes eld
20626 \begin_inset Quotes erd
20630 \begin_inset Formula $\times$
20634 \begin_inset Newline newline
20637 2x2 looks cheap compared to
20638 \begin_inset Formula $2\times2$
20644 \begin_layout Standard
20645 and more \SpecialChar ldots
20646 It is an invaluable tool when you are
20647 \begin_inset Quotes eld
20651 \begin_inset Quotes erd
20654 your document before printing, and you should run it right after the obligatory
20655 spelling check, and before you go fine tuning the typesetting.
20658 \begin_layout Subsection
20662 \begin_layout Standard
20663 If you have the program installed, usage is as simple as choosing
20665 Tools\SpecialChar menuseparator
20667 \begin_inset space ~
20673 This will make \SpecialChar LyX
20674 generate a \SpecialChar LaTeX
20675 file of your document, start
20677 Chk\SpecialChar TeX
20680 to check it, and then make \SpecialChar LyX
20682 \begin_inset Quotes eld
20686 \begin_inset Quotes erd
20689 with the warnings from
20691 Chk\SpecialChar TeX
20694 , if there were any.
20695 The warnings will be placed close to the point of the mistake, and you
20696 can quickly find them by using the
20698 Navigate\SpecialChar menuseparator
20701 menu item, or the shortcut key
20710 Open the error boxes by clicking on them with the mouse, or use the shortcut
20719 bindings, or the corresponding
20728 Read the warning and correct the mistake, if it is a mistake.
20729 If you have trouble understanding what the warning is about, you can safely
20731 Remember that there is a hidden layer between the document on screen and
20732 the technical details in invoking
20734 Chk\SpecialChar TeX
20737 , and this gap can make some warnings seem arcane or just plain silly.
20740 \begin_layout Standard
20741 This document is an excellent testing bed for the feature, and it should
20742 provide quite a few warnings for you to fiddle with.
20743 Since computers are only so smart, expect most of the warnings to be false
20747 \begin_layout Subsection
20748 How to fine tune it
20751 \begin_layout Standard
20752 Sometimes, you'll find that
20754 Chk\SpecialChar TeX
20757 makes more noise than suits your mood.
20758 Then you can choose not to use it, wait until your mood changes, or try
20761 Chk\SpecialChar TeX
20764 to get better along with you.
20767 \begin_layout Standard
20770 Chk\SpecialChar TeX
20777 very configurable and extensible, you should not expect to solve all problems
20780 Chk\SpecialChar TeX
20783 in \SpecialChar LyX
20785 Since \SpecialChar LyX
20786 has to generate a somewhat special \SpecialChar LaTeX
20787 file to be able to match the
20788 line numbers from the
20790 Chk\SpecialChar TeX
20797 \begin_layout Plain Layout
20798 You can inspect the specific output from
20804 Document\SpecialChar menuseparator
20807 \begin_inset space ~
20821 to the internal document structure, some of the warnings will not appear
20823 There are two things you can do about this:
20826 \begin_layout Itemize
20829 Chk\SpecialChar TeX
20832 invocation command line in
20833 \begin_inset Flex Noun
20836 \begin_layout Plain Layout
20837 Tools\SpecialChar menuseparator
20838 Preferences\SpecialChar menuseparator
20839 Output\SpecialChar menuseparator
20840 LaTeX\SpecialChar menuseparator
20848 Chk\SpecialChar TeX
20851 installation configuration file (usually with the file
20856 See below to learn what warnings can be enabled and disabled on the command
20860 \begin_layout Itemize
20861 Export your document as a raw \SpecialChar LaTeX
20864 File\SpecialChar menuseparator
20865 Export\SpecialChar menuseparator
20874 Invoked in this way, it can be a hassle to find the corresponding place
20875 in the document inside \SpecialChar LyX
20876 , but with a little patience, you should be able
20880 \begin_layout Standard
20881 Here follows the warning messages that can be enabled and disabled in
20890 to disable a warning, and
20894 to enable a warning.
20895 The emphasized entries are disabled by default, because the default is
20898 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
20903 \begin_layout Standard
20904 Notice that you should only use the options that enable and disable warnings,
20905 because \SpecialChar LyX
20906 relies on some of the other command line parameters to be set
20907 in a specific way to have a chance to communicate with
20914 \begin_layout Enumerate
20918 Command terminated with space.
20921 \begin_layout Enumerate
20924 Non-breaking space (
20925 \begin_inset Quotes eld
20933 \begin_inset Quotes erd
20936 ) should have been used.
20939 \begin_layout Enumerate
20943 You should enclose the previous parenthesis with
20944 \begin_inset Quotes eld
20952 \begin_inset Quotes erd
20958 \begin_layout Enumerate
20961 Italic correction (
20962 \begin_inset Quotes eld
20972 \begin_inset Quotes erd
20975 ) found in non-italic buffer.
20978 \begin_layout Enumerate
20981 Italic correction (
20982 \begin_inset Quotes eld
20992 \begin_inset Quotes erd
20995 ) found more than once.
20998 \begin_layout Enumerate
21002 No italic correction (
21003 \begin_inset Quotes eld
21013 \begin_inset Quotes erd
21019 \begin_layout Enumerate
21023 \begin_inset Quotes eld
21031 \begin_inset Quotes erd
21035 \begin_inset Quotes eld
21043 \begin_inset Quotes erd
21049 \begin_layout Enumerate
21052 Wrong length of dash may have been used.
21055 \begin_layout Enumerate
21059 \begin_inset Quotes eld
21067 \begin_inset Quotes erd
21071 \begin_inset Quotes eld
21079 \begin_inset Quotes erd
21085 \begin_layout Enumerate
21089 \begin_inset Quotes eld
21097 \begin_inset Quotes erd
21103 \begin_layout Enumerate
21107 \begin_inset Quotes eld
21115 \begin_inset Quotes erd
21118 to achieve an ellipsis.
21121 \begin_layout Enumerate
21124 Inter-word spacing (
21125 \begin_inset Quotes eld
21135 \begin_inset Quotes eld
21138 ) should perhaps be used.
21141 \begin_layout Enumerate
21144 Inter-sentence spacing (
21145 \begin_inset Quotes eld
21155 \begin_inset Quotes erd
21158 ) should perhaps be used.
21161 \begin_layout Enumerate
21164 Could not find argument for command.
21167 \begin_layout Enumerate
21171 \begin_inset Quotes eld
21179 \begin_inset Quotes erd
21185 \begin_layout Enumerate
21188 Math mode still on at end of \SpecialChar LaTeX
21192 \begin_layout Enumerate
21196 \begin_inset Quotes eld
21204 \begin_inset Quotes erd
21207 doesn't match the number of
21208 \begin_inset Quotes eld
21216 \begin_inset Quotes erd
21222 \begin_layout Enumerate
21225 You should use either
21228 \begin_inset Quotes eld
21236 \begin_inset Quotes erd
21241 as an alternative to
21242 \begin_inset Quotes eld
21250 \begin_inset Quotes erd
21256 \begin_layout Enumerate
21263 " (ASCII 39) instead of "
21270 \begin_layout Enumerate
21273 User-specified pattern found.
21276 \begin_layout Enumerate
21279 This command might not be intended.
21282 \begin_layout Enumerate
21289 \begin_layout Enumerate
21307 \begin_layout Enumerate
21310 Delete this space to maintain correct page references.
21313 \begin_layout Enumerate
21317 You might wish to put this between a pair of
21318 \begin_inset Quotes eld
21326 \begin_inset Quotes erd
21332 \begin_layout Enumerate
21335 You ought to remove spaces in front of punctuation.
21338 \begin_layout Enumerate
21341 Could not execute \SpecialChar LaTeX
21345 \begin_layout Enumerate
21354 in front of small punctuation.
21357 \begin_layout Enumerate
21365 may look prettier here.
21368 \begin_layout Enumerate
21372 Multiple spaces detected in output.
21375 \begin_layout Enumerate
21378 This text may be ignored.
21381 \begin_layout Enumerate
21387 \begin_inset Quotes eld
21392 to begin quotation, not
21399 \begin_layout Enumerate
21406 to end quotation, not
21409 \begin_inset Quotes eld
21417 \begin_layout Enumerate
21423 \begin_layout Enumerate
21426 You should perhaps use
21427 \begin_inset Quotes eld
21435 \begin_inset Quotes erd
21441 \begin_layout Enumerate
21444 You should put a space in front of/after parenthesis.
21447 \begin_layout Enumerate
21450 You should avoid spaces in front of/after parenthesis.
21453 \begin_layout Enumerate
21457 You should not use punctuation in front of/after quotes.
21460 \begin_layout Enumerate
21463 Double space found.
21466 \begin_layout Enumerate
21469 You should put punctuation outside inner/inside display math mode.
21472 \begin_layout Enumerate
21475 You ought to not use primitive \SpecialChar TeX
21476 in \SpecialChar LaTeX
21480 \begin_layout Enumerate
21483 You should remove spaces in front of
21484 \begin_inset Quotes eld
21492 \begin_inset Quotes erd
21498 \begin_layout Enumerate
21501 \begin_inset Quotes eld
21509 \begin_inset Quotes erd
21512 is normally not followed by
21513 \begin_inset Quotes eld
21521 \begin_inset Quotes erd
21527 \begin_layout Standard
21528 In later versions of \SpecialChar LyX
21529 , we hope to provide a more complete interface to this
21530 tool (and it's smaller cousin
21534 ) to exploit the full power of it.
21535 But it's not exactly useless as it is now: go try it on one of your existing
21536 documents of a certain length and be surprised.
21539 \begin_layout Section
21540 Version Control in \SpecialChar LyX
21544 \begin_layout Standard
21547 Lars Gullik Bjønnes
21554 \begin_layout Subsection
21558 \begin_layout Standard
21560 supports some of the most basic RCS/CVS/SVN/GIT commands.
21561 If you need something a bit more sophisticated you will have to do that
21562 manually in a terminal.
21565 \begin_layout Standard
21566 Also note that CVS support is not as good as subversion support, so we advise
21568 A good place to start learning Subversion is the SVN Book
21572 \begin_layout Plain Layout
21573 \begin_inset CommandInset href
21575 target "http://svnbook.red-bean.com/"
21586 In the case of RCS you should read
21587 \begin_inset Quotes eld
21591 \begin_inset Quotes erd
21594 (a man file, read it with
21599 This file describes all the basic features of RCS.
21600 You should especially notice the comment about a RCS directory, and the
21601 notion of a master RCS file (the file ending in
21608 \begin_layout Standard
21609 Before you begin to use the version control features in \SpecialChar LyX
21611 familiar with RCS/CVS/SVN/GIT usage.
21612 The implementation in \SpecialChar LyX
21613 assumes a recent version of the GNU RCS or CVS/SVN
21614 package — no guarantees are made for older versions.
21615 Most of the log messages are not currently displayed after operations —
21616 you can check them in the Messages pane if you are unsure.
21617 Regular users of version control will appreciate the VC toolbar, which
21620 View\SpecialChar menuseparator
21621 Toolbars\SpecialChar menuseparator
21623 \begin_inset space ~
21631 \begin_layout Standard
21632 For introducing your own external commands consult
21633 \begin_inset Flex Code
21636 \begin_layout Plain Layout
21650 \begin_layout Standard
21651 It is strongly recommended to store documents in uncompressed format if
21652 using version control (uncheck
21654 Document\SpecialChar menuseparator
21657 if it is checked): Uncompressed LyX documents are text files and therefore
21658 for merging two different versions by version control systems.
21659 Compressed LyX documents are binary files, which cannot be merged by version
21663 \begin_layout Subsection
21664 RCS commands in \SpecialChar LyX
21668 \begin_layout Standard
21669 The following sections describe the RCS commands supported by \SpecialChar LyX
21671 You can find them in the
21673 File\SpecialChar menuseparator
21675 \begin_inset space ~
21682 was tested against RCS 5.7/5.8.
21685 \begin_layout Subsubsection
21691 \begin_layout Standard
21692 If your document is not under revision control, this is the only item shown
21694 And if it is under revision control, the
21698 item is not visible.
21702 \begin_layout Standard
21703 This command registers your document with RCS (unless you are under the
21704 directory managed by CVS)\SpecialChar endofsentence
21705 You are asked interactively to supply an initial
21706 description of the document.
21707 The document is now set in Read-Only mode and you have to
21710 \begin_inset space ~
21714 \begin_inset space ~
21718 \begin_inset space ~
21723 , before making any changes to it.
21724 A document under revision control has a
21725 \begin_inset Quotes eld
21728 [RCS:<version> <locker>]
21729 \begin_inset Quotes erd
21732 item tagged to the filename in the minibuffer.
21735 \begin_layout Standard
21736 RCS command that is run:
21739 \begin_layout LyX-Code
21742 ci -q -u -i -t-"<initial description>" <file-name>
21745 \begin_layout Standard
21750 to understand the switches.
21754 \begin_layout Subsubsection
21760 \begin_layout Standard
21761 When you are finished editing a file, you check in your changes.
21762 When you do this, you are asked for a description of the changes.
21763 This is stored in the history log.
21764 The version number is bumped, your changes are applied to the master RCS
21765 file, the document is unlocked and set to Read-Only mode.
21768 \begin_layout Itemize
21771 ci -q -u -m"<description>" <file-name>
21774 \begin_layout Subsubsection
21780 \begin_layout Standard
21781 By doing this you lock the document so that only you can edit it.
21782 This will also make the document Read-Write only for you.
21783 You will usually continue editing for a while and when you are finished
21784 you check in your changes.
21785 The status line is changed to reflect that you have locked the file.
21788 \begin_layout Itemize
21791 co -q -l <file-name>
21794 \begin_layout Subsubsection
21797 Revert To Repository Version
21800 \begin_layout Standard
21801 This will discard all changes made to the document since the last check
21803 You get a warning before changes are discarded.
21806 \begin_layout Itemize
21809 co -f -u<version> <file-name>
21812 \begin_layout Subsubsection
21818 \begin_layout Standard
21819 This will create a copy of the current document.
21820 Since RCS does not support copy operations natively, the version history
21821 is not preserved, and the copy is added as a new file.
21822 It requires a clean document without any changes since the last checkin.
21823 You are asked for a file name and a description of the copy operation.
21824 After that the copy is created, both locally and in the repository.
21825 If the parent directories of the copied and original document differ, all
21826 relative paths of included files of the copy are adjusted (like in
21828 File\SpecialChar menuseparator
21833 Finally, the copy is loaded instead of the original document.
21836 \begin_layout Labeling
21837 \labelwidthstring 00.00.0000
21839 \begin_inset space ~
21843 \begin_inset space ~
21847 \begin_inset Newline newline
21851 \begin_inset Flex Code
21854 \begin_layout Plain Layout
21857 \begin_inset Quotes qld
21861 \begin_inset Quotes qld
21870 \begin_inset Flex Code
21873 \begin_layout Plain Layout
21876 \begin_inset Quotes qld
21880 \begin_inset Quotes qld
21889 \begin_inset Newline newline
21893 \begin_inset Flex Code
21896 \begin_layout Plain Layout
21900 \begin_inset Quotes qld
21904 \begin_inset Quotes qld
21915 \begin_layout Subsubsection
21921 \begin_layout Standard
21922 This makes as if the last check in never happened.
21923 No changes are made to the document loaded into \SpecialChar LyX
21924 , but the last version
21925 is removed from the master RCS file.
21928 \begin_layout Itemize
21931 rcs -o<version> <file-name>
21934 \begin_layout Subsubsection
21940 \begin_layout Standard
21941 This shows the complete history of the RCS document.
21946 is shown in a browser.
21954 \begin_layout Subsubsection
21958 \begin_layout Standard
21960 supports RCS version number, author name, date and time of last commit.
21961 All those are extracted from
21963 rlog -r <file-name>
21967 \begin_inset CommandInset ref
21969 reference "subsec:VCS-Revision-Information"
21976 \begin_layout Subsection
21977 CVS commands in \SpecialChar LyX
21981 \begin_layout Standard
21982 A subset of CVS operations is supported by \SpecialChar LyX
21984 You can find the commands in the
21986 File\SpecialChar menuseparator
21988 \begin_inset space ~
21994 The version control system SVN is more powerful, so please use it instead
21995 of CVS if possible.
21998 \begin_layout Subsubsection
22004 \begin_layout Standard
22005 If you start from scratch with CVS you have to create your repository and
22006 checkout the working copy with external tools.
22007 If you're using a client-server setup you may need to login before doing
22008 the first repository checkout.
22011 \begin_layout Standard
22012 If your documents are under revision control and others are using the same
22013 repository problems arise when different changes to the same document at
22014 the same location happen.
22015 Standard CVS repositories don't operate with a file locking mechanism.
22016 This may be surprising, but conflicts only occur if people disagree on
22017 the proper content of the same part of a document.
22018 So, if co-workers are used to communicate regularly, these conflicts occur
22020 If they don't communicate they have a fundamental problem anyway.
22021 Nevertheless some people like to work with so called
22022 \begin_inset Quotes eld
22026 \begin_inset Quotes erd
22030 If they do so the working copy of all files is readonly when checked out
22031 first and the user starts editing after using a special command to make
22032 the working copy writable.
22033 When the changes are checked in the working copy returns to readonly state.
22034 With \SpecialChar LyX
22035 one has to edit the
22036 \begin_inset Flex Code
22039 \begin_layout Plain Layout
22045 file and add the line
22046 \begin_inset Flex Code
22049 \begin_layout Plain Layout
22055 to work with reserved checkouts.
22056 The benefit is the possibility to see who is using a writable copy of some
22058 It's not guaranteed only one user makes a copy writable.
22061 \begin_layout Standard
22063 tries to guess if you're using reserved or non-reserved checkouts.
22064 If your working copy is readonly or it is writable and an additional copy
22065 of your document exists in the CVS/Base sub-directory a reserved otherwise
22066 a non-reserved checkout is assumed.
22067 When a reserved checkout is detected you have to use
22068 \begin_inset Flex Noun
22071 \begin_layout Plain Layout
22077 to make your working copy writable if it's readonly.
22079 \begin_inset Flex Noun
22082 \begin_layout Plain Layout
22088 operation is possible and that makes your working copy readonly again after
22089 transferring your changes to the repository.
22092 \begin_layout Standard
22093 More information about CVS can be found here
22094 \begin_inset Flex URL
22097 \begin_layout Plain Layout
22099 http://www.nongnu.org/cvs
22105 \begin_inset Flex URL
22108 \begin_layout Plain Layout
22110 http://ximbiot.com/cvs
22118 \begin_layout Standard
22123 to understand the sub-commands and the switches mentioned below.
22126 \begin_layout Subsubsection
22132 \begin_layout Standard
22133 If your document is not under revision control, this is the only item shown
22135 And if it is under revision control, the
22139 item is not visible.
22143 \begin_layout Standard
22144 This command registers in CVS your document
22145 \begin_inset Flex Strong
22148 \begin_layout Plain Layout
22156 in the case you have already the documents directory under CVS control
22162 This means you have to create or checkout the archive by yourself using
22164 (In case you forget that step \SpecialChar LyX
22165 registers the document with RCS.)
22168 \begin_layout Standard
22169 Then you are asked interactively to supply an initial description of the
22171 Don't forget that registered file is not yet checked in.
22174 \begin_layout Standard
22175 CVS command that is run:
22177 cvs -q add -m"<entered message>" "<file-name>"
22180 \begin_layout Standard
22185 above and for all other CVS commands is an abbreviation for
22186 \begin_inset Quotes eld
22189 change the current working directory to file location and use the file name
22190 without path component as argument
22191 \begin_inset Quotes erd
22197 \begin_layout Subsubsection
22203 \begin_layout Standard
22204 When you are finished editing a file, you commit your changes.
22205 When you do this and you had changed the document, you are asked for a
22206 description of the changes.
22207 After that changes are written to the repository.
22208 In case you didn't change the document and a reserved checkout is detected
22209 the reservation made on
22210 \begin_inset Flex Noun
22213 \begin_layout Plain Layout
22222 \begin_layout Labeling
22223 \labelwidthstring 00.00.0000
22225 \begin_inset space ~
22229 \begin_inset space ~
22233 \begin_inset Newline newline
22237 \begin_inset Flex Code
22240 \begin_layout Plain Layout
22243 -q commit -m"<description>" "<file-name>"
22249 \begin_inset Newline newline
22253 \begin_inset Flex Code
22256 \begin_layout Plain Layout
22267 \begin_layout Subsubsection
22273 \begin_layout Standard
22274 When you are sharing a repository with others, you may have to incorporate
22275 their changes into your working copy.
22278 \begin_layout Standard
22281 cvs -q update "<file-name>"
22284 \begin_layout Standard
22285 If a readonly checkout is detected the working copy is made writable and
22289 \begin_layout Standard
22292 cvs -q edit "<file-name>"
22295 \begin_layout Subsubsection
22298 Revert To Repository Version
22301 \begin_layout Standard
22302 This will discard all changes made to the document since the last check
22304 You get a warning before changes are discarded.
22305 Firstly the file is deleted, secondly CVS update command is run.
22308 \begin_layout Standard
22311 cvs -q update "<file-name>"
22314 \begin_layout Standard
22315 If a reserved checkout is detected and the working copy has no changes only
22316 the reservation is undone.
22319 \begin_layout Standard
22322 cvs -q unedit "<file-name>"
22325 \begin_layout Subsubsection
22331 \begin_layout Standard
22332 This will create a copy of the current document.
22333 Since CVS does not support copy operations natively, the version history
22334 is not preserved, and the copy is added as a new file.
22335 It requires a clean document without any changes since the last checkin.
22336 You are asked for a file name and a description of the copy operation.
22337 After that the copy is created, both locally and in the repository.
22338 If the parent directories of the copied and original document differ, all
22339 relative paths of included files of the copy are adjusted (like in
22341 File\SpecialChar menuseparator
22346 Finally, the copy is loaded instead of the original document.
22349 \begin_layout Labeling
22350 \labelwidthstring 00.00.0000
22352 \begin_inset space ~
22356 \begin_inset space ~
22360 \begin_inset Newline newline
22364 \begin_inset Flex Code
22367 \begin_layout Plain Layout
22374 \begin_inset Flex Code
22377 \begin_layout Plain Layout
22384 \begin_inset Newline newline
22388 \begin_inset Flex Code
22391 \begin_layout Plain Layout
22392 cvs -q add "<new-file-name>"
22400 \begin_layout Subsubsection
22406 \begin_layout Standard
22407 This will rename the current document.
22408 Since CVS does not support rename operations natively, the version history
22409 is not preserved, the renamed document is added as a new file, and the
22410 original document is deleted.
22411 It requires a clean document without any changes since the last checkin.
22412 You are asked for a file name and a description of the rename operation.
22413 After that the document is renamed, both locally and in the repository.
22414 If the parent directories of the new and old file names differ, all relative
22415 paths of included files are adjusted (like in
22417 File\SpecialChar menuseparator
22422 Finally, the document is reloaded using the new name.
22425 \begin_layout Labeling
22426 \labelwidthstring 00.00.0000
22428 \begin_inset space ~
22432 \begin_inset space ~
22436 \begin_inset Newline newline
22440 \begin_inset Flex Code
22443 \begin_layout Plain Layout
22450 \begin_inset Flex Code
22453 \begin_layout Plain Layout
22460 \begin_inset Newline newline
22464 \begin_inset Flex Code
22467 \begin_layout Plain Layout
22468 cvs -q add "<new-file-name>"
22474 \begin_inset Newline newline
22478 \begin_inset Flex Code
22481 \begin_layout Plain Layout
22482 cvs -q remove "<file-name>"
22490 \begin_layout Subsubsection
22491 Update of the local directory checkout from repository
22494 \begin_layout Standard
22495 Once your documents gets more complex, containing sub-documents and pictures,
22497 \begin_inset Flex Code
22500 \begin_layout Plain Layout
22506 files and so on using version control becomes more complicated.
22508 supports updating the whole tree in which resides the document.
22509 This become especially useful once you cooperate with people which neither
22510 have detailed knowledge about CVS usage nor they have ambition to commit
22511 additional material to the repository.
22512 You have to organize the files structure so that all external files are
22513 in the same directory or subdirectories of the document.
22514 It's good practice anyway to store multipart documents in an extra directory.
22517 \begin_layout Standard
22519 \begin_inset Flex Code
22522 \begin_layout Plain Layout
22523 Update local directory from repository
22528 command updates the whole directory.
22529 If local changes are detected user is warned before update starts.
22530 In case of merge conflicts both versions of the conflicting document parts
22531 are placed in the final document.
22532 You have to review and correct the result of the merge.
22533 You'll find the conflicts enclosed in pairs of
22534 \begin_inset Flex Code
22537 \begin_layout Plain Layout
22544 \begin_inset Flex Code
22547 \begin_layout Plain Layout
22554 \begin_inset Flex Code
22557 \begin_layout Plain Layout
22564 The first part is your version as before the update operation with the
22565 document name prepended.
22566 The second one is the repository version with the version number after
22568 \begin_inset Flex Code
22571 \begin_layout Plain Layout
22580 \begin_layout Labeling
22581 \labelwidthstring 00.00.0000
22583 \begin_inset space ~
22587 \begin_inset space ~
22591 \begin_inset Newline newline
22595 \begin_inset Flex Code
22598 \begin_layout Plain Layout
22606 (Ask if changes are detected.)
22607 \begin_inset Newline newline
22611 \begin_inset Flex Code
22614 \begin_layout Plain Layout
22615 cd $path; cvs -q update
22625 \begin_layout Standard
22627 \begin_inset Flex Code
22630 \begin_layout Plain Layout
22636 stands for the path to the document.
22639 \begin_layout Subsubsection
22645 \begin_layout Standard
22646 This shows the complete history of the CVS document.
22649 cvs log "<file-name>"
22651 is shown in a browser.
22654 \begin_layout Subsubsection
22658 \begin_layout Standard
22660 supports CVS version number, author name, date and time of last commit.
22661 All those are extracted from
22663 cvs log -r <file-name>
22667 \begin_inset CommandInset ref
22669 reference "subsec:VCS-Revision-Information"
22676 \begin_layout Subsection
22677 SVN commands in \SpecialChar LyX
22681 \begin_layout Standard
22682 SVN is now partially supported by \SpecialChar LyX
22684 You can find the commands in the
22686 File\SpecialChar menuseparator
22688 \begin_inset space ~
22694 Please note that if you use password protected access to repository via
22695 ssh, you will be asked in terminal window.
22697 was tested against SVN 1.5, 1.6, 1.7 and 1.8
22701 \begin_layout Plain Layout
22702 Most of the commands will work with 1.4 too, see
22703 \begin_inset CommandInset ref
22705 reference "subsec:SVN-Repo-Update"
22710 There seems to be currently unresolved permissions problem under SVN 1.8
22711 with reverting changes when file is locked.
22719 \begin_layout Subsubsection
22725 \begin_layout Standard
22726 If your document is not under revision control, this is the only item shown
22728 And if it is under revision control, the
22732 item is not visible.
22735 \begin_layout Standard
22736 This command registers in SVN your document ONLY in case you have already
22737 the documents directory under SVN control (in particular
22742 This means you have to checkout the archive by yourself.
22745 \begin_layout Standard
22746 Then you are asked interactively to supply an initial description of the
22748 Don't forget that registered file is not yet commited.
22751 \begin_layout Standard
22752 SVN command that is run:
22755 \begin_inset Quotes qld
22759 \begin_inset Quotes qld
22765 \begin_layout Standard
22770 to understand the switches.
22773 \begin_layout Subsubsection
22779 \begin_layout Standard
22780 When you are finished editing a file, you commit your changes.
22781 When you do this, you are asked for a description of the changes.
22782 After that changes are commited.
22785 \begin_layout Standard
22790 \begin_layout Plain Layout
22791 In case locking is not enabled.
22793 \begin_inset CommandInset ref
22795 reference "subsec:SVN-File-Locking"
22806 svn commit -q -m"<description>" <file-name>
22809 \begin_layout Subsubsection
22815 \begin_layout Standard
22816 Updates the changes of this file from the repository.
22817 Be sure you understand SVN merging and conflicts resolving before using
22818 this function, because all conflicts has to be resolved manually by you!
22821 \begin_layout Standard
22826 \begin_layout Plain Layout
22834 svn update --non-interactive
22835 \begin_inset Quotes qld
22839 \begin_inset Quotes qld
22845 \begin_layout Subsubsection
22848 Revert To Repository Version
22851 \begin_layout Standard
22852 This will discard all changes made to the document since the last check
22854 You get a warning before changes are discarded.
22857 \begin_layout Standard
22861 \begin_inset Quotes qld
22865 \begin_inset Quotes qld
22871 \begin_layout Subsubsection
22877 \begin_layout Standard
22878 This will create a copy of the current document including the version history.
22879 It requires a clean document without any changes since the last checkin.
22880 You are asked for a file name and a description of the copy operation.
22881 After that the copy is created, both locally and in the repository.
22882 If the parent directories of the copied and original document differ, all
22883 relative paths of included files of the copy are adjusted (like in
22885 File\SpecialChar menuseparator
22890 Finally, the copy is loaded instead of the original document.
22893 \begin_layout Labeling
22894 \labelwidthstring 00.00.0000
22896 \begin_inset space ~
22900 \begin_inset space ~
22904 \begin_inset Newline newline
22908 \begin_inset Flex Code
22911 \begin_layout Plain Layout
22915 \begin_inset Quotes qld
22919 \begin_inset Quotes qld
22923 \begin_inset Quotes qld
22927 \begin_inset Quotes qld
22936 \begin_inset Newline newline
22940 \begin_inset Flex Code
22943 \begin_layout Plain Layout
22952 \begin_layout Subsubsection
22958 \begin_layout Standard
22959 This will rename the current document including the version history.
22960 It requires a clean document without any changes since the last checkin.
22961 You are asked for a file name and a description of the rename operation.
22962 After that the document is renamed, both locally and in the repository.
22963 If the parent directories of the new and old file names differ, all relative
22964 paths of included files are adjusted (like in
22966 File\SpecialChar menuseparator
22971 Finally, the document is reloaded using the new name.
22974 \begin_layout Labeling
22975 \labelwidthstring 00.00.0000
22977 \begin_inset space ~
22981 \begin_inset space ~
22985 \begin_inset Newline newline
22989 \begin_inset Flex Code
22992 \begin_layout Plain Layout
22996 \begin_inset Quotes qld
23000 \begin_inset Quotes qld
23004 \begin_inset Quotes qld
23008 \begin_inset Quotes qld
23017 \begin_inset Newline newline
23021 \begin_inset Flex Code
23024 \begin_layout Plain Layout
23033 \begin_layout Subsubsection
23034 \begin_inset CommandInset label
23036 name "subsec:SVN-Repo-Update"
23040 Update of the local directory checkout from repository
23044 \begin_layout Plain Layout
23045 Note that this command will work only with subversion
23046 \begin_inset Formula $\geqq1.5$
23057 \begin_layout Standard
23058 All the commands above have one shortcoming – they deal with the current
23060 Once your document contains pictures, includes external
23061 \begin_inset Flex Code
23064 \begin_layout Plain Layout
23070 files and so on administration becomes more complicated.
23072 now supports updating the whole tree in which resides the document
23076 \begin_layout Plain Layout
23077 One need to organize the files structure so that all external files are
23078 in the same directory or subdirectories of the document.
23085 This become especially useful once you cooperate with people which neither
23086 know about subversion management nor they have ambition to commit additional
23087 material to the repository.
23091 \begin_layout Standard
23092 \begin_inset Flex Code
23095 \begin_layout Plain Layout
23096 Update local directory from repository
23101 command updates the whole directory and in case of merge conflicts local
23102 version of the files are left, so no unintended data loss occurs.
23103 If local changes are detected user is warned before update starts.
23106 \begin_layout Labeling
23107 \labelwidthstring 00.00.0000
23109 \begin_inset space ~
23113 \begin_inset space ~
23117 \begin_inset Newline newline
23121 \begin_inset Flex Code
23124 \begin_layout Plain Layout
23130 (Ask if changes are detected.)
23131 \begin_inset Newline newline
23135 \begin_inset Flex Code
23138 \begin_layout Plain Layout
23139 svn update --accept mine-full $path
23147 \begin_layout Standard
23149 \begin_inset Flex Code
23152 \begin_layout Plain Layout
23158 stands for the path to the document.
23161 \begin_layout Subsubsection
23167 \begin_layout Standard
23168 This shows the complete history of the SVN document.
23172 \begin_inset Quotes qld
23176 \begin_inset Quotes qld
23181 is shown in a browser.
23184 \begin_layout Subsubsection
23186 \begin_inset CommandInset label
23188 name "subsec:SVN-File-Locking"
23195 \begin_layout Standard
23196 The file exchange through various revision control systems brings the problem
23197 of merge conflicts in case two different users try to edit the same (parts
23199 When such a conflict happens it needs manual resolving and one reasonable
23200 alternative is to provide some kind of locking mechanism, which guarantees
23201 that only one user is allowed to edit file at the given time.
23204 \begin_layout Standard
23205 SVN has two such mechanisms to provide mutual exclusivity for file access
23206 – locks and automatic setting of write permissions (see sec.
23208 \begin_inset CommandInset ref
23210 reference "subsec:Automatical-Locking-Property"
23215 \begin_inset Flex Code
23218 \begin_layout Plain Layout
23228 \begin_layout Plain Layout
23229 \begin_inset Flex URL
23232 \begin_layout Plain Layout
23234 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
23245 If this property is detected for a given document \SpecialChar LyX
23246 starts to use SVN locks
23247 for document editing automatically and the whole check-in/out mechanism
23248 switches to the same regimen as for RCS.
23249 This in particular means there are two different modes of file use in \SpecialChar LyX
23253 \begin_layout Itemize
23255 The loaded file is in the read-only mode.
23256 For editing on needs to check-out.
23261 consists of updating from the repository and gaining write lock.
23262 If the lock is not possible to obtain, we remain in unlocked state.
23265 \begin_layout Itemize
23267 The loaded file is in the
23268 \begin_inset Quotes els
23272 \begin_inset Quotes ers
23276 No other user is allowed to edit the file.
23281 consists of commiting changes and releasing write-lock.
23282 If no changes have been made to the document, no commit will be produced
23286 \begin_layout Plain Layout
23287 Don't be puzzled by the fact that you will be asked for commit message anyway.
23292 and only the write-lock will be released.
23295 \begin_layout Standard
23299 \begin_layout Labeling
23300 \labelwidthstring 00.00.0000
23303 svn commit -q -m"<description>" "<file-name>"
23304 \begin_inset Newline newline
23307 svn unlock "<file-name>"
23310 \begin_layout Labeling
23311 \labelwidthstring 00.00.0000
23314 svn update "<file-name>"
23315 \begin_inset Newline newline
23318 svn lock "<file-name>"
23321 \begin_layout Subsubsection
23324 \begin_inset CommandInset label
23326 name "subsec:Automatical-Locking-Property"
23332 Automatic Locking Property
23335 \begin_layout Standard
23336 The above mentioned automatic setting of write permissions of the .lyx file
23339 File\SpecialChar menuseparator
23341 \begin_inset space ~
23344 Control\SpecialChar menuseparator
23345 Use Locking Property
23348 This command is active only when the file is not locked on the svn server
23350 you need to check-out before proceeding).
23353 \begin_layout Labeling
23354 \labelwidthstring 00.00.0000
23356 \begin_inset space ~
23362 \begin_layout Labeling
23363 \labelwidthstring 00.00.0000
23366 svn propset svn:needs-lock ON "<file-name>"
23369 \begin_layout Labeling
23370 \labelwidthstring 00.00.0000
23373 svn propdel svn:needs-lock "<file-name>"
23376 \begin_layout Subsubsection
23377 \begin_inset CommandInset label
23379 name "subsec:VCS-Revision-Information"
23383 Revision Information in Documents
23386 \begin_layout Standard
23387 There are more possibilities how to activate revision information in our
23391 \begin_layout Itemize
23397 \begin_layout Itemize
23398 tree revision information (
23399 \begin_inset Flex Code
23402 \begin_layout Plain Layout
23409 The result is the output of the
23410 \begin_inset Flex Code
23413 \begin_layout Plain Layout
23419 command, the following table gives you an idea, how to read the results.
23422 \begin_layout Standard
23424 \begin_inset Tabular
23425 <lyxtabular version="3" rows="6" columns="2">
23426 <features tabularvalignment="middle">
23427 <column alignment="left" valignment="top">
23428 <column alignment="left" valignment="top">
23430 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
23433 \begin_layout Plain Layout
23441 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
23444 \begin_layout Plain Layout
23454 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
23457 \begin_layout Plain Layout
23463 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
23466 \begin_layout Plain Layout
23467 mixed revision working copy
23474 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
23477 \begin_layout Plain Layout
23483 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
23486 \begin_layout Plain Layout
23487 modified working copy
23494 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
23497 \begin_layout Plain Layout
23503 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
23506 \begin_layout Plain Layout
23507 switched working copy
23514 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
23517 \begin_layout Plain Layout
23523 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
23526 \begin_layout Plain Layout
23527 partial working copy, from a sparse checkout
23534 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
23537 \begin_layout Plain Layout
23543 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
23546 \begin_layout Plain Layout
23547 mixed revision, modified, switched working copy
23560 \begin_layout Itemize
23561 file revision information.
23562 The result comes from parsing the output of
23563 \begin_inset Flex Code
23566 \begin_layout Plain Layout
23568 \begin_inset space ~
23572 \begin_inset space ~
23576 \begin_inset space ~
23585 Supported flags are:
23589 \begin_layout Itemize
23590 version number of the last commit (
23591 \begin_inset Flex Code
23594 \begin_layout Plain Layout
23603 \begin_layout Itemize
23604 author of the last commit (
23605 \begin_inset Flex Code
23608 \begin_layout Plain Layout
23617 \begin_layout Itemize
23618 date of the last commit (
23619 \begin_inset Flex Code
23622 \begin_layout Plain Layout
23631 \begin_layout Itemize
23632 time of the last commit (
23633 \begin_inset Flex Code
23636 \begin_layout Plain Layout
23646 \begin_layout Standard
23647 You can obtain this info via InsetInfo (
23648 \change_inserted 5863208 1564400022
23651 Insert\SpecialChar menuseparator
23652 Field\SpecialChar menuseparator
23653 Version Control Revision
23654 \change_deleted 5863208 1564399852
23659 \begin_inset Flex Code
23662 \begin_layout Plain Layout
23663 info-insert buffer vcs-date
23671 The information will be available only when you have the file stored under
23672 svn managment (i.e.
23674 \begin_inset Flex Code
23677 \begin_layout Plain Layout
23683 directory is available with your document).
23687 \begin_layout Itemize
23688 Another—a hacking one—possibility is to use svn keywords
23692 \begin_layout Plain Layout
23693 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
23699 In short – you set file keywords property (e.g.
23702 svn propset svn:keywords 'Rev' file.lyx
23704 ) and then paste keyword \SpecialChar TeX
23709 \begin_layout Plain Layout
23710 This is an easy way how to ensure that \SpecialChar LyX
23711 won't break the line in the middle
23717 tag in your document (e.g.
23719 \begin_inset Flex Code
23722 \begin_layout Plain Layout
23729 This way svn client will automatically substitute revision number (e.g.
23731 \begin_inset Flex Code
23734 \begin_layout Plain Layout
23740 ) after each update and commit.
23741 There are more problems with this approach.
23742 Firstly, the '$' character is used in \SpecialChar TeX
23743 world for math equations, so any
23744 occurence of math formula
23745 \begin_inset Formula $Rev$
23749 \begin_inset Formula $Rev:59$
23752 in your \SpecialChar LyX
23754 Similarly for other keywords like Id, Date, Author, etc.
23755 Secondly svn output is dependent on your locales, so its very easy that
23756 svn would produce some problematic strings once Date is used.
23757 Thirdly you get the whole 'Rev: 59' string in your document instead of
23759 Until subversion implements user's custom keywords it will be hard to use
23760 this approach reliably or let \SpecialChar LyX
23761 to support it directly.
23764 \begin_layout Subsection
23765 SVN and Windows Environment
23768 \begin_layout Quote
23769 My inclination is to say that if the user cannot figure out the command
23770 line operations on their own fairly quickly, they would be well advised
23771 to use TortoiseSVN.
23777 \begin_layout Subsubsection
23781 \begin_layout Standard
23782 In addition to installing \SpecialChar LyX
23783 , and having access to a Subversion repository,
23784 the user will need to install the Subversion client program.
23785 A Windows installer for the client program is available from
23786 \begin_inset CommandInset href
23789 target "http://www.collab.net/nonav/downloads/subversion/"
23795 The user may also want to install
23796 \begin_inset CommandInset href
23799 target "http://tortoisesvn.tigris.org/"
23804 , which integrates Subversion operations into the context (rightclick) menu
23805 of Windows Explorer.
23806 Operations done outside \SpecialChar LyX
23807 will typically be more convenient using the Explorer
23809 Note that TortoiseSVN is not a replacement for the client program, which
23810 is what \SpecialChar LyX
23814 \begin_layout Subsubsection
23815 Bringing a document under Subversion control
23818 \begin_layout Standard
23819 Before a \SpecialChar LyX
23820 document can be brought under version control in Subversion, its
23821 parent directory needs to be under version control.
23822 If the document is being added to a project already in the repository,
23823 this is accomplished by checking the project out to the directory where
23824 the new document will be placed.
23825 If the project itself is not yet under version control (for instance, if
23826 this document starts a new project), the directory must be imported into
23828 This is done outside \SpecialChar LyX
23830 Both import and checkout are easily accomplished from the Explorer context
23831 menu using TortoiseSVN, or alternatively can be done using the command
23832 line client at a DOS prompt.
23833 The procedure for importing the project using TortoiseSVN is described
23834 below, assuming an existing repository and a new project being started
23842 For information on using the Subversion client program, run
23849 \begin_layout Enumerate
23856 in Windows Explorer, right click it, and select
23858 TortoiseSVN\SpecialChar menuseparator
23862 If necessary, adjust the URL for the repository, then click OK.
23865 \begin_layout Enumerate
23866 Right click the level of the repository under which you want to place the
23867 new project folder (typically the top level) and click
23871 Supply a name for the project folder and click OK.
23872 Add a message for the log file if desired, then click OK again.
23873 The new project folder should appear in the repository.
23874 Finally, click OK again to exit the repository browser.
23877 \begin_layout Enumerate
23878 Once again right click
23884 , this time selecting SVN Checkout\SpecialChar ldots
23885 Select the URL of the project folder
23886 you just created in the repository, and set the checkout directory to
23894 You will be warned about a non-empty folder; click OK to proceed.
23895 You should now have a
23906 \begin_layout Enumerate
23907 Create or open your document in \SpecialChar LyX
23910 File\SpecialChar menuseparator
23912 \begin_inset space ~
23915 Control\SpecialChar menuseparator
23919 Add a log message and click OK to commit the document to version control.
23922 \begin_layout Standard
23923 From this point onward, you should have full functionality in the
23925 File\SpecialChar menuseparator
23927 \begin_inset space ~
23933 You also have the option of checking the document in and out, viewing its
23935 using the TortoiseSVN context menu in Windows Explorer or the Subversion
23936 client program from a command prompt.
23939 \begin_layout Subsubsection
23940 SSH tunnel used with SVN under Windows
23943 \begin_layout Standard
23944 Compared with Linux setting up an svn client to communicate over ssh under
23945 Windows is a rather troublesome task.
23946 We will at least offer some hints how to setup the client side but prior
23947 knowledge about ssh and the Windows command line is needed, also be prepared
23948 for a great deal of frustration\SpecialChar ldots
23952 \begin_layout Enumerate
23953 Get an svn client for windows, as described in the previous sections.
23954 When it is a fresh install run some svn command (e.g.
23956 \begin_inset Flex Code
23959 \begin_layout Plain Layout
23965 ) to create config files, which you will need to change later on.
23968 \begin_layout Enumerate
23969 Choose an ssh client for Windows.
23970 There are several possibilities, we will use the one from Putty tools
23974 \begin_layout Plain Layout
23975 \begin_inset Flex URL
23978 \begin_layout Plain Layout
23980 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
23991 You will need to set the connection up so that the client doesn't ask for
23992 any password from you.
23993 To keep things easy we will use only keys without any additional password
23998 \begin_layout Enumerate
24000 \begin_inset Flex Code
24003 \begin_layout Plain Layout
24010 Save your private .ppk key file and put the public one on the server side.
24011 If the SVN server runs on Linux, note that the format of the public key
24012 is not compatible with Linux openssh and you will need to direcly copy-paste
24014 \begin_inset Quotes eld
24019 Public key for pasting into OpenSSH authorized_keys file
24022 \begin_inset Quotes erd
24025 edit field into the server's
24026 \begin_inset Flex Code
24029 \begin_layout Plain Layout
24030 ~/.ssh/authorized_keys
24036 \begin_inset Flex Code
24039 \begin_layout Plain Layout
24048 \begin_layout Enumerate
24050 \begin_inset Flex Code
24053 \begin_layout Plain Layout
24060 In the SVN config file
24064 \begin_layout Plain Layout
24065 Exact path depends on Windows version, usually somewhere around
24066 \begin_inset Flex Code
24069 \begin_layout Plain Layout
24072 Documents and Settings
24086 \begin_inset Flex Code
24089 \begin_layout Plain Layout
24104 , section [tunnels], setup ssh command, e.g.
24106 \begin_inset Flex Code
24109 \begin_layout Plain Layout
24110 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
24119 \begin_layout Plain Layout
24120 It will usually take a lot of time to get exact command right and it depends
24122 For example do not have some remote server saved as a default session in
24124 If things fail, try to connect via plink without SVN first.
24133 \begin_layout Enumerate
24134 Checkout the SVN archive, e.
24135 \begin_inset space \thinspace{}
24139 \begin_inset Newline newline
24143 \begin_inset Flex Code
24146 \begin_layout Plain Layout
24147 svn co svn+ssh://user@server/repository_path
24155 \begin_layout Subsubsection
24156 End-of-Line Conversions
24159 \begin_layout Standard
24160 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
24162 use different line endings inside the .lyx files.
24163 This is not a problem as far as \SpecialChar LyX
24164 functionality is concerned, but the commit
24165 diffs will be huge and merge-conflicts prone.
24166 Fortunately SVN itself knows
24170 \begin_layout Plain Layout
24171 \begin_inset Flex URL
24174 \begin_layout Plain Layout
24176 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
24186 how to deal with CR/LF problems when switching .lyx files to the
24187 \begin_inset Flex Code
24190 \begin_layout Plain Layout
24200 \begin_layout Plain Layout
24202 \begin_inset Flex Code
24205 \begin_layout Plain Layout
24206 svn propset svn:eol-style native FILE_NAME
24219 \begin_layout Subsection
24220 GIT commands in \SpecialChar LyX
24224 \begin_layout Standard
24225 A minimal subset of GIT commands is now supported by \SpecialChar LyX
24227 You can find the commands in the
24229 File\SpecialChar menuseparator
24231 \begin_inset space ~
24237 Please note that if you use password protected access to repository via
24238 ssh, you will be asked in terminal window.
24240 was tested against GIT 1.7.
24244 \begin_layout Plain Layout
24245 Windows users please note that you need to ensure that git is on the path.
24246 This can be set from within \SpecialChar LyX
24249 Tools\SpecialChar menuseparator
24250 Preferences\SpecialChar menuseparator
24251 Paths\SpecialChar menuseparator
24262 \begin_layout Standard
24263 One big difference of GIT and the other supported version control systems
24264 is the distributed nature of GIT: With traditional version control systems
24265 there is one central server which hosts the repository.
24266 Users commit their changes to the server, and get updates made by other
24268 With GIT, users commit to a local repository.
24269 The local repository can be synchronized with one or more remote repositories
24271 \begin_inset Flex Code
24274 \begin_layout Plain Layout
24281 \begin_inset Flex Code
24284 \begin_layout Plain Layout
24292 does not interact in any way with remote GIT repositories.
24293 It works exclusively with the local repository in a very similar way as
24294 with a central CVS or SVN repository.
24295 If you use remote GIT repositories you need to do the
24296 \begin_inset Flex Code
24299 \begin_layout Plain Layout
24306 \begin_inset Flex Code
24309 \begin_layout Plain Layout
24315 operations with your favourite GIT client.
24318 \begin_layout Subsubsection
24324 \begin_layout Standard
24325 If your document is not under revision control, this is the only item shown
24327 And if it is under revision control, the
24331 item is not visible.
24334 \begin_layout Standard
24335 This command registers in GIT your document ONLY in case you have already
24336 the documents directory under GIT control (in particular
24341 This means you have to checkout the archive by yourself.
24344 \begin_layout Standard
24345 Then you are asked interactively to supply an initial description of the
24347 Don't forget that registered file is not yet committed.
24350 \begin_layout Standard
24351 GIT command that is run:
24354 \begin_inset Quotes qld
24358 \begin_inset Quotes qld
24364 \begin_layout Standard
24369 to understand the switches.
24372 \begin_layout Subsubsection
24378 \begin_layout Standard
24379 When you are finished editing a file, you commit your changes.
24380 When you do this, you are asked for a description of the changes.
24381 After that changes are committed.
24384 \begin_layout Standard
24387 git commit -q -m"<description>" <file-name>
24390 \begin_layout Subsubsection
24393 Revert To Repository Version
24396 \begin_layout Standard
24397 This will discard all changes made to the document since the last check
24399 You get a warning before changes are discarded.
24402 \begin_layout Standard
24406 \begin_inset Quotes qld
24410 \begin_inset Quotes qld
24416 \begin_layout Subsubsection
24422 \begin_layout Standard
24423 This will rename the current document including the version history.
24424 It requires a clean document without any changes since the last checkin.
24425 You are asked for a file name and a description of the rename operation.
24426 After that the document is renamed, both locally and in the repository.
24427 If the parent directories of the new and old file names differ, all relative
24428 paths of included files are adjusted (like in
24430 File\SpecialChar menuseparator
24435 Finally, the document is reloaded using the new name.
24438 \begin_layout Labeling
24439 \labelwidthstring 00.00.0000
24441 \begin_inset space ~
24445 \begin_inset space ~
24449 \begin_inset Newline newline
24453 \begin_inset Flex Code
24456 \begin_layout Plain Layout
24460 \begin_inset Quotes qld
24464 \begin_inset Quotes qld
24468 \begin_inset Quotes qld
24472 \begin_inset Quotes qld
24481 \begin_inset Newline newline
24485 \begin_inset Flex Code
24488 \begin_layout Plain Layout
24497 \begin_layout Subsubsection
24503 \begin_layout Standard
24504 This shows the complete history of the GIT document.
24508 \begin_inset Quotes qld
24512 \begin_inset Quotes qld
24517 is shown in a browser.
24520 \begin_layout Subsubsection
24524 \begin_layout Standard
24526 supports GIT hash number of the last commit to the file,
24527 \change_inserted 1119979965 1564297456
24528 its abbreviated form,
24530 author name, date and time of last commit.
24531 All those are extracted from
24533 git log -n 1 --pretty=format:%H%n
24534 \change_inserted 1119979965 1564297427
24540 Tree version information is obtained via
24542 git describe --abbrev --dirty --long
24546 \begin_inset CommandInset ref
24548 reference "subsec:VCS-Revision-Information"
24555 \begin_layout Subsection
24559 \begin_layout Standard
24560 With the recent addition of the
24561 \begin_inset Flex Code
24564 \begin_layout Plain Layout
24570 function \SpecialChar LyX
24571 power users are allowed to create their own commands for revision
24575 \begin_layout Standard
24576 As an example you can see how two TortoiseSVN commands could be integrated
24580 \begin_layout Description
24582 \begin_inset Flex Code
24585 \begin_layout Plain Layout
24586 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
24594 \begin_layout Description
24596 \begin_inset Flex Code
24599 \begin_layout Plain Layout
24600 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
24608 \begin_layout Subsection
24609 Version control and Document comparison
24612 \begin_layout Standard
24613 One of the typical uses of version control is to inspect the changes between
24614 revisions, usually by creating
24615 \begin_inset Flex Code
24618 \begin_layout Plain Layout
24625 While this is useful for plain text files, it is much less useful in the
24626 case of \SpecialChar LyX
24627 files, which have more a complicated structure.
24628 Hence we provide binding to the Document comparison feature.
24629 There are two ways of calling this feature – either by direct call of
24630 \begin_inset Flex Code
24633 \begin_layout Plain Layout
24640 function (for details see \SpecialChar LyX
24641 functions manual) or by the toolbar icon
24654 One can either compare two chosen revisions of the document or he can simply
24655 compare the current version of edited text with older revisions (where
24657 \begin_inset Flex Noun
24660 \begin_layout Plain Layout
24666 ' revisions back means comparison of the edited file with last commited
24671 \begin_layout Standard
24672 This feature is supported for SVN and RCS though due to the more complicated
24673 versioning scheme of RCS there is a constraint – when addressing the revisions
24674 in dialog, numbers always point to the last number in RCS revision number,
24677 We don't currently support GIT addressing of revisions, one can just compare
24678 edited document with its revision X steps backs, where X is addressed as
24680 \begin_inset Flex Code
24683 \begin_layout Plain Layout
24692 \begin_layout Section
24693 Literate Programming
24696 \begin_layout Standard
24701 (kayvan@sylvan.com)
24705 original documentation written by
24707 Edmar Wienskoski Jr.
24710 (edmar-w-jr@technologist.com)
24713 \begin_layout Subsection
24717 \begin_layout Standard
24718 The main purpose of this documentation is to show you how to use \SpecialChar LyX
24720 programming, where it is assumed that you are familiar with this programming
24721 technique, and know what
24722 \begin_inset Quotes eld
24726 \begin_inset Quotes erd
24730 \begin_inset Quotes eld
24734 \begin_inset Quotes erd
24738 If that is not the case, please follow the web links provided in the following
24740 There is a lot of good documentation out there covering old development
24741 history to the latest tools tips.
24744 \begin_layout Standard
24745 It is also assumed that you are familiar with \SpecialChar LyX
24746 itself to a point that you
24747 are comfortable changing your \SpecialChar LyX
24748 preferences, and X resources file.
24749 If that is not the case please refer to other \SpecialChar LyX
24750 documentation to cover your
24754 \begin_layout Subsection
24755 Literate Programming
24758 \begin_layout Standard
24759 From the Literate Programming FAQ:
24762 \begin_layout Quotation
24763 Literate programming is the combination of documentation and source together
24764 in a fashion suited for reading by human beings.
24765 In fact, literate programs should be enjoyable reading, even inviting!
24766 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
24767 and documentation in a single file.
24768 Literate programming tools then parse the file to produce either readable
24769 documentation or compilable source.
24770 The WEB style of literate programming was created by D.
24771 \begin_inset space \thinspace{}
24775 Knuth during the development of his \SpecialChar TeX
24776 typesetting software.
24780 \begin_layout Standard
24781 Another excerpt says:
24784 \begin_layout Quotation
24787 How is literate programming different from verbose commenting?
24790 \begin_layout Quotation
24791 There are three distinguishing characteristics.
24792 In order of importance, they are:
24796 \begin_layout Itemize
24797 flexible order of elaboration
24800 \begin_layout Itemize
24801 automatic support for browsing
24804 \begin_layout Itemize
24805 typeset documentation, especially diagrams and mathematics
24809 \begin_layout Standard
24810 Now that I sparked your curiosity, take a look in the references.
24813 \begin_layout Subsubsection
24817 \begin_layout Standard
24818 The complete Literate Programming FAQ can be found at:
24821 \begin_layout Quote
24822 Literate Programming FAQ
24823 \begin_inset Flex URL
24826 \begin_layout Plain Layout
24828 http://www.literateprogramming.com/lpfaq.pdf
24836 \begin_layout Standard
24837 The FAQ lists 23 (twenty three!) different literate programming tools.
24838 Where some are specialized or
24839 \begin_inset Quotes eld
24843 \begin_inset Quotes erd
24846 for particular programming languages, while other have general scope.
24851 for my own use for several reasons:
24854 \begin_layout Itemize
24855 It can generate the documentation either in \SpecialChar LaTeX
24859 \begin_layout Itemize
24860 It has a open architecture, i.
24861 \begin_inset space \thinspace{}
24865 \begin_inset space \space{}
24868 it is easy to plug in new filters
24872 \begin_layout Plain Layout
24877 are programs that read a given data stream and output a manipulated data
24879 That way, a WEB file (consisting of literate code) can be turned into a
24880 file consisting only of C program code or \SpecialChar LaTeX
24886 and to perform special processing that you may need.
24890 \begin_layout Itemize
24891 There is a good selection of filters available already (the HTML is one
24895 \begin_layout Itemize
24899 \begin_layout Standard
24900 The Noweb web page can be found at:
24903 \begin_layout Quote
24905 \begin_inset Flex URL
24908 \begin_layout Plain Layout
24910 https://www.cs.tufts.edu/~nr/noweb/
24918 \begin_layout Standard
24919 Starting from there you can reach many other interesting links and even
24920 some literate program examples.
24923 \begin_layout Subsection
24925 and Literate Programming with Noweb
24928 \begin_layout Standard
24929 The \SpecialChar LyX
24930 support for Literate Programming is provided by using the generic \SpecialChar LyX
24932 converters mechanism.
24933 This support is provided in a
24934 \begin_inset Quotes eld
24938 \begin_inset Quotes erd
24942 \begin_inset space \thinspace{}
24946 \begin_inset space \space{}
24949 you will be able to use this new \SpecialChar LyX
24950 feature with some other literate programming
24951 tool of your choice by just changing your \SpecialChar LyX
24955 \begin_layout Subsubsection
24956 Generating documents and code (weaving and tangling)
24959 \begin_layout Paragraph
24960 Using the noweb module
24963 \begin_layout Standard
24964 If you have installed Noweb and \SpecialChar LyX
24965 successfully, whenever you open a new document,
24966 after you have chosen its document class, use the
24968 Document\SpecialChar menuseparator
24972 \begin_inset Quotes eld
24976 \begin_inset Quotes erd
24980 If Noweb is correctly installed, when you click on the
24981 \begin_inset Quotes eld
24985 \begin_inset Quotes erd
24988 link, you will see the
24989 \begin_inset Quotes eld
24993 \begin_inset Quotes erd
24996 module in the available list and you can add it to your document.
24999 \begin_layout Paragraph
25003 \begin_layout Standard
25005 enables you to write code with a custom inset named
25006 \begin_inset Flex Noun
25009 \begin_layout Plain Layout
25016 Noweb delimits chunks like this:
25019 \begin_layout LyX-Code
25023 \begin_layout LyX-Code
25027 \begin_layout LyX-Code
25031 \begin_layout LyX-Code
25035 \begin_layout LyX-Code
25039 \begin_layout Standard
25040 The problem is that whatever is written in between the << and the
25044 must be taken literally, i.
25045 \begin_inset space \thinspace{}
25049 \begin_inset space \space{}
25053 should be prevented from making any special interpretation of what has
25055 This is also handled by
25056 \begin_inset Flex Noun
25059 \begin_layout Plain Layout
25065 , that works like a normal text inset but has a free spacing capability.
25068 \begin_layout Standard
25069 As a special note, you can also use the
25070 \begin_inset Quotes eld
25074 \begin_inset Quotes erd
25077 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
25081 \begin_layout LyX-Code
25085 \begin_layout LyX-Code
25086 def some_function(args):
25089 \begin_layout LyX-Code
25090 "This is the doc string for this function."
25093 \begin_layout LyX-Code
25094 print "My args: ", args
25097 \begin_layout LyX-Code
25098 @ %def some_function
25101 \begin_layout Standard
25102 For an example of this usage and the resulting cross-reference output, look
25103 at the Literate python program in
25105 LIBDIR/examples/listerrors.lyx
25107 which should make this all clear.
25110 \begin_layout Paragraph
25111 Generating the documentation
25114 \begin_layout Standard
25115 At this point you already have a new document file with a proper document
25116 class, and with some code and text on it.
25117 How do I print it? The answer is simple, you select
25119 View\SpecialChar menuseparator
25123 Just like you would do for a plain document.
25124 No special procedure is required.
25127 \begin_layout Standard
25128 To help orientate you, I will now explain what happens inside \SpecialChar LyX
25132 \begin_layout Enumerate
25135 Update\SpecialChar menuseparator
25138 menu option is chosen, a \SpecialChar LaTeX
25144 \begin_layout Standard
25145 If the document is of any literate class the generated file will be named
25146 with an extension name defined by the
25147 \begin_inset Quotes eld
25151 \begin_inset Quotes erd
25154 format (defined in the Preferences panel), otherwise the file will have
25163 \begin_layout Enumerate
25164 Note that the only difference so far is in the name of the file, no special
25165 processing is required by \SpecialChar LyX
25167 Given that you formatted the code using the
25168 \begin_inset Flex Noun
25171 \begin_layout Plain Layout
25177 inset that, by itself, takes care of the business.
25180 \begin_layout Enumerate
25181 If the document is of any literate class \SpecialChar LyX
25182 will then use the internal \SpecialChar LyX
25184 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
25189 \begin_layout Plain Layout
25190 The converters are defined in the
25192 Tools\SpecialChar menuseparator
25196 \begin_inset Quotes eld
25200 \begin_inset Quotes erd
25212 manual for general information about converters.
25217 to generate the \SpecialChar LaTeX
25222 \begin_layout Standard
25223 Otherwise it will just skip this step.
25227 \begin_layout Enumerate
25228 Finally, \SpecialChar LaTeX
25229 is invoked and the regular post processing continues as in a plain
25233 \begin_layout Standard
25234 Independence from a particular
25235 \begin_inset Quotes eld
25239 \begin_inset Quotes erd
25242 is easily achieved by changing the commands that are run by the various
25246 \begin_layout Paragraph
25247 Generating the code
25250 \begin_layout Standard
25251 When the build menu option is chosen or the corresponding button in the
25252 toolbar is pressed, a \SpecialChar LaTeX
25253 file is generated just like step 1 above.
25254 Next, \SpecialChar LyX
25260 This converter needs to be defined by the user and is not installed by
25261 default, though the Program format is.
25262 This converter (like any other converter) will have two parts:
25265 \begin_layout Enumerate
25266 The converter program itself.
25267 This program performs the conversion from the one format to the other (in
25268 this case, from the Noweb format to the Program pseudo-format).
25271 \begin_layout Enumerate
25272 The error log parser.
25273 This is a program whose sole purpose is to rewrite error messages in a
25274 format that \SpecialChar LyX
25276 This makes it possible for \SpecialChar LyX
25277 to place error boxes in the right places in
25281 \begin_layout Standard
25282 The first part, the
25283 \begin_inset Quotes eld
25287 \begin_inset Quotes erd
25290 setting, should be set to
25293 \begin_layout LyX-Code
25301 \begin_layout Standard
25302 This basically means that \SpecialChar LyX
25304 \begin_inset Quotes eld
25308 \begin_inset Quotes erd
25311 (a program or script) with the name of the Noweb file (normally a file
25312 in the \SpecialChar LyX
25313 temp directory) and the directory path of the original \SpecialChar LyX
25318 \begin_layout Standard
25319 This is an implementation of
25320 \begin_inset Quotes eld
25324 \begin_inset Quotes erd
25327 that you can place in a directory on your path:
25330 \begin_layout LyX-Code
25336 \begin_layout LyX-Code
25342 \begin_layout LyX-Code
25345 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
25348 \begin_layout Standard
25349 The next part of the converter setting is the
25350 \begin_inset Quotes eld
25354 \begin_inset Quotes erd
25357 which is to be set to
25360 \begin_layout LyX-Code
25363 parselog=$$s/scripts/listerrors
25366 \begin_layout Standard
25367 This will run any errors that are generated by the
25368 \begin_inset Quotes eld
25372 \begin_inset Quotes erd
25375 process through the
25376 \begin_inset Quotes eld
25380 \begin_inset Quotes erd
25386 \begin_layout Standard
25387 The build will normally take place in \SpecialChar LyX
25388 's temporary directory, so the files
25389 produced by the conversion will be in that directory.
25391 will copy out what it regards as the `main' file, but the
25395 conversion may produce several files, and so most of these would then be
25396 deleted when \SpecialChar LyX
25398 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
25399 the build-script chunk can place the generated files in that location.
25402 \begin_layout Paragraph
25403 Build instructions in the document
25406 \begin_layout Standard
25407 The last piece of the integration between \SpecialChar LyX
25409 \begin_inset Quotes eld
25413 \begin_inset Quotes erd
25417 Generally, the instructions for building your program should be embedded
25418 in a chunk of its own.
25420 \begin_inset Quotes eld
25424 \begin_inset Quotes erd
25427 above uses the notangle command to look for this chunk (called
25428 \begin_inset Quotes eld
25432 \begin_inset Quotes erd
25435 ) and runs its contents through
25436 \begin_inset Quotes eld
25440 \begin_inset Quotes erd
25446 \begin_layout Standard
25447 Typically, such a chunk would look something like this:
25450 \begin_layout LyX-Code
25454 \begin_layout LyX-Code
25456 \begin_inset Newline newline
25459 if [ -z "${NOWEB_SOURCE}" ]
25460 \begin_inset Newline newline
25466 \begin_layout LyX-Code
25467 NOWEB_SOURCE=myfile.nw
25468 \begin_inset Newline newline
25472 \begin_inset Newline newline
25476 code to extract files ...
25477 use NOWEB_OUTPUT_DIR here ...]
25478 \begin_inset Newline newline
25482 code to compile files ...]
25483 \begin_inset Newline newline
25489 \begin_layout Standard
25492 LIBDIR/examples/listerrors.lyx
25496 LIBDIR/examples/Literate.lyx
25498 which implement two versions of the
25499 \begin_inset Quotes eld
25503 \begin_inset Quotes erd
25506 program for some illustrations of how all of these pieces go together or
25509 LIBDIR/examples/noweb2lyx.lyx.
25512 Interestingly, these three files show off the language-indepence of the
25514 literate programming support since they are written in Python, C and Perl
25518 \begin_layout Subsubsection
25519 Configuring \SpecialChar LyX
25523 \begin_layout Standard
25524 All the Literate Programming support is configured by the
25526 Tools\SpecialChar menuseparator
25530 \begin_inset Quotes eld
25534 \begin_inset Quotes erd
25538 The important parts are:
25541 \begin_layout Description
25543 \begin_inset space ~
25547 \begin_inset Quotes eld
25551 \begin_inset Quotes erd
25555 \begin_inset space ~
25558 format Set up via the File Formats tab, this is where the Noweb-specific
25568 , the file extension is set to
25573 This tells \SpecialChar LyX
25574 to create a file with a
25578 extension in the first step of the conversion process.
25581 \begin_layout Description
25583 \begin_inset space ~
25591 \begin_inset space ~
25594 format This is an empty format whose sole purpose is to be the endpoint
25595 of a conversion (which then allows us to set up a converter for it).
25598 \begin_layout Description
25608 This converter performs the
25609 \begin_inset Quotes eld
25613 \begin_inset Quotes erd
25616 of the literate document.
25617 For Noweb, it is set to
25618 \begin_inset Quotes eld
25623 noweave -delay -index $$i > $$o
25626 \begin_inset Quotes erd
25632 \begin_layout Description
25642 \begin_inset Quotes eld
25646 \begin_inset Quotes erd
25650 As stated above, the Converter is set to
25651 \begin_inset Quotes eld
25659 \begin_inset Quotes erd
25662 , with Flags set to
25663 \begin_inset Newline newline
25667 \begin_inset Quotes eld
25672 parselog=$$s/scripts/listerrors
25675 \begin_inset Quotes erd
25681 \begin_layout Subsubsection
25685 \begin_layout Standard
25686 There is also a new function implemented in the \SpecialChar LyX
25688 \begin_inset Quotes eld
25691 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
25695 \begin_layout Standard
25696 When debugging code with ddd/gdb, it is possible to invoke a text editor
25697 at the current execution position with a single key stroke.
25698 The default ddd configuration for that is shift-ctrl-V.
25699 It happens that you can define the editor command line invocation in ddd
25702 Edit\SpecialChar menuseparator
25703 Preferences\SpecialChar menuseparator
25706 dialog and changing the "Edit Sources" entry.
25709 \begin_layout Standard
25710 I take advantage of the newly created \SpecialChar LyX
25711 server function and this ddd feature,
25713 \begin_inset Quotes eld
25717 \begin_inset Quotes erd
25723 \begin_layout LyX-Code
25724 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
25727 \begin_layout Standard
25728 With this, whenever you are using ddd and find a point in the program that
25729 you want to edit, you just press shift-ctrl-V (in the ddd window), and
25730 ddd will forward this information to \SpecialChar LyX
25731 through the \SpecialChar LyX
25732 server and then the
25734 window will show the same file with the cursor at the same position ddd
25736 No more guessing or long scrolling to locate a point in the program back
25740 \begin_layout Standard
25741 Note however that you must enable the \SpecialChar LyX
25742 server to get this feature working
25743 (it is disabled by default).
25745 \begin_inset space ~
25749 \begin_inset CommandInset ref
25751 reference "sec:Starting-the-Server"
25755 explains how to do that.
25758 \begin_layout Subsubsection
25762 \begin_layout Standard
25763 There are six new buttons that can be added to your \SpecialChar LyX
25765 Four of these buttons are short cuts to layout styles:
25783 , one for the custom inset
25788 The last one is a short cut to the
25789 \begin_inset Quotes eld
25793 \begin_inset Quotes erd
25800 \begin_layout Standard
25802 has a range of buttons that are available for tool bar customization.
25803 In my toolbar I like to combine the six short cuts above with two more:
25808 \SpecialChar menuseparator
25813 \SpecialChar menuseparator
25820 Document\SpecialChar menuseparator
25821 View\SpecialChar menuseparator
25825 Here is how it looks like:
25828 \begin_layout LyX-Code
25832 \begin_layout LyX-Code
25836 \begin_layout LyX-Code
25837 Icon "layout Standard"
25840 \begin_layout LyX-Code
25841 Icon "layout Section"
25844 \begin_layout LyX-Code
25845 Icon "layout \SpecialChar LaTeX
25849 \begin_layout LyX-Code
25850 Icon "layout \SpecialChar LyX
25854 \begin_layout LyX-Code
25855 Icon "flex.insert Chunk"
25858 \begin_layout LyX-Code
25862 \begin_layout LyX-Code
25866 \begin_layout LyX-Code
25867 Icon "buffer-typeset"
25870 \begin_layout LyX-Code
25871 Icon "build-program"
25874 \begin_layout LyX-Code
25878 \begin_layout LyX-Code
25882 \begin_layout LyX-Code
25886 \begin_layout LyX-Code
25890 \begin_layout LyX-Code
25894 \begin_layout Subsubsection
25895 Colors customization
25898 \begin_layout Standard
25899 There are a number of colors in \SpecialChar LyX
25900 that can be customized in
25905 One of the things that bothers people is the \SpecialChar LaTeX
25907 The default color is red, since the chunks uses \SpecialChar LaTeX
25908 font, and there is a lot
25909 of chunks in literate documents, you may get tired of seeing everything
25911 You can change it by going to the tabs
25920 \begin_layout Standard
25921 The next thing is the visible presence of the newline character in the screen.
25922 You can choose the color of this particular character and make it blend
25924 I recommend you choosing a color that is close to the background but not
25925 equal, that way you still can see it is there, but it is not bothering
25929 \begin_layout Subsection
25934 \begin_layout Standard
25943 is documented in the
25947 example file and in the Sweave manual (menu
25949 Help\SpecialChar menuseparator
25955 \begin_layout Chapter
25959 \begin_layout Standard
25960 You can do everything with \SpecialChar LyX
25961 that you can do with \SpecialChar LaTeX
25963 However, \SpecialChar LyX
25964 cannot support every \SpecialChar LaTeX
25966 But you can always use \SpecialChar TeX
25968 This chapter shows you some more special things you might want to use.
25969 For other special things you can do with figures, tables, floats, boxes
25970 and notes, have a look at the
25973 \begin_inset space ~
25981 \begin_layout Section
25982 Multiple Text Columns
25985 \begin_layout Standard
25986 This feature is independent of the option
25988 Two-column document
25990 in the document settings under
25995 If you want to have 2
25996 \begin_inset space ~
25999 columns for the whole document, it is recommended to use the
26001 Two-column document
26004 For all other cases use this feature.
26007 \begin_layout Standard
26008 To use multiple text columns in your document, you have to load the module
26015 Document\SpecialChar menuseparator
26016 Settings\SpecialChar menuseparator
26019 ) and must have the \SpecialChar LaTeX
26021 \begin_inset Flex Code
26024 \begin_layout Plain Layout
26033 \begin_layout Standard
26034 Footnotes within multiple columns will be placed at the bottom of the page
26035 and not under each column.
26036 Within the different columns you can use everything, with the limitation
26037 that for floats you need to use the float option
26044 \begin_layout Subsection
26048 \begin_layout Standard
26049 If you want to have 2
26050 \begin_inset space ~
26053 columns in your text, insert a multicolumn inset via the menu
26055 Insert\SpecialChar menuseparator
26057 \begin_inset space ~
26060 Insets\SpecialChar menuseparator
26062 \begin_inset space ~
26067 where the columns should start.
26068 Write all text that should be printed in 2
26069 \begin_inset space ~
26072 columns into this inset.
26075 \begin_layout Standard
26076 Here is an example:
26079 \begin_layout Standard
26081 \begin_inset Flex Multiple Columns
26084 \begin_layout Plain Layout
26089 The Adventure of the Empty House
26092 \begin_inset Newline newline
26095 by Sir Arthur Conan Doyle
26098 \begin_layout Plain Layout
26101 It was in the spring of the year 1894 that all London was interested, and
26102 the fashionable world dismayed, by the murder of the Honourable Ronald
26103 Adair under most unusual and inexplicable circumstances.
26104 The public has already learned those particulars of the crime which came
26105 out in the police investigation, but a good deal was suppressed upon that
26106 occasion, since the case for the prosecution was so overwhelmingly strong
26107 that it was not necessary to bring forward all the facts.
26108 Only now, at the end of nearly ten years, am I allowed to supply those
26109 missing links which make up the whole of that remarkable chain.
26110 The crime was of interest in itself, but that interest was as nothing to
26111 me compared to the inconceivable sequel, which afforded me the greatest
26112 shock and surprise of any event in my adventurous life.
26113 Even now, after this long interval, I find myself thrilling as I think
26114 of it, and feeling once more that sudden flood of joy, amazement, and increduli
26115 ty which utterly submerged my mind.
26116 Let me say to that public, which has shown some interest in those glimpses
26117 which I have occasionally given them of the thoughts and actions of a very
26118 remarkable man, that they are not to blame me if I have not shared my knowledge
26119 with them, for I should have considered it my first duty to do so, had
26120 I not been barred by a positive prohibition from his own lips, which was
26121 only withdrawn upon the third of last month.
26129 \begin_layout Standard
26130 To get 3 or more columns, set the cursor into the multicolumn inset and
26133 Insert\SpecialChar menuseparator
26135 \begin_inset space ~
26139 \begin_inset space ~
26145 The number of the desired columns is written into that inset (for 3
26146 \begin_inset space ~
26150 \begin_inset Quotes eld
26154 \begin_inset Quotes erd
26158 \begin_inset Newline newline
26161 Here is an example with 3
26162 \begin_inset space ~
26168 \begin_layout Standard
26169 \begin_inset Flex Multiple Columns
26172 \begin_layout Plain Layout
26175 \begin_inset Argument 1
26178 \begin_layout Plain Layout
26185 It can be imagined that my close intimacy with Sherlock Holmes had interested
26186 me deeply in crime, and that after his disappearance I never failed to
26187 read with care the various problems which came before the public.
26188 And I even attempted, more than once, for my own private satisfaction,
26189 to employ his methods in their solution, though with indifferent success.
26190 There was none, however, which appealed to me like this tragedy of Ronald
26192 As I read the evidence at the inquest, which led up to a verdict of willful
26193 murder against some person or persons unknown, I realized more clearly
26194 than I had ever done the loss which the community had sustained by the
26195 death of Sherlock Holmes.
26196 There were points about this strange business which would, I was sure,
26197 have specially appealed to him, and the efforts of the police would have
26198 been supplemented, or more probably anticipated, by the trained observation
26199 and the alert mind of the first criminal agent in Europe.
26200 All day, as I drove upon my round, I turned over the case in my mind and
26201 found no explanation which appeared to me to be adequate.
26202 At the risk of telling a twice-told tale, I will recapitulate the facts
26203 as they were known to the public at the conclusion of the inquest.
26211 \begin_layout Standard
26212 You can have up to 10
26213 \begin_inset space ~
26216 columns if you want to, but that might not be very pleasant for the readers
26220 \begin_layout Standard
26221 \begin_inset Newpage newpage
26227 \begin_layout Subsection
26228 Columns inside Columns
26231 \begin_layout Standard
26232 You can also have columns inside columns:
26235 \begin_layout Standard
26236 \begin_inset Flex Multiple Columns
26239 \begin_layout Plain Layout
26242 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
26243 at that time governor of one of the Australian colonies.
26244 Adair's mother had returned from Australia to undergo the operation for
26245 cataract, and she, her son Ronald, and her daughter Hilda were living together
26249 \begin_layout Plain Layout
26250 \begin_inset Flex Multiple Columns
26253 \begin_layout Plain Layout
26256 The youth moved in the best society
26257 \begin_inset space ~
26260 – had, so far as was known, no enemies and no particular vices.
26261 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
26262 had been broken off by mutual consent some months before, and there was
26263 no sign that it had left any very profound feeling behind it.
26264 For the rest {sic} the man's life moved in a narrow and conventional circle,
26265 for his habits were quiet and his nature unemotional.
26266 Yet it was upon this easy-going young aristocrat that death came, in most
26267 strange and unexpected form, between the hours of ten and eleven-twenty
26268 on the night of March 30, 1894.
26276 \begin_layout Plain Layout
26279 Ronald Adair was fond of cards
26280 \begin_inset space ~
26283 – playing continually, but never for such stakes as would hurt him.
26284 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
26285 It was shown that, after dinner on the day of his death, he had played
26286 a rubber of whist at the latter club.
26287 He had also played there in the afternoon.
26292 The evidence of those who had played with him
26293 \begin_inset space ~
26297 Murray, Sir John Hardy, and Colonel Moran
26298 \begin_inset space ~
26301 – showed that the game was whist, and that there was a fairly equal fall
26303 Adair might have lost five pounds, but not more.
26304 His fortune was a considerable one, and such a loss could not in any way
26306 He had played nearly every day at one club or other, but he was a cautious
26307 player, and usually rose a winner.
26308 It came out in evidence that, in partnership with Colonel Moran, he had
26309 actually won as much as four hundred and twenty pounds in a sitting, some
26310 weeks before, from Godfrey Milner and Lord Balmoral.
26311 So much for his recent history as it came out at the inquest.
26319 \begin_layout Subsection
26323 \begin_layout Standard
26324 The examples in this section show some more special features of multiple
26328 \begin_layout Standard
26329 For more features of multiple columns, have a look at the
26330 \begin_inset CommandInset href
26332 name "documentation"
26333 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
26338 of the \SpecialChar LaTeX
26340 \begin_inset Flex Code
26343 \begin_layout Plain Layout
26352 \begin_layout Subsubsection
26356 \begin_layout Standard
26357 To add a preface text for multiple columns, set the cursor into the multicolumn
26358 inset and use the menu
26360 Insert\SpecialChar menuseparator
26364 Write your preface text into that inset.
26365 \begin_inset Newline newline
26368 This is an example with some preface text:
26371 \begin_layout Standard
26372 \begin_inset VSpace bigskip
26378 \begin_layout Standard
26379 \begin_inset Flex Multiple Columns
26382 \begin_layout Plain Layout
26383 \begin_inset Argument 2
26386 \begin_layout Plain Layout
26387 And the story continues and continues and continues and continues\SpecialChar ldots
26395 On the evening of the crime, he returned from the club exactly at ten.
26396 His mother and sister were out spending the evening with a relation.
26397 The servant deposed that she heard him enter the front room on the second
26398 floor, generally used as his sitting-room.
26399 She had lit a fire there, and as it smoked she had opened the window.
26400 No sound was heard from the room until eleven-twenty, the hour of the return
26401 of Lady Maynooth and her daughter.
26402 Desiring to say good-night, she attempted to enter her son's room.
26403 The door was locked on the inside, and no answer could be got to their
26404 cries and knocking.
26405 Help was obtained, and the door forced.
26406 The unfortunate young man was found lying near the table.
26407 His head had been horribly mutilated by an expanding revolver bullet, but
26408 no weapon of any sort was to be found in the room.
26416 \begin_layout Standard
26417 You can also use a section heading as the preface if you use a section command
26418 as \SpecialChar TeX
26420 For example the command
26423 \begin_layout LyX-Code
26426 subsection{subsection title}
26429 \begin_layout Standard
26430 creates a subsection.
26431 In this example the preface is a subsubsection:
26434 \begin_layout Standard
26435 \begin_inset Flex Multiple Columns
26438 \begin_layout Plain Layout
26439 \begin_inset Argument 2
26442 \begin_layout Plain Layout
26446 \begin_layout Plain Layout
26455 This is a subsubsection heading as a preface
26459 \begin_layout Plain Layout
26473 A minute examination of the circumstances served only to make the case more
26475 In the first place, no reason could be given why the young man should have
26476 fastened the door upon the inside.
26477 There was the possibility that the murderer had done this, and had afterwards
26478 escaped by the window.
26479 The drop was at least twenty feet, however, and a bed of crocuses in full
26481 Neither the flowers nor the earth showed any sign of having been disturbed,
26482 nor were there any marks upon the narrow strip of grass which separated
26483 the house from the road.
26484 Apparently, therefore, it was the young man himself who had fastened the
26486 But how did he come by his death? No one could have climbed up to the window
26487 without leaving traces.
26488 Suppose a man had fired through the window, he would indeed be a remarkable
26489 shot who could with a revolver inflict so deadly a wound.
26490 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
26491 a hundred yards of the house.
26492 No one had heard a shot.
26500 \begin_layout Standard
26501 If there is less vertical space than 6
26502 \begin_inset space ~
26505 text lines is left on the page at the beginning of the multiple columns,
26506 a page break will be inserted before the multiple columns.
26507 Depending on the number of lines of the preface text, you might want to
26509 This is done by setting the cursor into the mulitcolumn inset behind the
26510 preface (if there is any) and using the menu
26512 Insert\SpecialChar menuseparator
26514 \begin_inset space ~
26518 \begin_inset space ~
26522 \begin_inset space ~
26528 Insert into that inset the amount of space like e.
26529 \begin_inset space \thinspace{}
26533 \begin_inset space \space{}
26537 \begin_inset Quotes eld
26541 \begin_inset Quotes erd
26545 \begin_inset Newline newline
26548 In this example the space is set to 7
26549 \begin_inset space ~
26552 text lines by using
26553 \begin_inset Flex Code
26556 \begin_layout Plain Layout
26565 \begin_inset Flex Code
26568 \begin_layout Plain Layout
26576 needs to be inserted as \SpecialChar TeX
26580 \begin_layout Standard
26581 \begin_inset Flex Multiple Columns
26584 \begin_layout Plain Layout
26585 \begin_inset Argument 3
26588 \begin_layout Plain Layout
26593 \begin_layout Plain Layout
26609 On the evening of the crime, he returned from the club exactly at ten.
26610 His mother and sister were out spending the evening with a relation.
26611 The servant deposed that she heard him enter the front room on the second
26612 floor, generally used as his sitting-room.
26613 She had lit a fire there, and as it smoked she had opened the window.
26614 No sound was heard from the room until eleven-twenty, the hour of the return
26615 of Lady Maynooth and her daughter.
26616 Desiring to say good-night, she attempted to enter her son's room.
26617 The door was locked on the inside, and no answer could be got to their
26618 cries and knocking.
26619 Help was obtained, and the door forced.
26620 The unfortunate young man was found lying near the table.
26621 His head had been horribly mutilated by an expanding revolver bullet, but
26622 no weapon of any sort was to be found in the room.
26630 \begin_layout Subsubsection
26634 \begin_layout Standard
26635 The amount of space before and after multiple columns can be changed by
26636 changing the length
26637 \begin_inset Flex Code
26640 \begin_layout Plain Layout
26649 For example the command
26652 \begin_layout LyX-Code
26660 \begin_layout Standard
26661 in \SpecialChar TeX
26662 Code changes its value to 3
26663 \begin_inset space \thinspace{}
26667 The change must be made before the multiple columns' start.
26668 The predefined value is 13
26669 \begin_inset space \thinspace{}
26675 \begin_layout Standard
26677 \begin_inset Flex Code
26680 \begin_layout Plain Layout
26689 \begin_inset space \thinspace{}
26695 \begin_layout Standard
26699 \begin_layout Plain Layout
26705 multicolsep}{2.5cm}
26713 \begin_layout Standard
26714 \begin_inset Flex Multiple Columns
26717 \begin_layout Plain Layout
26720 All day I turned these facts over in my mind, endeavouring to hit upon some
26721 theory which could reconcile them all, and to find that line of least resistanc
26722 e which my poor friend had declared to be the starting-point of every investigat
26724 I confess that I made little progress.
26725 In the evening I strolled across the Park, and found myself about six o'clock
26726 at the Oxford Street end of Park Lane.
26727 A group of loafers upon the pavements, all staring up at a particular window,
26728 directed me to the house which I had come to see.
26729 A tall, thin man with coloured glasses, whom I strongly suspected of being
26730 a plain-clothes detective, was pointing out some theory of his own, while
26731 the others crowded round to listen to what he said.
26732 I got as near him as I could, but his observations seemed to me to be absurd,
26733 so I withdrew again in some disgust.
26734 As I did so I struck against an elderly, deformed man, who had been behind
26735 me, and I knocked down several books which he was carrying.
26743 \begin_layout Standard
26744 \begin_inset Note Greyedout
26747 \begin_layout Plain Layout
26752 The values you set with
26753 \begin_inset Flex Code
26756 \begin_layout Plain Layout
26764 will be used for all following multiple columns until you change them again.
26772 \begin_layout Standard
26776 \begin_layout Plain Layout
26788 \begin_inset Note Note
26791 \begin_layout Plain Layout
26792 go back to the default
26800 \begin_layout Standard
26801 \begin_inset Newpage newpage
26807 \begin_layout Subsubsection
26811 \begin_layout Standard
26812 A column break can be forced by inserting the command
26813 \begin_inset Flex Code
26816 \begin_layout Plain Layout
26824 as \SpecialChar TeX
26825 Code to that position in the text where the column should be broken.
26826 Note that this leads in most cases to whitespace in the text.
26827 \begin_inset Newline newline
26830 Here is an example:
26833 \begin_layout Standard
26834 \begin_inset Flex Multiple Columns
26837 \begin_layout Plain Layout
26840 \begin_inset Quotes eld
26843 You're surprised to see me, sir,
26844 \begin_inset Quotes erd
26847 said he, in a strange, croaking voice.
26850 \begin_layout Plain Layout
26853 I acknowledged that I was.
26856 \begin_layout Plain Layout
26859 \begin_inset Quotes eld
26862 Well, I've a conscience, sir, and when I chanced to see you go into this
26863 house, as I came hobbling after you, I thought to myself, I'll just step
26864 in and see that kind gentleman, and tell him that if I was a bit gruff
26865 in my manner there was not any harm meant, and that I am much obliged to
26866 him for picking up my books.
26867 \begin_inset Quotes erd
26873 \begin_layout Plain Layout
26876 \begin_inset Quotes eld
26879 You make too much of a trifle,
26880 \begin_inset Quotes erd
26885 \begin_inset Quotes eld
26888 May I ask how you knew who I was?
26889 \begin_inset Quotes erd
26892 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
26896 \begin_layout Plain Layout
26908 \begin_layout Plain Layout
26911 \begin_inset Quotes eld
26914 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
26915 you'll find my little bookshop at the corner of Church Street, and very
26916 happy to see you, I am sure.
26917 Maybe you collect yourself, sir.
26921 \begin_inset space ~
26935 \begin_inset space ~
26938 – a bargain, every one of them.
26939 With five volumes you could just fill that gap on that second shelf.
26940 It looks untidy, does it not, sir?
26941 \begin_inset Quotes erd
26952 \begin_layout Subsubsection
26956 \begin_layout Standard
26957 The width of the columns is automatically calculated, but you can modify
26958 the space between the columns.
26959 This is done by changing the length
26960 \begin_inset Flex Code
26963 \begin_layout Plain Layout
26972 Its predefined value is 10
26973 \begin_inset space \thinspace{}
26977 Here is an example where
26978 \begin_inset Flex Code
26981 \begin_layout Plain Layout
26990 \begin_inset space \thinspace{}
26996 \begin_layout Standard
27000 \begin_layout Plain Layout
27014 \begin_layout Standard
27015 \begin_inset Flex Multiple Columns
27018 \begin_layout Plain Layout
27021 My observations of No.
27022 \begin_inset space \space{}
27025 427 Park Lane did little to clear up the problem in which I was interested.
27026 The house was separated from the street by a low wall and railing, the
27027 whole not more than five feet high.
27028 It was perfectly easy, therefore, for anyone to get into the garden, but
27029 the window was entirely inaccessible, since there was no water pipe or
27030 anything which could help the most active man to climb it.
27031 More puzzled than ever, I retraced my steps to Kensington.
27032 I had not been in my study five minutes when the maid entered to say that
27033 a person desired to see me.
27034 To my astonishment it was none other than my strange old book collector,
27035 his sharp, wizened face peering out from a frame of white hair, and his
27036 precious volumes, a dozen of them at least, wedged under his right arm.
27044 \begin_layout Standard
27048 \begin_layout Plain Layout
27060 \begin_inset Note Note
27063 \begin_layout Plain Layout
27064 go back to the default
27072 \begin_layout Subsubsection
27076 \begin_layout Standard
27077 Between the columns a rule with a width of the length
27078 \begin_inset Flex Code
27081 \begin_layout Plain Layout
27090 If this rule width is set to 0
27091 \begin_inset space \thinspace{}
27094 pt (this is the default), the rule is suppressed.
27095 In the following example the rule is 2
27096 \begin_inset space \thinspace{}
27102 \begin_layout Standard
27106 \begin_layout Plain Layout
27112 columnseprule}{2pt}
27120 \begin_layout Standard
27121 \begin_inset Flex Multiple Columns
27124 \begin_layout Plain Layout
27127 \begin_inset Quotes eld
27130 You're surprised to see me, sir,
27131 \begin_inset Quotes erd
27134 said he, in a strange, croaking voice.
27137 \begin_layout Plain Layout
27140 I acknowledged that I was.
27143 \begin_layout Plain Layout
27146 \begin_inset Quotes eld
27149 Well, I've a conscience, sir, and when I chanced to see you go into this
27150 house, as I came hobbling after you, I thought to myself, I'll just step
27151 in and see that kind gentleman, and tell him that if I was a bit gruff
27152 in my manner there was not any harm meant, and that I am much obliged to
27153 him for picking up my books.
27154 \begin_inset Quotes erd
27160 \begin_layout Plain Layout
27163 \begin_inset Quotes eld
27166 You make too much of a trifle,
27167 \begin_inset Quotes erd
27172 \begin_inset Quotes eld
27175 May I ask how you knew who I was?
27176 \begin_inset Quotes erd
27182 \begin_layout Plain Layout
27185 \begin_inset Quotes eld
27188 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
27189 you'll find my little bookshop at the corner of Church Street, and very
27190 happy to see you, I am sure.
27191 Maybe you collect yourself, sir.
27195 \begin_inset space ~
27209 \begin_inset space ~
27212 – a bargain, every one of them.
27213 With five volumes you could just fill that gap on that second shelf.
27214 It looks untidy, does it not, sir?
27215 \begin_inset Quotes erd
27226 \begin_layout Standard
27227 \begin_inset VSpace defskip
27233 \begin_layout Standard
27234 The rule can be colored by redefining the command
27235 \begin_inset Flex Code
27238 \begin_layout Plain Layout
27247 This is done by inserting the command
27250 \begin_layout LyX-Code
27255 columnseprulecolor}{
27260 \begin_layout Standard
27261 as \SpecialChar TeX
27262 Code before the multicolumn inset.
27264 \begin_inset Flex Code
27267 \begin_layout Plain Layout
27273 in this command by a color of your choice.
27274 You can use all pre- and self-defined colors.
27282 \begin_inset space ~
27287 for more information about pre- and self-defined colors.
27288 To go back to the default color insert the command
27291 \begin_layout LyX-Code
27296 columnseprulecolor}{
27301 \begin_layout Standard
27302 Here is the example with a cyan rule and 1
27303 \begin_inset space \thinspace{}
27306 cm column separation:
27309 \begin_layout Standard
27313 \begin_layout Plain Layout
27322 \begin_layout Plain Layout
27328 columnseprulecolor}{
27338 \begin_layout Standard
27339 \begin_inset Flex Multiple Columns
27342 \begin_layout Plain Layout
27345 \begin_inset Quotes eld
27348 You're surprised to see me, sir,
27349 \begin_inset Quotes erd
27352 said he, in a strange, croaking voice.
27355 \begin_layout Plain Layout
27358 I acknowledged that I was.
27361 \begin_layout Plain Layout
27364 \begin_inset Quotes eld
27367 Well, I've a conscience, sir, and when I chanced to see you go into this
27368 house, as I came hobbling after you, I thought to myself, I'll just step
27369 in and see that kind gentleman, and tell him that if I was a bit gruff
27370 in my manner there was not any harm meant, and that I am much obliged to
27371 him for picking up my books.
27372 \begin_inset Quotes erd
27378 \begin_layout Plain Layout
27381 \begin_inset Quotes eld
27384 You make too much of a trifle,
27385 \begin_inset Quotes erd
27390 \begin_inset Quotes eld
27393 May I ask how you knew who I was?
27394 \begin_inset Quotes erd
27400 \begin_layout Plain Layout
27403 \begin_inset Quotes eld
27406 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
27407 you'll find my little bookshop at the corner of Church Street, and very
27408 happy to see you, I am sure.
27409 Maybe you collect yourself, sir.
27413 \begin_inset space ~
27427 \begin_inset space ~
27430 – a bargain, every one of them.
27431 With five volumes you could just fill that gap on that second shelf.
27432 It looks untidy, does it not, sir?
27433 \begin_inset Quotes erd
27444 \begin_layout Standard
27448 \begin_layout Plain Layout
27454 columnseprule}{0pt}
27457 \begin_layout Plain Layout
27463 columnseprulecolor}{
27471 \begin_inset Note Note
27474 \begin_layout Plain Layout
27475 go back to the default
27483 \begin_layout Section
27484 Non-standard Paragraph Shapes
27487 \begin_layout Standard
27490 as well as any other text processor uses by default rectangular paragraphs.
27491 For special cases like for example posters, invitation cards or poems you
27492 can modify the paragraph shape to one of your choice.
27493 This can be done by using the \SpecialChar LaTeX
27495 \begin_inset Flex Code
27498 \begin_layout Plain Layout
27504 which is loaded by using in the document settings the module
27506 Custom paragraph shapes
27511 \begin_layout Subsection
27515 \begin_layout Standard
27520 provides the following shapes:
27523 \begin_layout Standard
27524 \begin_inset Tabular
27525 <lyxtabular version="3" rows="13" columns="3">
27526 <features booktabs="true" islongtable="true" longtabularalignment="center">
27527 <column alignment="left" valignment="middle" width="16col%">
27528 <column alignment="left" valignment="middle" width="40col%">
27529 <column alignment="left" valignment="middle" width="35col%">
27530 <row endhead="true">
27531 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
27534 \begin_layout Plain Layout
27543 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
27546 \begin_layout Plain Layout
27555 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
27558 \begin_layout Plain Layout
27568 <row interlinespace="default">
27569 <cell alignment="left" valignment="top" usebox="none">
27572 \begin_layout Plain Layout
27580 <cell alignment="left" valignment="top" usebox="none">
27583 \begin_layout Plain Layout
27586 Circle with circular hole (in the size of a CD/DVD)
27591 <cell alignment="left" valignment="top" usebox="none">
27594 \begin_layout Plain Layout
27597 Cannot be scaled, take care there is not too much text
27603 <row interlinespace="default">
27604 <cell alignment="left" valignment="top" usebox="none">
27607 \begin_layout Plain Layout
27615 <cell alignment="left" valignment="top" usebox="none">
27618 \begin_layout Plain Layout
27626 <cell alignment="left" valignment="top" usebox="none">
27629 \begin_layout Plain Layout
27632 Fragile, calculation might fail
27638 <row interlinespace="default">
27639 <cell alignment="left" valignment="top" usebox="none">
27642 \begin_layout Plain Layout
27650 <cell alignment="left" valignment="top" usebox="none">
27653 \begin_layout Plain Layout
27656 Rhomboid (symbolizing a
27657 \begin_inset Quotes eld
27661 \begin_inset Quotes erd
27669 <cell alignment="left" valignment="top" usebox="none">
27672 \begin_layout Plain Layout
27681 <row interlinespace="default">
27682 <cell alignment="left" valignment="top" usebox="none">
27685 \begin_layout Plain Layout
27693 <cell alignment="left" valignment="top" usebox="none">
27696 \begin_layout Plain Layout
27704 <cell alignment="left" valignment="top" usebox="none">
27707 \begin_layout Plain Layout
27716 <row interlinespace="default">
27717 <cell alignment="left" valignment="top" usebox="none">
27720 \begin_layout Plain Layout
27728 <cell alignment="left" valignment="top" usebox="none">
27731 \begin_layout Plain Layout
27739 <cell alignment="left" valignment="top" usebox="none">
27742 \begin_layout Plain Layout
27751 <row interlinespace="default">
27752 <cell alignment="left" valignment="top" usebox="none">
27755 \begin_layout Plain Layout
27763 <cell alignment="left" valignment="top" usebox="none">
27766 \begin_layout Plain Layout
27769 Nut for bolt (hexagon with circular hole)
27774 <cell alignment="left" valignment="top" usebox="none">
27777 \begin_layout Plain Layout
27786 <row interlinespace="default">
27787 <cell alignment="left" valignment="top" usebox="none">
27790 \begin_layout Plain Layout
27798 <cell alignment="left" valignment="top" usebox="none">
27801 \begin_layout Plain Layout
27809 <cell alignment="left" valignment="top" usebox="none">
27812 \begin_layout Plain Layout
27821 <row interlinespace="default">
27822 <cell alignment="left" valignment="top" usebox="none">
27825 \begin_layout Plain Layout
27833 <cell alignment="left" valignment="top" usebox="none">
27836 \begin_layout Plain Layout
27844 <cell alignment="left" valignment="top" usebox="none">
27847 \begin_layout Plain Layout
27856 <row interlinespace="default">
27857 <cell alignment="left" valignment="top" usebox="none">
27860 \begin_layout Plain Layout
27868 <cell alignment="left" valignment="top" usebox="none">
27871 \begin_layout Plain Layout
27879 <cell alignment="left" valignment="top" usebox="none">
27882 \begin_layout Plain Layout
27891 <row interlinespace="default">
27892 <cell alignment="left" valignment="top" usebox="none">
27895 \begin_layout Plain Layout
27903 <cell alignment="left" valignment="top" usebox="none">
27906 \begin_layout Plain Layout
27909 Normal/reversed rain drop
27914 <cell alignment="left" valignment="top" usebox="none">
27917 \begin_layout Plain Layout
27920 Fragile, calculation might fail
27926 <row interlinespace="default">
27927 <cell alignment="left" valignment="top" usebox="none">
27930 \begin_layout Plain Layout
27939 <cell alignment="left" valignment="top" usebox="none">
27942 \begin_layout Plain Layout
27945 The \SpecialChar TeX
27951 <cell alignment="left" valignment="top" usebox="none">
27954 \begin_layout Plain Layout
27963 <row interlinespace="default">
27964 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
27967 \begin_layout Plain Layout
27971 \begin_inset Newline newline
27979 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
27982 \begin_layout Plain Layout
27985 Triangles in different orientations
27990 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
27993 \begin_layout Plain Layout
28009 \begin_layout Standard
28010 To use a shape for your paragraph, simply select it in \SpecialChar LyX
28012 for environments in the toolbar.
28015 \begin_layout Standard
28016 \begin_inset Newpage newpage
28022 \begin_layout Standard
28023 Here is an example paragraph in the shape of a nut:
28026 \begin_layout Standard
28027 \begin_inset VSpace bigskip
28036 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28037 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28039 At vero eos et accusam et justo duo dolores et ea rebum.
28040 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
28042 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28043 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28047 \begin_layout Standard
28048 \begin_inset VSpace bigskip
28054 \begin_layout Standard
28055 \begin_inset Note Greyedout
28058 \begin_layout Plain Layout
28067 paragraphs cannot run over a page break.
28075 \begin_layout Standard
28076 \begin_inset VSpace bigskip
28082 \begin_layout Standard
28084 \begin_inset Flex Code
28087 \begin_layout Plain Layout
28093 takes care that the shape will always be preserved, no matter how much
28094 text is in the paragraph.
28095 Therefore the paragraph size changes with the amount of contained text.
28096 This can lead to paragraph sizes exceeding the page margins.
28097 To demonstrate the size scaling, here is the same example paragraph but
28098 with twice as much text:
28101 \begin_layout Standard
28102 \begin_inset Newpage newpage
28111 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28112 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28114 At vero eos et accusam et justo duo dolores et ea rebum.
28115 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
28117 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28118 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28120 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28121 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28123 At vero eos et accusam et justo duo dolores et ea rebum.
28124 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
28126 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28127 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28131 \begin_layout Standard
28132 \begin_inset VSpace bigskip
28138 \begin_layout Standard
28139 An exception is the shape
28144 It cannot be scaled because it must fit the size of a CD/DVD.
28145 Therefore the amount of text that fits into the shape is limited.
28146 \begin_inset Newline newline
28157 shape are fragile, meaning that the calculation of their size can fail,
28158 depending on the amount of text.
28159 You will then get the \SpecialChar LaTeX
28161 \begin_inset Quotes eld
28164 Arithmetic overflow
28165 \begin_inset Quotes erd
28169 In this case one can try to remove or add some text; if nothing works one
28170 has to use another shape.
28173 \begin_layout Standard
28174 \begin_inset VSpace bigskip
28180 \begin_layout Standard
28181 For shapes with tips you will maybe see that \SpecialChar LaTeX
28182 's hyphenation routine fails
28183 for text in the tips.
28184 Therefore it is often necessary to add hyphenation points
28189 arg "specialchar-insert hyphenation"
28194 ) to the corresponding text parts.
28197 \begin_layout Standard
28198 \begin_inset VSpace bigskip
28204 \begin_layout Standard
28205 Shapepar paragraphs are either always centered or placed on the page so
28206 that their left border touches the left page margin.
28207 You can therefore not use the paragraph dialog to align such paragraphs.
28208 A solution is to put the paragraph into a minipage or parbox and align
28210 The problem is hereby to find the right width for the box.
28211 Because if it is too wide and you center the box, the paragraph is not
28212 centered too because it sticks at the left side of the box.
28213 So you might have to play a bit with the width until it fits.
28214 Here are two heart-shaped paragraphs, the first one is not aligned, the
28215 second one is right-aligned:
28218 \begin_layout Standard
28219 \begin_inset Newpage newpage
28225 \begin_layout Heart
28229 Lo\SpecialChar softhyphen
28230 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28231 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28233 At vero eos et accusam et justo duo dolores et ea rebum.
28234 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
28238 \begin_layout Standard
28239 \begin_inset VSpace bigskip
28245 \begin_layout Standard
28248 \begin_inset Box Frameless
28258 height_special "totalheight"
28263 backgroundcolor "none"
28266 \begin_layout Heart
28270 Lo\SpecialChar softhyphen
28271 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28272 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28274 At vero eos et accusam et justo duo dolores et ea rebum.
28275 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
28284 \begin_layout Subsection
28288 \begin_layout Standard
28289 You can define any shape you want.
28290 Doing this manually is a lot of work because every coordinate must be specified.
28291 But there is a way to let the computer calculate the coordinates:
28294 \begin_layout Enumerate
28295 Install the program
28296 \begin_inset CommandInset href
28299 target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
28307 \begin_layout Enumerate
28314 TeX/LaTeX\SpecialChar menuseparator
28315 Settings\SpecialChar menuseparator
28318 and select the font size you are using in your document.
28319 For example this document uses the size 12
28320 \begin_inset space \thinspace{}
28326 \begin_layout Enumerate
28330 \begin_layout Enumerate
28333 TeX/LaTeX\SpecialChar menuseparator
28336 to export the shape to coordinates.
28337 In the appearing dialog use either the outline of your shape for the coordinate
28338 s or the path itself.
28342 \begin_layout Plain Layout
28343 For more information see
28344 \begin_inset CommandInset href
28346 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
28359 \begin_layout Standard
28360 The coordinates are written into a \SpecialChar TeX
28362 To use it for your \SpecialChar LyX
28366 \begin_layout Enumerate
28367 Place the cursor before the first character of your paragraph (or into a
28371 \begin_layout Enumerate
28372 Open in \SpecialChar LyX
28375 Insert\SpecialChar menuseparator
28376 File\SpecialChar menuseparator
28378 \begin_inset space ~
28383 , select the file and use
28392 \begin_layout Standard
28393 \begin_inset VSpace defskip
28399 \begin_layout Standard
28400 \begin_inset Note Greyedout
28403 \begin_layout Plain Layout
28408 : The changed shape only applies to the current paragraph; everything is
28409 reset to normal for the next paragraph.
28410 Therefore the shape definition file must be input into every paragraph
28411 with the desired shape.
28419 \begin_layout Standard
28420 \begin_inset VSpace bigskip
28426 \begin_layout Standard
28427 Here is an example:
28430 \begin_layout Standard
28431 \begin_inset VSpace bigskip
28437 \begin_layout Standard
28438 \begin_inset CommandInset include
28440 filename "SpecialParagraphShape.tex"
28447 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28448 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28450 At vero eos et accusam et justo duo dolores et ea rebum.
28451 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
28453 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28454 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28458 \begin_layout Standard
28459 \begin_inset VSpace bigskip
28465 \begin_layout Standard
28470 to draw complexer shapes in
28474 you can draw the shape in a program of your choice and import the resulting
28480 Then you only need to draw a line or spline along the outline of the image.
28483 \begin_layout Standard
28484 \begin_inset VSpace bigskip
28490 \begin_layout Standard
28493 Custom paragraph shapes
28495 also provides the two commands
28503 which can be used to define custom shapes coordinate by coordinate.
28507 \begin_layout Plain Layout
28508 These commands are internally used for all shapes described here.
28513 For information how these styles are used and about further customization
28514 possibilities, have a look at the
28515 \begin_inset CommandInset href
28517 name "documentation"
28518 target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
28524 \begin_inset Flex Code
28527 \begin_layout Plain Layout