1 #LyX 2.4 created this file. For more info see https://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 % DO NOT ALTER THIS PREAMBLE!!!
11 % This preamble is designed to ensure that the manual prints
12 % out as advertised. If you mess with this preamble,
13 % parts of the manual may not print out as expected. If you
14 % have problems LaTeXing this file, please contact
15 % the documentation team
16 % email: lyx-docs@lists.lyx.org
18 % the pages of the TOC are numbered roman
19 % and a PDF-bookmark for the TOC is added
21 \let\myTOC\tableofcontents
22 \renewcommand{\tableofcontents}{%
23 \pdfbookmark[1]{\contentsname}{}
26 \pagenumbering{arabic}}
28 % extra space for tables
29 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
31 \options bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
32 \use_default_options false
40 \maintain_unincluded_children no
42 \language_package default
45 \font_roman "lmodern" "default"
46 \font_sans "lmss" "default"
47 \font_typewriter "lmtt" "default"
48 \font_math "auto" "auto"
49 \font_default_family default
50 \use_non_tex_fonts false
54 \font_typewriter_osf false
55 \font_sf_scale 100 100
56 \font_tt_scale 100 100
58 \use_dash_ligatures true
60 \default_output_format pdf2
62 \bibtex_command default
63 \index_command default
67 \pdf_title "LyX's Additional Features manual"
68 \pdf_author "LyX Team"
69 \pdf_subject "LyX's additional features documentation"
70 \pdf_keywords "LyX, Documentation, Additional"
72 \pdf_bookmarksnumbered true
73 \pdf_bookmarksopen false
74 \pdf_bookmarksopenlevel 1
79 \pdf_pdfusetitle false
80 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
83 \use_package amsmath 1
84 \use_package amssymb 1
87 \use_package mathdots 1
88 \use_package mathtools 1
90 \use_package stackrel 1
91 \use_package stmaryrd 1
92 \use_package undertilde 1
94 \cite_engine_type default
98 \paperorientation portrait
104 \notefontcolor #0000ff
111 \paragraph_separation indent
112 \paragraph_indentation default
114 \math_indentation default
115 \math_numbering_side default
116 \quotes_style english
120 \paperpagestyle headings
122 \tracking_changes true
123 \output_changes false
125 \postpone_fragile_content false
129 \docbook_table_output 0
130 \docbook_mathml_prefix 1
131 \author -712698321 "Jürgen Spitzmüller"
134 \author 244031559 "Yuriy"
135 \author 564990737 "John Lyx"
136 \author 630872221 "Jean-Pierre Chrétien" jeanpierre.chretien@free.fr
137 \author 1075283030 "Thibaut"
138 \author 1119979965 "Joel A. Kulesza"
144 Additional \SpecialChar LyX
148 \begin_layout Subtitle
150 \change_deleted 630872221 1622909155
152 \change_inserted 630872221 1622909155
159 by the \SpecialChar LyX
164 \begin_layout Plain Layout
166 Principal maintainer of this file is
168 Richard Kimberly Heck
171 If you have comments or error corrections, please send them to the \SpecialChar LyX
174 \begin_inset Flex Code
177 \begin_layout Plain Layout
178 <lyx-docs@lists.lyx.org>
191 \begin_layout Standard
192 \begin_inset CommandInset toc
193 LatexCommand tableofcontents
200 \begin_layout Chapter
204 \begin_layout Standard
205 This manual is essentially Part II of the
207 User's Guide\SpecialChar endofsentence
210 The reason for separating the two documents is simple: the
214 is already quite lengthy, and it contains information on all of the basic
215 features one needs to know in order to prepare most documents.
216 However, the \SpecialChar LyX
217 Team has worked to make \SpecialChar LyX
218 extensible through various configuration
219 files and external packages.
220 That means that if you want to support the Fizzwizzle \SpecialChar LaTeX
222 create a layout file (or module) for it without having to alter \SpecialChar LyX
224 We've already had contributions of several new features this way, and some
225 of them are documented here.
226 There are also some more `advanced' features, such as how to control the
227 presentation of bibliographies and how to work with multi-part documents,
228 that are not covered in the
232 and are discussed here.
235 \begin_layout Standard
236 This manual also documents some special features, like fax support
237 \change_deleted 244031559 1603802929
239 \change_inserted 244031559 1603802931
243 \change_deleted 244031559 1603802954
246 , which require additional software to work properly.
247 There is also a chapter on \SpecialChar LyX
249 And lastly, there's a chapter of \SpecialChar LaTeX
250 tools and tips, things you can use to
251 spruce up your documents by directly using the powerful features of \SpecialChar LaTeX
253 After all, \SpecialChar LyX
258 only WYSIWYM and will only ever interface to some, not all, \SpecialChar LaTeX
262 \begin_layout Standard
263 If you haven't read the
267 yet, you are definitely in the wrong manual.
272 is the first place to go, since it describes the notation and format of
274 You should also be thoroughly familiar with the
278 and all of the basic features of \SpecialChar LyX
279 before attempting to read this one.
282 \begin_layout Standard
283 Since many of the topics in this manual depend heavily on \SpecialChar LyX
285 with \SpecialChar LaTeX
286 , this first chapter covers the inner workings of \SpecialChar LyX
289 to generate exactly the \SpecialChar LaTeX
291 It is obviously for more seasoned \SpecialChar LyX
295 \begin_layout Chapter
297 and \SpecialChar LaTeX
301 \begin_layout Section
303 Uses \SpecialChar LaTeX
307 \begin_layout Standard
308 This chapter is for both \SpecialChar TeX
309 -nicians and the \SpecialChar LaTeX
311 In it, we'll explain how \SpecialChar LyX
312 and \SpecialChar LaTeX
313 work together to produce printable output.
314 This is the only place in any of the manuals where we assume you know something
315 about \SpecialChar LaTeX
319 \begin_layout Standard
320 At one time, \SpecialChar LyX
322 \begin_inset Quotes eld
325 WYSIWYM frontend to \SpecialChar LaTeX
327 \begin_inset Quotes erd
330 but that's no longer true.
331 There are frontends to \SpecialChar LaTeX
336 \begin_layout Plain Layout
337 Some familar ones are \SpecialChar TeX
338 maker and kile, on Linux, and \SpecialChar TeX
340 There are also the \SpecialChar LaTeX
341 modes for vi and emacs, of course.
346 These are basically text editors with the ability to run \SpecialChar LaTeX
348 errors in the file you're editing.
349 Although \SpecialChar LyX
358 run \SpecialChar LaTeX
359 , and it also indicates errors in the file, it also does much, much
361 For one thing, you don't need to know \SpecialChar LaTeX
362 to use \SpecialChar LyX
365 has added its own extensions to \SpecialChar LaTeX
367 Try the following sometime: select
368 \begin_inset Flex Noun
371 \begin_layout Plain Layout
372 Export\SpecialChar menuseparator
379 \begin_inset Flex Noun
382 \begin_layout Plain Layout
389 \begin_inset Flex Noun
392 \begin_layout Plain Layout
393 View\SpecialChar menuseparator
403 ), then look at the preamble of the resulting
404 \begin_inset Flex Code
407 \begin_layout Plain Layout
414 You'll notice a variety of new macros defined specifically by \SpecialChar LyX
416 These macros are defined automatically, according to the features you use
420 \begin_layout Standard
421 There are several commands that automatically invoke \SpecialChar LaTeX
426 \begin_layout Itemize
427 \begin_inset Flex Noun
430 \begin_layout Plain Layout
431 Document\SpecialChar menuseparator
440 \begin_layout Itemize
441 \begin_inset Flex Noun
444 \begin_layout Plain Layout
445 Document\SpecialChar menuseparator
454 \begin_layout Standard
455 They will only invoke \SpecialChar LaTeX
456 if the file has changed since the last time \SpecialChar LaTeX
462 \begin_layout Standard
463 When \SpecialChar LyX
464 runs \SpecialChar LaTeX
465 on the file you're editing, it performs these steps:
468 \begin_layout Enumerate
469 Convert the document to \SpecialChar LaTeX
470 and save to a file with the extension
471 \begin_inset Flex Code
474 \begin_layout Plain Layout
481 \begin_inset Flex Code
484 \begin_layout Plain Layout
493 \begin_layout Enumerate
494 Run \SpecialChar LaTeX
496 \begin_inset Flex Code
499 \begin_layout Plain Layout
505 file (maybe several times), and run any other commands (such as
506 \begin_inset Flex Code
509 \begin_layout Plain Layout
516 \begin_inset Flex Code
519 \begin_layout Plain Layout
525 ) needed to compile the \SpecialChar LaTeX
529 \begin_layout Enumerate
530 If there are any errors, show the error log.
533 \begin_layout Standard
534 If you have run \SpecialChar LaTeX
536 \begin_inset Flex Noun
539 \begin_layout Plain Layout
540 View\SpecialChar menuseparator
547 then runs a DVI viewer to display the DVI-file.
549 \begin_inset Flex Noun
552 \begin_layout Plain Layout
553 View\SpecialChar menuseparator
560 performs further steps:
563 \begin_layout Enumerate
565 \begin_inset Flex Code
568 \begin_layout Plain Layout
574 to convert the DVI file to PostScript.
577 \begin_layout Enumerate
578 Run a PostScript viewer, such as
579 \begin_inset Flex Code
582 \begin_layout Plain Layout
588 , to display the PostScript file.
591 \begin_layout Standard
593 does similar things when viewing, or exporting, other formats.
596 \begin_layout Section
597 Translating \SpecialChar LaTeX
598 files into \SpecialChar LyX
602 \begin_layout Standard
603 You can import a \SpecialChar LaTeX
604 file into \SpecialChar LyX
606 \begin_inset Flex Noun
609 \begin_layout Plain Layout
610 File\SpecialChar menuseparator
611 Import\SpecialChar menuseparator
617 command in \SpecialChar LyX
619 This will call a program named
620 \begin_inset Flex Code
623 \begin_layout Plain Layout
629 which will create a file
630 \begin_inset Flex Code
633 \begin_layout Plain Layout
640 \begin_inset Flex Code
643 \begin_layout Plain Layout
651 will then open that file.
655 \begin_layout Plain Layout
656 \begin_inset Flex Code
659 \begin_layout Plain Layout
665 can also be run from the command line, of course.
673 \begin_layout Standard
674 \begin_inset Flex Code
677 \begin_layout Plain Layout
683 will translate most legal \SpecialChar LaTeX
684 , but not everything.
685 It will put things it doesn't understand into \SpecialChar TeX
686 code, so after translating
688 \begin_inset Flex Code
691 \begin_layout Plain Layout
697 , you can look for \SpecialChar TeX
698 code and hand-edit it until it looks right.
701 \begin_layout Standard
702 If you don't know what \SpecialChar TeX
703 code is, read the next section.
706 \begin_layout Section
707 \begin_inset CommandInset label
709 name "sec:Inserting-TeX-Code"
713 Inserting \SpecialChar TeX
714 Code into \SpecialChar LyX
718 \begin_layout Standard
719 Anything you can do in \SpecialChar LaTeX
720 you can do in \SpecialChar LyX
721 , for a very simple reason: You can
722 always insert \SpecialChar TeX
723 code into any \SpecialChar LyX
726 cannot, and will never be able to, display every possible \SpecialChar LaTeX
728 If ever you need to insert \SpecialChar LaTeX
729 commands into your \SpecialChar LyX
730 document, you can use the
732 \begin_inset Flex Code
735 \begin_layout Plain Layout
742 box, which you can insert into your document with
743 \begin_inset Flex Noun
746 \begin_layout Plain Layout
747 Insert\SpecialChar menuseparator
757 or the keyboard shortcut
766 \begin_layout Standard
767 Here's an example of inserting \SpecialChar LaTeX
768 commands in a \SpecialChar LyX
770 The code looks like this:
773 \begin_layout LyX-Code
777 \begin_inset Newline newline
783 \begin_inset Newline newline
786 This is an example of a minipage environment.
788 \begin_inset Newline newline
791 can put nearly everything in it, even (non-floating)
792 \begin_inset Newline newline
797 \begin_inset Newline newline
803 \begin_inset Newline newline
807 \begin_inset Newline newline
813 \begin_inset Newline newline
819 \begin_inset Newline newline
825 \begin_inset Newline newline
830 \begin_inset Newline newline
836 \begin_inset Newline newline
842 \begin_inset Newline newline
848 \begin_inset Newline newline
856 \begin_layout LyX-Code
860 \begin_layout Standard
862 \begin_inset Flex Code
865 \begin_layout Plain Layout
872 box containing this text is directly after this paragraph.
873 Those of you reading the manual in \SpecialChar LyX
874 will only see the \SpecialChar TeX
876 Those reading a printed version of the manuals will see the actual results:
877 \begin_inset VSpace bigskip
883 \begin_layout Standard
887 \begin_layout Plain Layout
894 \begin_layout Plain Layout
901 \begin_layout Plain Layout
903 This is an example of a minipage environment.
904 You can put nearly everything in it, even (non-floating) figures and tables.
908 \begin_layout Plain Layout
915 \begin_layout Plain Layout
920 \begin_layout Plain Layout
927 \begin_layout Plain Layout
934 \begin_layout Plain Layout
941 \begin_layout Plain Layout
947 \begin_layout Plain Layout
954 \begin_layout Plain Layout
961 \begin_layout Plain Layout
968 \begin_layout Plain Layout
978 \begin_inset VSpace bigskip
984 \begin_layout Standard
985 In addition to using \SpecialChar TeX
986 code, you can also create a separate file containing
987 some complex \SpecialChar LaTeX
988 structure and then use
989 \begin_inset Flex Noun
992 \begin_layout Plain Layout
993 Insert\SpecialChar menuseparator
1003 to include your file (you should select the type
1004 \begin_inset Flex Code
1007 \begin_layout Plain Layout
1014 We recommend that you only do this if you have a
1015 \begin_inset Flex Code
1018 \begin_layout Plain Layout
1029 Otherwise, you'll have a big job tracking down \SpecialChar LaTeX
1033 \begin_layout Standard
1034 There are a few last points to emphasize:
1037 \begin_layout Itemize
1043 check if your \SpecialChar LaTeX
1047 \begin_layout Itemize
1048 Beware of reinventing the wheel.
1051 \begin_layout Standard
1052 On that last point, \SpecialChar LyX
1053 does have quite a few features tucked into it, and
1055 Be sure to check the manuals to make sure that \SpecialChar LyX
1056 doesn't have such-and-such
1057 feature before you decide you have to do it by hand.
1058 Moreover, there are numerous \SpecialChar LaTeX
1059 packages out there to do all sorts of things,
1060 from labels to envelopes to fancy multipage tables.
1062 \change_inserted 244031559 1603815732
1064 \begin_inset CommandInset href
1067 target "https://www.ctan.org/"
1073 \change_deleted 244031559 1603815732
1075 \begin_inset CommandInset href
1078 target "http://www.ctan.org/"
1088 \begin_layout Standard
1089 If you do need to do some wild and fancy things within your document, be
1090 sure to check out a good \SpecialChar LaTeX
1091 book for assistance.
1092 There are a number of them listed in the bibliography of the
1099 \begin_layout Section
1101 and the \SpecialChar LaTeX
1105 \begin_layout Subsection
1106 About the \SpecialChar LaTeX
1110 \begin_layout Standard
1111 If you already know \SpecialChar LaTeX
1112 , there is no need to explain here what the preamble
1114 If you don't, the following will give you some ideas—we recommend again
1115 that you consult a \SpecialChar LaTeX
1116 book for further information.
1117 In any case, you should read the points below, because they explain what
1118 you can do and what you don't need to do in the \SpecialChar LaTeX
1119 preamble of a \SpecialChar LyX
1123 \begin_layout Standard
1124 The \SpecialChar LaTeX
1125 preamble comes at the very beginning of a document,
1133 \begin_layout Itemize
1134 Declare the document class.
1136 \begin_inset Newline newline
1140 already does this for you.
1141 If you're a seasoned \SpecialChar LaTeX
1142 -nician, and you have a custom document class you
1143 want to use, check out the
1145 Customization Manual
1147 for information on how to make \SpecialChar LyX
1151 \begin_layout Itemize
1152 Declare the usage of packages.
1154 \begin_inset Newline newline
1158 packages provide special commands, which are only available within a document
1159 when the package has been declared in the preamble.
1160 In addition to providing special commands, the inclusion of a package can
1161 change the document.
1162 For example, the package
1163 \begin_inset Flex Code
1166 \begin_layout Plain Layout
1172 forces all paragraphs to be indented.
1173 There are other packages for labels, envelopes, margins, etc.
1177 \begin_layout Itemize
1178 Set counters, variables, lengths and widths.
1180 \begin_inset Newline newline
1183 There are several \SpecialChar LaTeX
1184 counters and variables that
1188 be set globally from within the preamble in order to have the desired effect.
1189 (There are variables that you can set and reset inside the document, too.)
1190 Margins are a good example of something that must be set in the preamble.
1191 Another example is the label format for lists.
1192 You can actually set these just about anywhere, but it's best to do it
1193 just once, inside the preamble.
1196 \begin_layout Itemize
1197 Declare user defined commands (with
1198 \begin_inset Flex Code
1201 \begin_layout Plain Layout
1210 \begin_inset Flex Code
1213 \begin_layout Plain Layout
1222 \begin_inset Newline newline
1225 These are abbreviations for \SpecialChar LaTeX
1226 commands which appear very often inside a document.
1227 Although the preamble is a good place to declare such commands, they
1231 be declared anywhere (before they are used for the first time, of course).
1232 This can be useful if there is a lot of raw \SpecialChar LaTeX
1233 code in your document, which
1234 normally should not be the case.
1237 \begin_layout Standard
1239 adds its own set of definitions to the preamble of the
1240 \begin_inset Flex Code
1243 \begin_layout Plain Layout
1250 This makes \SpecialChar LaTeX
1251 files generated by \SpecialChar LyX
1255 \begin_layout Subsection
1256 Changing the Preamble
1259 \begin_layout Standard
1260 The commands which \SpecialChar LyX
1261 adds to the preamble of a \SpecialChar LaTeX
1262 file are fixed; you can't
1263 change them without patching \SpecialChar LyX
1265 You can, however, add your own stuff to the preamble by selecting
1266 \begin_inset Flex Noun
1269 \begin_layout Plain Layout
1272 \begin_inset space ~
1281 \begin_inset Flex Noun
1284 \begin_layout Plain Layout
1285 Document\SpecialChar menuseparator
1293 adds anything in the
1294 \begin_inset Flex Noun
1297 \begin_layout Plain Layout
1303 dialog to its own built-in preamble.
1304 Before adding your own declarations in the preamble, you should make sure
1305 that \SpecialChar LyX
1306 doesn't already support what you want to do.
1307 (Remember what we said about reinventing the wheel?) Also,
1309 make sure your preamble code is correct
1313 doesn't check it for you.
1314 If there is an error, you're likely to get an error like
1315 \begin_inset Quotes eld
1319 \begin_inset Flex Code
1322 \begin_layout Plain Layout
1331 \begin_inset Quotes erd
1335 If you see this error, check your preamble.
1338 \begin_layout Subsection
1342 \begin_layout Standard
1343 Here are some examples of what you can add to a preamble, and what they
1347 \begin_layout Subsubsection
1351 \begin_layout Standard
1352 There are two variables under \SpecialChar LaTeX
1353 that control page position:
1354 \begin_inset Flex Code
1357 \begin_layout Plain Layout
1366 \begin_inset Flex Code
1369 \begin_layout Plain Layout
1378 Their names should be self-explanatory.
1379 These variables are useful if you think for a moment about computer labels.
1380 Sometimes, the size of a print medium and the area of the medium that you
1381 can actually print on aren't the same.
1383 \begin_inset Flex Code
1386 \begin_layout Plain Layout
1395 \begin_inset Flex Code
1398 \begin_layout Plain Layout
1409 \begin_layout Standard
1410 The default values for
1411 \begin_inset Flex Code
1414 \begin_layout Plain Layout
1423 \begin_inset Flex Code
1426 \begin_layout Plain Layout
1435 \begin_inset space \thinspace{}
1439 \begin_inset space \thinspace{}
1443 \begin_inset space \space{}
1446 the page isn't shifted.
1447 Unfortunately, some DVI drivers always seem to shift the page.
1448 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1449 If you're using \SpecialChar LyX
1450 on a system that you don't personally maintain, and your
1451 sysadmin is a doofus,
1452 \begin_inset Flex Code
1455 \begin_layout Plain Layout
1464 \begin_inset Flex Code
1467 \begin_layout Plain Layout
1476 Suppose your left and top margins are always 0.5
1477 \begin_inset space \thinspace{}
1481 You can add this to the preamble:
1484 \begin_layout LyX-Code
1492 \begin_layout LyX-Code
1500 \begin_layout Standard
1501 and your margins should now be correct.
1504 \begin_layout Subsubsection
1508 \begin_layout Standard
1509 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1510 There's a rather nice package, available at your nearest CTAN archive,
1511 for printing sheets of labels:
1512 \begin_inset Flex Code
1515 \begin_layout Plain Layout
1522 Now, your system may not have this package installed by default.
1523 We leave that up to you to check.
1524 You'll also want to read the documentation for it; we're not going to do
1526 Since this is an example, however, we'll give you an example of how you
1530 \begin_layout Standard
1531 First, make sure you're using the
1532 \begin_inset Flex Code
1535 \begin_layout Plain Layout
1542 Next, you need to put the following in your preamble:
1545 \begin_layout LyX-Code
1551 \begin_layout LyX-Code
1557 \begin_layout LyX-Code
1563 \begin_layout LyX-Code
1569 \begin_layout LyX-Code
1575 \begin_layout LyX-Code
1581 \begin_layout LyX-Code
1587 \begin_layout Standard
1588 This sets things up for Avery label sheets, stock #5360.
1589 You're now ready to print labels, but you'll need to insert \SpecialChar LaTeX
1592 \begin_inset Flex Code
1595 \begin_layout Plain Layout
1604 \begin_inset Flex Code
1607 \begin_layout Plain Layout
1615 around each label text.
1616 This and other special features of
1617 \begin_inset Flex Code
1620 \begin_layout Plain Layout
1626 are explained in its documentation.
1629 \begin_layout Standard
1630 Someday, someone may write a \SpecialChar LyX
1631 layout file to support this package directly.
1632 Maybe that someone is you.
1635 \begin_layout Subsubsection
1636 Example #3: Paragraph Indentation
1639 \begin_layout Standard
1640 Americans are trained to indent the first line of
1645 As with all of their other weird quirks, most Americans will whine and
1646 moan until they can have their way and indent the first line of all paragraphs.
1655 \begin_layout Standard
1656 Of course, this behavior isn't standard typography.
1657 In books, you typically only indent the first line of a paragraph
1661 it follows another one.
1662 The idea behind indenting the first line of a paragraph is to distinguish
1663 neighboring paragraphs from one another.
1664 If there is no previous paragraph—for example, if it follows a figure or
1665 is the first paragraph in a section—then there is no need for indentation.
1669 \begin_layout Standard
1670 If you're a typical American (we're still joking!), though, you don't care
1671 about such esoteric things; you want your indentation! Add this to the
1675 \begin_layout LyX-Code
1678 usepackage{indentfirst}
1681 \begin_layout Standard
1682 If your \SpecialChar TeX
1683 distribution isn't braindead, you'll have this package, and all
1684 of your paragraphs will get the indentation the Founding Fathers intended
1688 \begin_layout Subsubsection
1689 Example #4: This Document
1692 \begin_layout Standard
1693 You can also check out the preamble of this document to get an idea of some
1694 of the advanced things you can do.
1697 \begin_layout Section
1699 and \SpecialChar LaTeX
1703 \begin_layout Standard
1704 When \SpecialChar LyX
1705 calls \SpecialChar LaTeX
1706 , it tells \SpecialChar LaTeX
1707 to blithely ignore any errors and keep going.
1708 It then uses the logfile from the \SpecialChar LaTeX
1709 run to do a post-mortem.
1710 After analyzing the logfile, \SpecialChar LyX
1711 displays a dialog listing the errors.
1712 Clicking on any one of them will take you to the position in your \SpecialChar LyX
1714 where the error occurred.
1718 \begin_layout Plain Layout
1720 Analyzing the logfile is a tough job, and \SpecialChar LyX
1721 doesn't always go to the right
1723 There are also cases where \SpecialChar LaTeX
1724 reports the error on one line, but the actual
1726 This is not unlike forgetting a closing brace in a program: You'll get
1727 an error, but only later.
1735 \begin_layout Standard
1736 Some folks also like to look at the log file directly: It is available from
1738 \begin_inset Flex Noun
1741 \begin_layout Plain Layout
1742 Document\SpecialChar menuseparator
1744 \begin_inset space ~
1753 There are some fairly common error messages and warnings.
1754 We'll cover those here.
1755 You should look at a good \SpecialChar LaTeX
1756 book for a complete listing.
1759 \begin_layout Itemize
1760 \begin_inset Flex Code
1763 \begin_layout Plain Layout
1770 \begin_inset Newline newline
1773 Anything beginning with these words is a warning message for the purpose
1775 \begin_inset Quotes eld
1779 \begin_inset Quotes erd
1782 the \SpecialChar LaTeX
1784 You'll get messages like this if you added or changed cross-references
1785 or bibliography entries, in which case, \SpecialChar LaTeX
1786 is trying to tell you that you
1787 need to make another run.
1788 You can by-and-large ignore these.
1791 \begin_layout Itemize
1792 \begin_inset Flex Code
1795 \begin_layout Plain Layout
1802 \begin_inset Newline newline
1805 Another warning message, this time about fonts which \SpecialChar LaTeX
1807 The rest of the message will often say something about a replacement font
1808 that \SpecialChar LaTeX
1810 You can safely ignore these, too.
1813 \begin_layout Itemize
1814 \begin_inset Flex Code
1817 \begin_layout Plain Layout
1826 \begin_inset Newline newline
1835 It seems to generate at least one of these messages for just about any
1837 They are warnings about lines that were too long and run past the right
1839 This happens if \SpecialChar LaTeX
1840 does not find a reasonable way to break the lines (notoriously
1841 often with typewriter font, since this does not allow for automatic break
1843 In many cases, this is unnoticeable in the final output.
1844 (It can be just a point or two.) Sometimes, however, the lines run rather
1845 visibly into the margin; something you will not want to have in your final
1848 \begin_inset Newline newline
1851 There are several global ways to try to minimize the overfull lines.
1854 Enable micro-typographic extensions
1858 Document\SpecialChar menuseparator
1859 Settings\SpecialChar menuseparator
1862 might already improve things a lot.
1863 Furthermore, \SpecialChar LaTeX
1864 code such as the following in
1866 Document\SpecialChar menuseparator
1867 Settings\SpecialChar menuseparator
1870 usually reduces the overfull lines drastically (we use this in the preamble
1875 \begin_layout LyX-Code
1879 \begin_inset Newline newline
1885 \begin_inset Newline newline
1890 emergencystretch 1.5em
1891 \begin_inset Newline newline
1899 \begin_layout Standard
1900 In some cases, however, you eventually have to rewrite the text to get the
1901 line breaking right.
1905 \begin_layout Plain Layout
1906 For more information, see
1907 \begin_inset Flex URL
1910 \begin_layout Plain Layout
1912 http://www.tex.ac.uk/FAQ-overfull.html
1925 \begin_layout Standard
1926 In any case, you should check the respective lines, at least for the final
1927 version of your document.
1928 Your eyes will tell you if there's a problem with something that's too
1933 \begin_layout Plain Layout
1934 You can also enable the `draft' option in
1935 \begin_inset Flex Noun
1938 \begin_layout Plain Layout
1939 Document\SpecialChar menuseparator
1945 , and then \SpecialChar LaTeX
1946 will draw a black box in the margin of lines that are overfull.
1955 \begin_layout Itemize
1956 \begin_inset Flex Code
1959 \begin_layout Plain Layout
1968 \begin_inset Newline newline
1971 Not quite as common as its cousin.
1972 This happens again if \SpecialChar LaTeX
1973 does not find a reasonable break point and consequently
1974 generates too loose lines.
1975 As with the overfull lines, you should check if this is a visible problem.
1978 \begin_layout Itemize
1979 \begin_inset Flex Code
1982 \begin_layout Plain Layout
1991 \begin_inset Flex Code
1994 \begin_layout Plain Layout
2003 \begin_inset Newline newline
2006 Warnings about troubles breaking the page.
2007 Once again, just look at the output.
2008 Your eyes will tell you where something has gone wrong.
2011 \begin_layout Itemize
2012 \begin_inset Flex Code
2015 \begin_layout Plain Layout
2017 \begin_inset Quotes els
2021 \begin_inset Quotes ers
2030 \begin_inset Newline newline
2034 \begin_inset Quotes eld
2038 \begin_inset Quotes erd
2041 isn't installed on this system.
2042 This usually appears because some package your document needs isn't installed.
2043 If you didn't touch the preamble or didn't use the
2044 \begin_inset Flex Code
2047 \begin_layout Plain Layout
2055 command, then one of the packages \SpecialChar LyX
2056 tried to load is missing.
2058 \begin_inset Flex Noun
2061 \begin_layout Plain Layout
2062 Help\SpecialChar menuseparator
2069 to get a list of packages that \SpecialChar LyX
2071 This file is updated whenever you reconfigure \SpecialChar LyX
2073 \begin_inset Flex Noun
2076 \begin_layout Plain Layout
2077 Tools\SpecialChar menuseparator
2083 ) and tells you which packages have been detected and what they do.
2084 \begin_inset Newline newline
2088 \begin_inset Flex Code
2091 \begin_layout Plain Layout
2099 command and the package in question isn't installed, then you'll need to
2100 install it yourself.
2103 \begin_layout Itemize
2104 \begin_inset Flex Code
2107 \begin_layout Plain Layout
2108 LaTeX Error: Unknown option
2114 \begin_inset Newline newline
2117 Error messages beginning with this are trying to tell you that you specified
2118 a bad or undefined option to a package.
2119 Check the package's documentation.
2122 \begin_layout Itemize
2123 \begin_inset Flex Code
2126 \begin_layout Plain Layout
2127 Undefined control sequence
2133 \begin_inset Newline newline
2136 If you've inserted \SpecialChar LaTeX
2137 code into your document, but made a typo, you'll get
2139 You may have forgotten to load a package.
2140 In any case, this error message usually means that you used an undefined
2145 \begin_layout Standard
2146 There are other error and warning messages.
2147 Some are self-explanatory.
2148 These are usually \SpecialChar LaTeX
2150 Others are downright cryptic.
2151 These are usually \SpecialChar TeX
2152 error messages, and we really have
2156 what they mean or how to decipher them.
2160 \begin_layout Standard
2161 There's a general sequence you should follow if you get error messages:
2164 \begin_layout Enumerate
2165 Look at the \SpecialChar LaTeX
2166 code you inserted for typos.
2169 \begin_layout Enumerate
2170 If there are no typos, check that you used the command(s) correctly.
2173 \begin_layout Enumerate
2174 If you get a bunch of error boxes piled up at the very top of the document—and
2175 especially if you see a
2176 \begin_inset Quotes eld
2180 \begin_inset Flex Code
2183 \begin_layout Plain Layout
2192 \begin_inset Quotes erd
2195 error—it means that there are errors in the preamble.
2196 Start debugging your preamble.
2199 \begin_layout Enumerate
2200 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2202 document, the first suspect is your \SpecialChar LaTeX
2203 distribution itself.
2204 Check for missing packages and install them.
2207 \begin_layout Enumerate
2208 Okay, so there are no missing packages.
2209 Did you use any of the fine-tuning options in \SpecialChar LyX
2210 ? Specifically, did you
2214 any of them, like trying to manually insert lots of
2215 \begin_inset Flex Code
2218 \begin_layout Plain Layout
2220 \change_deleted 177693 1654669036
2222 \change_inserted 177693 1654669038
2226 \begin_inset space ~
2230 \change_deleted 177693 1654669040
2232 \change_inserted 177693 1654669041
2241 \begin_inset Flex Code
2244 \begin_layout Plain Layout
2251 \begin_inset Flex Code
2254 \begin_layout Plain Layout
2260 ? Did you try to kludge something together with these instead of using the
2261 appropriate paragraph environment?
2264 \begin_layout Enumerate
2265 All right, you didn't use any of the fine-tuning options, you played by
2267 Did you try to pull a fancy maneuver? Did you do something funky inside
2268 a table or an equation, like inserting a graphic into a table cell?
2271 \begin_layout Enumerate
2272 Do you have long sections of text where \SpecialChar LaTeX
2273 cannot find a place to break a
2274 line? By default, \SpecialChar LaTeX
2275 is rather strict about how much extra inter-word spacing
2276 it will add in order to break a line.
2277 Preferably, you should rework the paragraph to avoid the problem.
2280 \begin_layout Enumerate
2281 Did you go overboard with the nesting? \SpecialChar LyX
2282 (currently) doesn't check to make
2283 sure you're in the limits for nesting environments.
2284 If you nested a bunch of environments to the
2285 \begin_inset Formula $17^{\mathrm{th}}$
2288 level, that's the problem.
2289 (The limit in \SpecialChar LaTeX
2293 \begin_layout Enumerate
2294 Okay, you didn't get any error messages, but your output looks awful.
2295 If you have a table or figure that's too wide or long for the page, you
2300 \begin_layout Enumerate
2301 rescale the figure so it fits.
2304 \begin_layout Enumerate
2305 trim down the table so it fits.
2309 \begin_layout Enumerate
2310 If something else is wrong with the output, and you didn't try to pull anything
2311 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2314 \begin_layout Standard
2315 If all this doesn't help—well, then
2319 you might have found a bug in \SpecialChar LyX
2324 \begin_layout Chapter
2326 \change_inserted 564990737 1670439508
2330 \begin_layout Section
2332 \change_inserted 564990737 1670439533
2333 \begin_inset CommandInset label
2335 name "sec:Collections"
2342 \begin_layout Subsection
2343 AMS \SpecialChar LaTeX
2347 \begin_layout Standard
2354 Richard Kimberly Heck
2357 \begin_layout Standard
2358 \begin_inset VSpace bigskip
2364 \begin_layout Standard
2366 The AMS \SpecialChar LaTeX
2367 layouts are set up to conform to suggested styles for mathematical
2368 papers to be submitted to American Mathematical Society publications.
2369 The layouts are not tailored to a specific journal, but easily can be.
2370 You should refer to the AMS documentation for specific instructions for
2371 each journal (usually it will entail only changing a single line in the
2374 That documentation is available on the Web at
2375 \begin_inset Flex URL
2378 \begin_layout Plain Layout
2386 \begin_inset Flex URL
2389 \begin_layout Plain Layout
2391 ftp://ftp.ams.org/pub/tex/amslatex/
2397 These layouts are appropriate, and useful, for any mathematical writing.
2401 \begin_layout Standard
2402 There are two basic AMS \SpecialChar LaTeX
2406 \begin_layout Itemize
2407 amsart: The standard AMS article format.
2410 \begin_layout Itemize
2411 amsbook: the standard AMS book (really, monograph) format.
2415 \begin_layout Standard
2416 The layouts themselves contain only the minimum necessary to use the AMS
2418 They do not, in particular, contain any of the `theorem' environments used
2419 for setting theorems, lemmas, and the like.
2420 These are contained, instead, in the
2421 \begin_inset Flex Code
2424 \begin_layout Plain Layout
2430 module, which is loaded by default when you select one of the AMS classes.
2431 (It can also be used with other classes and can be removed, if you would
2432 rather use something else.) Less commonly used environments are in the
2433 \begin_inset Flex Code
2436 \begin_layout Plain Layout
2437 Theorems (AMS-Extended)
2442 module, which must be loaded manually.
2445 \begin_layout Standard
2446 By default, theorems and the like are numbered consecutively throughout
2447 the document, but this may be modified by loading the module
2448 \begin_inset Flex Code
2451 \begin_layout Plain Layout
2452 Theorems (Order by Section)
2457 or, if you are using
2458 \begin_inset Flex Code
2461 \begin_layout Plain Layout
2468 \begin_inset Flex Code
2471 \begin_layout Plain Layout
2472 Theorems (Order by Chapter)
2478 These will number the results as
2479 \begin_inset Formula $n.m$
2482 , where the first number refers to the section (or chapter) and the second
2483 refers to the total number of results so far in that section (or chapter).
2484 Many environments are also available unnumbered.
2485 These are indicated by an asterisk at the end.
2486 If you happen to want
2490 unnumbered results, the module
2491 \begin_inset Flex Code
2494 \begin_layout Plain Layout
2500 provides that option.
2503 \begin_layout Standard
2504 Note that these modules do not
2508 to be used with the AMS classes.
2509 It is perfectly possible to use the
2510 \begin_inset Flex Code
2513 \begin_layout Plain Layout
2519 module, and the others mentioned, with other classes, such as
2520 \begin_inset Flex Code
2523 \begin_layout Plain Layout
2530 \begin_inset Flex Code
2533 \begin_layout Plain Layout
2540 \begin_inset Flex Code
2543 \begin_layout Plain Layout
2552 \begin_layout Subsubsection
2553 What these layouts provide
2556 \begin_layout Standard
2557 There is a long list of included environments provided by these layouts.
2558 In AMS-\SpecialChar LaTeX
2559 , there is, in fact, an opportunity to define an unlimited variety
2560 of `theorem' environments.
2561 However, the AMS recommends the environments that are available in \SpecialChar LyX
2566 \begin_layout Standard
2567 The following environments—as well as the standard environments, such as
2569 \begin_inset Flex Noun
2572 \begin_layout Plain Layout
2579 \begin_inset Flex Noun
2582 \begin_layout Plain Layout
2589 \begin_inset Flex Noun
2592 \begin_layout Plain Layout
2599 \begin_inset Flex Noun
2602 \begin_layout Plain Layout
2609 \begin_inset Flex Noun
2612 \begin_layout Plain Layout
2619 \begin_inset Flex Code
2622 \begin_layout Plain Layout
2629 \begin_inset Flex Code
2632 \begin_layout Plain Layout
2641 \begin_layout Description
2642 Address This should be the author's permanent address.
2645 \begin_layout Description
2647 \begin_inset space ~
2650 Address This should be the author's temporary address at the time of submission,
2651 if different from the Address.
2654 \begin_layout Description
2655 Email Author's e-mail address
2658 \begin_layout Description
2659 URL Author's Web address, if desired.
2662 \begin_layout Description
2663 Keywords Key words or phrases used to identify specific topics discussed
2667 \begin_layout Description
2668 Subjectclass These refer to the AMS Subject Classifications, published and
2671 Mathematical Reviews
2674 These are also available online at the AMS cites listed above.
2677 \begin_layout Description
2681 \begin_layout Description
2685 \begin_layout Description
2689 \begin_layout Standard
2690 The following environments are provided by both the
2691 \begin_inset Flex Code
2694 \begin_layout Plain Layout
2701 \begin_inset Flex Code
2704 \begin_layout Plain Layout
2710 modules, in the latter case in both starred (unnumbered) and unstarred
2711 (numbered) versions.
2712 These same environments are provided only in the starred versions by the
2714 \begin_inset Flex Code
2717 \begin_layout Plain Layout
2726 \begin_layout Theorem
2727 This is typically used for the statements of major results.
2731 \begin_layout Corollary*
2732 This is used for statements which follow fairly directly from previous statement
2734 Again, these can be major results.
2739 These are smaller results needed to prove other statements.
2742 \begin_layout Proposition
2743 These are less major results which (hopefully) add to the general theory
2747 \begin_layout Conjecture
2748 These are statements provided without justification, which the author does
2749 not know how to prove, but which seem to be true (to the author, at least).
2752 \begin_layout Definition*
2753 Guess what this is for.
2754 The font is different for this environment than for the previous ones.
2758 \begin_layout Example*
2759 Used for examples illustrating proven results.
2762 \begin_layout Problem
2763 It's not really known what this is for.
2764 You should figure it out.
2767 \begin_layout Exercise*
2768 Write a description for this one.
2771 \begin_layout Remark
2772 This environment is also a type of theorem, usually a lesser sort of observation.
2775 \begin_layout Claim*
2776 Often used in the course of giving a proof of a larger result.
2780 Generally, these are used to break up long arguments, using specific instances
2786 The numbering scheme for cases is on its own, not together with other numbered
2792 At the end of this environment, a QED symbol (usually a square, but it can
2793 vary with different styles) is placed.
2794 If you want to have other environments within this one—for example, Case
2795 environments—and have the QED symbol appear only after them, then the other
2796 environments need to be nested within the proof environment.
2799 Nesting Environments
2805 for information on nesting.
2808 \begin_layout Standard
2809 And these environments are provided by
2810 \begin_inset Flex Code
2813 \begin_layout Plain Layout
2814 Theorems (AMS-Extended)
2822 \begin_layout Criterion*
2823 A required condition.
2826 \begin_layout Algorithm*
2827 A general procedure to be used.
2830 \begin_layout Axiom*
2831 This is a property or statement taken as true within the system being discussed.
2834 \begin_layout Condition*
2835 Sometimes used to state a condition assumed within the present context of
2840 Similar to a Remark.
2843 \begin_layout Notation*
2844 Used for the explanation of, yes, notation.
2847 \begin_layout Summary
2848 Do we really need to tell you?
2851 \begin_layout Acknowledgement*
2855 \begin_layout Conclusion*
2856 Sometimes used at the end of a long train of argument.
2860 Used in a way similar to Proposition, though perhaps lower on the scale.
2863 \begin_layout Standard
2864 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
2867 They need to be available on your system in order to use these environments.
2870 \begin_layout Subsection
2874 \begin_layout Standard
2880 \begin_layout Subsubsection
2884 \begin_layout Standard
2885 The \SpecialChar LyX
2888 article (koma-script)
2892 report (koma-script)
2910 correspond to the \SpecialChar LaTeX
2928 \begin_inset space ~
2931 of the Koma-Script family.
2932 They are replacements for the standard document classes
2948 , resp., and fit better to European typography conventions in a number of
2952 \begin_layout Itemize
2953 Standard character size is 11pt in
2955 article (koma-script)
2959 report (koma-script)
2967 letter (koma-script)
2972 \begin_layout Itemize
2973 Headings, labels of the description environment, and a number of elements
2976 letter (koma-script)
2978 document class are set in a bold sans serif font.
2982 \begin_layout Plain Layout
2983 There is a big difference between the bold sans serif old cm fonts and new
2984 ec fonts, especially in the appearance of headings.
2985 In comparison, the ec bold sans serif fonts look a bit thin.
2986 Here the \SpecialChar LaTeX
2995 helps to produce the
2996 \begin_inset Quotes eld
3000 \begin_inset Quotes erd
3003 appearance when using the ec fonts.
3008 The numbering of chapter headings is made in the same way as the numbering
3009 of section headings, that is without the extra line
3010 \begin_inset Quotes eld
3013 Chapter\SpecialChar ldots
3015 \begin_inset Quotes erd
3019 In addition, the appearance of the headings can be modified by using a
3020 number of options (in \SpecialChar LyX
3021 to be entered in the field
3024 \begin_inset space ~
3031 Layout\SpecialChar menuseparator
3038 \begin_layout Itemize
3039 The main means in the Koma-Script document classes to design the type area
3048 (in \SpecialChar LyX
3049 to be entered in the extra class options field in the dialog
3051 Document\SpecialChar menuseparator
3055 They make a clearer modification of page margins possible as do the options
3058 Document\SpecialChar menuseparator
3065 \begin_layout Itemize
3066 The \SpecialChar LaTeX
3067 document classes of the Koma-Script family define a number of additional
3069 Those part of it which makes sense in \SpecialChar LyX
3070 is implemented in corresponding
3074 \begin_layout Standard
3075 Detailed descriptions of the \SpecialChar LaTeX
3076 document classes of the Koma-Script family
3077 can be found in the Koma-Script documentation
3088 \begin_layout Subsubsection
3089 article (koma-script), report (koma-script), and book (koma-script)
3092 \begin_layout Standard
3093 The document classes
3095 article (koma-script)
3099 report (koma-script)
3109 are implemented in the layout files
3122 They contain all the paragraph types of the corresponding standard document
3135 , resp., partly modified, with the exception of the \SpecialChar LyX
3140 -type, which is replaced by the new
3144 -type having the same functionality.
3149 -Type there is a number of new paragraph types added.
3156 letter (koma-script)
3161 \begin_layout Itemize
3170 : are equivalents to
3178 , resp., additionally inserting an entry in the table of contents.
3187 are not contained in
3189 article (koma-script)
3194 \begin_layout Itemize
3211 , resp., additionally clearing running heads.
3218 article (koma-script)
3224 \begin_layout Plain Layout
3237 report (koma-script)
3239 , but since this is identical to
3243 , is has not been implemented in \SpecialChar LyX
3252 \begin_layout Itemize
3257 : generates a heading directly above the following paragraph in the standard
3258 character size without affecting the structure of the document.
3261 \begin_layout Itemize
3270 are special captions which respect the different space settings needed
3271 for captions placed above or below an element (if you follow strict typographic
3272 rules, you might want to place table captions always above the table).
3273 You can also use the class option
3290 You need at least Koma-Script version 2.8q to use this.
3293 \begin_layout Itemize
3298 : can be used to set a bonmot, e.
3299 \begin_inset space \thinspace{}
3303 \begin_inset space \space{}
3306 at the beginning of a chapter.
3307 If you use the optional argument (
3309 Insert\SpecialChar menuseparator
3311 \begin_inset space ~
3316 ), you can insert the dictum's author there.
3317 Dictum and author are separated by a line.
3318 You need at least Koma-Script version 2.8q to use this.
3325 article (koma-script)
3330 \begin_layout Standard
3331 The following types, together with the standard types
3343 , form the title area of the document.
3344 They must be entered ahead of the first
3345 \begin_inset Quotes eld
3349 \begin_inset Quotes erd
3356 \begin_layout Plain Layout
3357 The corresponding \SpecialChar LaTeX
3358 commands must appear before the
3369 When such a type is used more than once, the latter usage overwrites the
3370 former one, that means, for every type only the latest usage is valid.
3371 The order of the different types however has, like
3383 , no effect on the appearance of the produced document.
3386 \begin_layout Itemize
3391 : produces a centered paragraph above the ordinary title (
3403 ) for the subject of the document.
3406 \begin_layout Itemize
3411 : produces a centered paragraph below the ordinary title (
3423 ) for the publishers' name.
3426 \begin_layout Itemize
3433 report (koma-script)
3439 produces a centered paragraph on its own page behind the title page, or
3442 article (koma-script)
3444 produces a centered paragraph below the ordinary title (
3463 \begin_layout Itemize
3468 : produces a left aligned paragraph above the ordinary title (
3484 ) for a document`s head.
3487 \begin_layout Itemize
3492 : produces in a double-sided print in
3494 report (koma-script)
3500 a left-aligned paragraph at the top of the title page`s back or has no
3501 effect in a single-sided print or in
3503 article (koma-script)
3508 \begin_layout Itemize
3513 : produces in a double-sided print in
3515 report (koma-script)
3521 a left-aligned paragraph at the bottom of the title page`s back or has
3522 no effect in a single-sided print or in
3524 article (koma-script)
3529 \begin_layout Itemize
3534 : produces a special
3535 \begin_inset Quotes eld
3539 \begin_inset Quotes erd
3542 page ahead of the actual document containing a paragraph without special
3546 \begin_layout Standard
3547 The layout files for the document classes
3549 article (koma-script)
3553 report (koma-script)
3564 This is thought of as a place to define your own types.
3569 in your personal layout directory and edit the file!
3572 \begin_layout Subsubsection
3573 letter (koma-script)
3576 \begin_layout Description
3577 Note: This section discusses the obsolete
3579 KOMA-Script-Letter (v.
3580 \begin_inset space ~
3585 , which is not even included anymore in recent KOMA releases.
3586 Please refer to the next section for the current KOMA-Script-Letter class
3588 \begin_inset space ~
3594 \begin_layout Standard
3598 letter (koma-script)
3600 is implemented in the layout file
3605 It contains all the paragraph types of the corresponding standard document
3610 , partly modified, with the exception of the \SpecialChar LyX
3624 type, which is replaced by the new
3629 In addition, it contains, in contrast to the standard document class, the
3648 Furthermore, there are a number of new letter specific types.
3651 \begin_layout Standard
3652 The appearance of the letter produced by this document class can be controlled
3653 by a number of \SpecialChar LaTeX
3654 commands, which you can put in the \SpecialChar LaTeX
3659 \begin_layout Plain Layout
3660 For example, the standard appearance of the letter`s heading, consisting
3661 of name and address, is quite self-willed.
3663 \begin_inset Quotes eld
3667 \begin_inset Quotes erd
3670 heading is produced by the following \SpecialChar LaTeX
3671 commands in the preamble:
3674 \begin_layout LyX-Code
3684 \begin_layout LyX-Code
3700 \begin_layout LyX-Code
3710 \begin_layout LyX-Code
3730 A detailed German description of such \SpecialChar LaTeX
3731 commands can be found in the Koma-Script
3737 With it, the letter's author can produce his personal letter layout.
3740 \begin_layout Standard
3749 define the beginning of the letter and must be used in every letter.
3750 To emphasize them in the \SpecialChar LyX
3751 document class, they are marked with the letter
3761 \begin_inset space ~
3765 It is possible to write any number of letters in one file.
3770 type produces a new letter using the same addressee and a
3774 type produces a new addressee.
3791 are ordinary paragraph types and can also be used several times in one
3792 and the same letter.
3795 \begin_layout Itemize
3800 : produces a paragraph for the addressee and implicitly defines the beginning
3804 \begin_layout Itemize
3809 : produces a paragraph for the form of address and implicitly produces a
3813 \begin_layout Itemize
3818 : produces a paragraph for a close.
3821 \begin_layout Itemize
3826 : produces a paragraph for a postscript.
3829 \begin_layout Itemize
3834 : produces a paragraph for a distribution list.
3837 \begin_layout Itemize
3842 : produces a paragraph for enclosures.
3845 \begin_layout Standard
3886 are input types provided with a label to enter information, which will
3887 be processed by the document class.
3891 \begin_layout Plain Layout
3892 It could be seen as a matter of inconsequence, that the types
3900 described above are not such input types as well.
3901 Because of the special meaning of those types, however, I have implemented
3902 them as ordinary paragraph types with a one letter mark in the left margin.
3903 Moreover, it would affect my feeling of symmetry, if the
3911 type had such a serious different appearance.
3916 The types must be used ahead of the corresponding
3923 \begin_layout Standard
3924 An implementation of these types in a WYSIWYG fashion does not seem to make
3925 sense, because the real appearance of the produced letter does not only
3926 depend on the usage of the particular type, but also on other factors.
3927 For example, a signature entered in the
3931 type will in the standard behavior appear in the produced letter only,
3932 when in the same letter also a
3937 The entered value of the
3941 type will in the standard behavior not appear in the produced letter at
3943 The possibility to design the letter`s heading freely is already indicated
3944 in a footnote above.
3947 \begin_layout Standard
3948 The input types can also be used as empty paragraphs.
3950 \begin_inset space \thinspace{}
3954 \begin_inset space \space{}
3966 type is not used at all, in the standard behavior the value of the
3970 type is used as signature, whereas if an empty
3974 type is used, no signature value is defined.
3977 \begin_layout Standard
3978 By using the input types it is possible to write a letter template, containing
3979 filled input types with your personal dates (name, address, etc.) and empty
3980 input types for other dates you want to enter.
3983 \begin_layout Itemize
3988 : sender's name, in the standard behavior appears as a centered paragraph
3989 in small caps in the letter`s heading.
3992 \begin_layout Itemize
3997 : sender's signature, in the standard behavior appears below the
4006 type is used, the value of the
4010 type appears instead.
4013 \begin_layout Itemize
4018 : sender's address, in the standard behavior appears in a centered paragraph
4019 in the letter`s heading below the sender's name.
4022 \begin_layout Itemize
4027 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
4038 \begin_layout Itemize
4043 : place of the letter`s making.
4046 \begin_layout Itemize
4051 : date of the letter`s making.
4060 , in the standard behavior, produce the place and the date in a right-aligned
4061 line below the addressee's field.
4066 type is used, neither place nor date appear, independent of the value of
4076 type is used, the date of the letter `s production is used.
4079 \begin_layout Itemize
4084 : sender`s back address, in the standard behavior appears above the addressee's
4085 field in a small sans serif font.
4088 \begin_layout Itemize
4093 : special mail information, in the standard behavior appears underlined
4094 above the addressee's field below the back address.
4097 \begin_layout Itemize
4102 : additional information, in the standard behavior appears on right side
4103 below the addressee`s field.
4106 \begin_layout Itemize
4111 : the letter's title, in the standard behavior appears in a big, bold, sans
4112 serif font above the subject.
4115 \begin_layout Itemize
4120 : the letter's subject, in the standard behavior appears in a bold font
4128 \begin_layout Standard
4149 produce a business letter like line above the
4153 line containing the fields
4154 \begin_inset Quotes eld
4158 \begin_inset Quotes erd
4162 \begin_inset Quotes eld
4166 \begin_inset Quotes erd
4170 \begin_inset Quotes eld
4174 \begin_inset Quotes erd
4178 \begin_inset Quotes eld
4182 \begin_inset Quotes erd
4186 \begin_inset Quotes eld
4190 \begin_inset Quotes erd
4194 \begin_inset Quotes eld
4198 \begin_inset Quotes erd
4202 For the date field, the value of the
4208 \begin_inset Quotes eld
4211 business letter types
4212 \begin_inset Quotes erd
4215 is used, the value of the
4219 type however does not appear, but only the \SpecialChar LaTeX
4227 The ordinary output of place and date in a right-aligned line below the
4228 addressee`s field is suppressed.
4229 The types are implemented as input types provided with a label and must
4230 be used ahead of the corresponding
4237 \begin_layout Itemize
4245 \begin_layout Itemize
4253 \begin_layout Itemize
4261 \begin_layout Itemize
4269 \begin_layout Itemize
4277 \begin_layout Subsubsection
4278 The new letter class: letter (koma-script v.2)
4281 \begin_layout Standard
4287 \begin_layout Standard
4288 \begin_inset VSpace medskip
4294 \begin_layout Standard
4296 Koma-Script version 2.8 has introduced a new letter class
4300 which supersedes the now unsupported
4305 It has — on the \SpecialChar LaTeX
4306 side — a completely new interface and is not compatible
4308 Therefore, \SpecialChar LyX
4309 supports both, though it is recommended you use the new class.
4312 \begin_layout Standard
4313 This class covers the same functionality as
4315 letter (koma-script),
4322 (receiver's address, same as
4339 will start a new letter (i.
4340 \begin_inset space \thinspace{}
4344 \begin_inset space \space{}
4347 you can write several letters per document).
4348 New elements are sender's
4364 and the possibility to use a
4370 Insert\SpecialChar menuseparator
4376 \begin_layout Standard
4377 The biggest improvement is, though, that the letter's layout is configurable
4378 to meet almost any needs.
4379 This can be done via the preamble or with a special style file (Letter
4380 Class Option, extension
4384 ), that will be read in as a class option.
4388 \begin_layout Plain Layout
4389 The KOMA package comes with some default
4394 There is, for instance, a
4398 file that follows german typesetting rules, or a
4402 that provides the default layout of the old
4407 The latter can be loaded with the class option
4413 Layout\SpecialChar menuseparator
4414 Document\SpecialChar menuseparator
4426 template that is included in \SpecialChar LyX
4428 A detailed description is to be found in the Koma-Script documentation
4436 \begin_layout Subsubsection
4440 \begin_layout Standard
4441 Visualizing the Koma-Script document classes in \SpecialChar LyX
4442 , the \SpecialChar LyX
4443 internals cause some
4447 \begin_layout Itemize
4448 The chapter number of a
4452 type appears on a line of its own above the chapter heading instead of
4453 appearing in the same line ahead of it.
4454 The cause for that is the \SpecialChar LyX
4455 internal behavior for the labeltype
4462 \begin_layout Itemize
4463 The headings of the types
4472 \begin_inset Quotes eld
4476 \begin_inset Quotes erd
4480 table of contents, but not in the \SpecialChar LyX
4483 Document\SpecialChar menuseparator
4485 \begin_inset space ~
4489 \begin_inset space ~
4497 \begin_layout Itemize
4502 document class appear in a skip separation mode, not indented.
4503 This is the standard behavior, no special \SpecialChar LaTeX
4504 commands are needed for that.
4507 Document\SpecialChar menuseparator
4510 dialog the corresponding radio button indicates
4519 value always has the effect that extra \SpecialChar LaTeX
4520 commands are inserted in the document
4521 to produce the gap, which is not what is wanted in this case.
4524 \begin_layout Subsection
4526 \change_inserted 564990737 1670924924
4528 \begin_inset space \thinspace{}
4532 \begin_inset space \space{}
4536 \change_deleted 564990737 1670924933
4537 Article (mwart), book (mwbk) and report (mwrep)
4538 \begin_inset Argument status
4541 \begin_layout Plain Layout
4556 \begin_layout Standard
4562 \begin_layout Standard
4563 The \SpecialChar LyX
4580 correspond to the \SpecialChar LaTeX
4594 They are replacements for the standard document classes
4606 , resp., and fit better to Polish typography conventions in a number of points.
4610 \begin_layout Standard
4614 \begin_layout Itemize
4615 Unnumbered titles (with star, e.
4616 \begin_inset space \thinspace{}
4620 \begin_inset space \space{}
4627 ) are added into table of contents,
4630 \begin_layout Itemize
4631 Additional page styles:
4635 \begin_layout Description
4636 uheadings header with separated lines,
4639 \begin_layout Description
4640 myheadings custom header, contents headers via commands:
4655 \begin_layout Description
4656 myuheadings custom header with separated lines,
4659 \begin_layout Description
4660 outer page number is placed on outer side of page
4664 \begin_layout Itemize
4669 \begin_layout Description
4670 rmheadings serif titles — default,
4673 \begin_layout Description
4674 sfheadings sansserif titles,
4677 \begin_layout Description
4678 authortitle on title page first placed is author next title — default,
4681 \begin_layout Description
4682 titleauthor on title page first placed is title next author,
4685 \begin_layout Description
4686 withmarginpar reserve place on page for margins.
4690 \begin_layout Section
4692 \change_inserted 564990737 1670439534
4696 \begin_layout Standard
4698 \change_inserted 564990737 1670794710
4699 See also the document classes in the Collections (section
4700 \begin_inset space ~
4704 \begin_inset CommandInset ref
4706 reference "sec:Collections"
4713 \begin_layout Subsection
4715 \change_inserted 564990737 1670794716
4721 \begin_layout Standard
4723 \change_inserted 564990737 1670794716
4730 ; updated by the \SpecialChar LyX
4734 \begin_layout Subsubsection
4736 \change_inserted 564990737 1670794716
4742 \begin_layout Standard
4744 \change_inserted 564990737 1670794716
4747 This section describes how \SpecialChar LyX
4748 can be used to write articles for submission
4749 to the scientific journal
4751 Astronomy and Astrophysics
4754 \begin_inset CommandInset href
4757 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
4762 ) using Version 9.1 of the document class
4766 ; information about it is available at
4767 \begin_inset Flex URL
4770 \begin_layout Plain Layout
4772 \change_inserted 564990737 1670794716
4774 https://www.aanda.org/for-authors/latex-issues/texnical-background-information
4784 \begin_layout Standard
4786 \change_inserted 564990737 1670794716
4789 A manual comes together with the package and should be consulted before
4790 installing this document class as described in the
4792 Installing New Document Classe
4802 \begin_layout Standard
4804 \change_inserted 564990737 1670794716
4807 \begin_inset Note Greyedout
4810 \begin_layout Plain Layout
4812 \change_inserted 564990737 1670794716
4815 Please note that the publisher of the journal was changed from Springer
4816 to EDP Sciences starting January 1, 2001.
4817 That change also involved some slight changes to the style files, namely
4818 the removal of the thesaurus command.
4819 If you have an older version installed, please upgrade.
4820 For information about compatibility with the old (version 4) layout, please
4821 refer to the comments in
4824 Dir/layouts/aapaper.layout
4834 \begin_layout Subsubsection
4836 \change_inserted 564990737 1670794716
4842 \begin_layout Standard
4844 \change_inserted 564990737 1670794716
4847 It is recommended you start from the template
4856 ile\SpecialChar menuseparator
4858 \begin_inset space ~
4866 \begin_inset space ~
4872 If you are not using the template, note the following settings:
4875 \begin_layout Itemize
4877 \change_inserted 564990737 1670794716
4889 ocument\SpecialChar menuseparator
4894 ettings\SpecialChar menuseparator
4896 \begin_inset space ~
4901 dialog (OK, that one was obvious).
4904 \begin_layout Itemize
4906 \change_inserted 564990737 1670794716
4912 \begin_inset space ~
4924 \begin_inset space ~
4929 dialog: leave it set to
4934 The whole layout is done by the macros, you shouldn't change anything.
4937 \begin_layout Subsubsection
4939 \change_inserted 564990737 1670794716
4945 \begin_layout Standard
4947 \change_inserted 564990737 1670794716
4950 First thing to enter is the header information.
4951 It consists of five entries, of which one is optional.
4955 \begin_layout Itemize
4957 \change_inserted 564990737 1670794716
4966 \begin_layout Itemize
4968 \change_inserted 564990737 1670794716
4977 \begin_layout Itemize
4979 \change_inserted 564990737 1670794716
4988 \begin_layout Itemize
4990 \change_inserted 564990737 1670794716
4999 \begin_layout Itemize
5001 \change_inserted 564990737 1670794716
5010 Received: <date>; Accepted <date>
5013 \begin_layout Standard
5015 \change_inserted 564990737 1670794716
5018 Although the order of the single header entries doesn't matter it is advised
5019 to keep the above sequence, just to get the best optics and meets the layout
5020 of the real document.
5023 \begin_layout Standard
5025 \change_inserted 564990737 1670794716
5028 If you want to place footnotes in the header block, e.
5029 \begin_inset space \thinspace{}
5033 \begin_inset space \space{}
5036 to state your present address, just use the standard footnote via the menu
5042 nsert\SpecialChar menuseparator
5051 will automagically use the term
5060 \begin_layout Standard
5062 \change_inserted 564990737 1670794716
5065 In addition to these topics, the macros use three additional \SpecialChar LaTeX
5067 have no counterpart in \SpecialChar LyX
5071 \begin_layout Itemize
5073 \change_inserted 564990737 1670794716
5081 to separate different names for more than one author and institute, respectivel
5085 \begin_layout Itemize
5087 \change_inserted 564990737 1670794716
5095 to mark corresponding author/institute pairs.
5096 The institutes are numbered sequentially as they appear in the
5100 field, so you have to put a marker to each author.
5103 \begin_layout Itemize
5105 \change_inserted 564990737 1670794716
5113 to supply an email address for fast contact.
5116 \begin_layout Standard
5118 \change_inserted 564990737 1670794716
5121 In all cases, the appropriate command has to be entered as \SpecialChar TeX
5122 code in \SpecialChar LyX
5124 See the examples in the template and in the file
5136 \begin_layout Subsubsection
5138 \change_inserted 564990737 1670794716
5144 \begin_layout Standard
5146 \change_inserted 564990737 1670794716
5149 The abstract should immediately follow the header block and must contain
5159 \begin_layout Enumerate
5161 \change_inserted 564990737 1670794716
5167 (optional) {} leave it empty if necessary
5170 \begin_layout Enumerate
5172 \change_inserted 564990737 1670794716
5181 \begin_layout Enumerate
5183 \change_inserted 564990737 1670794716
5192 \begin_layout Enumerate
5194 \change_inserted 564990737 1670794716
5203 \begin_layout Enumerate
5205 \change_inserted 564990737 1670794716
5211 (optional) {} leave it empty if necessary
5214 \begin_layout Standard
5216 \change_inserted 564990737 1670794716
5220 This structure not shown in
5227 \begin_layout Subsubsection
5229 \change_inserted 564990737 1670794716
5232 Supported environments
5235 \begin_layout Standard
5237 \change_inserted 564990737 1670794716
5240 The A&A paper layout supports the following environments for structuring
5244 \begin_layout Itemize
5246 \change_inserted 564990737 1670794716
5253 \begin_layout Itemize
5255 \change_inserted 564990737 1670794716
5262 \begin_layout Itemize
5264 \change_inserted 564990737 1670794716
5271 \begin_layout Itemize
5273 \change_inserted 564990737 1670794716
5280 \begin_layout Itemize
5282 \change_inserted 564990737 1670794716
5289 \begin_layout Itemize
5291 \change_inserted 564990737 1670794716
5298 \begin_layout Itemize
5300 \change_inserted 564990737 1670794716
5307 \begin_layout Itemize
5309 \change_inserted 564990737 1670794716
5316 \begin_layout Itemize
5318 \change_inserted 564990737 1670794716
5325 \begin_layout Itemize
5327 \change_inserted 564990737 1670794716
5334 \begin_layout Itemize
5336 \change_inserted 564990737 1670794716
5343 \begin_layout Itemize
5345 \change_inserted 564990737 1670794716
5353 \begin_layout Subsubsection
5355 \change_inserted 564990737 1670794716
5358 Commands not supported by \SpecialChar LyX
5362 \begin_layout Standard
5364 \change_inserted 564990737 1670794716
5367 Some commands are not yet supported by the
5371 layout for \SpecialChar LyX
5373 Some have already been mentioned.
5374 For the sake of completeness, they are listed all together here:
5377 \begin_layout Itemize
5379 \change_inserted 564990737 1670794716
5388 \begin_layout Itemize
5390 \change_inserted 564990737 1670794716
5399 \begin_layout Itemize
5401 \change_inserted 564990737 1670794716
5410 \begin_layout Itemize
5412 \change_inserted 564990737 1670794716
5421 \begin_layout Itemize
5423 \change_inserted 564990737 1670794716
5432 \begin_layout Standard
5434 \change_inserted 564990737 1670794716
5437 If you want to use any of these commands, you have to enter them yourself.
5440 Do not forget to use
5446 nsert\SpecialChar menuseparator
5449 \begin_inset space ~
5458 \begin_layout Subsubsection
5460 \change_inserted 564990737 1670794716
5463 Figure and Table Floats
5466 \begin_layout Standard
5468 \change_inserted 564990737 1670794716
5472 provides support for the necessary float environments
5474 figure, figure*, table
5480 , therefore we won't tell much about it here.
5484 \begin_inset space ~
5490 Just remember that tables should be left-aligned.
5491 For that, select the table and change the alignment in
5496 dit\SpecialChar menuseparator
5502 \begin_inset space ~
5508 \begin_layout Standard
5510 \change_inserted 564990737 1670794716
5513 There is only one special thing: the figures with a caption beside the figure.
5514 To create such a figure, you have to do the following:
5517 \begin_layout Enumerate
5519 \change_inserted 564990737 1670794716
5522 Create a wide figure float:
5527 nsert\SpecialChar menuseparator
5532 t\SpecialChar menuseparator
5535 , then, from within the float, use the menu
5540 dit\SpecialChar menuseparator
5546 \begin_inset space ~
5557 \begin_inset space ~
5569 \begin_layout Enumerate
5571 \change_inserted 564990737 1670794716
5574 Enter your caption text.
5577 \begin_layout Enumerate
5579 \change_inserted 564990737 1670794716
5586 to move the cursor above the caption.
5589 \begin_layout Enumerate
5591 \change_inserted 564990737 1670794716
5597 \begin_layout Enumerate
5599 \change_inserted 564990737 1670794716
5602 Position the cursor after the figure and insert a horizontal fill by using
5608 nsert\SpecialChar menuseparator
5613 rmatting\SpecialChar menuseparator
5619 \begin_inset space ~
5628 dialog and select the
5642 \begin_layout Enumerate
5644 \change_inserted 564990737 1670794716
5647 Switch to \SpecialChar LaTeX
5651 \begin_inset space ~
5659 \begin_layout Enumerate
5661 \change_inserted 564990737 1670794716
5672 Do not close the brace!
5675 \begin_layout Enumerate
5677 \change_inserted 564990737 1670794716
5680 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
5685 \begin_inset space ~
5697 \begin_layout Standard
5699 \change_inserted 564990737 1670794716
5702 Also, refer to the figures in the file
5713 \begin_layout Subsubsection
5715 \change_inserted 564990737 1670794716
5721 \begin_layout Standard
5723 \change_inserted 564990737 1670794716
5726 For submission, the paper has to be formatted in a special double-spacing
5728 For this purpose, you have to add the option
5739 \begin_inset space ~
5749 ocument\SpecialChar menuseparator
5754 ettings\SpecialChar menuseparator
5756 \begin_inset space ~
5765 \begin_layout Subsubsection
5767 \change_inserted 564990737 1670794716
5773 \begin_layout Standard
5775 \change_inserted 564990737 1670794716
5782 was written with \SpecialChar LyX
5784 It is the example paper from the original macro package,
5789 \begin_inset CommandInset href
5792 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
5797 , but translated to \SpecialChar LyX
5798 using the older unstructured abstract type.
5799 Use it for inspiration, and compare the \SpecialChar LaTeX
5804 with the \SpecialChar LyX
5808 \begin_layout Subsection
5813 \begin_layout Standard
5819 \begin_layout Subsubsection
5823 \begin_layout Standard
5825 is a set of macros produced by the American Astronomical Society to
5826 facilitate electronic manuscript submission to the three journals they
5827 publish: the Astrophysical Journal (including the Letters and Supplement),
5828 the Astronomical Journal, and the Publications of the Astronomical Society
5831 has proven to be an excellent tool for generating these documents, especially
5832 given its equation, citation, and figure handling capabilities.
5834 requires version 5.0 (or higher) of these macros; preferably 6.0, which
5835 is the version described here, or higher.
5836 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
5837 2.09 and are fundamentally
5838 incompatible with \SpecialChar LyX
5840 The AAS\SpecialChar TeX
5841 package may be downloaded from the AAS\SpecialChar TeX
5845 \begin_layout Standard
5846 \begin_inset VSpace medskip
5852 \begin_layout Standard
5854 \begin_inset Flex URL
5857 \begin_layout Plain Layout
5859 https://aas.org/aastex/aastex-downloads
5867 \begin_layout Standard
5868 \begin_inset VSpace medskip
5874 \begin_layout Standard
5875 A complete user guide is contained in that package and you should familiarize
5876 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
5879 will not reduce the need to figure out all the AAS\SpecialChar TeX
5880 commands, it will only
5881 reduce the drudgery of typing everything in.
5882 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
5884 completely to the requirements of the journal to which you are submitting
5888 \begin_layout Subsubsection
5889 Starting a New Paper
5892 \begin_layout Standard
5893 I strongly suggest that you start with the AAS\SpecialChar TeX
5897 File\SpecialChar menuseparator
5904 , enter the new file name, then choose the
5909 This will show the most common fields found in a manuscript.
5910 Simply overwrite the existing text (including the brackets,
5914 ) with the correct information.
5915 Many of the AAS\SpecialChar TeX
5916 commands and environments can be implemented directly in
5919 For commands such as these, the \SpecialChar LaTeX
5920 code must be entered directly and marked
5922 Such commands are referred to as \SpecialChar TeX
5923 code, or Evil Red Text.
5924 I tried to minimize the amount of \SpecialChar TeX
5925 code needed in an AAS\SpecialChar TeX
5929 \begin_layout Subsubsection
5930 Finishing Your Paper
5933 \begin_layout Standard
5934 When the paper is finished to your satisfaction and previews/prints correctly,
5936 \begin_inset Quotes eld
5940 \begin_inset Quotes erd
5943 actions which need to be done before you submit it to the journals.
5947 \begin_layout Enumerate
5948 Export your paper as a \SpecialChar LaTeX
5951 File\SpecialChar menuseparator
5952 Export\SpecialChar menuseparator
5960 \begin_layout Enumerate
5965 file with your favorite text editor
5969 \begin_layout Enumerate
5970 remove the comment lines before the
5979 \begin_layout Enumerate
5984 usepackage...{fontenc}
5986 line if it appears (usually just after
6001 \begin_layout Enumerate
6002 remove everything between (and including) the
6014 commands, except for any commands you specifically put into the \SpecialChar LaTeX
6016 (which should appear immediately after the
6017 \begin_inset Quotes eld
6020 User specified \SpecialChar LaTeX
6022 \begin_inset Quotes erd
6033 \begin_layout Enumerate
6034 Run the resulting file through \SpecialChar LaTeX
6035 to make sure it still processes correctly.
6038 \begin_layout Enumerate
6039 Reread the journal requirements to make sure your filenames and formats
6043 \begin_layout Enumerate
6047 \begin_layout Subsubsection
6048 Comments On Specific Commands
6051 \begin_layout Standard
6052 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
6059 ) gives a good description of each.
6060 Thus it's probably easiest for me to go down the list as found in the guide
6061 and offer comments where necessary.
6062 So let's begin \SpecialChar ldots
6066 \begin_layout Paragraph
6067 Things that work as expected
6070 \begin_layout Standard
6071 Because they work as you might expect, I simply list them and the section
6172 begin{thebibliography}
6180 (2.13.2), all the cite commands and their variations (2.13.2), the generic
6181 graphicx figure commands (2.14.1),
6205 (2.15.4, amongst other places),
6232 \begin_layout Standard
6233 The following style options also work correctly:
6254 Simply put them in the
6260 Layout\SpecialChar menuseparator
6266 \begin_layout Paragraph
6267 Things that work, but require more comment
6270 \begin_layout Standard
6271 The following items work, but require a little more discussion:
6274 \begin_layout Itemize
6275 These items are reserved for use by the journal editors, but you can put
6276 them into the \SpecialChar LaTeX
6277 preamble if you feel compelled to do so:
6310 \begin_layout Itemize
6311 These items may be placed in the \SpecialChar LaTeX
6312 preamble, and are included as blanks in
6334 \begin_layout Itemize
6341 (2.3) – can only be used
6342 \begin_inset Quotes eld
6346 \begin_inset Quotes erd
6349 , not in the middle of a paragraph.
6350 Use \SpecialChar TeX
6351 code if you need to embed it.
6354 \begin_layout Itemize
6361 (2.3) – will have extra {} after it.
6362 This should not cause an error.
6365 \begin_layout Itemize
6372 (2.6) – can only be used
6373 \begin_inset Quotes eld
6377 \begin_inset Quotes erd
6380 , not in the middle of a paragraph.
6381 Use \SpecialChar TeX
6382 code if you need to embed it.
6385 \begin_layout Itemize
6392 (2.8) – can't insert a cross-reference tag, you must type the tag name by
6396 \begin_layout Itemize
6410 \begin_layout Itemize
6417 (2.9) – will have extra {} after it.
6418 This should not cause an error.
6421 \begin_layout Itemize
6428 (2.11) – will have extra {} after it.
6429 This should not cause an error.
6432 \begin_layout Itemize
6439 (2.14.2) – you can insert an optional filename argument by placing the cursor
6440 at the beginning of the text and selecting
6442 Insert\SpecialChar menuseparator
6447 \begin_inset Quotes eld
6451 \begin_inset Quotes erd
6454 inserts an optional argument of the type needed by
6461 Hopefully it will be renamed someday.
6464 \begin_layout Itemize
6477 for the catalog ID optional parameter
6480 \begin_layout Itemize
6493 for the catalog ID optional parameter
6496 \begin_layout Paragraph
6497 Things not implemented, use \SpecialChar TeX
6501 \begin_layout Standard
6512 setcounter{equation}
6514 (2.12), Journal name abbreviations (2.13.4),
6550 (2.15.4, insert it as the first element in the lefthand cell after where
6552 Don't use any of \SpecialChar LyX
6553 's rules in the table),
6565 (2.15.5), much of Misc (2.17, except
6616 \begin_layout Paragraph
6617 Things that cannot be implemented
6620 \begin_layout Standard
6622 at least in any meaningful sort of way, so I suggest ignoring them.
6623 They are the references environment (2.13.3), and the deluxetable environment
6625 If you really, really need to use deluxetable, I suggest editing it in
6626 a separate file with a text editor, then using
6628 Insert\SpecialChar menuseparator
6630 \begin_inset space ~
6635 to include it in your \SpecialChar LyX
6641 file to see an example of this.
6644 \begin_layout Subsubsection
6645 FAQs, Tips, Tricks, and Other Ruminations
6648 \begin_layout Paragraph
6649 Getting \SpecialChar LyX
6650 and AAS\SpecialChar TeX
6654 \begin_layout Standard
6655 It can be a bit tricky to get \SpecialChar LyX
6656 to recognize a new layout and document class.
6657 When all else fails, do this:
6660 \begin_layout Enumerate
6661 Make certain that \SpecialChar LaTeX
6662 can find AAS\SpecialChar TeX
6664 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
6666 directory completely unrelated to \SpecialChar LaTeX
6667 or AAS\SpecialChar TeX
6668 and run \SpecialChar LaTeX
6676 \begin_layout Enumerate
6681 appears in \SpecialChar LyX
6689 \begin_layout Enumerate
6692 Tools\SpecialChar menuseparator
6696 , then restart \SpecialChar LyX
6700 \begin_layout Enumerate
6701 Open a regular new file, not from a template.
6702 Does AAS\SpecialChar TeX
6703 appear in the class list in
6705 Document\SpecialChar menuseparator
6711 \begin_layout Standard
6712 If you get a warning from an existing AAS\SpecialChar TeX
6713 document about not being able
6714 to find the AAS\SpecialChar TeX
6715 layout or a message about
6716 \begin_inset Quotes eld
6719 You should not mix title layouts with normal ones
6720 \begin_inset Quotes erd
6723 , things haven't been installed correctly.
6726 \begin_layout Paragraph
6728 error processing a table
6731 \begin_layout Standard
6733 , by default, attempts to center the table caption/title.
6734 This seems to produce a bad interaction in AAS\SpecialChar TeX
6735 so you should click somewhere
6736 in the caption/title, then select
6738 Edit\SpecialChar menuseparator
6740 \begin_inset space ~
6754 This took care of it for me.
6757 \begin_layout Paragraph
6761 \begin_layout Standard
6762 A couple of things: 1) I have noticed some funny spacing in the reference
6763 entries in the text.
6764 When you enter the bibliography item data, make sure their is
6768 space between the last author and the parenthesis setting off the year;
6772 \begin_inset space \thinspace{}
6776 \begin_inset space \space{}
6790 2) Entering the references at all is not obvious.
6791 The easiest thing is to start typing your first reference at the end of
6792 the document, then mark it as type
6797 That will put a small gray box in front of what you just typed.
6798 Click on the box to fill in the rest of the information.
6799 For new references, go to the end of an existing reference and press return.
6800 That will create a new line with its own box, etc.
6803 \begin_layout Paragraph
6807 \begin_layout Standard
6808 Even though AAS\SpecialChar TeX
6809 provides its own figure commands (
6815 , for example), I much prefer \SpecialChar LaTeX
6816 's standard figure commands (with the default
6825 \begin_inset space ~
6828 commands as \SpecialChar TeX
6829 code into a Figure Float box if you desire, but I never have
6830 much luck getting the layout right.
6831 With the standard graphics, \SpecialChar LyX
6836 usepackage{graphicx}
6838 command into the \SpecialChar LaTeX
6839 preamble and handle the figures in the standard \SpecialChar LaTeX2e
6841 interspersing the figures in the text.
6842 I believe ApJ accepts figures exactly this way now; AJ might still use
6844 \begin_inset Quotes eld
6847 stack everything at the end
6848 \begin_inset Quotes erd
6854 \begin_layout Paragraph
6855 Things I could have done, but didn't
6858 \begin_layout Standard
6860 \begin_inset Quotes eld
6864 \begin_inset Quotes erd
6867 things I could have implemented, but chose not to.
6868 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
6870 even though it is double-spaced in the paper manuscript.
6871 Also, I chose not to make separate layouts for the preprint and preprint2
6873 Since I assume you will spend most of your time in the plain manuscript
6874 mode anyway, I decided not to chew up more disk space with this.
6878 \begin_layout Subsubsection
6882 \begin_layout Standard
6883 Your mileage may vary.
6884 I've now had papers published by both ApJ and AJ that have had 98% of the
6885 effort done in \SpecialChar LyX
6886 ; the last 2% was the \SpecialChar LaTeX
6887 post-processing and a few cleanups.
6888 I have had no trouble with the submission process, and I'm sure the journals
6889 were never aware that there might be a difference.
6890 So, go forth and publish!
6893 \begin_layout Subsection
6895 \change_inserted 564990737 1671042028
6901 \begin_layout Standard
6903 \change_inserted 564990737 1671042028
6909 \begin_inset space \thinspace{}
6919 This provides the following additional environments:
6922 \begin_inset space ~
6930 \begin_inset space ~
6938 \begin_inset space ~
6961 is available in the menu
6966 ile\SpecialChar menuseparator
6968 \begin_inset space ~
6976 \begin_inset space ~
6982 It has been customized with further environments and contains all the informati
6984 However, the documentation is also available from
6985 \begin_inset CommandInset href
6988 target "http://mirrors.ctan.org/macros/latex/contrib/elsarticle/doc/elsdoc.pdf"
6996 \begin_layout Subsection
6998 \change_inserted 564990737 1671042046
7004 \begin_layout Standard
7006 \change_inserted 564990737 1671042046
7012 \begin_inset space \thinspace{}
7017 provides an alternative to the
7022 It provides similar functionality, but you might prefer this layout with
7023 sans serif sections, headings, and more.
7026 \begin_layout Subsection
7031 \begin_layout Standard
7037 \begin_layout Standard
7038 \begin_inset VSpace bigskip
7044 \begin_layout Standard
7049 \begin_inset space ~
7054 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
7056 \begin_inset Formula $\beta$
7059 release of May, 1999) class.
7062 \begin_layout Standard
7068 textclass, which works with Rev\SpecialChar TeX
7070 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
7072 That means that it doesn't interact very well with \SpecialChar LyX
7073 , which requires \SpecialChar LaTeX2e
7075 it has been kludged to work.
7076 Since Rev\SpecialChar TeX
7077 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
7084 \begin_inset space ~
7089 textclass should also be pretty easy to use.
7092 \begin_layout Standard
7093 These documents are supposed to be used in
7097 to the Rev\SpecialChar TeX
7098 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
7100 and assume you'll know what to put in the preamble if necessary.
7103 \begin_layout Subsection
7105 \change_inserted 564990737 1671042072
7111 \begin_layout Standard
7113 \change_inserted 564990737 1671042072
7120 classes were replaced in 2013 with a completely new
7125 This package provides a \SpecialChar LaTeX
7126 class and templates for books to be published
7127 at Springer Gabler Research, Springer Vieweg Research, Springer Spektrum
7128 Research, Springer VS Research, or Springer VS Forschung.
7129 The documentation is available in German from
7130 \begin_inset CommandInset href
7133 target "http://mirrors.ctan.org/macros/latex/contrib/springer/sr-vorl/sr-vorl.pdf"
7141 \begin_layout Section
7143 \change_inserted 564990737 1670439560
7147 \begin_layout Standard
7149 \change_inserted 564990737 1670439581
7150 See also the document classes in the Collections (section
7151 \begin_inset space ~
7155 \begin_inset CommandInset ref
7157 reference "sec:Collections"
7164 \begin_layout Subsection
7168 \begin_layout Standard
7174 \begin_layout Subsubsection
7178 \begin_layout Standard
7179 Memoir is a very powerful and constantly evolving class.
7180 It has been designed with regard to fictional and non-fictional literature.
7181 Its aim is to let the user have maximum control over the typesetting of
7183 Memoir is based on the standard book class, but it can also emulate the
7184 article class (see below).
7187 \begin_layout Standard
7188 Peter Wilson, the developer of Memoir, is known as the author of lots of
7189 useful packages in the \SpecialChar LaTeX
7191 Most of them have been merged with Memoir.
7192 Therefore, it is much easier to layout the table of contents, appendices,
7193 chapter designs and such.
7195 , though, does not support all of these goodies natively.
7196 Some of them might be added to forthcoming releases
7200 \begin_layout Plain Layout
7201 You are invited to send suggestions to
7202 \begin_inset Flex URL
7205 \begin_layout Plain Layout
7207 lyx-devel@lists.lyx.org
7217 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
7219 Of course you can still use all features with the help of some native \SpecialChar LaTeX
7221 commands (\SpecialChar TeX
7226 \begin_layout Plain Layout
7231 \begin_layout Plain Layout
7241 \begin_inset space ~
7245 \begin_inset CommandInset ref
7247 reference "sec:Inserting-TeX-Code"
7257 In this section, we can only list those features that are natively supported
7260 For detailed descriptions (and for the rest of features) we recommend you
7261 have a look at the detailed manual of the Memoir class
7265 \begin_layout Plain Layout
7270 \begin_layout Plain Layout
7280 \begin_inset Flex URL
7283 \begin_layout Plain Layout
7285 CTAN:/macros/latex/memoir/memman.pdf
7295 , which is not only a user guide for the class, but also both a comprehensive
7296 description on good typesetting and a superb example for good typesetting
7300 \begin_layout Subsubsection
7301 Basic features and restrictions
7304 \begin_layout Standard
7305 Memoir supports basically all features of the standard book classes.
7306 There are, however, some differences, as follows:
7309 \begin_layout Description
7311 \begin_inset space ~
7314 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
7317 \begin_layout Description
7319 \begin_inset space ~
7322 style: The fancy page style is not supported, due to a command clash between
7323 Memoir and the fancyhdr package (they both define a command with the same
7324 name, which confuses \SpecialChar LaTeX
7326 Instead, Memoir comes with a number of its own page styles (see
7328 Document\SpecialChar menuseparator
7329 Settings\SpecialChar menuseparator
7331 \begin_inset space ~
7337 If you want to use these for the chapter pages, you have to use the command
7344 in the main text or in preamble (e.
7345 \begin_inset space \thinspace{}
7349 \begin_inset space \space{}
7356 chapterstyle{companion}
7361 \begin_layout Description
7362 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
7363 optional argument in the standard classes.
7364 With this, you can specify an alternative version of the title for the
7365 table of contents and the headers (for instance, if the title is too long).
7367 , you can do this via
7369 Insert\SpecialChar menuseparator
7371 \begin_inset space ~
7376 at the beginning of a chapter/section.
7377 Memoir features a second optional argument and thus separates the table
7378 of contents from the header.
7379 You can define three variants of a title with this: one for the main text,
7380 one for the table of contents, and one for the headers.
7382 makes these available in form of specific
7393 \begin_layout Description
7394 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
7395 of contents, the list of figures and the list of table start a new page
7397 Memoir does not follow this route.
7398 You have to insert a page break yourself, if you want to have one.
7401 \begin_layout Description
7402 Titlepage: For some unknown reason, Memoir uses pagination on the title
7403 page (in the standard classes, title pages are
7404 \begin_inset Quotes eld
7408 \begin_inset Quotes erd
7412 If you want an empty title page, type
7416 aliaspagestyle{title}{empty}
7421 \begin_layout Description
7422 Article: With the class option
7428 Document\SpecialChar menuseparator
7429 Settings\SpecialChar menuseparator
7430 Class Settings\SpecialChar menuseparator
7432 \begin_inset space ~
7437 ), you can emulate article style.
7438 That is, counters (footnotes, figures, tables etc.) will not be reset on
7439 new chapters, chapters don't start a new page (but are—in contrary to
7440 \begin_inset Quotes eld
7444 \begin_inset Quotes erd
7447 article classes—still allowed), parts, though, use their own page, as in
7451 \begin_layout Description
7452 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
7453 font commands, which have been used in the old \SpecialChar LaTeX
7455 \begin_inset space \thinspace{}
7459 \begin_inset space \space{}
7475 It produces an error and stops \SpecialChar LaTeX
7476 whenever such a command appears.
7481 reallows the commands and spits out warnings instead (which does at least
7482 not stop \SpecialChar LaTeX
7484 Since a lot of packages and particularly Bib\SpecialChar TeX
7485 style files are still using
7486 those commands, we have decided to use this option by default.
7489 \begin_layout Subsubsection
7493 \begin_layout Standard
7494 We will only describe the features supported by \SpecialChar LyX
7495 (which is not much currently).
7496 Please consult the Memoir manual
7500 \begin_layout Plain Layout
7505 \begin_layout Plain Layout
7515 \begin_inset Flex URL
7518 \begin_layout Plain Layout
7520 CTAN:/macros/latex/memoir/memman.pdf
7533 \begin_layout Description
7534 Abstract: You may wonder why an abstract is an extra feature.
7535 Well, it is in book class.
7536 Usually books don't have abstracts.
7537 Memoir, however, has.
7538 You can use it wherever and how often you like.
7541 \begin_layout Description
7542 Chapterprecis: You may know this older typesetting style: The contents of
7543 a chapter are summarized below the title and also in the table of contents
7545 \begin_inset space \thinspace{}
7549 \begin_inset space \space{}
7554 Our hero arrives in Troia; he loses some friends; he finds others
7557 Chapterprecis does exactly this.
7558 It is therefore only sensible below a chapter.
7561 \begin_layout Description
7562 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
7563 The epigraph environment provides an elegant way of typesetting such a
7565 The motto itself (text) and its (optional) author (source) are divided
7567 The author (source) can be inserted via
7569 Insert\SpecialChar menuseparator
7576 \begin_layout Description
7577 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
7578 complex figurative poems).
7580 can only support a few of them.
7581 One is poemtitle, which is a centered title for poems, which will also
7582 be added to the table of contents (verse is the standard environment for
7584 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
7586 because they have to be nested inside regular verse environments, which
7587 is not possible with \SpecialChar LyX
7591 \begin_layout Description
7592 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
7595 \begin_layout Section
7597 \change_inserted 564990737 1670439605
7601 \begin_layout Section
7603 \change_inserted 564990737 1671041968
7607 \begin_layout Subsection
7609 \change_inserted 564990737 1671041970
7615 \begin_layout Standard
7617 \change_inserted 564990737 1671041970
7628 document class for writing letters according to the
7630 Deutsches Institut für Normung
7642 ile\SpecialChar menuseparator
7644 \begin_inset space ~
7652 \begin_inset space ~
7657 offers guidance on its use.
7658 The documentation is available from
7659 \begin_inset CommandInset href
7662 target "http://mirrors.ctan.org/macros/latex/contrib/dinbrief/liesmich"
7670 \begin_layout Section
7672 \change_inserted 564990737 1670439660
7676 \begin_layout Subsection
7679 Foil\SpecialChar TeX
7683 \begin_inset CommandInset label
7692 \begin_layout Standard
7698 \begin_layout Subsubsection
7702 \begin_layout Standard
7703 This section describes how to use \SpecialChar LyX
7704 to make slides for overhead projectors.
7705 There are two document classes that can do this: the default slides class
7708 Foil\SpecialChar TeX
7712 This section documents the latter.
7715 \begin_layout Standard
7716 I'm going to say this again, nice and clear, so that there's no misunderstanding
7720 \begin_layout Standard
7721 \begin_inset VSpace bigskip
7727 \begin_layout Standard
7731 This section documents the class
7732 \begin_inset Quotes eld
7740 \begin_inset Quotes erd
7748 \begin_layout Standard
7749 \begin_inset VSpace bigskip
7755 \begin_layout Standard
7756 If you're looking for the documentation for
7757 \begin_inset Quotes eld
7765 \begin_inset Quotes erd
7769 \begin_inset space ~
7773 \begin_inset CommandInset ref
7775 reference "sec:slitex"
7780 If your machine doesn't have the
7788 installed, you'll probably have to use the default
7792 class, which isn't quite as good as
7797 \begin_layout Standard
7802 class is designed for use with version
7803 \begin_inset space ~
7811 class file which is now an integral part of \SpecialChar LaTeX2e
7815 \begin_layout Subsubsection
7819 \begin_layout Standard
7820 Obviously, to use this document class, you need to select
7831 \begin_inset space ~
7837 There are some settings in the
7840 \begin_inset space ~
7845 dialog that you should know about that are specific to this class:
7848 \begin_layout Itemize
7849 Don't change the options
7860 \begin_inset space ~
7866 They're ignored by the
7873 \begin_layout Itemize
7874 The default font size is 20
7875 \begin_inset space \thinspace{}
7878 pt with the other options being 17
7879 \begin_inset space \thinspace{}
7883 \begin_inset space \thinspace{}
7887 \begin_inset space \thinspace{}
7893 \begin_layout Itemize
7902 but all math equations are still typeset in the usual roman font.
7905 \begin_layout Itemize
7908 Foil\SpecialChar TeX
7911 supports A4 and Letter paper sizes as well as a special size for working
7913 \begin_inset space \thinspace{}
7917 It doesn't support A5, B5, legal or executive paper sizes.
7920 \begin_layout Itemize
7921 Don't bother changing the
7925 settings because they are ignored anyway.
7926 All floats appear where they are defined in the text.
7929 \begin_layout Itemize
7934 setting behaves a bit differently for this class.
7937 Foil\SpecialChar TeX
7940 provides extensive footer and header capabilities including a user-defined
7943 \begin_inset space ~
7947 \begin_inset CommandInset ref
7949 reference "sec:foilfoot"
7954 The title page is treated differently to all other pages in the document
7963 has the logo centered at the bottom of the page (if one is defined).
7964 The possible page style choices and what they do are as follows:
7968 \begin_layout Labeling
7969 \labelwidthstring MMMMMMM
7976 The final output contains no page numbers, or other headers or footers
7977 (except footnotes of course).
7981 \begin_layout Labeling
7982 \labelwidthstring MMMMMMM
7989 The final output contains page numbers centered at the bottom of the page.
7990 No other headings or footers (other than footnotes).
7993 \begin_layout Labeling
7994 \labelwidthstring MMMMMMM
7999 Page numbers in lower right corner.
8000 Additional headers and footers are also shown.
8001 This is also the default.
8004 \begin_layout Labeling
8005 \labelwidthstring MMMMMMM
8010 Gives you access to the
8014 package although its use with
8016 Foil\SpecialChar TeX
8019 is discouraged by the writer of the
8021 Foil\SpecialChar TeX
8024 package because of some potential page layout clashes.
8028 \begin_layout Paragraph
8032 \begin_layout Standard
8033 The following options may be used in the extra class options in the
8035 Document\SpecialChar menuseparator
8041 \begin_layout Labeling
8042 \labelwidthstring MMMMMMx
8047 This sets up the page layout for 7.33
8048 \begin_inset space \thinspace{}
8052 \begin_inset space \thinspace{}
8055 in paper, which is about the same aspect ratio as a 35
8056 \begin_inset space \thinspace{}
8059 mm slide, making it a bit easier to work with this medium.
8062 \begin_layout Labeling
8063 \labelwidthstring MMMMMMx
8068 Places a rule across the page below the header on every page except the
8072 \begin_layout Labeling
8073 \labelwidthstring MMMMMMx
8078 Places a rule across the page above the footer on every page except the
8082 \begin_layout Labeling
8083 \labelwidthstring MMMMMMx
8088 This is automatically set each time you create a new
8095 Foil\SpecialChar TeX
8098 to use the dvips driver to rotate those pages that are set as landscape
8102 \begin_layout Labeling
8103 \labelwidthstring MMMMMMx
8108 Simply changes the page dimensions to those of a landscape page but doesn't
8110 Thus if you use this option you need to use an external program to rotate
8111 each page or feed your paper through your printer as landscape.
8112 Note that this option effectively reverses the roles of the
8120 environments (don't worry these are described in the next section).
8123 \begin_layout Labeling
8124 \labelwidthstring MMMMMMx
8129 Equation numbers on the left.
8132 \begin_layout Labeling
8133 \labelwidthstring MMMMMMx
8138 Flush-left equations.
8141 \begin_layout Subsubsection
8142 Supported Environments
8145 \begin_layout Standard
8146 Most of the environments commonly supported in other classes are also supported
8152 There are several additional environments provided by
8154 Foil\SpecialChar TeX
8157 as well as a couple added by \SpecialChar LyX
8159 The following environments are shared with other classes:
8162 \begin_layout Standard
8163 \begin_inset Flex Multiple Columns
8166 \begin_layout Itemize
8172 \begin_layout Itemize
8178 \begin_layout Itemize
8184 \begin_layout Itemize
8190 \begin_layout Itemize
8196 \begin_layout Itemize
8203 \begin_layout Itemize
8209 \begin_layout Itemize
8215 \begin_layout Itemize
8221 \begin_layout Itemize
8227 \begin_layout Itemize
8233 \begin_layout Itemize
8239 \begin_layout Itemize
8245 \begin_layout Itemize
8251 \begin_layout Itemize
8262 \begin_layout Standard
8263 That is, all the major environments apart from the sectioning environments.
8264 Since foils are essentially self-contained sections, with a title and body,
8267 Foil\SpecialChar TeX
8270 provides specific commands for starting new foils and these are:
8273 \begin_layout Itemize
8279 \begin_layout Itemize
8285 \begin_layout Standard
8287 also provides slightly modified versions of these two environments called:
8290 \begin_layout Itemize
8296 \begin_layout Itemize
8302 \begin_layout Standard
8303 and the differences will be explained in the next section.
8306 \begin_layout Standard
8307 Since foils are often used in presenting ideas or new theorems and such
8310 Foil\SpecialChar TeX
8313 also provides a comprehensive box of goodies for presenting them:
8316 \begin_layout Standard
8317 \begin_inset Flex Multiple Columns
8320 \begin_layout Itemize
8326 \begin_layout Itemize
8332 \begin_layout Itemize
8338 \begin_layout Itemize
8344 \begin_layout Itemize
8350 \begin_layout Itemize
8356 \begin_layout Itemize
8362 \begin_layout Itemize
8368 \begin_layout Itemize
8374 \begin_layout Itemize
8380 \begin_layout Itemize
8391 \begin_layout Standard
8392 The starred versions are unnumbered while the unstarred versions are numbered.
8393 There are also two list environments added by \SpecialChar LyX
8397 \begin_layout Itemize
8403 \begin_layout Itemize
8409 \begin_layout Standard
8412 Foil\SpecialChar TeX
8415 provides some powerful header and footer capabilities that are best set
8416 in the preamble although they may be set at any point in a document.
8417 If you want to change these settings in your document the best place to
8418 do so is at the very top of a foil, i.
8419 \begin_inset space \thinspace{}
8425 \begin_inset space \space{}
8430 straight after the foilhead.
8433 \begin_layout Standard
8434 For this purpose, the following command styles are provided [
8441 \begin_layout Standard
8442 \begin_inset Flex Multiple Columns
8445 \begin_layout Itemize
8449 \begin_inset space ~
8455 \begin_layout Itemize
8461 \begin_layout Itemize
8465 \begin_inset space ~
8471 \begin_layout Itemize
8475 \begin_inset space ~
8481 \begin_layout Itemize
8485 \begin_inset space ~
8492 \begin_layout Plain Layout
8493 \begin_inset space ~
8505 \begin_layout Standard
8506 There are also a few commands provided by
8508 Foil\SpecialChar TeX
8511 that aren't directly supported by \SpecialChar LyX
8512 but I'll tell you what they do and how
8513 to use them in section
8514 \begin_inset space ~
8518 \begin_inset CommandInset ref
8520 reference "sec:unsuppfoils"
8527 \begin_layout Subsubsection
8528 Building a Set of Foils
8531 \begin_layout Standard
8532 This section will give a simple introduction to using the different environments
8533 to build a set of foils.
8534 If you want to see an example set of foils, take a look at the
8538 file you find in \SpecialChar LyX
8546 \begin_layout Paragraph
8547 Give It a Title Page
8550 \begin_layout Standard
8551 Unlike other classes that provide
8571 creates the title on a page of its own.
8572 If you leave out the
8576 environment \SpecialChar LaTeX
8577 will substitute the current date (every time you regenerate
8581 \begin_layout Paragraph
8585 \begin_layout Standard
8586 As I mentioned earlier, there are four ways of starting a new foil.
8587 For portrait foils you should use
8596 The difference between these two environments is the amount of space between
8597 the title of the foil (the foilhead) and the body of the foil.
8600 \begin_layout Standard
8601 Landscape foils are generated using the
8610 Again the only difference is the spacing between foilhead and body.
8611 Both of the short versions have 0.5
8612 \begin_inset space ~
8615 inches less separation between the foilhead and the body.
8619 \begin_layout Standard
8620 One problem with the support for landscape foils is the requirement that
8625 driver to generate the PostScript output otherwise the foils won't be rotated.
8626 It is possible to get landscape foils even if you haven't got the
8630 driver provided you can feed your foils sideways through your printer ;-)
8633 \begin_layout Paragraph
8634 Theorems, Lemmas, Proofs and more
8637 \begin_layout Standard
8638 You can't have two of the same type of these environments directly following
8640 If you use a normal paragraph break, , you will just be extending the previous
8641 environment as if you had merged the two environments together.
8642 Rather than that, you need to insert a so-called separator.
8643 Please refer to the section entitled
8654 \begin_layout Paragraph
8658 \begin_layout Standard
8659 You get all the commonly supported list styles found in other classes as
8660 well as two new ones.
8661 I'll only describe the new ones here.
8662 If you want to find out more about the other list environments check out
8668 If you intend to use itemized lists you might also want to read about the
8672 \begin_inset space ~
8676 \begin_inset space ~
8681 dialog described above in section
8682 \begin_inset space ~
8686 \begin_inset CommandInset ref
8688 reference "sec:bullet"
8695 \begin_layout Standard
8696 The two new list styles,
8704 , are designed to make it easier for you to create lists of do's and don'ts
8705 or right and wrong by providing dedicated environments that use a tick
8706 or a cross as the label of the list.
8707 These lists are in fact dedicated variants of the
8712 They do however require that you have the
8719 \begin_layout Paragraph
8723 \begin_layout Standard
8726 Foil\SpecialChar TeX
8729 redefines the floating tables and figures so that they appear exactly where
8730 they are in the text rather than pushing them to the top of the page or
8731 to some user specified location.
8732 In fact if you change the float placement settings they are simply ignored.
8735 \begin_layout Paragraph
8736 Page Headers and Footers
8737 \begin_inset CommandInset label
8746 \begin_layout Standard
8750 \begin_inset space ~
8759 are two commands used to control the left-footer text string.
8760 The first is meant to allow you to include a graphic logo on your foils
8762 \begin_inset Quotes eld
8767 Foil\SpecialChar TeX
8771 \begin_inset Quotes erd
8775 While the second is meant to provide a classification for the audience,
8779 \begin_inset space \thinspace{}
8785 \begin_inset space \space{}
8789 It is empty by default.
8792 \begin_layout Standard
8793 The remaining page corners can be filled by
8796 \begin_inset space ~
8801 (which defaults to page numbers),
8804 \begin_inset space ~
8812 \begin_inset space ~
8820 \begin_layout Subsubsection
8823 Foil\SpecialChar TeX
8827 \begin_inset CommandInset label
8829 name "sec:unsuppfoils"
8836 \begin_layout Standard
8837 All the commands mentioned below need to be set in a
8847 within another environment.
8850 \begin_layout Paragraph
8854 \begin_layout Standard
8855 All lengths are adjusted using the
8878 should be replaced by the name given to the length you want to change and
8883 is the length value.
8884 All lengths should be specified in units of length such as inches (
8896 ) or relative to some document or font-based length such as
8906 \begin_layout Standard
8907 It's possible to change the spacing between a foilhead and the body of the
8908 foil by adjusting the length specified by
8915 For example, to make
8920 \begin_inset space \space{}
8923 in closer to their bodies put the following in the preamble:
8929 foilheadskip}{-0.5in}
8932 \begin_layout Standard
8933 The spacings around floats can be adjusted by setting these lengths:
8936 \begin_layout Labeling
8937 \labelwidthstring MMMMMMMMMMM
8944 Separation between the text and the top of the float
8947 \begin_layout Labeling
8948 \labelwidthstring MMMMMMMMMMM
8955 Separation between the float and the caption
8958 \begin_layout Labeling
8959 \labelwidthstring MMMMMMMMMMM
8966 Separation between the caption and the following text
8969 \begin_layout Labeling
8970 \labelwidthstring MMMMMMMMMMM
8977 You can make the captions narrower than the surrounding text by adjusting
8979 Best done relative to
8988 \begin_layout Standard
8989 There are also several title page related lengths that you may find useful
8990 if you have a long title or several authors:
8993 \begin_layout Labeling
8994 \labelwidthstring MMMMMMMMMMM
9001 Separation from headers to
9006 \begin_layout Labeling
9007 \labelwidthstring MMMMMMMMMMM
9025 \begin_layout Labeling
9026 \labelwidthstring MMMMMMMMMMM
9040 \begin_layout Labeling
9041 \labelwidthstring MMMMMMMMMMM
9057 \begin_layout Labeling
9058 \labelwidthstring MMMMMMMMMMM
9074 \begin_layout Standard
9075 The last length related command affects all the list environments.
9086 a list environment then all the vertical spacing between the list items
9088 Note that this is a command not a length so it doesn't require
9094 like the stuff mentioned above.
9097 \begin_layout Paragraph
9101 \begin_layout Standard
9114 commands control whether the logo in the
9118 definition appear on a given page.
9125 in the preamble then none of the foils will have the logo on them.
9126 If you don't want the logo on a particular page place the
9132 directly after the foilhead of that page and the
9138 directly after the next foilhead.
9141 \begin_layout Standard
9142 If you decide to use the
9146 page style setting in the
9149 \begin_inset space ~
9154 dialog you should probably add
9164 to your preamble so headers and footers on landscape pages are correctly
9165 placed when rotated.
9166 This is due to some clashes between the page layouts provided by the
9177 \begin_layout Subsection
9184 \begin_inset CommandInset label
9193 \begin_layout Standard
9201 \begin_layout Subsubsection
9205 \begin_layout Standard
9206 This section describes how to use \SpecialChar LyX
9207 to make slides for overhead projectors.
9208 There are two document classes that can do this: the default slides class
9211 Foil\SpecialChar TeX
9215 This section documents the former.
9218 \begin_layout Standard
9219 I'm going to say this again, nice and clear, so that there's no misunderstanding
9223 \begin_layout Standard
9224 \begin_inset VSpace bigskip
9230 \begin_layout Standard
9234 This section documents the class
9235 \begin_inset Quotes eld
9243 \begin_inset Quotes erd
9251 \begin_layout Standard
9252 \begin_inset VSpace bigskip
9258 \begin_layout Standard
9259 If you're looking for the documentation for
9260 \begin_inset Quotes eld
9265 slides (Foil\SpecialChar TeX
9269 \begin_inset Quotes erd
9273 \begin_inset space ~
9277 \begin_inset CommandInset ref
9279 reference "sec:foiltex"
9289 \begin_inset Quotes eld
9294 slides (Foil\SpecialChar TeX
9298 \begin_inset Quotes erd
9301 ] is actually somewhat better than the default
9309 \begin_layout Plain Layout
9311 or so I've been told repeatedly by its advocates.
9312 Having never used it, I have no idea if this claim is true or not.
9317 which this section documents.
9320 \begin_layout Standard
9321 This class is the \SpecialChar LaTeX2e
9322 improvement of the old
9328 Every \SpecialChar LaTeX2e
9329 distribution includes this class [which I'll just refer to as
9330 \begin_inset Quotes eld
9338 \begin_inset Quotes erd
9341 from now on], so you're bound to have it.
9342 As I noted earlier, there are other classes, such as
9346 , which also produce slides for overhead projectors and do a better job
9348 However, there are some things which
9352 can do which the others can't, such as generate overlays.
9353 Read on to learn more!
9356 \begin_layout Subsubsection
9358 \begin_inset CommandInset label
9360 name "sec:slidesetup"
9367 \begin_layout Standard
9368 Obviously, to use this document class, you need to select
9369 \begin_inset Quotes eld
9377 \begin_inset Quotes erd
9380 from the class list in the
9382 Document\SpecialChar menuseparator
9386 There are some other special things you should know about this class:
9389 \begin_layout Itemize
9390 Don't bother changing the options
9395 They're not supported by the
9402 \begin_layout Itemize
9406 \begin_inset space ~
9411 behaves a bit differently for this class.
9412 The possible choices and what they do are as follows:
9416 \begin_layout Description
9421 The final output contains page numbers in the lower right corner.
9424 \begin_layout Description
9433 , but also prints out any time markers you've put in.
9434 This is the default.
9437 \begin_layout Description
9442 The final output contains no page numbers, time markers, or alignment markers.
9446 \begin_layout Itemize
9451 class has an extra option:
9457 \begin_inset Quotes eld
9465 \begin_inset Quotes erd
9468 in the extra class options.
9472 \begin_layout Standard
9473 Using this options allows you to add time markers to
9479 \begin_inset space ~
9483 \begin_inset CommandInset ref
9485 reference "sec:slideNote"
9493 \begin_layout Standard
9494 You can also use the template file
9495 \begin_inset Quotes eld
9503 \begin_inset Quotes erd
9506 to automatically set up a document to use the
9512 File\SpecialChar menuseparator
9514 \begin_inset space ~
9518 \begin_inset space ~
9523 to open your new document].
9524 The template file also contains some examples of the special paragraph
9525 environments used by this class.
9526 I'll describe those next.
9529 \begin_layout Subsubsection
9530 Paragraph Environments
9533 \begin_layout Paragraph
9534 Supported Environments
9537 \begin_layout Standard
9538 The first thing you'll notice when you start up a new
9542 document is the font size and type: it's the equivalent of the size
9543 \begin_inset Quotes eld
9551 \begin_inset Quotes erd
9557 \begin_inset space ~
9563 This is also what's used in the output.
9565 \begin_inset Quotes eld
9569 \begin_inset Quotes erd
9572 to remind you that this is a slide.
9573 Your final slides will use a larger font; ergo, you'll have less space.
9574 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
9577 \begin_layout Standard
9578 The next thing that becomes obvious is the changes to the paragraph environment
9579 pull-down box [at the far-left end of the toolbar].
9580 Most of the paragraph environments you're used to seeing are missing.
9581 There are also five new ones.
9586 class itself only supports certain paragraph environments:
9589 \begin_layout Itemize
9595 \begin_layout Itemize
9601 \begin_layout Itemize
9607 \begin_layout Itemize
9613 \begin_layout Itemize
9619 \begin_layout Itemize
9625 \begin_layout Itemize
9631 \begin_layout Itemize
9637 \begin_layout Itemize
9643 \begin_layout Itemize
9650 \begin_layout Standard
9651 All of the other standard environments, including the section-heading environmen
9652 ts, aren't used in the
9659 \begin_layout Standard
9660 On the other hand, you'll notice the following new environments:
9663 \begin_layout Itemize
9669 \begin_layout Itemize
9675 \begin_layout Itemize
9681 \begin_layout Itemize
9687 \begin_layout Itemize
9693 \begin_layout Standard
9694 These five are kind of quirky, due to a
9695 \begin_inset Quotes eld
9699 \begin_inset Quotes erd
9704 You see, \SpecialChar LyX
9705 doesn't permit you to nest any other paragraph environment into
9706 an empty environment.
9707 Now, that's fine and dandy, but it means that you wouldn't be able to start
9708 a slide with anything except plain text.
9709 To deal with this, I've performed a little
9710 \begin_inset Quotes eld
9715 \begin_inset Quotes erd
9721 \begin_layout Paragraph
9722 Quirks of the New Environments
9723 \begin_inset CommandInset label
9725 name "sec:slideQuirk"
9732 \begin_layout Standard
9733 All five of the new paragraph environments are somewhat quirky due to inherent
9734 limitiations in the current version of \SpecialChar LyX
9736 As I just mentioned, \SpecialChar LyX
9737 forbids environments that begin with another environment.
9738 To get around this, the
9742 environment isn't a paragraph environment as described in the
9750 \begin_layout Standard
9764 \begin_inset Quotes eld
9767 pseudo-environments.
9768 \begin_inset Quotes erd
9771 They look like a section heading or a
9772 \begin_inset Quotes eld
9780 \begin_inset Quotes erd
9783 but really begin a [and, if necessary, end the previous] paragraph environment.
9793 \begin_inset Quotes eld
9797 \begin_inset Quotes erd
9800 These two perform some action.
9803 \begin_layout Standard
9804 A common feature of all five environments,
9824 , is a rather long-ish label.
9825 The text following this label — ordinarily the contents of the paragraph
9826 environment — is utterly irrelevant for
9848 completely ignores it.
9849 In fact, you can leave these five environments completely empty.
9853 \begin_layout Standard
9858 to put any text after the rather long-ish label, you might want to.
9859 This could be a short description of the contents of the
9864 In that case, enter your descriptive comment and hit
9868 as you normally would.
9871 \begin_layout Standard
9872 If, on the other hand, you don't want to enter any descriptive text, you'll
9873 hit another \SpecialChar LyX
9876 , like nature, abhors a vacuum, and will not let you start a new paragraph
9877 environment until you put something in the old one.
9881 \begin_layout Itemize
9882 Start entering the text that will
9910 \begin_layout Itemize
9911 Now move to the beginning of that paragraph.
9915 \begin_layout Itemize
9924 \begin_layout Itemize
9925 Finally, change this new, empty paragraph to a
9949 \begin_layout Standard
9950 Some future version of \SpecialChar LyX
9951 will, hopefully, resolve this quirkiness\SpecialChar ldots
9955 \begin_layout Subsubsection
9956 Making a Presentation with
9969 \begin_layout Paragraph
9977 \begin_layout Standard
9978 If you're expecting this section to teach you how to actually make a presentatio
9979 n, you'll be sorely disappointed.
9980 Naturally, I'll describe all of the ways the
9984 class can assist you in preparing the materials for a presentation.
9985 Filling in the contents, however, is up to you.
9990 the \SpecialChar LyX
9994 \begin_layout Standard
9999 environment [in the manner described in section
10000 \begin_inset space ~
10004 \begin_inset CommandInset ref
10006 reference "sec:slideQuirk"
10010 ] tells \SpecialChar LyX
10011 to begin a new slide [duh].
10012 The label for this environment/
10013 \begin_inset Quotes erd
10017 \begin_inset Quotes erd
10021 \begin_inset Quotes eld
10025 \begin_inset Quotes erd
10028 in cool blue, followed by the label,
10029 \begin_inset Quotes eld
10033 \begin_inset Quotes erd
10037 Any text or paragraph environments that follow this one go on the new slide.
10041 \begin_layout Standard
10042 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
10044 (this can be specified in the
10049 In fact, you'll want to, once you finish entering the contents of one slide.
10050 If you've entered more text than can physically fit on a slide, the extra
10051 overflows onto a new slide.
10052 I don't recommend doing this, however, since the overflow slide won't have
10053 any page number on it.
10054 Furthermore, it may interfere with any
10058 you've made to accompany the oversized
10065 \begin_layout Standard
10074 environments work the same way as the
10079 They both create an
10080 \begin_inset Quotes eld
10084 \begin_inset Quotes erd
10087 followed by a label [
10088 \begin_inset Quotes eld
10092 \begin_inset Quotes erd
10096 \begin_inset Quotes eld
10100 \begin_inset Quotes erd
10104 The color is a stunning magenta instead of blue, and the
10105 \begin_inset Quotes eld
10109 \begin_inset Quotes erd
10112 will look different, in style and in length.
10113 The label fonts of all three also differ from one another.
10116 \begin_layout Standard
10121 , if the contents of a
10129 exceed the physical size of a slide or sheet of paper, the extra will overflow
10131 Again, you should avoid this.
10132 It defeats the whole purpose of
10143 \begin_layout Paragraph
10153 \begin_layout Standard
10158 is a slide that sits atop another slide.
10159 Perhaps you wish to discuss a figure on the main
10163 before displaying the text associated with it.
10164 One way to accomplish this is tape a flap of dark paper over the part of
10169 you want to display later.
10170 This method fails, however, if you wish to overlap one graph with another,
10172 You would then have to fumble while speaking to align the two separate,
10177 s to align the two graphs.
10182 environment in both cases makes life much easier.
10185 \begin_layout Standard
10190 receives the page number of its
10191 \begin_inset Quotes eld
10195 \begin_inset Quotes erd
10203 \begin_inset Quotes eld
10211 \begin_inset Quotes erd
10218 \begin_layout Plain Layout
10219 Presumably, mutliple
10224 \begin_inset Quotes eld
10232 \begin_inset Quotes erd
10236 \begin_inset Quotes eld
10244 \begin_inset Quotes erd
10248 \begin_inset Quotes eld
10256 \begin_inset Quotes erd
10260 \begin_inset space ~
10263 appended to the page number of the parent
10273 Clearly, you want the contents of both the
10281 to each fit on a single physical slide! You should probably consider an
10287 \begin_inset Quotes eld
10291 \begin_inset Quotes erd
10299 Indeed, the \SpecialChar LyX
10304 class provides a visual cue for this: the label at the start of an
10308 is shorter than that at the start of a
10313 Lastly, when you generate printable output, you'll find alignment markers
10314 in all four corners of both the
10318 page and its parent
10323 These will assist you in lining up the two physical slides.
10326 \begin_layout Standard
10327 The major problem in overlaying two slides is aligning the contents of the
10328 two transparencies.
10329 How much space should you leave for that graph on the second slide? Worse
10330 still, what if you want a graph and a sentence on second slide, but there
10331 is text on the main transparency that goes in between them? You could try
10332 and insert vertical space of the right size.
10333 The better way is to use
10344 \begin_layout Standard
10345 As their names imply,
10353 are two command-like paragraph environments that make all subsequent text
10354 invisible and visible, respectively.
10356 \begin_inset space ~
10360 \begin_inset CommandInset ref
10362 reference "sec:slideQuirk"
10366 that you don't place anything
10370 these two environments, however.
10375 , it inserts a centered, sky-blue label into the page reading
10376 \begin_inset Quotes eld
10379 <Invisible Text Follows>
10380 \begin_inset Quotes erd
10384 For paragraphs following this label, the parts of the
10392 ; it doesn't matter which] where they would be contain instead blank space.
10396 \begin_layout Standard
10401 , the corresponding centered label is
10402 \begin_inset Quotes eld
10405 <Visible Text Follows>
10406 \begin_inset Quotes erd
10410 Paragraphs following this label behave normally.
10411 Note that the beginning of a new
10423 automatically shuts off an
10428 It's therefore not necessary to use
10439 \begin_layout Standard
10440 By now, it should be obvious how to create overlay transparencies using
10441 the proper combination of
10460 \begin_layout Enumerate
10465 , including everything that will appear on it, whether on the main slide
10473 \begin_layout Enumerate
10474 Before each figure or paragraph that will appear only on the
10483 If necessary, insert a
10487 environment after the
10494 \begin_layout Enumerate
10499 immediately following the
10506 \begin_layout Enumerate
10507 Copy the contents of this
10518 \begin_layout Enumerate
10523 , change all of the
10534 \begin_layout Standard
10536 You've just made an
10543 \begin_layout Standard
10544 There's one problem with the way I've designed the \SpecialChar LyX
10549 class: you can't make text in the middle of a paragraph invisible, nor
10550 make text in the middle of an invisible paragraph visible again.
10551 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
10556 \begin_layout Plain Layout
10557 The commands of interest are:
10560 \begin_layout Itemize
10565 invisible \SpecialChar ldots
10569 \begin_layout Itemize
10574 visible \SpecialChar ldots
10578 \begin_layout Plain Layout
10580 and need to be marked as \SpecialChar TeX
10583 \begin_inset Quotes eld
10587 \begin_inset Quotes erd
10590 you wish to change goes in between the brackets [and after the
10603 If you don't know how to mark text as \SpecialChar TeX
10604 , see the appropriate section of
10617 \begin_layout Paragraph
10627 \begin_inset CommandInset label
10629 name "sec:slideNote"
10636 \begin_layout Standard
10645 is associated with a
10646 \begin_inset Quotes eld
10650 \begin_inset Quotes erd
10658 Here, too, the \SpecialChar LyX
10663 class provides visual cues.
10668 is shorter than that of a
10672 [yet longer than that of an
10676 ] and, like the label of an
10680 is shockingly magenta.
10681 Additionally, the printed
10685 has the page number of its
10686 \begin_inset Quotes eld
10690 \begin_inset Quotes erd
10698 \begin_inset Quotes eld
10706 \begin_inset Quotes erd
10710 \begin_inset Quotes eld
10718 \begin_inset Quotes erd
10722 \begin_inset Quotes eld
10730 \begin_inset Quotes erd
10734 You can have multiple
10738 s associated with a single
10750 , you'll probably want to break up long
10754 s so that they fit on a single sheet of paper.
10757 \begin_layout Standard
10762 is obvious: it contains anything additional you might want to say about
10768 It could also be used as a sheet of reminders for a particular
10773 In the case of the latter, you might want to make use of time markers.
10774 Currently, the \SpecialChar LyX
10780 \begin_inset Quotes eld
10784 \begin_inset Quotes erd
10787 support for time markers, a
10789 Sli\SpecialChar TeX
10793 So, you'll have to resort to using the \SpecialChar LaTeX
10797 \begin_layout Standard
10798 To use time markers, you'll need to specify the extra class option
10799 \begin_inset Quotes eld
10807 \begin_inset Quotes erd
10811 \begin_inset space ~
10815 \begin_inset CommandInset ref
10817 reference "sec:slidesetup"
10822 This option turns on timing marks, which will appear in the lower-left-hand
10828 To set what appears in the time marker, you use the \SpecialChar LaTeX
10830 \begin_inset Quotes eld
10840 \begin_inset Quotes erd
10844 \begin_inset Quotes eld
10854 \begin_inset Quotes erd
10858 The arguments of both commands are time measured in seconds.
10860 \begin_inset Quotes eld
10870 \begin_inset Quotes erd
10873 sets the time marker to a given time.
10875 \begin_inset Quotes eld
10885 \begin_inset Quotes erd
10888 increments the time marker by the specified amount.
10889 Using time markers and
10893 s in this fashion, you can remind yourself how much time to spend on a particula
10901 \begin_layout Standard
10902 There's one last feature to describe.
10903 Clearly, you'd like to print out all of your
10911 s on transparencies while printing all of your
10928 with which it is associated.
10929 What's a person to do?
10932 \begin_layout Standard
10933 Luckily, there are two \SpecialChar LaTeX
10934 commands that allow you to select what to print
10936 Both must be placed into the preamble of your document.
10938 \begin_inset Quotes eld
10950 \begin_inset Quotes erd
10953 will cause the output to contain only the
10962 Correspondingly, the command
10963 \begin_inset Quotes eld
10975 \begin_inset Quotes erd
10978 prevents the output of anything but
10983 I'd advise placing both commands in the preamble and initially comment
10985 You can then preview your entire presentation as you write.
10986 When you're done writing, you can then uncomment one of the two to select
10987 what you want to print.
10988 I like to uncomment
10989 \begin_inset Quotes eld
11001 \begin_inset Quotes erd
11004 , print to a file with
11005 \begin_inset Quotes eld
11013 \begin_inset Quotes erd
11016 in its name, comment it back out, then uncomment
11017 \begin_inset Quotes eld
11029 \begin_inset Quotes erd
11033 \begin_inset Quotes eld
11041 \begin_inset Quotes erd
11045 I can then send either file to a printer, loading transparencies or plain
11046 paper as appropriate.
11049 \begin_layout Standard
11050 You can also provide other arguments to the
11051 \begin_inset Quotes eld
11061 \begin_inset Quotes erd
11065 \begin_inset Quotes eld
11075 \begin_inset Quotes erd
11079 See a good \SpecialChar LaTeX
11083 \begin_layout Subsubsection
11088 Class Template File
11091 \begin_layout Standard
11092 I have also provided a template file,
11093 \begin_inset Quotes eld
11101 \begin_inset Quotes erd
11109 To use it, begin your new presentation with
11111 File\SpecialChar menuseparator
11113 \begin_inset space ~
11117 \begin_inset space ~
11123 Your new \SpecialChar LyX
11124 presentation file will contain an example
11145 additionally contain an example of the use of
11154 Lastly, the preamble will contain:
11157 \begin_layout LyX-Code
11158 % Uncomment to print out only slides and overlays
11161 \begin_layout LyX-Code
11165 \begin_layout LyX-Code
11171 \begin_inset Newline newline
11177 \begin_layout LyX-Code
11178 % Uncomment to print out only notes
11181 \begin_layout LyX-Code
11185 \begin_layout LyX-Code
11193 \begin_layout Standard
11194 One final thing: I created this class to support the \SpecialChar LaTeX2e
11196 \begin_inset Quotes eld
11201 Sli\SpecialChar TeX
11205 \begin_inset Quotes erd
11208 class, one of the built-in \SpecialChar LaTeX2e
11210 Neither I nor the rest of the \SpecialChar LyX
11211 Team endorse or oppose the use of this built-in
11213 It's here if you want it or need it.
11214 There exist other \SpecialChar LaTeX2e
11215 classes for creating presentations, such as the
11220 \begin_inset space ~
11224 \begin_inset CommandInset ref
11226 reference "sec:foiltex"
11231 \begin_inset Quotes eld
11239 \begin_inset Quotes erd
11242 package [present on some \SpecialChar TeX
11244 The latter is not yet supported under \SpecialChar LyX
11249 \begin_layout Plain Layout
11250 Perhaps you can take on the task\SpecialChar ldots
11256 I know nothing about these other classes.
11257 Try them out to see what sort of alternative they provide.
11260 \begin_layout Section
11262 \change_inserted 564990737 1670439661
11266 \begin_layout Subsection
11268 \change_inserted 564990737 1670439661
11272 \begin_layout Standard
11274 \change_inserted 564990737 1670439661
11283 document class for preparing reports.
11288 document class, this provides parts, chapters and sections but does not
11289 provide the paragraph styles needed for a book; like the
11293 document class, it provides the abstract paragraph style.
11294 In two-sided mode, it does not start a new chapter on the right hand page.
11297 \begin_layout Standard
11299 \change_inserted 564990737 1670439674
11304 document classes are described in the Collections (section
11305 \begin_inset space ~
11309 \begin_inset CommandInset ref
11311 reference "sec:Collections"
11318 \begin_layout Section
11320 \change_inserted 564990737 1670439674
11324 \begin_layout Subsection
11328 \begin_layout Standard
11334 \begin_layout Subsubsection
11338 \begin_layout Standard
11339 Broadway is for writing plays.
11340 The format is more decorative than Hollywood, and much less standardized.
11341 This format should be suitable for workshops.
11344 \begin_layout Subsubsection
11348 \begin_layout Standard
11349 The same as in Hollywood.
11352 \begin_layout Subsubsection
11356 \begin_layout Standard
11361 names as labels then cross-reference the label to insert the name.
11362 The cross-reference dialog will show the current cast of characters.
11365 \begin_layout Subsubsection
11366 Paper size and Margins
11369 \begin_layout Standard
11370 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
11373 \begin_layout Subsubsection
11377 \begin_layout Standard
11378 The following environments are available.
11379 You can use broadway.bind to get the bind keys shown at the right.
11382 \begin_layout Itemize
11386 \begin_inset Newline newline
11391 You should not have to use this, but it is here for anything that does not
11395 \begin_layout Itemize
11399 \begin_inset space \hfill{}
11403 \begin_inset Newline newline
11408 Used to describe stage setting and the action.
11409 First use of speaker names in all CAPs.
11412 \begin_layout Itemize
11416 \begin_inset space \hfill{}
11420 \begin_inset Newline newline
11425 Automatically numbered.
11426 On screen it will be arabic, but will print as Roman.
11429 \begin_layout Itemize
11433 \begin_inset space \hfill{}
11437 \begin_inset Newline newline
11447 It is just centered text.
11450 \begin_layout Itemize
11454 \begin_inset space \hfill{}
11458 \begin_inset Newline newline
11463 Not automatically numbered.
11464 You supply the number.
11465 This is because I couldn't figure out how.
11468 \begin_layout Itemize
11472 \begin_inset space \hfill{}
11476 \begin_inset Newline newline
11481 A special case of Narrative to describe the setting and action as the curtain
11485 \begin_layout Itemize
11489 \begin_inset space \hfill{}
11493 \begin_inset Newline newline
11498 The speaker's (actor's) title, centered in all CAPS.
11501 \begin_layout Itemize
11505 \begin_inset space \hfill{}
11509 \begin_inset Newline newline
11514 Instructions to the speaker.
11515 The parentheses are automatically inserted.
11516 The ( will appear on screen, but both will be in the printed play.
11517 This environment is only used within
11524 \begin_layout Itemize
11528 \begin_inset space \hfill{}
11532 \begin_inset Newline newline
11537 What the Speaker says.
11540 \begin_layout Itemize
11544 \begin_inset space \hfill{}
11548 \begin_inset Newline newline
11553 The curtain comes down.
11556 \begin_layout Itemize
11560 \begin_inset space \hfill{}
11566 \begin_layout Itemize
11570 \begin_inset space \hfill{}
11576 \begin_layout Itemize
11580 \begin_inset space \hfill{}
11586 \begin_layout Standard
11590 \begin_layout Subsection
11591 Hollywood (Hollywood spec scripts)
11594 \begin_layout Standard
11600 \begin_layout Subsubsection
11604 \begin_layout Standard
11605 Getting the format of a Hollywood script right is a
11606 \begin_inset Quotes eld
11610 \begin_inset Quotes erd
11613 It is designed to make the readers focus on content and to be easy and
11614 familiar for the actors to read.
11615 Each page of a script should be one minute of film.
11616 Nothing goes in a script that you cannot see or hear on screen.
11617 The courier 12 pt font should be used throughout.
11621 \begin_layout Subsubsection
11625 \begin_layout Standard
11626 Speakers' lines should NEVER break in mid-sentence.
11627 If a speaker's lines continue over a page break, repeat the
11631 title followed by (Cont'd).
11634 \begin_layout Subsubsection
11638 \begin_layout Standard
11643 names as labels then cross-reference the label to insert the name.
11644 The cross-reference dialog will show the current cast of characters.
11645 You can use this to insert the speaker name in narratives also.
11648 \begin_layout Subsubsection
11649 Paper size and Margins
11652 \begin_layout Standard
11653 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
11656 \begin_layout Subsubsection
11660 \begin_layout Standard
11661 The following environments are available.
11662 You can use hollywood.bind to get the bind keys shown at the right.
11665 \begin_layout Itemize
11669 \begin_inset Newline newline
11674 Used where nothing else works.
11678 \begin_layout Itemize
11684 \begin_inset space \hfill{}
11692 \begin_inset Newline newline
11695 Usually followed by something like
11696 \begin_inset Quotes eld
11699 on Sally waking up.
11700 \begin_inset Quotes erd
11706 \begin_layout Itemize
11710 \begin_inset space \hfill{}
11714 \begin_inset Newline newline
11719 Introduces a new INTERIOR camera set-up.
11720 Always followed by DAY or NIGHT, or something similar to define the lighting
11722 Everthing on this line in CAPS.
11725 \begin_layout Itemize
11729 \begin_inset space \hfill{}
11733 \begin_inset Newline newline
11738 Introduces a new EXTERIOR camera set-up.
11739 Everthing on this line in CAPS.
11742 \begin_layout Itemize
11746 \begin_inset space \hfill{}
11750 \begin_inset Newline newline
11755 The character speaking.
11758 \begin_layout Itemize
11762 \begin_inset space \hfill{}
11766 \begin_inset Newline newline
11771 Instructions to the speaker.
11772 The () are automatically inserted.
11775 \begin_layout Itemize
11779 \begin_inset space \hfill{}
11783 \begin_inset Newline newline
11795 \begin_layout Itemize
11799 \begin_inset space \hfill{}
11803 \begin_inset Newline newline
11808 Camera movement instruction.
11810 \begin_inset space \thinspace{}
11814 \begin_inset space \space{}
11820 \begin_layout Itemize
11824 \begin_inset space \hfill{}
11830 \begin_layout Itemize
11834 \begin_inset space \hfill{}
11840 \begin_layout Itemize
11844 \begin_inset space \hfill{}
11850 \begin_layout Itemize
11854 \begin_inset space \hfill{}
11860 \begin_layout Subsubsection
11864 \begin_layout Itemize
11868 \begin_layout Itemize
11872 \begin_layout Itemize
11874 \begin_inset space \thinspace{}
11881 \begin_layout Itemize
11886 \begin_layout Itemize
11887 PAN — camera movement
11890 \begin_layout Itemize
11891 INSERT — cut to close-up of
11894 \begin_layout Chapter
11898 \begin_layout Standard
11899 All you need to do is install Rev\SpecialChar TeX
11900 4, as described in the package's README
11902 The package can be found at The Rev\SpecialChar TeX
11904 \begin_inset Flex URL
11907 \begin_layout Plain Layout
11909 http://publish.aps.org/revtex4/
11915 Install it somewhere that \SpecialChar LaTeX
11917 Test it by trying to \SpecialChar LaTeX
11918 a short Rev\SpecialChar TeX
11919 4 document in some random directory (i.
11920 \begin_inset space \thinspace{}
11924 \begin_inset space \space{}
11927 not the directory where you installed the class file.) Then, if you reconfigure
11929 , it will find the class file and let you use the Rev\SpecialChar TeX
11933 \begin_layout Standard
11934 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
11943 \begin_inset space ~
11948 template, found in the templates directory.
11951 \begin_layout Chapter
11955 \begin_layout Standard
11956 Optional arguments to
11963 \begin_inset Quotes eld
11967 \begin_inset Quotes erd
11971 \begin_inset Quotes eld
11975 \begin_inset Quotes erd
11981 \begin_inset space ~
11989 \begin_inset space ~
11995 Remember that in Rev\SpecialChar TeX
11996 , at least one optional argument is required!
11999 \begin_layout Standard
12000 Other preamble matter, like
12007 \begin_inset space ~
12014 \begin_inset space ~
12019 dialog, also as usual.
12022 \begin_layout Chapter
12026 \begin_layout Standard
12027 The layouts basically correspond to the commands in Rev\SpecialChar TeX
12029 For example, the Email layout corresponds to
12036 Note that (at least as of Rev\SpecialChar TeX
12045 layouts are exactly equivalent, so you shouldn't need to use both.
12049 \begin_layout Plain Layout
12050 In case you're curious, both were included so that
12054 would be able to translate both
12074 \begin_layout Chapter
12078 \begin_layout Standard
12079 There are a couple of important unique aspects of Rev\SpecialChar TeX
12080 4 which might cause
12081 bugs that will be even more confusing in \SpecialChar LyX
12085 \begin_layout Standard
12086 In Rev\SpecialChar TeX
12104 The \SpecialChar LyX
12105 equivalent is that there is a separate Thanks layout.
12110 write footnotes in the
12114 layout, or weird things may happen.
12115 See the Rev\SpecialChar TeX
12116 4 documentation for more details.
12119 \begin_layout Standard
12123 \begin_inset space ~
12131 \begin_inset space ~
12140 layouts must be placed
12148 layout and the corresponding
12165 , the \SpecialChar LaTeX
12169 \begin_layout Chapter
12173 \begin_layout Section
12174 Customizing Bibliographies with Bib\SpecialChar TeX
12178 \begin_layout Standard
12179 The most basic information about how to use Bib\SpecialChar TeX
12184 with \SpecialChar LyX
12185 is contained in the section
12187 Bibliography databases
12194 The following subsections explain special bibliography features supported
12195 by \SpecialChar LyX
12199 \begin_layout Subsection
12200 Alternative Citation Styles
12203 \begin_layout Standard
12204 Standard Bib\SpecialChar TeX
12206 \begin_inset space \thinspace{}
12210 \begin_inset space \space{}
12214 \begin_inset Quotes eld
12218 \begin_inset Quotes erd
12221 ) to refer to a cited work.
12222 However, in many scientific disciplines, other citation styles are in use.
12223 The most common one is the author-year style (e.
12224 \begin_inset space \thinspace{}
12228 \begin_inset space \space{}
12232 \begin_inset Quotes eld
12236 \begin_inset Quotes erd
12241 supports three packages that provide this style,
12242 \begin_inset Flex Code
12245 \begin_layout Plain Layout
12252 \begin_inset Flex Code
12255 \begin_layout Plain Layout
12262 \begin_inset Flex Code
12265 \begin_layout Plain Layout
12272 Each of these packages has their pros and cons, which cannot be listed
12274 If you only want to have simple author-year (or author-numerical) style,
12275 or if you want to use one of the countless style files for
12276 \begin_inset Flex Code
12279 \begin_layout Plain Layout
12285 , then the established
12286 \begin_inset Flex Code
12289 \begin_layout Plain Layout
12295 package is probably your choice.
12296 If you look for specific citation styles common in law studies, you might
12298 \begin_inset Flex Code
12301 \begin_layout Plain Layout
12308 If you want to have full control over the formatting or look for advanced
12309 features such as ibidem, footnote citations, full title citations, advanced
12310 date formats (such as 400 BC) or full localization to other languages than
12311 English, you should definitely consider
12312 \begin_inset Flex Code
12315 \begin_layout Plain Layout
12321 , which exceeds all other packages in terms of features, but is also quite
12322 heavy and more resource-hungry.
12325 \begin_layout Standard
12326 The handling of these packages in \SpecialChar LyX
12327 is basically the same.
12329 \begin_inset Flex Noun
12332 \begin_layout Plain Layout
12333 Document\SpecialChar menuseparator
12340 \begin_inset Flex Noun
12343 \begin_layout Plain Layout
12350 \begin_inset Flex Noun
12353 \begin_layout Plain Layout
12360 \begin_inset Flex Noun
12363 \begin_layout Plain Layout
12370 \begin_inset Flex Noun
12373 \begin_layout Plain Layout
12380 \begin_inset Flex Noun
12383 \begin_layout Plain Layout
12384 Biblatex (Natbib mode)
12390 \begin_inset Flex Noun
12393 \begin_layout Plain Layout
12400 \begin_inset Flex Noun
12403 \begin_layout Plain Layout
12410 \begin_inset space ~
12413 6.5.3 in the User's Guide for more information on these choices).
12414 With all these packages, you will get some extra features in the citation
12415 dialog and you can select the style of the reference (
12416 \begin_inset Quotes eld
12420 \begin_inset Quotes erd
12424 \begin_inset Quotes eld
12428 \begin_inset Quotes erd
12432 \begin_inset Quotes eld
12436 \begin_inset Quotes erd
12440 \begin_inset Quotes eld
12444 \begin_inset Quotes erd
12448 Note that either package needs specifically designed style files.
12449 They all ship their own, but there are lots of additional style files,
12450 and there is even an interactive style file builder
12454 \begin_layout Plain Layout
12456 \begin_inset Flex URL
12459 \begin_layout Plain Layout
12461 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
12472 \begin_inset Flex Code
12475 \begin_layout Plain Layout
12484 \begin_layout Subsection
12485 Subdivided Bibliographies
12488 \begin_layout Standard
12489 Sometimes you might need to divide your bibliography into several sections.
12490 If you are for instance a historian, the possibility to separate sources
12491 and scientific works is most likely a
12492 \begin_inset Quotes eld
12496 \begin_inset Quotes erd
12500 Unfortunately, Bib\SpecialChar TeX
12501 itself does not allow you to do this.
12502 But with the help of some \SpecialChar LaTeX
12503 packages, Bib\SpecialChar TeX
12504 can be extended to fit your needs.
12507 \begin_layout Standard
12509 provides native support for one of these packages,
12517 \begin_layout Plain Layout
12519 \begin_inset Flex URL
12522 \begin_layout Plain Layout
12524 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
12534 The advantage of this package (compared to other packages such as
12538 ) is that you don't need to define new citation commands.
12539 Instead, you need to prepare different bibliographic databases which include
12540 the entries for the different sections of the bibliography.
12541 For example: If you want to divide your bibliography into the sections
12543 \begin_inset Quotes eld
12547 \begin_inset Quotes erd
12551 \begin_inset Quotes eld
12555 \begin_inset Quotes erd
12558 , you first need to create two bibliographic databases, e.
12559 \begin_inset space \thinspace{}
12563 \begin_inset space \space{}
12567 \begin_inset Flex Code
12570 \begin_layout Plain Layout
12577 \begin_inset Flex Code
12580 \begin_layout Plain Layout
12590 \begin_layout Standard
12592 \begin_inset Flex Noun
12595 \begin_layout Plain Layout
12596 Document\SpecialChar menuseparator
12603 \begin_inset Flex Noun
12606 \begin_layout Plain Layout
12613 \begin_inset Flex Noun
12616 \begin_layout Plain Layout
12617 Subdivided bibliography
12623 Now you can insert multiple Bib\SpecialChar TeX
12624 bibliographies, one for each section of
12626 Returning to our example: Insert the Bib\SpecialChar TeX
12628 \begin_inset Flex Code
12631 \begin_layout Plain Layout
12637 and a second one for the database
12638 \begin_inset Flex Code
12641 \begin_layout Plain Layout
12648 You are free to use the same or different styles for each section.
12649 Additionally, you can choose if the bibliography section should contain
12651 \begin_inset Quotes eld
12654 all cited references
12655 \begin_inset Quotes erd
12658 of the specified database(s) (which is the default),
12659 \begin_inset Quotes eld
12662 all uncited references
12663 \begin_inset Quotes erd
12667 \begin_inset Quotes eld
12671 \begin_inset Quotes erd
12675 This might be useful if you would like to separate your bibliography into
12677 \begin_inset Quotes eld
12681 \begin_inset Quotes erd
12685 \begin_inset Quotes eld
12689 \begin_inset Quotes erd
12693 \begin_inset Quotes eld
12697 \begin_inset Quotes erd
12701 The titles for the sections can be added as ordinary sections or subsections.
12703 \begin_inset Flex Code
12706 \begin_layout Plain Layout
12712 removes the bibliography title, you have to manually re-add that, too (as
12713 a chapter* or section*, for instance).
12716 \begin_layout Standard
12721 , the procedure is a bit different.
12730 , the aforementioned
12731 \begin_inset Flex Noun
12734 \begin_layout Plain Layout
12735 Subdivided bibliography
12740 option is disabled if you use
12749 provides its own means to generate subdivided bibliographies.
12750 You can either add keywords to bibliography entries via the
12751 \begin_inset Flex Code
12754 \begin_layout Plain Layout
12760 entry option and then filter bibliography sections by keyword (by adding
12762 \begin_inset Flex Code
12765 \begin_layout Plain Layout
12772 \begin_inset Flex Noun
12775 \begin_layout Plain Layout
12781 field of the dialog that opens if you left-click on the
12782 \begin_inset Flex Noun
12785 \begin_layout Plain Layout
12786 Biblatex Generated Bibliography
12791 button), or you can filter by entry types (such as
12800 \begin_inset space \thinspace{}
12805 \begin_inset Flex Code
12808 \begin_layout Plain Layout
12815 \begin_inset Flex Code
12818 \begin_layout Plain Layout
12825 \begin_inset Flex Noun
12828 \begin_layout Plain Layout
12834 field, or you can create so-called
12835 \begin_inset Quotes eld
12838 Bibliography Categories
12839 \begin_inset Quotes erd
12842 to which you can assign individual entries.
12843 Please refer to the Biblatex manual, section
12845 Subdivided Bibliographies
12850 \begin_layout Subsection
12851 Multiple Bibliographies
12852 \begin_inset CommandInset label
12854 name "subsec:Multiple-Bibliographies"
12861 \begin_layout Standard
12862 Multiple bibliographies, e.
12863 \begin_inset space \thinspace{}
12867 \begin_inset space \space{}
12870 a bibliography for each part, chapter, section, subsection or child (sub-documen
12871 t) of the document, are also supported by \SpecialChar LyX
12873 In order to enable it, go to
12874 \begin_inset Flex Noun
12877 \begin_layout Plain Layout
12878 Document\SpecialChar menuseparator
12879 Settings\SpecialChar menuseparator
12885 and select the relevant unit (e.
12886 \begin_inset space \thinspace{}
12890 \begin_inset Quotes eld
12894 \begin_inset Quotes erd
12898 \begin_inset Flex Noun
12901 \begin_layout Plain Layout
12902 Multiple Bibliographies
12908 Then add a Bib(la)\SpecialChar TeX
12909 bibliography to each unit (e.
12910 \begin_inset space \thinspace{}
12913 g., section) of your document.
12914 In the output, a separate bibliography, containing only the references
12915 done in the current unit is generated.
12918 \begin_layout Standard
12919 If you use Bib\SpecialChar TeX
12921 \begin_inset Flex Code
12924 \begin_layout Plain Layout
12931 \begin_inset Flex Code
12934 \begin_layout Plain Layout
12940 package is used to create multiple bibliographies.
12941 The former package is used if you select
12942 \begin_inset Quotes eld
12946 \begin_inset Quotes erd
12954 \begin_inset Flex Noun
12957 \begin_layout Plain Layout
12958 Sectioned Bibliography
12964 In all other cases,
12965 \begin_inset Flex Code
12968 \begin_layout Plain Layout
12978 \begin_layout Plain Layout
12979 An alternative approach, if you are willing to use some
12980 \begin_inset Flex Noun
12983 \begin_layout Plain Layout
12991 \begin_inset space ~
12995 \begin_inset CommandInset ref
12997 reference "sec:Inserting-TeX-Code"
13002 \begin_inset Flex Code
13005 \begin_layout Plain Layout
13017 \begin_inset Flex Code
13020 \begin_layout Plain Layout
13026 is used, \SpecialChar LyX
13027 encloses the specified units in
13028 \begin_inset Flex Code
13031 \begin_layout Plain Layout
13038 \begin_inset Flex Code
13041 \begin_layout Plain Layout
13050 \begin_inset Flex Code
13053 \begin_layout Plain Layout
13061 in order to create the units.
13062 Note that this approach has some limitations.
13063 First, every citation reference has to be inside some
13064 \begin_inset Flex Code
13067 \begin_layout Plain Layout
13074 So citations outside a defined unit (e.
13075 \begin_inset space \thinspace{}
13078 g., before the first section if you use
13079 \begin_inset Quotes eld
13083 \begin_inset Quotes erd
13087 \begin_inset Quotes eld
13091 \begin_inset Quotes erd
13095 You can also create your own units by entering
13096 \begin_inset Flex Code
13099 \begin_layout Plain Layout
13108 \begin_inset Flex Code
13111 \begin_layout Plain Layout
13119 as \SpecialChar TeX
13120 code (for instance to work around the mentioned limitation).
13122 \begin_inset Flex Code
13125 \begin_layout Plain Layout
13131 s cannot be nested.
13132 A second limitation is that
13133 \begin_inset Flex Code
13136 \begin_layout Plain Layout
13142 always processes all references of a bibliography database, even if they
13144 This can result in odd labels (e.
13145 \begin_inset space \thinspace{}
13150 \begin_inset Quotes eld
13154 \begin_inset Quotes erd
13157 if two works of this author from 2014 are in the database, even if only
13161 \begin_layout Standard
13167 \begin_inset Flex Code
13170 \begin_layout Plain Layout
13176 option is used instead.
13177 If you need specific units, you can start them with the \SpecialChar TeX
13179 \begin_inset Flex Code
13182 \begin_layout Plain Layout
13191 \begin_inset Flex Code
13194 \begin_layout Plain Layout
13203 If you also want to control the end of the unit, use the environment
13204 \begin_inset Flex Code
13207 \begin_layout Plain Layout
13217 \begin_inset Flex Code
13220 \begin_layout Plain Layout
13230 \begin_inset Flex Code
13233 \begin_layout Plain Layout
13239 s cannot be nested.
13240 In addition to the individual bibliography of the current unit,
13244 also provides an easy way to output all bibliographies, subsequently, at
13246 \begin_inset space \thinspace{}
13249 g., at the end of the document).
13251 \begin_inset Quotes eld
13254 all reference units
13255 \begin_inset Quotes erd
13258 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve
13260 Please refer to the
13264 manual for more information on this topic.
13267 \begin_layout Section
13268 Multipart Documents
13271 \begin_layout Subsection
13275 \begin_layout Standard
13276 When you are working on a large file with many sections, it is often convenient
13277 to break up the document into several files, or perhaps you have something
13278 where a table may change from time to time, but the preceding text does
13280 In these cases, you should seriously consider using multipart documents.
13281 For example, scientific papers often have five major sections: the introduction
13282 , observations, results, discussion, and conclusion.
13283 Each of these could be its own separate \SpecialChar LyX
13285 \begin_inset Quotes eld
13289 \begin_inset Quotes erd
13292 file which contains the title, authors, abstract, references, etc., plus
13293 the five included files.
13294 It is important to note that each of these files is a full \SpecialChar LyX
13296 can be formatted and printed on its own, as well as included in a master
13298 Each of these files must have the same document class, however—don't attempt
13299 to mix book classes with article classes.
13300 You may also include \SpecialChar LaTeX
13301 files; however, these files must not have their own
13303 \begin_inset space \thinspace{}
13307 \begin_inset space \space{}
13310 everything up to and including the
13311 \begin_inset Flex Code
13314 \begin_layout Plain Layout
13322 line as well as the
13323 \begin_inset Flex Code
13326 \begin_layout Plain Layout
13334 line must be deleted) or else errors will be generated when you try to
13338 \begin_layout Standard
13340 allows you to include files quite easily with
13341 \begin_inset Flex Noun
13344 \begin_layout Plain Layout
13345 Insert\SpecialChar menuseparator
13347 \begin_inset space ~
13356 When you click on this selection a small box is inserted into the file
13357 at the current cursor location.
13358 Clicking on the box raises a dialog which allows you to select the file
13359 to be included, and the method of its inclusion.
13363 \begin_layout Standard
13364 The file selection box should by now be obvious.
13365 The three inclusion methods are
13366 \begin_inset Quotes eld
13370 \begin_inset Quotes erd
13374 \begin_inset Quotes eld
13378 \begin_inset Quotes erd
13382 \begin_inset Quotes eld
13386 \begin_inset Quotes erd
13391 \begin_inset Quotes eld
13395 \begin_inset Quotes erd
13399 \begin_inset Quotes eld
13403 \begin_inset Quotes erd
13406 are similar in many ways, but there are also some notable differences:
13409 \begin_layout Enumerate
13411 \begin_inset Quotes eld
13415 \begin_inset Quotes erd
13418 are typeset beginning on a new page, while files that are
13419 \begin_inset Quotes eld
13423 \begin_inset Quotes erd
13426 are typeset starting on the current page.
13429 \begin_layout Enumerate
13430 \begin_inset Quotes eld
13434 \begin_inset Quotes erd
13437 files cannot themselves
13438 \begin_inset Quotes eld
13442 \begin_inset Quotes erd
13446 \begin_inset Quotes eld
13450 \begin_inset Quotes erd
13455 \begin_inset Quotes eld
13459 \begin_inset Quotes erd
13462 , on the other hand, infinite sub-inputting is possible.
13465 \begin_layout Enumerate
13466 \begin_inset Quotes eld
13470 \begin_inset Quotes erd
13473 allow for the output of only selected
13474 \begin_inset Quotes eld
13478 \begin_inset Quotes erd
13481 files, while maintaining the actual counters (pagination etc.) and references
13482 (please refer to the section
13485 \begin_inset space ~
13493 \begin_inset space ~
13498 manual for details).
13501 \begin_layout Standard
13503 \begin_inset Quotes eld
13507 \begin_inset Quotes erd
13510 is the preferred method for chapters that are outsourced to child documents,
13512 \begin_inset Quotes eld
13516 \begin_inset Quotes erd
13519 is more suitable for arbitrary file inheritance.
13522 \begin_layout Standard
13524 \begin_inset Quotes eld
13528 \begin_inset Quotes erd
13531 included file allows you to include a file typeset exactly as it appears
13533 \begin_inset space \thinspace{}
13537 \begin_inset space \space{}
13541 \begin_inset Flex Code
13544 \begin_layout Plain Layout
13550 mode, with the characters set in a fixed-width typewriter font.
13551 Normally, spaces in this file are invisible, though two consecutive spaces
13552 are conserved, unlike \SpecialChar LyX
13553 's normal treatment of spaces.
13554 However, setting the
13555 \begin_inset Flex Noun
13558 \begin_layout Plain Layout
13560 \begin_inset space ~
13564 \begin_inset space ~
13568 \begin_inset space ~
13576 checkbox typesets a mark to unambiguously define the presence of a space.
13580 \begin_layout Standard
13581 Generally, the master file is converted into a full \SpecialChar LaTeX
13582 file before typesetting,
13583 while the included files are converted to \SpecialChar LaTeX
13584 files that do not have all the
13585 preamble information.
13588 \begin_layout Subsection
13589 Cross-References Between Files
13592 \begin_layout Standard
13593 \begin_inset Box Shadowbox
13603 height_special "totalheight"
13608 backgroundcolor "none"
13611 \begin_layout Plain Layout
13612 This section is somewhat out of date.
13613 Need to describe default master documents and how children are opened when
13623 \begin_layout Standard
13624 It is possible to set up cross-references between the different files.
13625 First, open all the files in question: let's call them A and B in a two
13626 file example, where B is included in A.
13627 Let's say you insert a label in A, then want to reference it in B.
13628 Open the cross-reference dialog whilst in document B, and you can select
13630 \begin_inset Quotes eld
13634 \begin_inset Quotes erd
13640 \begin_layout Subsection
13641 Bibliography Lists in all Subdocuments
13644 \begin_layout Standard
13645 If you work with child documents, you might want to have only one main bibliogra
13646 phy at the end, but still be able to have a selected bibliography for the
13647 child if you output it on its own.
13648 Here is how to achieve this.
13651 \begin_layout Standard
13652 For the main document, you just insert a bibliography inset at the place
13653 where the main bibliography has to appear (within the master file or within
13655 If the bibliography inset is in the master file, the references will be
13656 inherited by all children, so they are available in the citation dialog
13660 \begin_layout Standard
13661 For child-specific bibliographies, insert bibliography insets within the
13662 child documents, at the place where the bibliography should appear when
13663 the child is compiled separately.
13664 However, the trick is to insert them into a branch (
13666 Insert\SpecialChar menuseparator
13667 Branch\SpecialChar menuseparator
13668 Insert New Branch...
13671 \begin_inset space \thinspace{}
13676 \begin_inset Quotes eld
13680 \begin_inset Quotes erd
13684 Within the children, activate the branch (
13686 Document\SpecialChar menuseparator
13687 Settings...\SpecialChar menuseparator
13691 Within the master, deactivate the branch (
13693 Document\SpecialChar menuseparator
13694 Settings...\SpecialChar menuseparator
13698 Now the child's bibliography will be ignored by the master, but considered
13702 \begin_layout Standard
13703 If you need multiple bibliographies (e.
13704 \begin_inset space \thinspace{}
13707 g., one per child in the
13711 ), please refer to sec.
13712 \begin_inset space ~
13716 \begin_inset CommandInset ref
13718 reference "subsec:Multiple-Bibliographies"
13725 \begin_layout Section
13730 \begin_layout Standard
13731 Users sometimes need to be able to
13732 \begin_inset Quotes eld
13736 \begin_inset Quotes erd
13740 file together with all the images (and other files) on which it depends,
13741 either for sending to a publisher or for sharing with a co-author.
13743 includes a Python script (
13744 \begin_inset Flex Code
13747 \begin_layout Plain Layout
13753 ) that automates this process.
13754 To use it, you must have either the
13755 \begin_inset Flex Code
13758 \begin_layout Plain Layout
13765 \begin_inset Flex Code
13768 \begin_layout Plain Layout
13774 python modules installed on your system.
13775 By default, the script prefers the
13776 \begin_inset Flex Code
13779 \begin_layout Plain Layout
13786 \begin_inset Flex Code
13789 \begin_layout Plain Layout
13795 format on Unix-like systems and the
13796 \begin_inset Flex Code
13799 \begin_layout Plain Layout
13808 \begin_layout Standard
13810 's configuration process will set the script up to export a `\SpecialChar LyX
13812 and this format will then be available under
13813 \begin_inset Flex Code
13816 \begin_layout Plain Layout
13817 File\SpecialChar menuseparator
13826 \begin_layout Standard
13827 Independently of the platform, the generation of a particular archive format
13828 can be forced by adding either the
13829 \begin_inset Flex Code
13832 \begin_layout Plain Layout
13839 \begin_inset Flex Code
13842 \begin_layout Plain Layout
13849 \begin_inset Flex Code
13852 \begin_layout Plain Layout
13859 \begin_inset Flex Code
13862 \begin_layout Plain Layout
13868 format) switch to the
13869 \begin_inset Flex Code
13872 \begin_layout Plain Layout
13874 \SpecialChar menuseparator
13882 \begin_inset Flex Code
13885 \begin_layout Plain Layout
13886 Tools\SpecialChar menuseparator
13887 Preferences\SpecialChar menuseparator
13888 File Handling\SpecialChar menuseparator
13895 (Make sure you add the switch after the script name, not before it.)
13898 \begin_layout Section
13899 Fancy Headers and Footers
13902 \begin_layout Standard
13903 The default page layout is rather plain; for an
13904 \begin_inset Flex Code
13907 \begin_layout Plain Layout
13913 document class, all you get is a centered page number at the bottom of
13915 This document uses KOMA-script's book class, so it appears to be a bit
13917 But to really put on a show, you need to set the document page style to
13919 \begin_inset Quotes eld
13923 \begin_inset Quotes erd
13926 , as mentioned in the
13931 This section describes the \SpecialChar LaTeX
13932 code you need to insert in your \SpecialChar LaTeX
13934 order to get the desired effects.
13937 \begin_layout Standard
13938 For more information on fancy headers, see the
13939 \begin_inset Flex Code
13942 \begin_layout Plain Layout
13948 package documentation.
13950 \begin_inset Flex URL
13953 \begin_layout Plain Layout
13955 https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
13963 \begin_layout Standard
13964 The page header is divided into three fields, not surprisingly labeled
13965 \begin_inset Quotes eld
13969 \begin_inset Quotes erd
13973 \begin_inset Quotes eld
13977 \begin_inset Quotes erd
13981 \begin_inset Quotes eld
13985 \begin_inset Quotes erd
13989 The footer is also divided into these three fields.
13990 The \SpecialChar LaTeX
13991 commands to set these fields in the simplest manner are
13992 \begin_inset Flex Code
13995 \begin_layout Plain Layout
14004 \begin_inset Flex Code
14007 \begin_layout Plain Layout
14016 \begin_inset Flex Code
14019 \begin_layout Plain Layout
14028 \begin_inset Flex Code
14031 \begin_layout Plain Layout
14040 Suppose you wish to put your name in the upper left hand corner of each
14042 Simply insert the following command in the preamble:
14045 \begin_layout Standard
14054 \begin_layout Standard
14055 You will now see your name in the upper left.
14056 If a field has a default entry that you would like to get rid of (often
14057 the page number appears in the central footer) simply include a command
14058 with a blank argument, e.
14059 \begin_inset space \thinspace{}
14065 \begin_layout Standard
14073 \begin_layout Standard
14074 Let's get really fancy: lets put the section number with the word
14075 \begin_inset Quotes eld
14079 \begin_inset Quotes erd
14083 \begin_inset space \thinspace{}
14087 \begin_inset space \space{}
14090 Section 3) in the upper left, the page number (e.
14091 \begin_inset space \thinspace{}
14095 \begin_inset space \space{}
14098 Page 4) in the upper right, your name in the lower left, and the date in
14100 The following commands should now appear in the preamble:
14103 \begin_layout Standard
14113 \begin_layout Standard
14121 \begin_layout Standard
14131 \begin_layout Standard
14140 \begin_layout Standard
14148 \begin_layout Standard
14158 \begin_layout Standard
14160 \begin_inset Flex Code
14163 \begin_layout Plain Layout
14172 \begin_inset Flex Code
14175 \begin_layout Plain Layout
14183 access \SpecialChar LaTeX
14184 's section and page counters, and so print out the current section
14187 \begin_inset Flex Code
14190 \begin_layout Plain Layout
14198 simply prints out today's date.
14201 \begin_layout Standard
14202 The thicknesses of the horizontal rules drawn beneath the header and above
14203 the footer can also be modified.
14204 If you don't want one of the rules, set its thickness to 0.
14205 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
14211 \begin_inset Flex Code
14214 \begin_layout Plain Layout
14219 headrulewidth}{0.4pt}
14225 \begin_inset Flex Code
14228 \begin_layout Plain Layout
14233 footrulewidth}{0.4pt}
14238 to set the thicknesses.
14241 \begin_layout Standard
14242 You can switch the header/footer settings on and off for individual pages
14243 using commands like
14244 \begin_inset Flex Code
14247 \begin_layout Plain Layout
14250 thispagestyle{empty}
14256 \begin_inset Flex Code
14259 \begin_layout Plain Layout
14262 thispagestyle{plain}
14268 \begin_inset Flex Code
14271 \begin_layout Plain Layout
14274 thispagestyle{fancy}
14280 Simply insert them in the text on the page you want changed and mark them
14281 as \SpecialChar TeX
14283 In fact, title pages are marked as plain by default, while following pages
14284 are marked fancy when using the global fancy setting.
14287 \begin_layout Standard
14288 As a final example, it is possible to include an image in the header or
14290 Suppose you want to put a company logo in the upper lefthand corner.
14291 You might try something like
14294 \begin_layout Standard
14303 includegraphics{logo.eps}}}
14306 \begin_layout Standard
14308 (you may need to preface this with
14309 \begin_inset Flex Code
14312 \begin_layout Plain Layout
14315 usepackage{graphics}
14320 if you don't include graphics elsewhere in your document).
14323 \begin_layout Section
14324 Itemize Bullet Selection
14325 \begin_inset CommandInset label
14334 \begin_layout Standard
14340 \begin_layout Subsection
14344 \begin_layout Standard
14346 provides 216 bullet shapes that can be accessed from a simple dialog.
14347 Using this dialog you can easily specify what bullet shape to use at each
14348 level of an itemized list.
14349 These settings are document-wide so you won't be able to specify different
14350 sets of bullets for different paragraphs.
14354 \begin_layout Plain Layout
14355 Well, actually you can but you'll have to do it by hand.
14363 \begin_layout Subsection
14367 \begin_layout Standard
14368 Open the dialog by selecting the
14369 \begin_inset Flex Noun
14372 \begin_layout Plain Layout
14373 Document\SpecialChar menuseparator
14379 menu item and then select the
14380 \begin_inset Flex Noun
14383 \begin_layout Plain Layout
14392 \begin_layout Standard
14393 The dialog provides you with a table of bullet shapes.
14394 A column of buttons on the left of the table provides access to the six
14395 different panels of bullet shapes.
14396 The row of buttons across the top is used to select which bullet depth
14399 \change_deleted 244031559 1603875981
14400 A text entry under the table shows the currently selected bullet shape's
14402 equivalent and this can be edited if desired.
14403 If you do modify the text you will also need to specify any needed packages
14404 in the \SpecialChar LaTeX
14410 \begin_layout Standard
14411 The six panels are divided up by the packages they require.
14412 The following table shows the mappings from button name to \SpecialChar LaTeX
14416 \begin_layout Standard
14418 \begin_inset Tabular
14419 <lyxtabular version="3" rows="7" columns="2">
14420 <features tabularvalignment="middle">
14421 <column alignment="center" valignment="top" width="0pt">
14422 <column alignment="center" valignment="top" width="0pt">
14424 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
14427 \begin_layout Plain Layout
14442 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
14445 \begin_layout Plain Layout
14462 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
14465 \begin_layout Plain Layout
14480 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
14483 \begin_layout Plain Layout
14492 base \SpecialChar LaTeX
14500 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
14503 \begin_layout Plain Layout
14518 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
14521 \begin_layout Plain Layout
14538 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
14541 \begin_layout Plain Layout
14556 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
14559 \begin_layout Plain Layout
14576 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
14579 \begin_layout Plain Layout
14594 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
14597 \begin_layout Plain Layout
14614 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
14617 \begin_layout Plain Layout
14632 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
14635 \begin_layout Plain Layout
14652 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
14655 \begin_layout Plain Layout
14670 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
14673 \begin_layout Plain Layout
14696 \begin_layout Standard
14698 doesn't stop you using bullets from packages you don't have.
14699 If you get errors from \SpecialChar LaTeX
14700 when you try to view or print the file, then it
14701 is likely you are missing a package.
14705 \begin_layout Plain Layout
14707 doesn't restrict your use since you may be editing locally and exporting
14716 \begin_layout Subsection
14720 \begin_layout Standard
14721 Select which bullet depth you want to change then select the bullet shape
14723 Any changes will not be visible in \SpecialChar LyX
14724 , but are visible when viewing the document.
14727 \begin_layout Standard
14728 You can reset a bullet shape to the default simply by clicking your right
14729 mouse button on the appropriate bullet depth button.
14733 \begin_layout Plain Layout
14738 want to have multiple sets of paragraphs with different sets of bullets
14739 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
14741 The bullet selection dialog can help though because it provides you with
14742 the \SpecialChar LaTeX
14743 code for a wide range of bullet shapes.
14744 To make your own custom paragraphs you have the following options:
14747 \begin_layout Plain Layout
14751 \begin_layout Plain Layout
14767 \begin_layout Plain Layout
14771 \begin_layout Plain Layout
14793 \begin_layout Itemize
14794 Use the \SpecialChar LaTeX
14796 \begin_inset Flex Code
14799 \begin_layout Plain Layout
14807 to specify a new bullet shape for a given depth.
14808 You'll also need to save the current bullet shape so you can restore it
14810 In this itemized list the following \SpecialChar LaTeX
14811 code was used to change the bullet
14812 used for the first depth.
14816 \begin_layout LyX-Code
14826 \begin_layout LyX-Code
14843 \begin_layout Itemize
14844 Note that the itemize depth is specified in Roman numerals as part of the
14854 \begin_layout Itemize
14855 \begin_inset Argument item:1
14858 \begin_layout Plain Layout
14862 \begin_layout Plain Layout
14880 Specify each individual entry by starting each item with the bullet shape
14882 \begin_inset Quotes eld
14886 \begin_inset Quotes erd
14889 inset (available at
14891 Insert\SpecialChar menuseparator
14895 \begin_inset Flex Noun
14898 \begin_layout Plain Layout
14906 For example, this item was started with
14907 \begin_inset Flex Code
14910 \begin_layout Plain Layout
14925 \begin_layout Plain Layout
14929 \begin_layout Plain Layout
14945 \begin_layout Plain Layout
14946 You'll also need to revert the labelitem back to its previous setting for
14947 the global bullet shape settings to remain in effect.
14948 The way used here was:
14951 \begin_layout LyX-Code
14966 \begin_layout Chapter
14968 and the World Wide Web
14971 \begin_layout Standard
14973 has long supported the export of documents to various web-friendly formats,
14975 Before version 2.0, however, HTML export was always accomplished by the
14976 use of external converters.
14980 \begin_layout Plain Layout
14981 For details on the use of external converters with \SpecialChar LyX
14986 section of the Customization manual.
14991 These fall into two large groups: there are converters that use \SpecialChar LaTeX
14993 intermediate format, such as
14994 \begin_inset Flex Code
14997 \begin_layout Plain Layout
15004 \begin_inset Flex Code
15007 \begin_layout Plain Layout
15014 \begin_inset Flex Code
15017 \begin_layout Plain Layout
15023 , relying upon \SpecialChar LyX
15024 to produce the \SpecialChar LaTeX
15025 ; and there is a converter that works directly
15026 on \SpecialChar LyX
15028 \begin_inset Flex Code
15031 \begin_layout Plain Layout
15039 All of these have different advantages and disadvantages.
15043 \begin_layout Standard
15044 The \SpecialChar LaTeX
15045 -based converters have the advantage that, in principle, they know everythin
15046 g about the exported document that \SpecialChar LaTeX
15048 Such converters do not care, for example, if a certain block of code was
15049 produced by \SpecialChar LyX
15050 or was Evil Red Text.
15051 These converters know about
15052 \begin_inset Flex Code
15055 \begin_layout Plain Layout
15061 files, counters, and references, and can often make use of the
15062 \begin_inset Flex Code
15065 \begin_layout Plain Layout
15071 files generated by Bib\SpecialChar TeX
15073 On the other hand, \SpecialChar LaTeX
15074 is a very hard language to parse—it is sometimes said
15075 that only \SpecialChar TeX
15076 itself understands \SpecialChar TeX
15077 —and \SpecialChar LaTeX
15078 -based converters will often choke on
15079 what seem to be quite simple constructs; complex ones can throw them completely
15080 , and as of this writing, for example, the
15084 manual will not export with
15085 \begin_inset Flex Code
15088 \begin_layout Plain Layout
15094 , though the others will.
15095 The other issue concerns how math is handled.
15096 These converters typically convert the formulae into little pictures that
15097 are then linked from the HTML document.
15098 Since these are actually generated by \SpecialChar LaTeX
15099 , they are accurate.
15100 But they do not scale well, and just getting them to look as if they are
15101 actually meant to be in your document—so that the font sizes seem to be
15102 roughly the same—can be a challenge.
15105 \begin_layout Standard
15107 \begin_inset Flex Code
15110 \begin_layout Plain Layout
15118 \begin_inset CommandInset href
15120 name "http://pinchito.es/elyxer/"
15121 target "http://pinchito.es/elyxer/"
15126 ) solves some of these problems.
15127 In particular, the formulae it produces scale perfectly, since it renders
15128 math using a combination of HTML and CSS rather than converting the formulae
15130 But even moderately complex formula are rendered less well than with
15131 \begin_inset Flex Code
15134 \begin_layout Plain Layout
15140 ; this reflects the limitations of HTML.
15144 \begin_layout Plain Layout
15146 \begin_inset Flex Code
15149 \begin_layout Plain Layout
15156 can also use jsMath and MathJax for equations, but this setting is only
15157 available globally and requires one to have access to a server that runs
15163 More importantly (as of version 1.1.1, at least),
15164 \begin_inset Flex Code
15167 \begin_layout Plain Layout
15174 has limited support for math macros and no support for user-defined paragraph
15175 or character styles.
15176 These limitations make
15177 \begin_inset Flex Code
15180 \begin_layout Plain Layout
15187 unsuitable for many of the documents \SpecialChar LyX
15189 In principle, of course, these problems could be solved, but the \SpecialChar LyX
15191 have decided to follow a different path and have made \SpecialChar LyX
15193 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
15194 , DocBook, and plaintext.
15197 \begin_layout Standard
15198 As of this writing, XHTML output remains under development and should probably
15200 \begin_inset Quotes eld
15204 \begin_inset Quotes erd
15211 \begin_layout Plain Layout
15213 \begin_inset Flex Code
15216 \begin_layout Plain Layout
15217 development/HTML/HTML.notes
15222 , which can be found in the \SpecialChar LyX
15224 \begin_inset CommandInset href
15226 name "accessed online"
15227 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
15232 , usually contains up-to-date information about the state of XHTML output.
15233 See also the list of XHTML bugs on
15234 \begin_inset CommandInset href
15236 name "the bug tracker"
15237 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"
15247 Still, the developers have chosen this approach because it has several
15248 potential advantages over the other two.
15251 \begin_layout Standard
15252 These advantages are primarily due to the fact that the XHTML output routines,
15253 since they are part of \SpecialChar LyX
15254 , know everything \SpecialChar LyX
15255 knows about the document being
15260 \begin_layout Plain Layout
15261 Another advantage is that, since these routines are internal to \SpecialChar LyX
15263 immune to changes in \SpecialChar LyX
15264 's file format, or to changes in the semantics of
15270 So they know about the table of contents (as displayed in the outline),
15271 about the counters associated with different paragraph styles, and about
15272 user-defined styles.
15273 The XHTML output routines know what \SpecialChar LyX
15274 knows about internationalization,
15275 too, so they will output
15276 \begin_inset Quotes eld
15280 \begin_inset Quotes erd
15284 \begin_inset Quotes eld
15292 \begin_inset Quotes erd
15295 , depending upon the language in effect at the time.
15299 \begin_layout Standard
15300 Quite generally, the output routines know what \SpecialChar LyX
15301 knows about document layout,
15302 that is, about how the document is to be rendered on screen.
15303 We use this information when we output the document as XHTML.
15304 In particular, \SpecialChar LyX
15309 generates CSS style information corresponding to the layout information
15310 it uses to render the document on screen: if section headings are supposed
15311 to be sans-serif and bold as seen in \SpecialChar LyX
15312 , then (by default) they will be sans-seri
15313 f and bold when viewed in a web browser, too.
15314 And this is true not just for pre-defined styles, like Section, but for
15315 any style, including user-defined styles.
15316 Indeed, the XHTML output routines make no distinction between user-defined
15318 \change_deleted 244031559 1603876931
15320 \change_inserted 244031559 1603876940
15323 styles and \SpecialChar LyX
15324 's own pre-defined styles: in each case, everything \SpecialChar LyX
15326 the styles is contained in the layout files.
15327 And much the same is true as regards pre-defined textual insets, such as
15328 footnotes, and various custom insets.
15332 \begin_layout Standard
15333 The result is that XHTML output can be customized and extended in exactly
15334 the same way \SpecialChar LaTeX
15335 output can be customized and extended: through layout files
15337 See chapter five of the
15341 manual for the details.
15344 \begin_layout Standard
15345 The remainder of this chapter contains more detailed information on XHTML
15346 output, its limitations, and ways to work around those limitations.
15349 \begin_layout Section
15350 Math Output in XHTML
15353 \begin_layout Standard
15355 offers four choices for how math is rendered.
15356 These have various advantages and disadvantages:
15359 \begin_layout Itemize
15361 \begin_inset Newline newline
15364 MathML is a dialect of XML designed specifically for mathematics on the
15365 web, and it typically renders very well in browsers that support it.
15366 The disadvantage is that not all browsers support MathML, and support is
15367 not complete even in the Gecko-based browsers, such as Firefox.
15368 \begin_inset Newline newline
15371 If \SpecialChar LyX
15372 is unable to render a formula as MathML—for example, if the formula
15374 \begin_inset Flex Code
15377 \begin_layout Plain Layout
15383 package or ERT—then it will instead output the formula as an image.
15387 \begin_layout Itemize
15389 \begin_inset Newline newline
15392 As mentioned above,
15393 \begin_inset Flex Code
15396 \begin_layout Plain Layout
15402 outputs math as HTML, styled by CSS.
15406 \begin_layout Plain Layout
15408 has borrowed some of the CSS for its HTML output from
15409 \begin_inset Flex Code
15412 \begin_layout Plain Layout
15423 For simple formulae, this can work quite well, though with more complicated
15424 formulae it tends to break down.
15425 Still, this method has the advantage that it is very widely supported and
15426 so it may be appropriate for documents that contain only a little, fairly
15428 \begin_inset Newline newline
15431 If Lyx is unable to render a formula as HTML—for example, if the formula
15433 \begin_inset Flex Code
15436 \begin_layout Plain Layout
15442 package or ERT—then it will instead output the formula as an image.
15446 \begin_layout Itemize
15448 \begin_inset Newline newline
15452 \begin_inset Flex Code
15455 \begin_layout Plain Layout
15462 will output formulae as images, the very same images, in fact, that are
15463 used for instant preview.
15467 \begin_layout Plain Layout
15468 Instant preview does
15472 have to be on for images to be output, however.
15477 The advantage to this method is that the images are simply generated by
15479 , so they are very accurate.
15480 The disadvantage, as mentioned earlier, is that these are bitmapped images,
15481 so they do not scale terribly well, and one cannot copy them, etc.
15482 \begin_inset Newline newline
15485 The size of the images can be controlled by setting the
15486 \begin_inset Quotes eld
15489 Math Images Scaling
15490 \begin_inset Quotes erd
15494 \begin_inset Flex Noun
15497 \begin_layout Plain Layout
15498 Document\SpecialChar menuseparator
15499 Settings\SpecialChar menuseparator
15509 \begin_layout Plain Layout
15510 For those who want to know, this controls the resolution of the image in
15511 dots per inch and is based upon a default of 75 dpi.
15517 \begin_inset Newline newline
15520 If \SpecialChar LyX
15521 for some reason fails to create an image for a formula (e.g., if a required
15523 package is not installed), then it will fall back to outputing the raw
15528 \begin_layout Itemize
15531 \begin_inset Newline newline
15534 Finally, \SpecialChar LyX
15535 will happily output math as \SpecialChar LaTeX
15537 As well as being the output of last resort, this method can be used with
15539 \begin_inset CommandInset href
15542 target "http://www.math.union.edu/~dpvc/jsMath/"
15547 , which uses JavaScript to render \SpecialChar LaTeX
15548 embedded in HTML documents.
15550 wraps the \SpecialChar LaTeX
15552 \begin_inset Flex Code
15555 \begin_layout Plain Layout
15561 (for inline formulas) or
15562 \begin_inset Flex Code
15565 \begin_layout Plain Layout
15571 (for displayed formulas) with
15572 \begin_inset Flex Code
15575 \begin_layout Plain Layout
15581 , as is required for jsMath.
15584 \begin_layout Standard
15585 One of these output methods must be selected under
15586 \begin_inset Flex Noun
15589 \begin_layout Plain Layout
15590 Document\SpecialChar menuseparator
15591 Settings\SpecialChar menuseparator
15598 By default, \SpecialChar LyX
15600 This is a document-wide setting, therefore.
15603 \begin_layout Standard
15604 Eventually, \SpecialChar LyX
15605 will offer the user the option to select an alternate output
15606 method for a particular inset, say, one that isn't being rendered very
15611 \begin_layout Plain Layout
15612 That said, since \SpecialChar LyX
15613 falls back to images if the inset contains ERT, then one
15614 can force output as an image by putting some harmless ERT into the math,
15616 \begin_inset Formula $a=b\relax$
15627 \begin_layout Section
15628 Bibliography and Citations
15631 \begin_layout Standard
15632 XHTML output fully supports bibliographies and citations.
15636 \begin_layout Standard
15637 Citation labels are generated by the same machinery that generates \SpecialChar LyX
15639 labels, so the labels will look in the output much as they do in \SpecialChar LyX
15642 If you are using numerical citations, then \SpecialChar LyX
15643 will output numerical labels,
15644 such as [1] or [17], rather than simply showing the citation key in square
15645 brackets, as it does on-screen.
15646 If you are using author-year citations, then \SpecialChar LyX
15647 will add lowercase letters
15648 to the years, just as Bib\SpecialChar TeX
15649 does, if it finds more than one citation for
15650 a given author-year combination.
15651 The labels will be printed with the bibliography entries.
15652 Note that there is, at present, no way to customize the appearance of the
15653 labels, for example, to choose between square brackets and parentheses.
15656 \begin_layout Standard
15657 Bibliography output is handled by the same machinery that handles the presentati
15658 on of reference information in the citation dialog, so you will see in the
15659 XHTML output pretty much what you would see if you were to look at a given
15660 entry in the citation dialog.
15661 The formatting can be customized in your layout file or, preferably, in
15667 manual for the details.
15670 \begin_layout Standard
15671 The main defect at present is that cross-referenced information is printed
15672 with every entry with which it is associated.
15673 So you can see things like this:
15676 \begin_layout Quote
15678 \begin_inset Quotes eld
15681 Context and Logical Form
15682 \begin_inset Quotes erd
15687 Language in Context: Selected Essays
15689 (Oxford: Oxford University Press, 2007), pp.
15693 \begin_layout Quote
15695 \begin_inset Quotes eld
15698 Semantics in Context
15699 \begin_inset Quotes erd
15704 Language in Context: Selected Essays
15706 (Oxford: Oxford University Press, 2007), pp.
15710 \begin_layout Standard
15711 This should be fixed before long.
15714 \begin_layout Standard
15715 There is no support at present for sectioned bibliographies.
15716 If you have multiple bibliographies, then \SpecialChar LyX
15717 will print the same bibliography
15721 \begin_layout Section
15725 \begin_layout Standard
15727 will happily export indexes as XHTML, but with certain limitations at the
15731 \begin_layout Standard
15732 Index export will be most reliable when you do not attempt to use the fancy
15733 constructs that are described in the section on indexes in the
15741 \begin_layout Plain Layout
15742 The main issue here is that \SpecialChar LyX
15743 itself does not really handle these.
15744 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
15750 We'll describe how they are handled using the subsection headings from
15754 \begin_layout Itemize
15755 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
15756 makes an effort to support these,
15757 but the entries must be separated by
15758 \begin_inset Quotes eld
15762 \begin_inset Quotes erd
15765 , that is, there must be spaces around the exclamation point.
15766 This is because it is otherwise too difficult to check for escaped exclamation
15767 points, ones in math, and so forth.
15770 \begin_layout Itemize
15771 Page Ranges: There is no support at all for page ranges, since these make
15772 no sense with XHMTL.
15773 Instead, you will just get two index entries, one at either end.
15776 \begin_layout Itemize
15777 Cross-referencing: There is no support for cross-referencing.
15778 If \SpecialChar LyX
15779 finds an entry containing the
15780 \begin_inset Quotes eld
15783 |see\SpecialChar ldots
15785 \begin_inset Quotes erd
15788 construct, it is just dropped, and the rest is treated as an ordinary index
15792 \begin_layout Itemize
15793 Index Entry Order: \SpecialChar LyX
15794 does support attempts to fix the sorting order.
15795 It will take what is before the first `@' it finds and use that for sorting,
15796 taking what follows the first `@' to be the actual entry.
15797 At present, \SpecialChar LyX
15798 does not check for escaped `@', so do not try to index email
15802 \begin_layout Itemize
15803 Index Entry Layout: You can format entries by using the text style dialog,
15804 or by using any other method available within \SpecialChar LyX
15806 There is no support for constructs like:
15807 \begin_inset Quotes eld
15811 \begin_inset Quotes erd
15815 Indeed, if \SpecialChar LyX
15816 finds a pipe symbol, `|', in an entry, it will delete it and
15817 everything that follows it.
15820 \begin_layout Itemize
15821 Multiple Indexes: There is no support for multiple indexes.
15822 Rather, all index entries will be printed as one large index.
15823 To avoid our printing several versions of the index, we print only the
15824 main index, so make sure you have one.
15827 \begin_layout Section
15828 Nomenclature and Glossary
15831 \begin_layout Standard
15832 There is at present no support for glossaries.
15833 Adding it would be fairly trivial, and welcome.
15836 \begin_layout Chapter
15838 \change_inserted 1075283030 1616534180
15842 \begin_layout Standard
15844 \change_inserted 1075283030 1616534386
15845 Apart from HTML, \SpecialChar LyX
15846 can generate documents in the DocBook XML vocabulary.
15847 With versions 2.3 and before, only select templates could be used to generate
15848 DocBook documents (only version 4).
15849 Starting with \SpecialChar LyX
15850 2.4, most \SpecialChar LyX
15851 layouts can generate valid DocBook documents (only
15853 This feature is built into \SpecialChar LyX
15854 and does not require the use of external tools.
15857 \begin_layout Standard
15859 \change_inserted 1075283030 1616534437
15860 The result is that the DocBook output can be customized and extended in
15861 exactly the same way \SpecialChar LaTeX
15862 output can be customized and extended: through layout
15864 See chapter five of the
15868 manual for the details.
15871 \begin_layout Standard
15873 \change_inserted 1075283030 1616534475
15874 Most \SpecialChar LyX
15875 features are supported with DocBook, like math output.
15878 \begin_layout Itemize
15880 \change_inserted 1075283030 1616534741
15881 Math output is performed mostly in MathML (the major exception being constructio
15882 ns not supported by \SpecialChar LyX
15885 All formulae are also available in raw \SpecialChar TeX
15886 in the DocBook output for further
15890 \begin_layout Itemize
15892 \change_inserted 1075283030 1616534852
15893 Bibliographies and citations are implemented, including with an external
15895 Bibliography entries are not prerendered when the detailed information
15896 are available, but rather output with the standard DocBook constructs.
15897 The external DocBook processor is expected to handle the rendering of entries.
15900 \begin_layout Itemize
15902 \change_inserted 1075283030 1616534863
15903 Indexes are supported, including multiple indices.
15908 ), page ranges, and cross-references (
15912 ) are supported, with the exception of the same symbols escaped.
15921 ) are not supported.
15922 There is no support for escaping of index entries.
15925 \begin_layout Itemize
15927 \change_inserted 1075283030 1616534884
15928 Glossaries are implemented.
15931 \begin_layout Standard
15933 \change_inserted 1075283030 1616534894
15934 Two major parameters can be set at the document level.
15937 \begin_layout Itemize
15939 \change_inserted 1075283030 1616534948
15940 Format for tables: \SpecialChar LyX
15941 can generate tables either as HTML (default value) or
15942 CALS, depending on the user's requirements.
15943 Most DocBook processors accept both formats.
15946 \begin_layout Itemize
15948 \change_inserted 1075283030 1616535006
15949 MathML prefix: in DocBook, MathML is included within its own name space,
15951 The implication is that there must be an indication of the tags belonging
15952 to the MathML standard.
15953 Three choices are offered:
15957 \begin_layout Itemize
15959 \change_inserted 1075283030 1616535044
15960 Inline: the MathML name space is defined for each formula (using the
15964 attribute on each formula)
15967 \begin_layout Itemize
15969 \change_inserted 1075283030 1616535090
15974 prefix (default): the MathML name space is defined at the document level
15979 attribute on the root element).
15980 Each MathML is prefixed with
15989 \begin_layout Itemize
15991 \change_inserted 1075283030 1616620405
15996 prefix: similar to the
16005 \begin_layout Standard
16007 \change_inserted 1075283030 1616620470
16008 This option is especially useful if you want \SpecialChar LyX
16009 to match your personal style
16010 or to work with buggy software that only accepts one prefix for MathML.
16016 \begin_layout Chapter
16017 The \SpecialChar LyX
16021 \begin_layout Section
16025 \begin_layout Standard
16026 The `\SpecialChar LyX
16027 server' allows other programs to talk to \SpecialChar LyX
16028 , invoke \SpecialChar LyX
16029 commands, and retrieve
16030 information about the \SpecialChar LyX
16032 This is only intended for advanced users, but they should find it useful.
16033 It is by writing to the \SpecialChar LyX
16034 server, for example, that bibliography managers,
16035 such as JabRef, are able to
16036 \begin_inset Quotes eld
16040 \begin_inset Quotes erd
16043 citations to \SpecialChar LyX
16047 \begin_layout Section
16048 Starting the \SpecialChar LyX
16050 \begin_inset CommandInset label
16052 name "sec:Starting-the-Server"
16059 \begin_layout Standard
16060 The \SpecialChar LyX
16061 server works through the use of a pair of named pipes.
16062 These are usually located in
16063 \begin_inset Flex Code
16066 \begin_layout Plain Layout
16072 , (except on Windows, where
16076 named pipes are special objects located in
16077 \begin_inset Flex Code
16080 \begin_layout Plain Layout
16092 ) and have the names
16093 \begin_inset Quotes eld
16097 \begin_inset Flex Code
16100 \begin_layout Plain Layout
16107 \begin_inset Quotes erd
16111 \begin_inset Quotes eld
16115 \begin_inset Flex Code
16118 \begin_layout Plain Layout
16125 \begin_inset Quotes erd
16129 External programs write into
16130 \begin_inset Flex Code
16133 \begin_layout Plain Layout
16139 and read back data from
16140 \begin_inset Flex Code
16143 \begin_layout Plain Layout
16150 The stem of the pipe names can be defined in the
16151 \begin_inset Flex Noun
16154 \begin_layout Plain Layout
16155 Tools\SpecialChar menuseparator
16161 dialog, for example
16162 \begin_inset Flex Code
16165 \begin_layout Plain Layout
16166 "/home/myhome/lyxpipe"
16172 \begin_inset Flex Code
16175 \begin_layout Plain Layout
16189 on Windows (where any working path instead of lyxpipe can be used, for
16191 \begin_inset Flex Code
16194 \begin_layout Plain Layout
16217 configure this manually in order for the server to start.
16220 \begin_layout Standard
16223 \begin_inset Flex Code
16226 \begin_layout Plain Layout
16233 \begin_inset Flex Code
16236 \begin_layout Plain Layout
16242 ' to create the pipes.
16243 If one of the pipes already exists, \SpecialChar LyX
16244 will assume that another \SpecialChar LyX
16246 is already running and will not start the server.
16247 On POSIX (Unix like) systems, if for some other reason, an unused
16248 \begin_inset Quotes eld
16252 \begin_inset Quotes erd
16255 pipe is left in existence when \SpecialChar LyX
16256 closes, then \SpecialChar LyX
16257 will try to delete it.
16258 If this fails for some reason, you will need to delete the pipes manually
16259 and then restart \SpecialChar LyX
16261 On Windows, pipes are deleted by the OS on program termination or crash,
16263 \begin_inset Quotes eld
16267 \begin_inset Quotes erd
16270 pipes should not be possible.
16273 \begin_layout Standard
16274 To have several \SpecialChar LyX
16275 processes with servers at the same time, you have to use
16276 different configurations, perhaps by using separate user directories, each
16278 \begin_inset Flex Code
16281 \begin_layout Plain Layout
16287 file, for each process.
16290 \begin_layout Standard
16291 If you are developing a client program, you might find it useful to enable
16292 debugging information from the \SpecialChar LyX
16294 Do this by starting \SpecialChar LyX
16296 \begin_inset Flex Code
16299 \begin_layout Plain Layout
16308 \begin_layout Standard
16309 You can find a complete example client written in C++ in the source distribution
16311 \begin_inset Flex Code
16314 \begin_layout Plain Layout
16315 development/lyxserver/server_monitor.cpp
16323 \begin_layout Standard
16324 Another useful tool is the command-line based client found in
16325 \begin_inset Flex Code
16328 \begin_layout Plain Layout
16329 src/client/lyxclient
16337 \begin_layout Section
16338 Normal communication
16341 \begin_layout Standard
16342 To issue a \SpecialChar LyX
16343 call, the client writes a line of ASCII text into the input
16345 This line has the following format:
16348 \begin_layout Quote
16362 \begin_layout Description
16363 clientname is a name that the client can choose arbitrarily.
16364 Its only use is that \SpecialChar LyX
16365 will echo it if it sends an answer—so a client can
16366 dispatch results from different requesters.
16369 \begin_layout Description
16370 function is the function you want \SpecialChar LyX
16372 It is the same as the commands you'd use in the minibuffer.
16375 \begin_layout Description
16376 argument is an optional argument which is meaningful only to some functions
16378 \begin_inset Quotes eld
16382 \begin_inset Quotes erd
16385 LFUN will insert the argument as text at the cursor position).
16388 \begin_layout Standard
16389 The answer from \SpecialChar LyX
16390 will arrive in the output pipe and be of the form
16393 \begin_layout Quote
16407 \begin_layout Standard
16416 are just echoed from the command request, while
16420 is more or less useful information filled according to how the command
16421 execution worked out.
16422 Some commands, such as
16423 \begin_inset Quotes eld
16427 \begin_inset Quotes erd
16430 , will return information about the internal state of \SpecialChar LyX
16432 return an empty data-response.
16433 This means that the command execution went fine.
16436 \begin_layout Standard
16437 In case of errors, the response from \SpecialChar LyX
16438 will have this form
16441 \begin_layout Quote
16455 \begin_layout Standard
16460 should contain an explanation of why the command failed.
16463 \begin_layout Standard
16467 \begin_layout LyX-Code
16468 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
16469 \begin_inset Newline newline
16472 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
16473 \begin_inset Newline newline
16476 read a <~/.lyxpipe.out
16477 \begin_inset Newline newline
16483 \begin_layout Subsection
16484 AppleScript (Mac OS X)
16487 \begin_layout Standard
16488 Since \SpecialChar LyX
16489 2.1, \SpecialChar LyX
16490 supports basic interactions with AppleScript for normal communicatio
16491 n through the command run.
16492 This command takes a direct argument (the
16496 to perform) and an optional argument.
16497 It either returns the output of the function or triggers an error with
16498 the error message and code.
16501 \begin_layout Standard
16505 \begin_layout LyX-Code
16506 tell application "\SpecialChar LyX
16510 \begin_layout LyX-Code
16514 \begin_layout LyX-Code
16515 -- Stores the current file name into f
16518 \begin_layout LyX-Code
16519 set f to (run "server-get-filename" with argument "")
16522 \begin_layout LyX-Code
16523 on error the error_message number the error_number
16526 \begin_layout LyX-Code
16527 display dialog "Error: " & the error_number & ".
16531 \begin_layout LyX-Code
16532 & the error_message buttons {"OK"} default button 1
16535 \begin_layout LyX-Code
16539 \begin_layout LyX-Code
16543 \begin_layout Section
16547 \begin_layout Standard
16549 can notify clients of events going on asynchronously.
16550 Currently it will only do this if the user binds a key sequence with the
16552 \begin_inset Quotes eld
16556 \begin_inset Quotes erd
16560 The format of the string \SpecialChar LyX
16561 sends is as follows:
16564 \begin_layout Quote
16565 \begin_inset Flex Code
16568 \begin_layout Plain Layout
16579 \begin_layout Standard
16584 is the printed representation of the key sequence that was actually typed
16588 \begin_layout Standard
16589 This mechanism can be used to extend \SpecialChar LyX
16590 's command set and implement macros.
16591 Bind some key sequence to
16592 \begin_inset Quotes eld
16596 \begin_inset Quotes erd
16600 Then start a client that listens on the output pipe, dispatches the command
16601 according to the sequence, and starts a function that may use \SpecialChar LyX
16604 requests to issue a command or a series of commands to \SpecialChar LyX
16608 \begin_layout Section
16609 The simple \SpecialChar LyX
16613 \begin_layout Standard
16615 implements a simple protocol that can be used for session management.
16616 All messages are of the form
16619 \begin_layout Quote
16629 \begin_layout Standard
16635 \begin_inset Quotes eld
16639 \begin_inset Quotes erd
16643 \begin_inset Quotes eld
16647 \begin_inset Quotes erd
16652 \begin_inset Quotes eld
16656 \begin_inset Quotes erd
16659 is received from a client, \SpecialChar LyX
16660 will report back to inform the client that
16661 it's listening to it's messages, while
16662 \begin_inset Quotes eld
16666 \begin_inset Quotes erd
16669 sent from \SpecialChar LyX
16670 will inform clients that \SpecialChar LyX
16674 \begin_layout Section
16675 Reverse DVI/PDF search
16678 \begin_layout Standard
16679 Some DVI/PDF viewers
16683 \begin_layout Plain Layout
16684 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
16685 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
16694 facility (also called
16699 This means that you can tell \SpecialChar LyX
16700 to put the cursor to a specific line in the
16701 document by clicking at the respective position in the DVI/PDF output.
16702 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
16704 This is done via the \SpecialChar LyX
16705 server either by using the named pipe (
16709 ), or the UNIX domain socket (
16713 ) that \SpecialChar LyX
16714 creates in its temporary directory (this is the way the
16715 \begin_inset Flex Code
16718 \begin_layout Plain Layout
16724 program communicates with \SpecialChar LyX
16726 In some cases, you need a helper script that mediates between the viewer
16727 and \SpecialChar LyX
16728 , in others, the viewer can communicate with \SpecialChar LyX
16730 This depends on the selected viewer and on your operating system.
16731 The same applies to the way viewers need to be configured and the way the
16732 reverse search is actually performed.
16733 In what follows, we will thus describe how to setup reverse search for
16735 Before we turn to this, though, we will explain what needs to be done generally
16736 to enable reverse search in the DVI/PDF output.
16739 \begin_layout Subsection
16741 \begin_inset CommandInset label
16743 name "subsec:rev-search"
16750 \begin_layout Standard
16751 In most cases \SpecialChar LyX
16752 will do the work for you by pressing the following button
16756 arg "buffer-toggle-output-sync"
16760 Alternatively, you can also enable the feature by checking
16762 Synchronize with Output
16765 \begin_inset Flex Noun
16768 \begin_layout Plain Layout
16769 Document\SpecialChar menuseparator
16770 Settings\SpecialChar menuseparator
16777 In such a case \SpecialChar LyX
16778 will automatically insert the necessary Sync\SpecialChar TeX
16780 PDF) or load the srcltx package (for DVI) respectively.
16781 This option can be easily reached also on
16782 \begin_inset Flex Code
16785 \begin_layout Plain Layout
16794 \begin_layout Standard
16795 If you need a different setting, you can select or input a custom macro
16796 from the drop down box just below
16797 \begin_inset Flex Noun
16800 \begin_layout Plain Layout
16801 Document\SpecialChar menuseparator
16802 Settings\SpecialChar menuseparator
16803 Output\SpecialChar menuseparator
16804 Synchronize with Output
16812 \begin_layout Standard
16813 Note that the method
16814 \begin_inset Flex Code
16817 \begin_layout Plain Layout
16825 enables gzip compression.
16826 If your viewer does not support it, you should instead use
16827 \begin_inset Flex Code
16830 \begin_layout Plain Layout
16841 \begin_layout Standard
16842 Please also note that including the
16843 \begin_inset Flex Code
16846 \begin_layout Plain Layout
16853 \begin_inset Flex Code
16856 \begin_layout Plain Layout
16862 sometimes has an undesired impact on the typesetting.
16863 Thus, you should switch output synchronization off for the final typesetting
16865 \begin_inset Flex Code
16868 \begin_layout Plain Layout
16875 \begin_inset Flex Code
16878 \begin_layout Plain Layout
16888 \begin_layout Standard
16889 In case you need some more special settings that are not covered by the
16890 automatic settings, read the next section about how to set up output synchroniz
16892 If the automatic setup suits your needs, you can readily jump to section
16893 \begin_inset space ~
16897 \begin_inset CommandInset ref
16899 reference "subsec:configuring-viewers"
16903 , where the necessary configuration steps in your viewer – needed both with
16904 the automatic and the manual setup – are described.
16907 \begin_layout Subsection
16911 \begin_layout Standard
16913 provides several different methods for reverse search.
16914 Some are built-in in the
16915 \begin_inset Flex Code
16918 \begin_layout Plain Layout
16924 program, some are provided by external packages.
16925 Your choice depends on whether your \SpecialChar LaTeX
16926 distribution already provides a given
16927 method (the built-in methods are rather new) and whether your viewer can
16929 The available methods are described in the following.
16932 \begin_layout Subsubsection*
16933 Built-in DVI-search via src-specials (DVI only)
16936 \begin_layout Standard
16937 This method provides the DVI file with the necessary information for reverse
16939 It is available in \SpecialChar LaTeX
16940 since quite some time (any somewhat recent \SpecialChar LaTeX
16942 should include it), and it works reliably.
16943 To enable it, change the
16944 \begin_inset Flex Noun
16947 \begin_layout Plain Layout
16958 \begin_inset Flex Noun
16961 \begin_layout Plain Layout
16972 \begin_inset Flex Noun
16975 \begin_layout Plain Layout
16976 Preferences\SpecialChar menuseparator
16977 File Handling\SpecialChar menuseparator
16984 \begin_inset Flex Code
16987 \begin_layout Plain Layout
16988 latex -src-specials $$i
16994 If this doesn't work, check if your \SpecialChar TeX
16995 engine needs different options (the
16996 syntax might differ in some distributions).
16999 \begin_layout Subsubsection*
17000 External Packages (PDFSync and scrltx)
17003 \begin_layout Standard
17012 provide reverse search facility for PDF output (via pdflatex) and DVI output,
17014 In order to enable it, load the packages in the \SpecialChar LyX
17018 \begin_layout Itemize
17019 \begin_inset Flex Code
17022 \begin_layout Plain Layout
17025 usepackage{pdfsync}
17030 for reverse PDF search,
17033 \begin_layout Itemize
17034 \begin_inset Flex Code
17037 \begin_layout Plain Layout
17040 usepackage[active]{srcltx}
17045 for reverse DVI search.
17048 \begin_layout Standard
17049 If you want to be able to perform both DVI and PDF reverse searches, you
17050 can also insert in the preamble the following lines
17053 \begin_layout LyX-Code
17057 \begin_inset Newline newline
17063 \begin_inset Newline newline
17068 usepackage{pdfsync}
17069 \begin_inset Newline newline
17075 \begin_inset Newline newline
17080 usepackage[active]{srcltx}
17081 \begin_inset Newline newline
17089 \begin_layout Standard
17090 This way, you can preview the file as either DVI or PDF (pdflatex) and the
17091 right package will be used.
17094 \begin_layout Standard
17095 Note that PDFSync might affect the output layout of your document.
17096 It is therefore advised to disable PDFsync for final documents.
17099 \begin_layout Subsubsection*
17100 Built-in reverse search via Sync\SpecialChar TeX
17104 \begin_layout Standard
17106 \begin_inset Flex Code
17109 \begin_layout Plain Layout
17115 have built-in support for both PDF and DVI reverse search.
17118 Sync\SpecialChar TeX
17121 facility is basically the result of the integration of the PDFSync package
17122 to the pdftex program and its merge with the
17127 You need at least \SpecialChar TeX
17128 Live 2008 or a recent Mik\SpecialChar TeX
17129 distribution in order to use
17134 \begin_layout Plain Layout
17135 For some reason, Mik\SpecialChar TeX
17136 does not understand/obey the command \SpecialChar LyX
17138 the preamble when you check the "Enable Forward/Reverse Search" button
17139 in the toolbar and does not generate the necessary info.
17142 \begin_layout Plain Layout
17143 The generation of the required info can be forced by changing the converter
17144 "\SpecialChar LaTeX
17145 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
17146 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
17147 the -synctex=1 switch).
17152 Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
17153 Skim on the Mac, SumatraPDF on Windows; see the next section for details)
17154 already provide Sync\SpecialChar TeX
17158 \begin_layout Standard
17159 To enable Sync\SpecialChar TeX
17160 for DVI output, change the
17161 \begin_inset Flex Noun
17164 \begin_layout Plain Layout
17175 \begin_inset Flex Noun
17178 \begin_layout Plain Layout
17183 (plain) -> DraftDVI
17189 \begin_inset Flex Noun
17192 \begin_layout Plain Layout
17193 Preferences\SpecialChar menuseparator
17194 File Handling\SpecialChar menuseparator
17201 \begin_inset Flex Code
17204 \begin_layout Plain Layout
17205 latex -synctex=1 $$i
17210 , and for PDF output, change the
17211 \begin_inset Flex Noun
17214 \begin_layout Plain Layout
17219 (pdflatex) -> PDF (pdflatex)
17225 \begin_inset Flex Code
17228 \begin_layout Plain Layout
17229 pdflatex -synctex=1 $$i
17235 Should your viewer not be considered in the following description, or in
17236 case of missing success, please check the documentation of your viewer
17237 whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
17242 \begin_layout Plain Layout
17243 Note that the option
17244 \begin_inset Flex Code
17247 \begin_layout Plain Layout
17253 option enables gzip compression.
17254 If your viewer does not support it, you should instead use
17255 \begin_inset Flex Code
17258 \begin_layout Plain Layout
17272 \begin_layout Subsection
17273 Configuring and using specific viewers
17274 \begin_inset CommandInset label
17276 name "subsec:configuring-viewers"
17283 \begin_layout Subsubsection*
17284 Xdvi (all platforms)
17287 \begin_layout Standard
17289 \begin_inset Flex Code
17292 \begin_layout Plain Layout
17298 , you don't need to do anything else for performing a reverse DVI search,
17299 as \SpecialChar LyX
17300 already provides the necessary hooks for automatically using the
17301 \begin_inset Flex Code
17304 \begin_layout Plain Layout
17311 Just setup your document as described above (reverse search is triggered
17312 by Ctrl-click or Alt-click on Mac OSX, respectively).
17315 \begin_layout Standard
17316 However, if for whatever reason you want to use the named pipe instead of
17317 the socket for communicating with \SpecialChar LyX
17318 , simply change the DVI viewer in
17319 \begin_inset Flex Noun
17322 \begin_layout Plain Layout
17323 Preferences\SpecialChar menuseparator
17324 File Handling\SpecialChar menuseparator
17334 \begin_layout Plain Layout
17335 On Mac OSX you have to use
17336 \begin_inset Flex Code
17339 \begin_layout Plain Layout
17340 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
17351 \begin_inset Flex Code
17354 \begin_layout Plain Layout
17355 xdvi -editor "lyxeditor.sh %f %l"
17361 \begin_inset Flex Code
17364 \begin_layout Plain Layout
17370 is a suitable script.
17371 For example, a minimal shell script is the following one:
17374 \begin_layout LyX-Code
17376 \begin_inset Newline newline
17379 LYXPIPE="/path/to/lyxpipe"
17380 \begin_inset Newline newline
17383 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
17384 \begin_inset Newline newline
17387 echo "$COMMAND" > "${LYXPIPE}".in || exit
17388 \begin_inset Newline newline
17391 read TMP < "${LYXPIPE}".out || exit
17394 \begin_layout Standard
17396 \begin_inset Flex Code
17399 \begin_layout Plain Layout
17405 is the LyXServer pipe path specified in
17406 \begin_inset Flex Noun
17409 \begin_layout Plain Layout
17410 Preferences\SpecialChar menuseparator
17420 \begin_layout Plain Layout
17422 \begin_inset Flex Code
17425 \begin_layout Plain Layout
17431 folder of a source distribution you can find a
17432 \begin_inset Flex Code
17435 \begin_layout Plain Layout
17441 script which is able to locate the
17445 based on your preferences.
17453 \begin_layout Subsubsection*
17457 \begin_layout Standard
17459 \begin_inset Flex Code
17462 \begin_layout Plain Layout
17463 /Applications/MacDviX_Folder/calleditor.script
17468 , add the following lines:
17471 \begin_layout LyX-Code
17472 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
17473 \begin_inset Newline newline
17479 \begin_layout Standard
17480 Modify the lines accordingly if you install \SpecialChar LyX
17481 somewhere else than in the
17482 Applications folder.
17485 \begin_layout Standard
17486 Reverse search is triggered by Alt-click (OPTION-click).
17489 \begin_layout Subsubsection*
17493 \begin_layout Standard
17495 \begin_inset Flex Code
17498 \begin_layout Plain Layout
17499 open -a Skim.app $$i
17504 to the viewer setting in
17505 \begin_inset Flex Noun
17508 \begin_layout Plain Layout
17509 Preferences\SpecialChar menuseparator
17510 File Handling\SpecialChar menuseparator
17511 File formats\SpecialChar menuseparator
17518 \begin_inset Flex Noun
17521 \begin_layout Plain Layout
17522 Skim\SpecialChar menuseparator
17523 Preferences\SpecialChar menuseparator
17530 \begin_inset Flex Noun
17533 \begin_layout Plain Layout
17539 preset and enter command
17540 \begin_inset Flex Noun
17543 \begin_layout Plain Layout
17544 /Applications/\SpecialChar LyX
17545 .app/Contents/MacOS/lyxeditor
17553 \begin_layout Standard
17554 Reverse search is triggered by COMMAND-SHIFT-click
17557 \begin_layout Subsubsection*
17561 \begin_layout Standard
17562 Reverse search with evince does not work out of the box, but it can be achieved
17563 by means of some third party helper scripts.
17565 \begin_inset CommandInset href
17567 target "https://wiki.lyx.org/LyX/SyncTeX"
17575 \begin_layout Subsubsection*
17579 \begin_layout Standard
17581 \begin_inset Flex Noun
17584 \begin_layout Plain Layout
17585 Settings\SpecialChar menuseparator
17586 Configure Okular\SpecialChar menuseparator
17593 \begin_inset Quotes erd
17597 This inserts the appropriate command (
17598 \begin_inset Flex Code
17601 \begin_layout Plain Layout
17610 \begin_layout Standard
17611 Reverse search is triggered by SHIFT-click.
17613 \change_inserted -712698321 1578211026
17614 Note that this only works if Okular is in
17615 \begin_inset Quotes eld
17619 \begin_inset Quotes erd
17623 \begin_inset space \thinspace{}
17626 e., the hand symbol is clicked).
17631 \begin_layout Subsubsection*
17635 \begin_layout Standard
17636 Qpdfview supports Sync\SpecialChar TeX
17637 since version 0.3.5.
17639 \begin_inset Flex Noun
17642 \begin_layout Plain Layout
17643 Edit\SpecialChar menuseparator
17644 Settings\SpecialChar menuseparator
17650 , click on the input field of the
17651 \begin_inset Quotes eld
17655 \begin_inset Quotes erd
17658 item and add the command
17659 \begin_inset Flex Code
17662 \begin_layout Plain Layout
17671 \begin_layout Standard
17672 Reverse search is triggered by double-click or, in more recent versions,
17676 \begin_layout Subsubsection*
17680 \begin_layout Standard
17681 Launch yap, choose its
17682 \begin_inset Flex Noun
17685 \begin_layout Plain Layout
17686 View\SpecialChar menuseparator
17692 menu and select the
17693 \begin_inset Quotes eld
17697 \begin_inset Quotes erd
17702 \begin_inset Quotes eld
17705 New\SpecialChar ldots
17707 \begin_inset Quotes erd
17710 button and, in the window that opens, enter
17711 \begin_inset Quotes eld
17716 \begin_inset Quotes erd
17719 (or any other name you like) in the
17720 \begin_inset Quotes eld
17724 \begin_inset Quotes erd
17728 Now click on the button labeled
17729 \begin_inset Quotes eld
17734 \begin_inset Quotes erd
17737 to open a file dialog and navigate to the directory containing the batch
17739 \begin_inset Flex Code
17742 \begin_layout Plain Layout
17750 \begin_inset Flex Code
17753 \begin_layout Plain Layout
17759 and then specify the program arguments as
17760 \begin_inset Flex Code
17763 \begin_layout Plain Layout
17771 \begin_inset Flex Code
17774 \begin_layout Plain Layout
17780 wrapper is used for communicating with \SpecialChar LyX
17788 \begin_layout LyX-Code
17790 \begin_inset Newline newline
17793 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
17802 \begin_inset Newline newline
17816 \begin_layout Standard
17817 Make sure that the \SpecialChar LyX
17818 Server pipe path you specified in \SpecialChar LyX
17820 \begin_inset Flex Code
17823 \begin_layout Plain Layout
17837 , otherwise change the
17838 \begin_inset Flex Code
17841 \begin_layout Plain Layout
17847 wrapper accordingly.
17850 \begin_layout Standard
17851 In yap, reverse search is triggered by double-click.
17854 \begin_layout Subsubsection*
17855 SumatraPDF (Windows)
17858 \begin_layout Standard
17859 In order to use SumatraPDF for inverse search, enter
17860 \begin_inset Flex Code
17863 \begin_layout Plain Layout
17864 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
17869 in the viewer setting in
17870 \begin_inset Flex Noun
17873 \begin_layout Plain Layout
17874 Preferences\SpecialChar menuseparator
17875 File Handling\SpecialChar menuseparator
17876 File formats\SpecialChar menuseparator
17883 \begin_inset Flex Code
17886 \begin_layout Plain Layout
17892 is the previous wrapper.
17893 If SumatraPDF.exe is not in your command PATH, use its full file name.
17896 \begin_layout Standard
17897 Reverse search is triggered by double-click.
17900 \begin_layout Subsubsection*
17904 \begin_layout Standard
17905 First of all, make sure that yap is your default DVI viewer in the Windows
17906 environment, then launch it, choose its
17907 \begin_inset Flex Noun
17910 \begin_layout Plain Layout
17911 View\SpecialChar menuseparator
17917 menu and select the
17918 \begin_inset Quotes eld
17922 \begin_inset Quotes erd
17927 \begin_inset Quotes eld
17930 New\SpecialChar ldots
17932 \begin_inset Quotes erd
17935 button and, in the window that opens, enter
17936 \begin_inset Quotes eld
17941 \begin_inset Quotes erd
17944 (or any other name you like) in the
17945 \begin_inset Quotes eld
17949 \begin_inset Quotes erd
17953 Now click on the button labeled
17954 \begin_inset Quotes eld
17959 \begin_inset Quotes erd
17962 to open a file dialog and navigate to the directory containing the
17963 \begin_inset Flex Code
17966 \begin_layout Plain Layout
17972 program (which is installed by default on Cygwin along with the \SpecialChar LyX
17975 \begin_inset Flex Code
17978 \begin_layout Plain Layout
17984 and then specify the program arguments as
17985 \begin_inset Flex Code
17988 \begin_layout Plain Layout
17995 In this way, you will be using the
17999 for communicating with \SpecialChar LyX
18001 If, for whatever reason, you want to use the
18006 \begin_inset Flex Code
18009 \begin_layout Plain Layout
18015 option and be sure to specify the \SpecialChar LyX
18016 Server pipe path in the \SpecialChar LyX
18020 \begin_layout Standard
18021 In yap, reverse search is triggered by double-click.
18024 \begin_layout Subsubsection*
18025 SumatraPDF (Cygwin)
18028 \begin_layout Standard
18029 In order to use SumatraPDF for inverse search, enter
18030 \begin_inset Flex Code
18033 \begin_layout Plain Layout
18034 SumatraPDF -inverse-search "lyxeditor -g %f %l"
18039 in the viewer setting in
18040 \begin_inset Flex Noun
18043 \begin_layout Plain Layout
18044 Preferences\SpecialChar menuseparator
18045 File Handling\SpecialChar menuseparator
18046 File formats\SpecialChar menuseparator
18053 If SumatraPDF.exe is not in your command PATH, use its full posix path.
18055 \begin_inset Flex Code
18058 \begin_layout Plain Layout
18064 enables communication via the
18070 \begin_inset Flex Code
18073 \begin_layout Plain Layout
18079 option if you want to use the
18083 , and be sure to specify the \SpecialChar LyX
18084 Server pipe path in the \SpecialChar LyX
18088 \begin_layout Standard
18089 Reverse search is triggered by double-click.
18092 \begin_layout Section
18096 \begin_layout Standard
18097 Forward search is, as the name implies, in a sense the
18098 \begin_inset Quotes eld
18102 \begin_inset Quotes erd
18106 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
18108 If forward search is set up (as described in what follows), you can put
18109 the cursor anywhere in your \SpecialChar LyX
18111 \begin_inset Flex Noun
18114 \begin_layout Plain Layout
18115 Navigate\SpecialChar menuseparator
18122 \begin_inset Flex Noun
18125 \begin_layout Plain Layout
18131 in the context menu via right mouse click), and then the viewer will jump
18132 to that position as well.
18133 This implies, of course, that your viewer supports this function.
18136 \begin_layout Standard
18137 To make forward search possible, you first need to provide the generated
18138 output PDF/DVI file with additional information about the \SpecialChar TeX
18140 This can be done via the methods described in the section
18141 \begin_inset CommandInset ref
18143 reference "subsec:rev-search"
18150 \begin_layout Standard
18151 Additionally, you need to configure \SpecialChar LyX
18152 for using your viewers in
18153 \begin_inset Flex Noun
18156 \begin_layout Plain Layout
18157 Tools\SpecialChar menuseparator
18158 Preferences\SpecialChar menuseparator
18159 Output\SpecialChar menuseparator
18166 We provide a range of tested configurations for some viewers, which you
18167 can select from the drop down list.
18168 If none of these configurations suits you, you have to find out and enter
18169 a suitable configuration yourself.
18170 The definition syntax uses the following placeholders:
18173 \begin_layout Itemize
18175 \begin_inset Flex Code
18178 \begin_layout Plain Layout
18187 \begin_layout Itemize
18189 \begin_inset Flex Code
18192 \begin_layout Plain Layout
18198 : name of the (temporary) exported .tex file (without path)
18201 \begin_layout Itemize
18203 \begin_inset Flex Code
18206 \begin_layout Plain Layout
18212 : name of the (temporary) exported .tex file (including path)
18215 \begin_layout Itemize
18217 \begin_inset Flex Code
18220 \begin_layout Plain Layout
18226 : name of the exported output file (either dvi or pdf, depending on which
18227 one exists in the temporary directory)
18230 \begin_layout Standard
18231 Note that only some of the viewers provide full and usable forward search
18232 functionality out of the box, among them yap, xdvi, okular
18236 \begin_layout Plain Layout
18237 You might want to set
18238 \begin_inset Flex Code
18241 \begin_layout Plain Layout
18248 \begin_inset Flex Noun
18251 \begin_layout Plain Layout
18252 Tools\SpecialChar menuseparator
18253 Preferences\SpecialChar menuseparator
18254 File Handling\SpecialChar menuseparator
18256 \begin_inset space ~
18269 , qpdfview, and SumatraPDF
18273 \begin_layout Plain Layout
18274 SumatraPDF can also use DDE commands through the external program CMCDDE
18275 — downloadable from
18276 \begin_inset CommandInset href
18278 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
18289 Others, such as evince
18293 \begin_layout Plain Layout
18294 Forward search with evince can be achieved by means of third party helper
18297 \begin_inset CommandInset href
18299 target "https://wiki.lyx.org/LyX/SyncTeX"
18309 , require some extra tools in order to use forward search.
18310 While many of the widespread PDF viewers (most notably Adobe Reader) do
18311 not support forward search at all, some other viewers – e.
18312 \begin_inset space \thinspace{}
18316 xpdf – allow at least to reload the document and jump to a specific page
18317 of the file, so you can at least navigate
18318 \begin_inset Quotes eld
18322 \begin_inset Quotes erd
18326 This latter functionality is provided by an external call of synctex (see
18327 the predefined example configurations).
18331 \begin_layout Standard
18332 Forward search works both with DVI and PDF output.
18334 simply checks which preview format you have used before (i.
18335 \begin_inset space \thinspace{}
18338 e., which format is already there in the temporary directory) and chooses
18339 the appropriate configuration for the respective format.
18342 \begin_layout Chapter
18343 Special Document Classes
18346 \begin_layout Section
18348 \change_deleted 564990737 1669742044
18352 \begin_layout Standard
18354 \change_deleted 564990737 1669742044
18360 \begin_layout Subsection
18362 \change_deleted 564990737 1669742044
18366 \begin_layout Standard
18368 \change_deleted 564990737 1669742044
18369 This section describes how \SpecialChar LyX
18370 can be used to write articles for submission
18371 to the scientific journal
18373 Astronomy and Astrophysics
18376 \begin_inset Flex URL
18379 \begin_layout Plain Layout
18381 https://www.aanda.org/
18386 ) using Version 5.01 of the document class
18391 This package can be downloaded from the ftp site
18394 \begin_layout Standard
18396 \change_deleted 564990737 1669742044
18397 \begin_inset VSpace medskip
18403 \begin_layout Standard
18406 \change_deleted 564990737 1669742044
18407 \begin_inset Flex URL
18410 \begin_layout Plain Layout
18412 ftp://ftp.edpsciences.org/pub/aa/readme.html
18420 \begin_layout Standard
18422 \change_deleted 564990737 1669742044
18423 \begin_inset VSpace medskip
18429 \begin_layout Standard
18431 \change_deleted 564990737 1669742044
18432 A manual comes together with that package, and this text is not meant to
18433 replace the original manual but is merely a short guide in how to realize
18434 the correct form of your paper.
18438 \begin_layout Standard
18440 \change_deleted 564990737 1669742044
18441 Please note that the publisher of the journal was changed from Springer
18442 to EDP Sciences starting January 1, 2001.
18443 That change involved also some slight changes to the style files, namely
18444 the removal of the thesaurus command.
18445 The \SpecialChar LyX
18446 class aa supports the newest version of these style files, V 5.01.
18447 If you have an older version installed, please upgrade.
18448 For compatibility, the old (version 4) layout has been kept as
18453 Please refer to the comments in
18456 Dir/layouts/aapaper.layout
18461 \begin_layout Subsection
18463 \change_deleted 564990737 1669742044
18467 \begin_layout Standard
18469 \change_deleted 564990737 1669742044
18470 It is recommended you start from the example template distributed with \SpecialChar LyX
18472 If you are not using a template, note the following settings:
18475 \begin_layout Itemize
18477 \change_deleted 564990737 1669742044
18484 Document\SpecialChar menuseparator
18487 dialog (OK, that one was obvious).
18490 \begin_layout Itemize
18492 \change_deleted 564990737 1669742044
18493 Don't change the option
18496 \begin_inset space ~
18506 The whole layout is done by the macros, you shouldn't change anything.
18509 \begin_layout Subsection
18511 \change_deleted 564990737 1669742044
18515 \begin_layout Standard
18517 \change_deleted 564990737 1669742044
18518 First thing to enter is the header information.
18519 It consists of seven entries, of which some are optional.
18523 \begin_layout Itemize
18525 \change_deleted 564990737 1669742044
18533 \begin_layout Itemize
18535 \change_deleted 564990737 1669742044
18543 \begin_layout Itemize
18545 \change_deleted 564990737 1669742044
18553 \begin_layout Itemize
18555 \change_deleted 564990737 1669742044
18563 \begin_layout Itemize
18565 \change_deleted 564990737 1669742044
18570 : [optional] if more than one author: whom to contact for offprint requests.
18573 \begin_layout Itemize
18575 \change_deleted 564990737 1669742044
18580 : [optional] mail address for contacts.
18583 \begin_layout Itemize
18585 \change_deleted 564990737 1669742044
18591 Suggested format is
18593 Received: <date>; Accepted <date>
18596 \begin_layout Standard
18598 \change_deleted 564990737 1669742044
18599 There is no need to issue the
18605 command, this is done automatically by \SpecialChar LyX
18606 when the header is finished.
18607 Although the order of the single header entries doesn't matter it is advised
18608 to keep the above sequence, just to get the best optics and meets the layout
18609 of the real document.
18612 \begin_layout Standard
18614 \change_deleted 564990737 1669742044
18615 If you want to place footnotes in the header block, e.
18616 \begin_inset space \thinspace{}
18620 \begin_inset space \space{}
18623 to state your present address, just use the standard footnote via the menu
18626 Insert\SpecialChar menuseparator
18631 will automagically use the term
18640 \begin_layout Standard
18642 \change_deleted 564990737 1669742044
18645 Edit\SpecialChar menuseparator
18648 , you'll find two insets which are relevant for the titling:
18651 \begin_layout Itemize
18653 \change_deleted 564990737 1669742044
18660 to mark corresponding author\SpecialChar breakableslash
18662 The institutes are numbered sequentially as they appear in the
18666 field, so you have to put a marker to each author.
18669 \begin_layout Itemize
18671 \change_deleted 564990737 1669742044
18676 to supply an email address for fast contact.
18679 \begin_layout Standard
18681 \change_deleted 564990737 1669742044
18682 In addition to these topics, the macros use one additional \SpecialChar LaTeX
18684 has no counterpart in \SpecialChar LyX
18688 \begin_layout Itemize
18690 \change_deleted 564990737 1669742044
18697 to separate different names for more than one author and institute, respectivel
18701 \begin_layout Standard
18703 \change_deleted 564990737 1669742044
18704 The appropriate command has to be entered in \SpecialChar LyX
18705 and marked as \SpecialChar LaTeX
18711 \begin_layout Subsection
18713 \change_deleted 564990737 1669742044
18717 \begin_layout Standard
18719 \change_deleted 564990737 1669742044
18720 The abstract should immediately follow the header block.
18721 With version 5 the abstract environment was changed to a command, and there
18722 is now a restriction to only one paragraph.
18723 In addition, it should contain an entry with the keywords.
18724 This is done via the paragraph style
18729 Refer to the example paper.
18732 \begin_layout Subsection
18734 \change_deleted 564990737 1669742044
18735 Supported environments
18738 \begin_layout Standard
18740 \change_deleted 564990737 1669742044
18741 The A&A paper layout supports the following environments for structuring
18745 \begin_layout Itemize
18747 \change_deleted 564990737 1669742044
18753 \begin_layout Itemize
18755 \change_deleted 564990737 1669742044
18761 \begin_layout Itemize
18763 \change_deleted 564990737 1669742044
18769 \begin_layout Itemize
18771 \change_deleted 564990737 1669742044
18777 \begin_layout Itemize
18779 \change_deleted 564990737 1669742044
18785 \begin_layout Itemize
18787 \change_deleted 564990737 1669742044
18793 \begin_layout Itemize
18795 \change_deleted 564990737 1669742044
18801 \begin_layout Itemize
18803 \change_deleted 564990737 1669742044
18809 \begin_layout Itemize
18811 \change_deleted 564990737 1669742044
18817 \begin_layout Itemize
18819 \change_deleted 564990737 1669742044
18825 \begin_layout Itemize
18827 \change_deleted 564990737 1669742044
18833 \begin_layout Itemize
18835 \change_deleted 564990737 1669742044
18842 \begin_layout Subsection
18844 \change_deleted 564990737 1669742044
18845 Commands not supported by \SpecialChar LyX
18849 \begin_layout Standard
18851 \change_deleted 564990737 1669742044
18852 Some commands are not yet supported by the
18856 layout for \SpecialChar LyX
18858 Some have already been mentioned.
18859 For the sake of completeness, they are listed all together here:
18862 \begin_layout Itemize
18864 \change_deleted 564990737 1669742044
18872 \begin_layout Itemize
18874 \change_deleted 564990737 1669742044
18882 \begin_layout Itemize
18884 \change_deleted 564990737 1669742044
18892 \begin_layout Itemize
18894 \change_deleted 564990737 1669742044
18902 \begin_layout Standard
18904 \change_deleted 564990737 1669742044
18905 If you want to use any of these commands, you have to enter them yourself.
18908 Do not forget to mark them as \SpecialChar LaTeX
18912 \begin_layout Subsection
18914 \change_deleted 564990737 1669742044
18915 Figure and Table Floats
18918 \begin_layout Standard
18920 \change_deleted 564990737 1669742044
18922 provides support for the necessary float environments
18924 figure, figure*, table
18930 , therefore we won't tell much about it here.
18934 \begin_inset space ~
18940 Just remember that tables should be left-aligned.
18941 For that, select the table and change the alignment in
18943 Edit\SpecialChar menuseparator
18945 \begin_inset space ~
18951 \begin_layout Standard
18953 \change_deleted 564990737 1669742044
18954 There is only one special thing: the figures with caption besides the figure.
18955 To create such a figure, you have to do the following:
18958 \begin_layout Enumerate
18960 \change_deleted 564990737 1669742044
18961 Create a wide figure float:
18963 Insert\SpecialChar menuseparator
18964 Float\SpecialChar menuseparator
18967 , then right click in the figure and select
18970 \begin_inset space ~
18978 \begin_layout Enumerate
18980 \change_deleted 564990737 1669742044
18981 Enter your caption text.
18984 \begin_layout Enumerate
18986 \change_deleted 564990737 1669742044
18991 to move the cursor above the caption.
18994 \begin_layout Enumerate
18996 \change_deleted 564990737 1669742044
19000 \begin_layout Enumerate
19002 \change_deleted 564990737 1669742044
19003 Position the cursor behind the figure and insert a horizontal fill:
19005 Insert\SpecialChar menuseparator
19007 \begin_inset space ~
19010 Character\SpecialChar menuseparator
19012 \begin_inset space ~
19020 \begin_layout Enumerate
19022 \change_deleted 564990737 1669742044
19023 Switch to \SpecialChar LaTeX
19027 \begin_inset space ~
19035 \begin_layout Enumerate
19037 \change_deleted 564990737 1669742044
19047 Do not close the brace!
19050 \begin_layout Enumerate
19052 \change_deleted 564990737 1669742044
19053 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
19058 \begin_inset space ~
19070 \begin_layout Standard
19072 \change_deleted 564990737 1669742044
19073 Also, refer to the figures in the example paper.
19076 \begin_layout Subsection
19078 \change_deleted 564990737 1669742044
19082 \begin_layout Standard
19084 \change_deleted 564990737 1669742044
19085 For submission, the paper has to be formated in a special double-spacing
19087 For this purpose, you have to give the option
19091 to the document class.
19092 This must be done using the custom class options field in the
19094 Document\SpecialChar menuseparator
19098 Just enter the string
19105 \begin_layout Subsection
19107 \change_deleted 564990737 1669742044
19111 \begin_layout Standard
19113 \change_deleted 564990737 1669742044
19118 directory contains an example paper written with \SpecialChar LyX
19120 It is the example paper from the original macro package, translated to
19123 Use it for inspiration, and compare the original \SpecialChar LaTeX
19124 code with \SpecialChar LyX
19128 \begin_layout Section
19132 \begin_layout Standard
19137 can be used to type letters according to German conventions.
19138 A template file is included in
19140 .../lyx/share/templates
19142 for you to use as a starting point.
19145 \begin_layout Section
19149 \begin_layout Standard
19150 See the \SpecialChar LyX
19156 It contains all infos you need.
19159 \begin_layout Section
19161 \change_deleted 564990737 1669755802
19165 \begin_layout Standard
19167 \change_deleted 564990737 1669755802
19170 Panayotis Papasotiriou
19173 \begin_layout Subsection
19175 \change_deleted 564990737 1669755802
19179 \begin_layout Standard
19181 \change_deleted 564990737 1669755802
19182 The ijmpc package is a set of macros that facilitates electronic manuscript
19185 International Journal of Modern Physics C
19188 Similarly, the ijmpd package is for creating manuscripts to be submitted
19191 International Journal of Modern Physics D
19194 Both journals are published by World Scientific.
19195 The corresponding document classes are named
19204 These files, together with instructions for the authors, can be downloaded
19206 \begin_inset Flex URL
19209 \begin_layout Plain Layout
19211 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
19217 \begin_inset Flex URL
19220 \begin_layout Plain Layout
19222 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
19228 Both packages are modified versions of the standard
19229 \begin_inset Quotes eld
19233 \begin_inset Quotes erd
19236 package, and they are almost (but not exactly) identical.
19237 Most of their features are supported by \SpecialChar LyX
19239 I have used \SpecialChar LyX
19240 successfully to write articles submitted to both journals
19241 without any problem.
19244 \begin_layout Subsection
19246 \change_deleted 564990737 1669755802
19250 \begin_layout Standard
19252 \change_deleted 564990737 1669755802
19253 As usual, the easiest way to write a paper is to start with a template.
19256 File\SpecialChar menuseparator
19272 This will give an (almost) empty document that includes the most common
19273 fields found in a manuscript.
19274 Simply overwrite the existing text (including the brackets,
19279 You should keep in mind the following remarks.
19282 \begin_layout Enumerate
19284 \change_deleted 564990737 1669755802
19286 won't let you change the font size and the page style of the document,
19287 because such modifications are not allowed by both packages.
19290 \begin_layout Enumerate
19292 \change_deleted 564990737 1669755802
19293 The language of the document should not be changed.
19294 Before previewing your paper, be sure that the babel package is not used.
19295 To do this, click on
19298 arg "dialog-show document"
19303 \SpecialChar menuseparator
19307 \begin_inset Quotes eld
19311 \begin_inset Quotes erd
19321 \begin_layout Enumerate
19323 \change_deleted 564990737 1669755802
19325 \begin_inset Quotes eld
19329 \begin_inset Quotes erd
19332 style must be used to define keywords.
19335 \begin_layout Enumerate
19337 \change_deleted 564990737 1669755802
19338 The ijmpc package provides a style named
19339 \begin_inset Quotes eld
19342 Classification Codes
19343 \begin_inset Quotes erd
19346 , which can be used to define classification codes, such as PACS numbers.
19347 Note that this facility is not supported by the ijmpd package.
19350 \begin_layout Enumerate
19352 \change_deleted 564990737 1669755802
19353 Several new environments are available:
19354 \begin_inset Quotes eld
19358 \begin_inset Quotes erd
19362 \begin_inset Quotes eld
19366 \begin_inset Quotes erd
19370 \begin_inset Quotes eld
19374 \begin_inset Quotes erd
19378 \begin_inset Quotes eld
19382 \begin_inset Quotes erd
19386 \begin_inset Quotes eld
19390 \begin_inset Quotes erd
19394 \begin_inset Quotes eld
19398 \begin_inset Quotes erd
19402 \begin_inset Quotes eld
19406 \begin_inset Quotes erd
19410 \begin_inset Quotes eld
19414 \begin_inset Quotes erd
19418 \begin_inset Quotes eld
19422 \begin_inset Quotes erd
19426 \begin_inset Quotes eld
19430 \begin_inset Quotes erd
19434 \begin_inset Quotes eld
19438 \begin_inset Quotes erd
19442 \begin_inset Quotes eld
19446 \begin_inset Quotes erd
19450 \begin_inset Quotes eld
19454 \begin_inset Quotes erd
19458 \begin_inset Quotes eld
19462 \begin_inset Quotes erd
19466 Their use is more or less obvious.
19468 supports all these environments; it will use the proper label, text style,
19469 and numbering scheme for each of them.
19472 \begin_layout Enumerate
19474 \change_deleted 564990737 1669755802
19475 Both packages use basic citations; the natbib package should not be used.
19476 In \SpecialChar LyX
19477 , citation references are shown as usual; in the output, citations are
19478 shown as superscripts.
19479 If you want to use a citation as normal text, you should use the
19484 \begin_inset space \thinspace{}
19488 \begin_inset space \space{}
19492 \begin_inset Quotes eld
19496 \begin_inset space \space{}
19506 \begin_inset Quotes erd
19512 \begin_layout Enumerate
19514 \change_deleted 564990737 1669755802
19516 \begin_inset Quotes eld
19520 \begin_inset Quotes erd
19523 section in both packages.
19524 To put acknowledgments, just use the
19525 \begin_inset Quotes eld
19529 \begin_inset Quotes erd
19535 \begin_layout Enumerate
19537 \change_deleted 564990737 1669755802
19538 Appendices may be added to the paper,
19542 the Acknowledgments and
19548 provides a special environment, called
19549 \begin_inset Quotes eld
19553 \begin_inset Quotes erd
19556 which marks the beginning of the appendices.
19557 This environment should be left blank; it just sends a \SpecialChar LaTeX
19558 command, but nothing
19560 In \SpecialChar LyX
19562 \begin_inset Quotes eld
19566 \begin_inset Quotes erd
19569 is printed with blue letters, as a signal that all sections after that
19570 point are appendices.
19571 To write an appendix, use the
19572 \begin_inset Quotes eld
19576 \begin_inset Quotes erd
19581 will number each appendix with capital letters, as required by both journals.
19583 \begin_inset Quotes eld
19587 \begin_inset Quotes erd
19594 be present before the first appendix; if not, all appendices will be numbered
19595 as normal sections in the output.
19598 \begin_layout Enumerate
19600 \change_deleted 564990737 1669755802
19601 The ijmpc and the ijmpd packages use the
19605 command to implement table captions.
19606 As a result, a table created by \SpecialChar LyX
19607 is printed correctly, but its caption
19609 However, you can use some \SpecialChar TeX
19610 code to overcome this problem, so that captions
19611 are printed as expected.
19612 To do so, create a float table as usual, remove the caption, and replace
19613 it with the \SpecialChar TeX
19624 (sic); you must also the \SpecialChar TeX
19629 immediately after the tabular material.
19630 Study the example table included in the template files to see how this
19631 trick is implemented.
19632 Alternatively, If you need table captions, you should implement the whole
19637 file, then include this file to the \SpecialChar LyX
19640 Insert\SpecialChar menuseparator
19641 File\SpecialChar menuseparator
19643 \begin_inset space ~
19649 Details on how to create a table float can be found in the files
19657 , included in the corresponding packages.
19660 \begin_layout Subsection
19662 \change_deleted 564990737 1669755802
19663 Preparing a paper for submission
19666 \begin_layout Standard
19668 \change_deleted 564990737 1669755802
19669 Before you submit your paper you must export the \SpecialChar LyX
19670 document as a \SpecialChar LaTeX
19673 File\SpecialChar menuseparator
19674 Export\SpecialChar menuseparator
19682 \begin_layout Plain Layout
19683 Actually you have the choice between \SpecialChar LaTeX
19684 (plain) and pdflatex.
19685 If you intend to use pdflatex to prepare the paper, you should use the
19686 pdflatex option so that included graphics are converted to PDF format,
19687 ready for use by pdflatex.
19692 , then make the following changes to the resulting
19699 \begin_layout Enumerate
19701 \change_deleted 564990737 1669755802
19702 Remove the comment lines before the
19711 \begin_layout Enumerate
19713 \change_deleted 564990737 1669755802
19714 Remove everything between (and including) the
19726 commands, except for any commands you specifically put into the \SpecialChar LaTeX
19730 \begin_layout Standard
19732 \change_deleted 564990737 1669755802
19737 file should be saved and processed through \SpecialChar LaTeX
19738 as many times as necessary.
19739 You may also want to check the resulting
19748 \begin_layout Section
19750 \change_deleted 564990737 1669801478
19754 \begin_layout Standard
19756 \change_deleted 564990737 1669801478
19762 \begin_layout Subsection
19764 \change_deleted 564990737 1669801478
19768 \begin_layout Standard
19770 \change_deleted 564990737 1669801478
19771 The iopart package provides a document class to create electronic manuscript
19772 submission to the journals published by the Institute of Physics.
19773 Instructions for the authors how to create a paper using the iopart class
19774 can be downloaded together with the iopart package from the site
19775 \begin_inset Flex URL
19778 \begin_layout Plain Layout
19780 ftp://ftp.iop.org/pub/journals/latex2e
19788 \begin_layout Subsection
19790 \change_deleted 564990737 1669801478
19794 \begin_layout Standard
19796 \change_deleted 564990737 1669801478
19797 The easiest way to write a paper is to start with the template
19801 that is available via
19803 File\SpecialChar menuseparator
19806 The template explains how to use the special text environments.
19807 Here are the most important advices:
19810 \begin_layout Itemize
19812 \change_deleted 564990737 1669801478
19813 To be able to compile your document to a PDF, PS, or DVI, ensure that the
19814 no AMS packages are loaded in
19816 Document\SpecialChar menuseparator
19817 Settings\SpecialChar menuseparator
19823 \begin_layout Itemize
19825 \change_deleted 564990737 1669801478
19828 The title environment defines the kind of your paper.
19829 So use one of the following environments for the title:
19833 \begin_layout Itemize
19835 \change_deleted 564990737 1669801478
19844 \begin_layout Itemize
19846 \change_deleted 564990737 1669801478
19855 \begin_layout Itemize
19857 \change_deleted 564990737 1669801478
19863 for a Topical review
19866 \begin_layout Itemize
19868 \change_deleted 564990737 1669801478
19877 \begin_layout Itemize
19879 \change_deleted 564990737 1669801478
19888 \begin_layout Itemize
19890 \change_deleted 564990737 1669801478
19896 for a Paper (same as Title)
19899 \begin_layout Itemize
19901 \change_deleted 564990737 1669801478
19907 for a Preliminary communication
19910 \begin_layout Itemize
19912 \change_deleted 564990737 1669801478
19918 for a Rapid communication
19921 \begin_layout Itemize
19923 \change_deleted 564990737 1669801478
19929 for a Letter to the editor
19933 \begin_layout Itemize
19935 \change_deleted 564990737 1669801478
19938 All title environments except of
19942 can have an optional short title.
19945 \begin_layout Itemize
19947 \change_deleted 564990737 1669801478
19948 There is a general title environment
19952 which is not directly supported by \SpecialChar LyX
19954 This can be used as \SpecialChar TeX
19955 code when your document doesn't fit into one of the
19959 \begin_layout Standard
19961 \change_deleted 564990737 1669801478
19962 For more informations like hints for special table and formula formatting,
19963 look at the IOP author guidelines.
19968 \begin_layout Section
19970 \change_deleted 564990737 1670317155
19974 \begin_layout Standard
19976 \change_deleted 564990737 1670317155
19979 Panayotis Papasotiriou
19982 \begin_layout Subsection
19984 \change_deleted 564990737 1670317155
19988 \begin_layout Standard
19990 \change_deleted 564990737 1670317155
19991 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
19992 that facilitates electronic manuscript submission to the journals they
19994 Most known of them (at least in my domain of interest) are
19996 Astrophysics and Space Science
20002 , but there are many others (see a complete list at
20003 \begin_inset Flex URL
20006 \begin_layout Plain Layout
20008 http://www.wkap.nl/jrnllist.htm/JRNLHOME
20014 The Kluwer package may be downloaded from the site
20015 \begin_inset Flex URL
20018 \begin_layout Plain Layout
20020 http://www.wkap.nl/kaphtml.htm/STYLEFILES
20026 A complete user guide is contained in that package (but it can also be
20027 downloaded separately).
20030 \begin_layout Standard
20032 \change_deleted 564990737 1670317155
20034 supports many features of the package but not everything.
20035 However, the \SpecialChar TeX
20036 code needed is reduced to some
20037 \begin_inset Quotes eld
20041 \begin_inset Quotes erd
20044 commands of the package (see
20045 \begin_inset space ~
20049 \begin_inset CommandInset ref
20051 reference "subsec:kluwer_peculiarities"
20056 I have recently used \SpecialChar LyX
20057 to write an article submitted to the
20059 Astrophysics and Space Science
20061 without any problem.
20064 \begin_layout Subsection
20066 \change_deleted 564990737 1670317155
20070 \begin_layout Standard
20072 \change_deleted 564990737 1670317155
20073 The easiest way to write a paper is to start with the Kluwer template file.
20076 File\SpecialChar menuseparator
20088 This will give an (almost) empty document that includes the most common
20089 fields found in a manuscript and a short description of their use.
20090 As in most templates, simply overwrite the existing text (including the
20095 ) with the correct information.
20098 \begin_layout Subsection
20100 \change_deleted 564990737 1670317155
20101 Preparing a paper for submission
20104 \begin_layout Standard
20106 \change_deleted 564990737 1670317155
20107 As in the AAS\SpecialChar TeX
20108 package, before you submit your paper to a journal you must
20110 \begin_inset Quotes eld
20114 \begin_inset Quotes erd
20120 \begin_layout Enumerate
20122 \change_deleted 564990737 1670317155
20123 Export your paper as a \SpecialChar LaTeX
20125 To do this, click on
20127 File\SpecialChar menuseparator
20128 Export\SpecialChar menuseparator
20136 \begin_layout Enumerate
20138 \change_deleted 564990737 1670317155
20143 file with a text editor and make the following changes
20147 \begin_layout Enumerate
20149 \change_deleted 564990737 1670317155
20150 remove the comment lines before the
20159 \begin_layout Enumerate
20161 \change_deleted 564990737 1670317155
20162 remove everything between (and including) the
20174 commands, except for any commands you specifically put into the \SpecialChar LaTeX
20178 \begin_layout Standard
20180 \change_deleted 564990737 1670317155
20189 \begin_layout Enumerate
20191 \change_deleted 564990737 1670317155
20196 file through \SpecialChar LaTeX
20197 as many times as necessary (usually up to three).
20200 \begin_layout Enumerate
20202 \change_deleted 564990737 1670317155
20208 \begin_inset space \thinspace{}
20212 \begin_inset space \space{}
20219 , and check if everything is OK (it should, if you didn't make any mistake).
20222 \begin_layout Subsection
20224 \change_deleted 564990737 1670317155
20225 \begin_inset Quotes eld
20229 \begin_inset Quotes erd
20232 of the Kluwer package
20233 \begin_inset CommandInset label
20235 name "subsec:kluwer_peculiarities"
20242 \begin_layout Standard
20244 \change_deleted 564990737 1670317155
20245 The Kluwer package has the following
20246 \begin_inset Quotes eld
20250 \begin_inset Quotes erd
20256 \begin_layout Enumerate
20258 \change_deleted 564990737 1670317155
20259 It is possible to write multiple articles in the same \SpecialChar LaTeX
20264 \begin_layout Plain Layout
20265 I can't imagine any good reason to do this.
20271 Each article must be included in the environment
20272 \begin_inset Quotes eld
20276 \begin_inset Quotes erd
20280 Unfortunately, this environment cannot be omitted, even if you write just
20282 Therefore, each article starts with the command
20288 and, obviously, ends with the command
20295 Although this can be implemented in \SpecialChar LyX
20296 , I didn't included it, since it looks
20297 ugly and can confuse the novice user.
20298 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
20301 \begin_inset Quotes eld
20306 \begin_inset Quotes erd
20312 \begin_layout Enumerate
20314 \change_deleted 564990737 1670317155
20315 Information given at the beginning of the article (i.
20316 \begin_inset space \thinspace{}
20320 \begin_inset space \space{}
20323 title, subtitle, author, institution, running title, running author, abstract
20324 and keywords) must be included in an environment called
20325 \begin_inset Quotes eld
20329 \begin_inset Quotes erd
20333 This is not implemented in \SpecialChar LyX
20334 , so you must enter title, subtitle etc.
20335 \begin_inset space ~
20338 between two \SpecialChar TeX
20354 \begin_layout Enumerate
20356 \change_deleted 564990737 1670317155
20357 According to the user manual, the label of each bibliography item must be
20381 \begin_layout Standard
20383 \change_deleted 564990737 1670317155
20388 template takes care of all these
20389 \begin_inset Quotes eld
20393 \begin_inset Quotes erd
20397 If you start a new paper using this template you don't need to do anything
20402 \begin_layout Enumerate
20404 \change_deleted 564990737 1670317155
20405 don't delete the \SpecialChar TeX
20406 code included in the template, and
20409 \begin_layout Enumerate
20411 \change_deleted 564990737 1670317155
20412 copy the example bibliography item included in the template and modify it
20413 as necessary to enter new bibliography items.
20416 \begin_layout Section
20420 \begin_layout Standard
20425 provides an alternative to the standard
20430 It provides similar functionality, but you might prefer this layout with
20431 sans serif sections, headings, and more.
20434 \begin_layout Section
20435 Springer Journals (
20442 \begin_layout Standard
20448 \begin_layout Subsection
20452 \begin_layout Standard
20453 These are the layout files for some of the journal formats used by Springer
20454 Verlag and listed on
20455 \begin_inset Flex URL
20458 \begin_layout Plain Layout
20460 http://www.springer.de/author/tex/help-journals.html
20465 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
20467 It is a modular system: the things common to all journals are implemented
20472 , which journal-specific layout files (such as, e.
20473 \begin_inset space \thinspace{}
20477 \begin_inset space \space{}
20484 for Journal of Geodesy) can include.
20487 \begin_layout Standard
20488 This means that implementing support for any other Springer journal on this
20489 list is as simple as writing your own
20497 file following the outline given in
20505 \begin_layout Standard
20506 It is reasonably well tested only for the Journal of Geodesy.
20515 come with the standard \SpecialChar LyX
20517 Install the relevant class file (downloaded from Springer) in a proper
20518 directory, reconfigure \SpecialChar LaTeX
20519 (in the te\SpecialChar TeX
20524 , as root if necessary — doesn't \SpecialChar LyX
20525 take care of this?), reconfigure \SpecialChar LyX
20530 \begin_layout Subsection
20534 \begin_layout Standard
20535 A large number of theorem-like styles —
20547 \begin_layout Standard
20550 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
20551 _Title, Author_Running, Institute,
20552 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
20555 See the Springer class file documentation for details.
20558 \begin_layout Subsection
20562 \begin_layout Itemize
20574 \begin_layout Itemize
20577 Probability Theory and Related Fields
20583 — Jean-Marc Lasgouttes
20586 \begin_layout Standard
20587 Add your own, it isn't so hard!
20590 \begin_layout Subsection
20594 \begin_layout Standard
20595 These files are partly based on the older
20599 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
20601 file from Springer.
20606 layout, are now defunct.
20607 Jean-Marc Lasgouttes helped out big in making me find my way around the
20609 layout file mechanism.
20612 \begin_layout Subsection
20616 \begin_layout Standard
20618 But probably less than in the old hacked-\SpecialChar LaTeX
20626 \begin_layout Chapter
20628 Features needing Extra Software
20631 \begin_layout Section
20632 Checking \SpecialChar TeX
20636 \begin_layout Standard
20642 \begin_layout Subsection
20646 \begin_layout Standard
20655 \begin_layout Plain Layout
20660 is not yet available when you are using the \SpecialChar LaTeX
20661 distribution MiK\SpecialChar TeX
20667 , you'll find in the
20674 \begin_inset space ~
20685 \begin_inset Newline newline
20689 \begin_inset CommandInset href
20691 target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
20699 \begin_layout Standard
20702 Chk\SpecialChar TeX
20705 package is a program that was written by
20706 \begin_inset Flex Noun
20709 \begin_layout Plain Layout
20711 \begin_inset space ~
20719 in frustration because some constructs in \SpecialChar LaTeX
20720 are sometimes non-intuitive,
20721 and easy to forget.
20722 The program runs over your \SpecialChar LaTeX
20723 file, checks the integrity of the file, and
20724 flags some common errors.
20725 In other technical words, it is
20729 for \SpecialChar LaTeX
20733 \begin_layout Standard
20734 Well, what is a syntax checker doing in \SpecialChar LyX
20735 which is supposed to produce correct
20737 anyways? The answer is simple: Just as
20741 not only checks the
20745 of C programs, but also does
20749 checks for type-errors,
20751 Chk\SpecialChar TeX
20754 catches some common
20758 errors, in addition to the syntactical ones.
20761 Chk\SpecialChar TeX
20764 is capable of detecting several common errors, such as
20767 \begin_layout Itemize
20768 Ellipsis detection:
20769 \begin_inset Newline newline
20772 Use \SpecialChar ldots
20776 \begin_layout Itemize
20777 No space in front of/after parenthesis:
20778 \begin_inset Newline newline
20784 \begin_layout Itemize
20785 Enforcement of normal space after common abbreviations:
20786 \begin_inset Newline newline
20790 \begin_inset space \thinspace{}
20794 \begin_inset space \space{}
20797 is too wide spacing.
20800 \begin_layout Itemize
20801 Enforcement of end-of-sentence space when the last sentence ends with a
20803 \begin_inset Newline newline
20807 And this is wrong spacing.
20810 \begin_layout Itemize
20811 Space in front of labels and similar commands:
20812 \begin_inset Newline newline
20815 The label should stick right up to the text to avoid falling to a wrong
20818 \begin_inset CommandInset label
20828 \begin_layout Plain Layout
20829 This footnote is in danger of falling off to a wrong page
20834 The label is separated too much.
20837 \begin_layout Itemize
20838 Space in front of references, instead of hard spaces:
20839 \begin_inset Newline newline
20842 If you have bad luck, the text will break right between the referenced text
20843 and reference number, and that's a pity.
20845 \begin_inset CommandInset ref
20847 reference "sec:chktex"
20854 \begin_layout Itemize
20856 \begin_inset Quotes eld
20860 \begin_inset Quotes erd
20864 \begin_inset Formula $\times$
20868 \begin_inset Newline newline
20871 2x2 looks cheap compared to
20872 \begin_inset Formula $2\times2$
20878 \begin_layout Standard
20879 and more \SpecialChar ldots
20880 It is an invaluable tool when you are
20881 \begin_inset Quotes eld
20885 \begin_inset Quotes erd
20888 your document before printing, and you should run it right after the obligatory
20889 spelling check, and before you go fine tuning the typesetting.
20892 \begin_layout Subsection
20896 \begin_layout Standard
20897 If you have the program installed, usage is as simple as choosing
20899 Tools\SpecialChar menuseparator
20901 \begin_inset space ~
20907 This will make \SpecialChar LyX
20908 generate a \SpecialChar LaTeX
20909 file of your document, start
20911 Chk\SpecialChar TeX
20914 to check it, and then make \SpecialChar LyX
20916 \begin_inset Quotes eld
20920 \begin_inset Quotes erd
20923 with the warnings from
20925 Chk\SpecialChar TeX
20928 , if there were any.
20929 The warnings will be placed close to the point of the mistake, and you
20930 can quickly find them by using the
20932 Navigate\SpecialChar menuseparator
20935 menu item, or the shortcut key
20944 Open the error boxes by clicking on them with the mouse, or use the shortcut
20953 bindings, or the corresponding
20962 Read the warning and correct the mistake, if it is a mistake.
20963 If you have trouble understanding what the warning is about, you can safely
20965 Remember that there is a hidden layer between the document on screen and
20966 the technical details in invoking
20968 Chk\SpecialChar TeX
20971 , and this gap can make some warnings seem arcane or just plain silly.
20974 \begin_layout Standard
20975 This document is an excellent testing bed for the feature, and it should
20976 provide quite a few warnings for you to fiddle with.
20977 Since computers are only so smart, expect most of the warnings to be false
20981 \begin_layout Subsection
20982 How to fine tune it
20985 \begin_layout Standard
20986 Sometimes, you'll find that
20988 Chk\SpecialChar TeX
20991 makes more noise than suits your mood.
20992 Then you can choose not to use it, wait until your mood changes, or try
20995 Chk\SpecialChar TeX
20998 to get better along with you.
21001 \begin_layout Standard
21004 Chk\SpecialChar TeX
21011 very configurable and extensible, you should not expect to solve all problems
21014 Chk\SpecialChar TeX
21017 in \SpecialChar LyX
21019 Since \SpecialChar LyX
21020 has to generate a somewhat special \SpecialChar LaTeX
21021 file to be able to match the
21022 line numbers from the
21024 Chk\SpecialChar TeX
21031 \begin_layout Plain Layout
21032 You can inspect the specific output from
21038 Document\SpecialChar menuseparator
21041 \begin_inset space ~
21055 to the internal document structure, some of the warnings will not appear
21057 There are two things you can do about this:
21060 \begin_layout Itemize
21063 Chk\SpecialChar TeX
21066 invocation command line in
21067 \begin_inset Flex Noun
21070 \begin_layout Plain Layout
21071 Tools\SpecialChar menuseparator
21072 Preferences\SpecialChar menuseparator
21073 Output\SpecialChar menuseparator
21074 LaTeX\SpecialChar menuseparator
21082 Chk\SpecialChar TeX
21085 installation configuration file (usually with the file
21090 See below to learn what warnings can be enabled and disabled on the command
21094 \begin_layout Itemize
21095 Export your document as a raw \SpecialChar LaTeX
21098 File\SpecialChar menuseparator
21099 Export\SpecialChar menuseparator
21108 Invoked in this way, it can be a hassle to find the corresponding place
21109 in the document inside \SpecialChar LyX
21110 , but with a little patience, you should be able
21114 \begin_layout Standard
21115 Here follows the warning messages that can be enabled and disabled in
21124 to disable a warning, and
21128 to enable a warning.
21129 The emphasized entries are disabled by default, because the default is
21132 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
21137 \begin_layout Standard
21138 Notice that you should only use the options that enable and disable warnings,
21139 because \SpecialChar LyX
21140 relies on some of the other command line parameters to be set
21141 in a specific way to have a chance to communicate with
21148 \begin_layout Enumerate
21152 Command terminated with space.
21155 \begin_layout Enumerate
21158 Non-breaking space (
21159 \begin_inset Quotes eld
21167 \begin_inset Quotes erd
21170 ) should have been used.
21173 \begin_layout Enumerate
21177 You should enclose the previous parenthesis with
21178 \begin_inset Quotes eld
21186 \begin_inset Quotes erd
21192 \begin_layout Enumerate
21195 Italic correction (
21196 \begin_inset Quotes eld
21206 \begin_inset Quotes erd
21209 ) found in non-italic buffer.
21212 \begin_layout Enumerate
21215 Italic correction (
21216 \begin_inset Quotes eld
21226 \begin_inset Quotes erd
21229 ) found more than once.
21232 \begin_layout Enumerate
21236 No italic correction (
21237 \begin_inset Quotes eld
21247 \begin_inset Quotes erd
21253 \begin_layout Enumerate
21257 \begin_inset Quotes eld
21265 \begin_inset Quotes erd
21269 \begin_inset Quotes eld
21277 \begin_inset Quotes erd
21283 \begin_layout Enumerate
21286 Wrong length of dash may have been used.
21289 \begin_layout Enumerate
21293 \begin_inset Quotes eld
21301 \begin_inset Quotes erd
21305 \begin_inset Quotes eld
21313 \begin_inset Quotes erd
21319 \begin_layout Enumerate
21323 \begin_inset Quotes eld
21331 \begin_inset Quotes erd
21337 \begin_layout Enumerate
21341 \begin_inset Quotes eld
21349 \begin_inset Quotes erd
21352 to achieve an ellipsis.
21355 \begin_layout Enumerate
21358 Inter-word spacing (
21359 \begin_inset Quotes eld
21369 \begin_inset Quotes eld
21372 ) should perhaps be used.
21375 \begin_layout Enumerate
21378 Inter-sentence spacing (
21379 \begin_inset Quotes eld
21389 \begin_inset Quotes erd
21392 ) should perhaps be used.
21395 \begin_layout Enumerate
21398 Could not find argument for command.
21401 \begin_layout Enumerate
21405 \begin_inset Quotes eld
21413 \begin_inset Quotes erd
21419 \begin_layout Enumerate
21422 Math mode still on at end of \SpecialChar LaTeX
21426 \begin_layout Enumerate
21430 \begin_inset Quotes eld
21438 \begin_inset Quotes erd
21441 doesn't match the number of
21442 \begin_inset Quotes eld
21450 \begin_inset Quotes erd
21456 \begin_layout Enumerate
21459 You should use either
21462 \begin_inset Quotes eld
21470 \begin_inset Quotes erd
21475 as an alternative to
21476 \begin_inset Quotes eld
21484 \begin_inset Quotes erd
21490 \begin_layout Enumerate
21497 " (ASCII 39) instead of "
21504 \begin_layout Enumerate
21507 User-specified pattern found.
21510 \begin_layout Enumerate
21513 This command might not be intended.
21516 \begin_layout Enumerate
21523 \begin_layout Enumerate
21541 \begin_layout Enumerate
21544 Delete this space to maintain correct page references.
21547 \begin_layout Enumerate
21551 You might wish to put this between a pair of
21552 \begin_inset Quotes eld
21560 \begin_inset Quotes erd
21566 \begin_layout Enumerate
21569 You ought to remove spaces in front of punctuation.
21572 \begin_layout Enumerate
21575 Could not execute \SpecialChar LaTeX
21579 \begin_layout Enumerate
21588 in front of small punctuation.
21591 \begin_layout Enumerate
21599 may look prettier here.
21602 \begin_layout Enumerate
21606 Multiple spaces detected in output.
21609 \begin_layout Enumerate
21612 This text may be ignored.
21615 \begin_layout Enumerate
21621 \begin_inset Quotes eld
21626 to begin quotation, not
21633 \begin_layout Enumerate
21640 to end quotation, not
21643 \begin_inset Quotes eld
21651 \begin_layout Enumerate
21657 \begin_layout Enumerate
21660 You should perhaps use
21661 \begin_inset Quotes eld
21669 \begin_inset Quotes erd
21675 \begin_layout Enumerate
21678 You should put a space in front of/after parenthesis.
21681 \begin_layout Enumerate
21684 You should avoid spaces in front of/after parenthesis.
21687 \begin_layout Enumerate
21691 You should not use punctuation in front of/after quotes.
21694 \begin_layout Enumerate
21697 Double space found.
21700 \begin_layout Enumerate
21703 You should put punctuation outside inner/inside display math mode.
21706 \begin_layout Enumerate
21709 You ought to not use primitive \SpecialChar TeX
21710 in \SpecialChar LaTeX
21714 \begin_layout Enumerate
21717 You should remove spaces in front of
21718 \begin_inset Quotes eld
21726 \begin_inset Quotes erd
21732 \begin_layout Enumerate
21735 \begin_inset Quotes eld
21743 \begin_inset Quotes erd
21746 is normally not followed by
21747 \begin_inset Quotes eld
21755 \begin_inset Quotes erd
21761 \begin_layout Standard
21762 In later versions of \SpecialChar LyX
21763 , we hope to provide a more complete interface to this
21764 tool (and it's smaller cousin
21768 ) to exploit the full power of it.
21769 But it's not exactly useless as it is now: go try it on one of your existing
21770 documents of a certain length and be surprised.
21773 \begin_layout Section
21774 Version Control in \SpecialChar LyX
21778 \begin_layout Standard
21781 Lars Gullik Bjønnes
21788 \begin_layout Subsection
21792 \begin_layout Standard
21794 supports some of the most basic RCS/CVS/SVN/GIT commands.
21795 If you need something a bit more sophisticated you will have to do that
21796 manually in a terminal.
21799 \begin_layout Standard
21800 Also note that CVS support is not as good as subversion support, so we advise
21802 A good place to start learning Subversion is the SVN Book
21806 \begin_layout Plain Layout
21807 \begin_inset CommandInset href
21809 target "http://svnbook.red-bean.com/"
21820 In the case of RCS you should read
21821 \begin_inset Quotes eld
21825 \begin_inset Quotes erd
21828 (a man file, read it with
21833 This file describes all the basic features of RCS.
21834 You should especially notice the comment about a RCS directory, and the
21835 notion of a master RCS file (the file ending in
21842 \begin_layout Standard
21843 Before you begin to use the version control features in \SpecialChar LyX
21845 familiar with RCS/CVS/SVN/GIT usage.
21846 The implementation in \SpecialChar LyX
21847 assumes a recent version of the GNU RCS or CVS/SVN
21848 package — no guarantees are made for older versions.
21849 Most of the log messages are not currently displayed after operations —
21850 you can check them in the Messages pane if you are unsure.
21851 Regular users of version control will appreciate the VC toolbar, which
21854 View\SpecialChar menuseparator
21855 Toolbars\SpecialChar menuseparator
21857 \begin_inset space ~
21865 \begin_layout Standard
21866 For introducing your own external commands consult
21867 \begin_inset Flex Code
21870 \begin_layout Plain Layout
21884 \begin_layout Standard
21885 It is strongly recommended to store documents in uncompressed format if
21886 using version control (uncheck
21888 Document\SpecialChar menuseparator
21891 if it is checked): Uncompressed LyX documents are text files and therefore
21892 for merging two different versions by version control systems.
21893 Compressed LyX documents are binary files, which cannot be merged by version
21897 \begin_layout Subsection
21898 RCS commands in \SpecialChar LyX
21902 \begin_layout Standard
21903 The following sections describe the RCS commands supported by \SpecialChar LyX
21905 You can find them in the
21907 File\SpecialChar menuseparator
21909 \begin_inset space ~
21916 was tested against RCS 5.7/5.8.
21919 \begin_layout Subsubsection
21925 \begin_layout Standard
21926 If your document is not under revision control, this is the only item shown
21928 And if it is under revision control, the
21932 item is not visible.
21936 \begin_layout Standard
21937 This command registers your document with RCS (unless you are under the
21938 directory managed by CVS)\SpecialChar endofsentence
21939 You are asked interactively to supply an initial
21940 description of the document.
21941 The document is now set in Read-Only mode and you have to
21944 \begin_inset space ~
21948 \begin_inset space ~
21952 \begin_inset space ~
21957 , before making any changes to it.
21958 A document under revision control has a
21959 \begin_inset Quotes eld
21962 [RCS:<version> <locker>]
21963 \begin_inset Quotes erd
21966 item tagged to the filename in the minibuffer.
21969 \begin_layout Standard
21970 RCS command that is run:
21973 \begin_layout LyX-Code
21976 ci -q -u -i -t-"<initial description>" <file-name>
21979 \begin_layout Standard
21984 to understand the switches.
21988 \begin_layout Subsubsection
21994 \begin_layout Standard
21995 When you are finished editing a file, you check in your changes.
21996 When you do this, you are asked for a description of the changes.
21997 This is stored in the history log.
21998 The version number is bumped, your changes are applied to the master RCS
21999 file, the document is unlocked and set to Read-Only mode.
22002 \begin_layout Itemize
22005 ci -q -u -m"<description>" <file-name>
22008 \begin_layout Subsubsection
22014 \begin_layout Standard
22015 By doing this you lock the document so that only you can edit it.
22016 This will also make the document Read-Write only for you.
22017 You will usually continue editing for a while and when you are finished
22018 you check in your changes.
22019 The status line is changed to reflect that you have locked the file.
22022 \begin_layout Itemize
22025 co -q -l <file-name>
22028 \begin_layout Subsubsection
22031 Revert To Repository Version
22034 \begin_layout Standard
22035 This will discard all changes made to the document since the last check
22037 You get a warning before changes are discarded.
22040 \begin_layout Itemize
22043 co -f -u<version> <file-name>
22046 \begin_layout Subsubsection
22052 \begin_layout Standard
22053 This will create a copy of the current document.
22054 Since RCS does not support copy operations natively, the version history
22055 is not preserved, and the copy is added as a new file.
22056 It requires a clean document without any changes since the last checkin.
22057 You are asked for a file name and a description of the copy operation.
22058 After that the copy is created, both locally and in the repository.
22059 If the parent directories of the copied and original document differ, all
22060 relative paths of included files of the copy are adjusted (like in
22062 File\SpecialChar menuseparator
22067 Finally, the copy is loaded instead of the original document.
22070 \begin_layout Labeling
22071 \labelwidthstring 00.00.0000
22073 \begin_inset space ~
22077 \begin_inset space ~
22081 \begin_inset Newline newline
22085 \begin_inset Flex Code
22088 \begin_layout Plain Layout
22091 \begin_inset Quotes qld
22095 \begin_inset Quotes qld
22104 \begin_inset Flex Code
22107 \begin_layout Plain Layout
22110 \begin_inset Quotes qld
22114 \begin_inset Quotes qld
22123 \begin_inset Newline newline
22127 \begin_inset Flex Code
22130 \begin_layout Plain Layout
22134 \begin_inset Quotes qld
22138 \begin_inset Quotes qld
22149 \begin_layout Subsubsection
22155 \begin_layout Standard
22156 This makes as if the last check in never happened.
22157 No changes are made to the document loaded into \SpecialChar LyX
22158 , but the last version
22159 is removed from the master RCS file.
22162 \begin_layout Itemize
22165 rcs -o<version> <file-name>
22168 \begin_layout Subsubsection
22174 \begin_layout Standard
22175 This shows the complete history of the RCS document.
22180 is shown in a browser.
22188 \begin_layout Subsubsection
22192 \begin_layout Standard
22194 supports RCS version number, author name, date and time of last commit.
22195 All those are extracted from
22197 rlog -r <file-name>
22201 \begin_inset CommandInset ref
22203 reference "subsec:VCS-Revision-Information"
22210 \begin_layout Subsection
22211 CVS commands in \SpecialChar LyX
22215 \begin_layout Standard
22216 A subset of CVS operations is supported by \SpecialChar LyX
22218 You can find the commands in the
22220 File\SpecialChar menuseparator
22222 \begin_inset space ~
22228 The version control system SVN is more powerful, so please use it instead
22229 of CVS if possible.
22232 \begin_layout Subsubsection
22238 \begin_layout Standard
22239 If you start from scratch with CVS you have to create your repository and
22240 checkout the working copy with external tools.
22241 If you're using a client-server setup you may need to login before doing
22242 the first repository checkout.
22245 \begin_layout Standard
22246 If your documents are under revision control and others are using the same
22247 repository problems arise when different changes to the same document at
22248 the same location happen.
22249 Standard CVS repositories don't operate with a file locking mechanism.
22250 This may be surprising, but conflicts only occur if people disagree on
22251 the proper content of the same part of a document.
22252 So, if co-workers are used to communicate regularly, these conflicts occur
22254 If they don't communicate they have a fundamental problem anyway.
22255 Nevertheless some people like to work with so called
22256 \begin_inset Quotes eld
22260 \begin_inset Quotes erd
22264 If they do so the working copy of all files is readonly when checked out
22265 first and the user starts editing after using a special command to make
22266 the working copy writable.
22267 When the changes are checked in the working copy returns to readonly state.
22268 With \SpecialChar LyX
22269 one has to edit the
22270 \begin_inset Flex Code
22273 \begin_layout Plain Layout
22279 file and add the line
22280 \begin_inset Flex Code
22283 \begin_layout Plain Layout
22289 to work with reserved checkouts.
22290 The benefit is the possibility to see who is using a writable copy of some
22292 It's not guaranteed only one user makes a copy writable.
22295 \begin_layout Standard
22297 tries to guess if you're using reserved or non-reserved checkouts.
22298 If your working copy is readonly or it is writable and an additional copy
22299 of your document exists in the CVS/Base sub-directory a reserved otherwise
22300 a non-reserved checkout is assumed.
22301 When a reserved checkout is detected you have to use
22302 \begin_inset Flex Noun
22305 \begin_layout Plain Layout
22311 to make your working copy writable if it's readonly.
22313 \begin_inset Flex Noun
22316 \begin_layout Plain Layout
22322 operation is possible and that makes your working copy readonly again after
22323 transferring your changes to the repository.
22326 \begin_layout Standard
22327 More information about CVS can be found here
22328 \begin_inset Flex URL
22331 \begin_layout Plain Layout
22333 http://www.nongnu.org/cvs
22339 \begin_inset Flex URL
22342 \begin_layout Plain Layout
22344 http://ximbiot.com/cvs
22352 \begin_layout Standard
22357 to understand the sub-commands and the switches mentioned below.
22360 \begin_layout Subsubsection
22366 \begin_layout Standard
22367 If your document is not under revision control, this is the only item shown
22369 And if it is under revision control, the
22373 item is not visible.
22377 \begin_layout Standard
22378 This command registers in CVS your document
22379 \begin_inset Flex Strong
22382 \begin_layout Plain Layout
22390 in the case you have already the documents directory under CVS control
22396 This means you have to create or checkout the archive by yourself using
22398 (In case you forget that step \SpecialChar LyX
22399 registers the document with RCS.)
22402 \begin_layout Standard
22403 Then you are asked interactively to supply an initial description of the
22405 Don't forget that registered file is not yet checked in.
22408 \begin_layout Standard
22409 CVS command that is run:
22411 cvs -q add -m"<entered message>" "<file-name>"
22414 \begin_layout Standard
22419 above and for all other CVS commands is an abbreviation for
22420 \begin_inset Quotes eld
22423 change the current working directory to file location and use the file name
22424 without path component as argument
22425 \begin_inset Quotes erd
22431 \begin_layout Subsubsection
22437 \begin_layout Standard
22438 When you are finished editing a file, you commit your changes.
22439 When you do this and you had changed the document, you are asked for a
22440 description of the changes.
22441 After that changes are written to the repository.
22442 In case you didn't change the document and a reserved checkout is detected
22443 the reservation made on
22444 \begin_inset Flex Noun
22447 \begin_layout Plain Layout
22456 \begin_layout Labeling
22457 \labelwidthstring 00.00.0000
22459 \begin_inset space ~
22463 \begin_inset space ~
22467 \begin_inset Newline newline
22471 \begin_inset Flex Code
22474 \begin_layout Plain Layout
22477 -q commit -m"<description>" "<file-name>"
22483 \begin_inset Newline newline
22487 \begin_inset Flex Code
22490 \begin_layout Plain Layout
22501 \begin_layout Subsubsection
22507 \begin_layout Standard
22508 When you are sharing a repository with others, you may have to incorporate
22509 their changes into your working copy.
22512 \begin_layout Standard
22515 cvs -q update "<file-name>"
22518 \begin_layout Standard
22519 If a readonly checkout is detected the working copy is made writable and
22523 \begin_layout Standard
22526 cvs -q edit "<file-name>"
22529 \begin_layout Subsubsection
22532 Revert To Repository Version
22535 \begin_layout Standard
22536 This will discard all changes made to the document since the last check
22538 You get a warning before changes are discarded.
22539 Firstly the file is deleted, secondly CVS update command is run.
22542 \begin_layout Standard
22545 cvs -q update "<file-name>"
22548 \begin_layout Standard
22549 If a reserved checkout is detected and the working copy has no changes only
22550 the reservation is undone.
22553 \begin_layout Standard
22556 cvs -q unedit "<file-name>"
22559 \begin_layout Subsubsection
22565 \begin_layout Standard
22566 This will create a copy of the current document.
22567 Since CVS does not support copy operations natively, the version history
22568 is not preserved, and the copy is added as a new file.
22569 It requires a clean document without any changes since the last checkin.
22570 You are asked for a file name and a description of the copy operation.
22571 After that the copy is created, both locally and in the repository.
22572 If the parent directories of the copied and original document differ, all
22573 relative paths of included files of the copy are adjusted (like in
22575 File\SpecialChar menuseparator
22580 Finally, the copy is loaded instead of the original document.
22583 \begin_layout Labeling
22584 \labelwidthstring 00.00.0000
22586 \begin_inset space ~
22590 \begin_inset space ~
22594 \begin_inset Newline newline
22598 \begin_inset Flex Code
22601 \begin_layout Plain Layout
22608 \begin_inset Flex Code
22611 \begin_layout Plain Layout
22618 \begin_inset Newline newline
22622 \begin_inset Flex Code
22625 \begin_layout Plain Layout
22626 cvs -q add "<new-file-name>"
22634 \begin_layout Subsubsection
22640 \begin_layout Standard
22641 This will rename the current document.
22642 Since CVS does not support rename operations natively, the version history
22643 is not preserved, the renamed document is added as a new file, and the
22644 original document is deleted.
22645 It requires a clean document without any changes since the last checkin.
22646 You are asked for a file name and a description of the rename operation.
22647 After that the document is renamed, both locally and in the repository.
22648 If the parent directories of the new and old file names differ, all relative
22649 paths of included files are adjusted (like in
22651 File\SpecialChar menuseparator
22656 Finally, the document is reloaded using the new name.
22659 \begin_layout Labeling
22660 \labelwidthstring 00.00.0000
22662 \begin_inset space ~
22666 \begin_inset space ~
22670 \begin_inset Newline newline
22674 \begin_inset Flex Code
22677 \begin_layout Plain Layout
22684 \begin_inset Flex Code
22687 \begin_layout Plain Layout
22694 \begin_inset Newline newline
22698 \begin_inset Flex Code
22701 \begin_layout Plain Layout
22702 cvs -q add "<new-file-name>"
22708 \begin_inset Newline newline
22712 \begin_inset Flex Code
22715 \begin_layout Plain Layout
22716 cvs -q remove "<file-name>"
22724 \begin_layout Subsubsection
22725 Update of the local directory checkout from repository
22728 \begin_layout Standard
22729 Once your documents gets more complex, containing sub-documents and pictures,
22731 \begin_inset Flex Code
22734 \begin_layout Plain Layout
22740 files and so on using version control becomes more complicated.
22742 supports updating the whole tree in which resides the document.
22743 This become especially useful once you cooperate with people which neither
22744 have detailed knowledge about CVS usage nor they have ambition to commit
22745 additional material to the repository.
22746 You have to organize the files structure so that all external files are
22747 in the same directory or subdirectories of the document.
22748 It's good practice anyway to store multipart documents in an extra directory.
22751 \begin_layout Standard
22753 \begin_inset Flex Code
22756 \begin_layout Plain Layout
22757 Update local directory from repository
22762 command updates the whole directory.
22763 If local changes are detected user is warned before update starts.
22764 In case of merge conflicts both versions of the conflicting document parts
22765 are placed in the final document.
22766 You have to review and correct the result of the merge.
22767 You'll find the conflicts enclosed in pairs of
22768 \begin_inset Flex Code
22771 \begin_layout Plain Layout
22778 \begin_inset Flex Code
22781 \begin_layout Plain Layout
22788 \begin_inset Flex Code
22791 \begin_layout Plain Layout
22798 The first part is your version as before the update operation with the
22799 document name prepended.
22800 The second one is the repository version with the version number after
22802 \begin_inset Flex Code
22805 \begin_layout Plain Layout
22814 \begin_layout Labeling
22815 \labelwidthstring 00.00.0000
22817 \begin_inset space ~
22821 \begin_inset space ~
22825 \begin_inset Newline newline
22829 \begin_inset Flex Code
22832 \begin_layout Plain Layout
22840 (Ask if changes are detected.)
22841 \begin_inset Newline newline
22845 \begin_inset Flex Code
22848 \begin_layout Plain Layout
22849 cd $path; cvs -q update
22859 \begin_layout Standard
22861 \begin_inset Flex Code
22864 \begin_layout Plain Layout
22870 stands for the path to the document.
22873 \begin_layout Subsubsection
22879 \begin_layout Standard
22880 This shows the complete history of the CVS document.
22883 cvs log "<file-name>"
22885 is shown in a browser.
22888 \begin_layout Subsubsection
22892 \begin_layout Standard
22894 supports CVS version number, author name, date and time of last commit.
22895 All those are extracted from
22897 cvs log -r <file-name>
22901 \begin_inset CommandInset ref
22903 reference "subsec:VCS-Revision-Information"
22910 \begin_layout Subsection
22911 SVN commands in \SpecialChar LyX
22915 \begin_layout Standard
22916 SVN is now partially supported by \SpecialChar LyX
22918 You can find the commands in the
22920 File\SpecialChar menuseparator
22922 \begin_inset space ~
22928 Please note that if you use password protected access to repository via
22929 ssh, you will be asked in terminal window.
22931 was tested against SVN 1.5, 1.6, 1.7 and 1.8
22935 \begin_layout Plain Layout
22936 Most of the commands will work with 1.4 too, see
22937 \begin_inset CommandInset ref
22939 reference "subsec:SVN-Repo-Update"
22944 There seems to be currently unresolved permissions problem under SVN 1.8
22945 with reverting changes when file is locked.
22953 \begin_layout Subsubsection
22959 \begin_layout Standard
22960 If your document is not under revision control, this is the only item shown
22962 And if it is under revision control, the
22966 item is not visible.
22969 \begin_layout Standard
22970 This command registers in SVN your document ONLY in case you have already
22971 the documents directory under SVN control (in particular
22976 This means you have to checkout the archive by yourself.
22979 \begin_layout Standard
22980 Then you are asked interactively to supply an initial description of the
22982 Don't forget that registered file is not yet commited.
22985 \begin_layout Standard
22986 SVN command that is run:
22989 \begin_inset Quotes qld
22993 \begin_inset Quotes qld
22999 \begin_layout Standard
23004 to understand the switches.
23007 \begin_layout Subsubsection
23013 \begin_layout Standard
23014 When you are finished editing a file, you commit your changes.
23015 When you do this, you are asked for a description of the changes.
23016 After that changes are commited.
23019 \begin_layout Standard
23024 \begin_layout Plain Layout
23025 In case locking is not enabled.
23027 \begin_inset CommandInset ref
23029 reference "subsec:SVN-File-Locking"
23040 svn commit -q -m"<description>" <file-name>
23043 \begin_layout Subsubsection
23049 \begin_layout Standard
23050 Updates the changes of this file from the repository.
23051 Be sure you understand SVN merging and conflicts resolving before using
23052 this function, because all conflicts has to be resolved manually by you!
23055 \begin_layout Standard
23060 \begin_layout Plain Layout
23068 svn update --non-interactive
23069 \begin_inset Quotes qld
23073 \begin_inset Quotes qld
23079 \begin_layout Subsubsection
23082 Revert To Repository Version
23085 \begin_layout Standard
23086 This will discard all changes made to the document since the last check
23088 You get a warning before changes are discarded.
23091 \begin_layout Standard
23095 \begin_inset Quotes qld
23099 \begin_inset Quotes qld
23105 \begin_layout Subsubsection
23111 \begin_layout Standard
23112 This will create a copy of the current document including the version history.
23113 It requires a clean document without any changes since the last checkin.
23114 You are asked for a file name and a description of the copy operation.
23115 After that the copy is created, both locally and in the repository.
23116 If the parent directories of the copied and original document differ, all
23117 relative paths of included files of the copy are adjusted (like in
23119 File\SpecialChar menuseparator
23124 Finally, the copy is loaded instead of the original document.
23127 \begin_layout Labeling
23128 \labelwidthstring 00.00.0000
23130 \begin_inset space ~
23134 \begin_inset space ~
23138 \begin_inset Newline newline
23142 \begin_inset Flex Code
23145 \begin_layout Plain Layout
23149 \begin_inset Quotes qld
23153 \begin_inset Quotes qld
23157 \begin_inset Quotes qld
23161 \begin_inset Quotes qld
23170 \begin_inset Newline newline
23174 \begin_inset Flex Code
23177 \begin_layout Plain Layout
23186 \begin_layout Subsubsection
23192 \begin_layout Standard
23193 This will rename the current document including the version history.
23194 It requires a clean document without any changes since the last checkin.
23195 You are asked for a file name and a description of the rename operation.
23196 After that the document is renamed, both locally and in the repository.
23197 If the parent directories of the new and old file names differ, all relative
23198 paths of included files are adjusted (like in
23200 File\SpecialChar menuseparator
23205 Finally, the document is reloaded using the new name.
23208 \begin_layout Labeling
23209 \labelwidthstring 00.00.0000
23211 \begin_inset space ~
23215 \begin_inset space ~
23219 \begin_inset Newline newline
23223 \begin_inset Flex Code
23226 \begin_layout Plain Layout
23230 \begin_inset Quotes qld
23234 \begin_inset Quotes qld
23238 \begin_inset Quotes qld
23242 \begin_inset Quotes qld
23251 \begin_inset Newline newline
23255 \begin_inset Flex Code
23258 \begin_layout Plain Layout
23267 \begin_layout Subsubsection
23268 \begin_inset CommandInset label
23270 name "subsec:SVN-Repo-Update"
23274 Update of the local directory checkout from repository
23278 \begin_layout Plain Layout
23279 Note that this command will work only with subversion
23280 \begin_inset Formula $\geqq1.5$
23291 \begin_layout Standard
23292 All the commands above have one shortcoming – they deal with the current
23294 Once your document contains pictures, includes external
23295 \begin_inset Flex Code
23298 \begin_layout Plain Layout
23304 files and so on administration becomes more complicated.
23306 now supports updating the whole tree in which resides the document
23310 \begin_layout Plain Layout
23311 One need to organize the files structure so that all external files are
23312 in the same directory or subdirectories of the document.
23319 This become especially useful once you cooperate with people which neither
23320 know about subversion management nor they have ambition to commit additional
23321 material to the repository.
23325 \begin_layout Standard
23326 \begin_inset Flex Code
23329 \begin_layout Plain Layout
23330 Update local directory from repository
23335 command updates the whole directory and in case of merge conflicts local
23336 version of the files are left, so no unintended data loss occurs.
23337 If local changes are detected user is warned before update starts.
23340 \begin_layout Labeling
23341 \labelwidthstring 00.00.0000
23343 \begin_inset space ~
23347 \begin_inset space ~
23351 \begin_inset Newline newline
23355 \begin_inset Flex Code
23358 \begin_layout Plain Layout
23364 (Ask if changes are detected.)
23365 \begin_inset Newline newline
23369 \begin_inset Flex Code
23372 \begin_layout Plain Layout
23373 svn update --accept mine-full $path
23381 \begin_layout Standard
23383 \begin_inset Flex Code
23386 \begin_layout Plain Layout
23392 stands for the path to the document.
23395 \begin_layout Subsubsection
23401 \begin_layout Standard
23402 This shows the complete history of the SVN document.
23406 \begin_inset Quotes qld
23410 \begin_inset Quotes qld
23415 is shown in a browser.
23418 \begin_layout Subsubsection
23420 \begin_inset CommandInset label
23422 name "subsec:SVN-File-Locking"
23429 \begin_layout Standard
23430 The file exchange through various revision control systems brings the problem
23431 of merge conflicts in case two different users try to edit the same (parts
23433 When such a conflict happens it needs manual resolving and one reasonable
23434 alternative is to provide some kind of locking mechanism, which guarantees
23435 that only one user is allowed to edit file at the given time.
23438 \begin_layout Standard
23439 SVN has two such mechanisms to provide mutual exclusivity for file access
23440 – locks and automatic setting of write permissions (see sec.
23442 \begin_inset CommandInset ref
23444 reference "subsec:Automatical-Locking-Property"
23449 \begin_inset Flex Code
23452 \begin_layout Plain Layout
23462 \begin_layout Plain Layout
23463 \begin_inset Flex URL
23466 \begin_layout Plain Layout
23468 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
23479 If this property is detected for a given document \SpecialChar LyX
23480 starts to use SVN locks
23481 for document editing automatically and the whole check-in/out mechanism
23482 switches to the same regimen as for RCS.
23483 This in particular means there are two different modes of file use in \SpecialChar LyX
23487 \begin_layout Itemize
23489 The loaded file is in the read-only mode.
23490 For editing on needs to check-out.
23495 consists of updating from the repository and gaining write lock.
23496 If the lock is not possible to obtain, we remain in unlocked state.
23499 \begin_layout Itemize
23501 The loaded file is in the
23502 \begin_inset Quotes els
23506 \begin_inset Quotes ers
23510 No other user is allowed to edit the file.
23515 consists of commiting changes and releasing write-lock.
23516 If no changes have been made to the document, no commit will be produced
23520 \begin_layout Plain Layout
23521 Don't be puzzled by the fact that you will be asked for commit message anyway.
23526 and only the write-lock will be released.
23529 \begin_layout Standard
23533 \begin_layout Labeling
23534 \labelwidthstring 00.00.0000
23537 svn commit -q -m"<description>" "<file-name>"
23538 \begin_inset Newline newline
23541 svn unlock "<file-name>"
23544 \begin_layout Labeling
23545 \labelwidthstring 00.00.0000
23548 svn update "<file-name>"
23549 \begin_inset Newline newline
23552 svn lock "<file-name>"
23555 \begin_layout Subsubsection
23558 \begin_inset CommandInset label
23560 name "subsec:Automatical-Locking-Property"
23566 Automatic Locking Property
23569 \begin_layout Standard
23570 The above mentioned automatic setting of write permissions of the .lyx file
23573 File\SpecialChar menuseparator
23575 \begin_inset space ~
23578 Control\SpecialChar menuseparator
23579 Use Locking Property
23582 This command is active only when the file is not locked on the svn server
23584 you need to check-out before proceeding).
23587 \begin_layout Labeling
23588 \labelwidthstring 00.00.0000
23590 \begin_inset space ~
23596 \begin_layout Labeling
23597 \labelwidthstring 00.00.0000
23600 svn propset svn:needs-lock ON "<file-name>"
23603 \begin_layout Labeling
23604 \labelwidthstring 00.00.0000
23607 svn propdel svn:needs-lock "<file-name>"
23610 \begin_layout Subsubsection
23611 \begin_inset CommandInset label
23613 name "subsec:VCS-Revision-Information"
23617 Revision Information in Documents
23620 \begin_layout Standard
23621 There are more possibilities how to activate revision information in our
23625 \begin_layout Itemize
23631 \begin_layout Itemize
23632 tree revision information (
23633 \begin_inset Flex Code
23636 \begin_layout Plain Layout
23643 The result is the output of the
23644 \begin_inset Flex Code
23647 \begin_layout Plain Layout
23653 command, the following table gives you an idea, how to read the results.
23656 \begin_layout Standard
23658 \begin_inset Tabular
23659 <lyxtabular version="3" rows="6" columns="2">
23660 <features tabularvalignment="middle">
23661 <column alignment="left" valignment="top">
23662 <column alignment="left" valignment="top">
23664 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
23667 \begin_layout Plain Layout
23675 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
23678 \begin_layout Plain Layout
23688 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
23691 \begin_layout Plain Layout
23697 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
23700 \begin_layout Plain Layout
23701 mixed revision working copy
23708 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
23711 \begin_layout Plain Layout
23717 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
23720 \begin_layout Plain Layout
23721 modified working copy
23728 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
23731 \begin_layout Plain Layout
23737 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
23740 \begin_layout Plain Layout
23741 switched working copy
23748 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
23751 \begin_layout Plain Layout
23757 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
23760 \begin_layout Plain Layout
23761 partial working copy, from a sparse checkout
23768 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
23771 \begin_layout Plain Layout
23777 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
23780 \begin_layout Plain Layout
23781 mixed revision, modified, switched working copy
23794 \begin_layout Itemize
23795 file revision information.
23796 The result comes from parsing the output of
23797 \begin_inset Flex Code
23800 \begin_layout Plain Layout
23802 \begin_inset space ~
23806 \begin_inset space ~
23810 \begin_inset space ~
23819 Supported flags are:
23823 \begin_layout Itemize
23824 version number of the last commit (
23825 \begin_inset Flex Code
23828 \begin_layout Plain Layout
23837 \begin_layout Itemize
23838 author of the last commit (
23839 \begin_inset Flex Code
23842 \begin_layout Plain Layout
23851 \begin_layout Itemize
23852 date of the last commit (
23853 \begin_inset Flex Code
23856 \begin_layout Plain Layout
23865 \begin_layout Itemize
23866 time of the last commit (
23867 \begin_inset Flex Code
23870 \begin_layout Plain Layout
23880 \begin_layout Standard
23881 You can obtain this info via InsetInfo (
23882 \change_inserted 5863208 1564400022
23885 Insert\SpecialChar menuseparator
23886 Field\SpecialChar menuseparator
23887 Version Control Revision
23888 \change_deleted 5863208 1564399852
23893 \begin_inset Flex Code
23896 \begin_layout Plain Layout
23897 info-insert buffer vcs-date
23905 The information will be available only when you have the file stored under
23906 svn managment (i.e.
23908 \begin_inset Flex Code
23911 \begin_layout Plain Layout
23917 directory is available with your document).
23921 \begin_layout Itemize
23922 Another—a hacking one—possibility is to use svn keywords
23926 \begin_layout Plain Layout
23927 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
23933 In short – you set file keywords property (e.g.
23936 svn propset svn:keywords 'Rev' file.lyx
23938 ) and then paste keyword \SpecialChar TeX
23943 \begin_layout Plain Layout
23944 This is an easy way how to ensure that \SpecialChar LyX
23945 won't break the line in the middle
23951 tag in your document (e.g.
23953 \begin_inset Flex Code
23956 \begin_layout Plain Layout
23963 This way svn client will automatically substitute revision number (e.g.
23965 \begin_inset Flex Code
23968 \begin_layout Plain Layout
23974 ) after each update and commit.
23975 There are more problems with this approach.
23976 Firstly, the '$' character is used in \SpecialChar TeX
23977 world for math equations, so any
23978 occurence of math formula
23979 \begin_inset Formula $Rev$
23983 \begin_inset Formula $Rev:59$
23986 in your \SpecialChar LyX
23988 Similarly for other keywords like Id, Date, Author, etc.
23989 Secondly svn output is dependent on your locales, so its very easy that
23990 svn would produce some problematic strings once Date is used.
23991 Thirdly you get the whole 'Rev: 59' string in your document instead of
23993 Until subversion implements user's custom keywords it will be hard to use
23994 this approach reliably or let \SpecialChar LyX
23995 to support it directly.
23998 \begin_layout Subsection
23999 SVN and Windows Environment
24002 \begin_layout Quote
24003 My inclination is to say that if the user cannot figure out the command
24004 line operations on their own fairly quickly, they would be well advised
24005 to use TortoiseSVN.
24011 \begin_layout Subsubsection
24015 \begin_layout Standard
24016 In addition to installing \SpecialChar LyX
24017 , and having access to a Subversion repository,
24018 the user will need to install the Subversion client program.
24019 A Windows installer for the client program is available from
24020 \begin_inset CommandInset href
24023 target "http://www.collab.net/nonav/downloads/subversion/"
24029 The user may also want to install
24030 \begin_inset CommandInset href
24033 target "http://tortoisesvn.tigris.org/"
24038 , which integrates Subversion operations into the context (rightclick) menu
24039 of Windows Explorer.
24040 Operations done outside \SpecialChar LyX
24041 will typically be more convenient using the Explorer
24043 Note that TortoiseSVN is not a replacement for the client program, which
24044 is what \SpecialChar LyX
24048 \begin_layout Subsubsection
24049 Bringing a document under Subversion control
24052 \begin_layout Standard
24053 Before a \SpecialChar LyX
24054 document can be brought under version control in Subversion, its
24055 parent directory needs to be under version control.
24056 If the document is being added to a project already in the repository,
24057 this is accomplished by checking the project out to the directory where
24058 the new document will be placed.
24059 If the project itself is not yet under version control (for instance, if
24060 this document starts a new project), the directory must be imported into
24062 This is done outside \SpecialChar LyX
24064 Both import and checkout are easily accomplished from the Explorer context
24065 menu using TortoiseSVN, or alternatively can be done using the command
24066 line client at a DOS prompt.
24067 The procedure for importing the project using TortoiseSVN is described
24068 below, assuming an existing repository and a new project being started
24076 For information on using the Subversion client program, run
24083 \begin_layout Enumerate
24090 in Windows Explorer, right click it, and select
24092 TortoiseSVN\SpecialChar menuseparator
24096 If necessary, adjust the URL for the repository, then click OK.
24099 \begin_layout Enumerate
24100 Right click the level of the repository under which you want to place the
24101 new project folder (typically the top level) and click
24105 Supply a name for the project folder and click OK.
24106 Add a message for the log file if desired, then click OK again.
24107 The new project folder should appear in the repository.
24108 Finally, click OK again to exit the repository browser.
24111 \begin_layout Enumerate
24112 Once again right click
24118 , this time selecting SVN Checkout\SpecialChar ldots
24119 Select the URL of the project folder
24120 you just created in the repository, and set the checkout directory to
24128 You will be warned about a non-empty folder; click OK to proceed.
24129 You should now have a
24140 \begin_layout Enumerate
24141 Create or open your document in \SpecialChar LyX
24144 File\SpecialChar menuseparator
24146 \begin_inset space ~
24149 Control\SpecialChar menuseparator
24153 Add a log message and click OK to commit the document to version control.
24156 \begin_layout Standard
24157 From this point onward, you should have full functionality in the
24159 File\SpecialChar menuseparator
24161 \begin_inset space ~
24167 You also have the option of checking the document in and out, viewing its
24169 using the TortoiseSVN context menu in Windows Explorer or the Subversion
24170 client program from a command prompt.
24173 \begin_layout Subsubsection
24174 SSH tunnel used with SVN under Windows
24177 \begin_layout Standard
24178 Compared with Linux setting up an svn client to communicate over ssh under
24179 Windows is a rather troublesome task.
24180 We will at least offer some hints how to setup the client side but prior
24181 knowledge about ssh and the Windows command line is needed, also be prepared
24182 for a great deal of frustration\SpecialChar ldots
24186 \begin_layout Enumerate
24187 Get an svn client for windows, as described in the previous sections.
24188 When it is a fresh install run some svn command (e.g.
24190 \begin_inset Flex Code
24193 \begin_layout Plain Layout
24199 ) to create config files, which you will need to change later on.
24202 \begin_layout Enumerate
24203 Choose an ssh client for Windows.
24204 There are several possibilities, we will use the one from Putty tools
24208 \begin_layout Plain Layout
24209 \begin_inset Flex URL
24212 \begin_layout Plain Layout
24214 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
24225 You will need to set the connection up so that the client doesn't ask for
24226 any password from you.
24227 To keep things easy we will use only keys without any additional password
24232 \begin_layout Enumerate
24234 \begin_inset Flex Code
24237 \begin_layout Plain Layout
24244 Save your private .ppk key file and put the public one on the server side.
24245 If the SVN server runs on Linux, note that the format of the public key
24246 is not compatible with Linux openssh and you will need to direcly copy-paste
24248 \begin_inset Quotes eld
24253 Public key for pasting into OpenSSH authorized_keys file
24256 \begin_inset Quotes erd
24259 edit field into the server's
24260 \begin_inset Flex Code
24263 \begin_layout Plain Layout
24264 ~/.ssh/authorized_keys
24270 \begin_inset Flex Code
24273 \begin_layout Plain Layout
24282 \begin_layout Enumerate
24284 \begin_inset Flex Code
24287 \begin_layout Plain Layout
24294 In the SVN config file
24298 \begin_layout Plain Layout
24299 Exact path depends on Windows version, usually somewhere around
24300 \begin_inset Flex Code
24303 \begin_layout Plain Layout
24306 Documents and Settings
24320 \begin_inset Flex Code
24323 \begin_layout Plain Layout
24338 , section [tunnels], setup ssh command, e.g.
24340 \begin_inset Flex Code
24343 \begin_layout Plain Layout
24344 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
24353 \begin_layout Plain Layout
24354 It will usually take a lot of time to get exact command right and it depends
24356 For example do not have some remote server saved as a default session in
24358 If things fail, try to connect via plink without SVN first.
24367 \begin_layout Enumerate
24368 Checkout the SVN archive, e.
24369 \begin_inset space \thinspace{}
24373 \begin_inset Newline newline
24377 \begin_inset Flex Code
24380 \begin_layout Plain Layout
24381 svn co svn+ssh://user@server/repository_path
24389 \begin_layout Subsubsection
24390 End-of-Line Conversions
24393 \begin_layout Standard
24394 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
24396 use different line endings inside the .lyx files.
24397 This is not a problem as far as \SpecialChar LyX
24398 functionality is concerned, but the commit
24399 diffs will be huge and merge-conflicts prone.
24400 Fortunately SVN itself knows
24404 \begin_layout Plain Layout
24405 \begin_inset Flex URL
24408 \begin_layout Plain Layout
24410 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
24420 how to deal with CR/LF problems when switching .lyx files to the
24421 \begin_inset Flex Code
24424 \begin_layout Plain Layout
24434 \begin_layout Plain Layout
24436 \begin_inset Flex Code
24439 \begin_layout Plain Layout
24440 svn propset svn:eol-style native FILE_NAME
24453 \begin_layout Subsection
24454 GIT commands in \SpecialChar LyX
24458 \begin_layout Standard
24459 A minimal subset of GIT commands is now supported by \SpecialChar LyX
24461 You can find the commands in the
24463 File\SpecialChar menuseparator
24465 \begin_inset space ~
24471 Please note that if you use password protected access to repository via
24472 ssh, you will be asked in terminal window.
24474 was tested against GIT 1.7.
24478 \begin_layout Plain Layout
24479 Windows users please note that you need to ensure that git is on the path.
24480 This can be set from within \SpecialChar LyX
24483 Tools\SpecialChar menuseparator
24484 Preferences\SpecialChar menuseparator
24485 Paths\SpecialChar menuseparator
24496 \begin_layout Standard
24497 One big difference of GIT and the other supported version control systems
24498 is the distributed nature of GIT: With traditional version control systems
24499 there is one central server which hosts the repository.
24500 Users commit their changes to the server, and get updates made by other
24502 With GIT, users commit to a local repository.
24503 The local repository can be synchronized with one or more remote repositories
24505 \begin_inset Flex Code
24508 \begin_layout Plain Layout
24515 \begin_inset Flex Code
24518 \begin_layout Plain Layout
24526 does not interact in any way with remote GIT repositories.
24527 It works exclusively with the local repository in a very similar way as
24528 with a central CVS or SVN repository.
24529 If you use remote GIT repositories you need to do the
24530 \begin_inset Flex Code
24533 \begin_layout Plain Layout
24540 \begin_inset Flex Code
24543 \begin_layout Plain Layout
24549 operations with your favourite GIT client.
24552 \begin_layout Subsubsection
24558 \begin_layout Standard
24559 If your document is not under revision control, this is the only item shown
24561 And if it is under revision control, the
24565 item is not visible.
24568 \begin_layout Standard
24569 This command registers in GIT your document ONLY in case you have already
24570 the documents directory under GIT control (in particular
24575 This means you have to checkout the archive by yourself.
24578 \begin_layout Standard
24579 Then you are asked interactively to supply an initial description of the
24581 Don't forget that registered file is not yet committed.
24584 \begin_layout Standard
24585 GIT command that is run:
24588 \begin_inset Quotes qld
24592 \begin_inset Quotes qld
24598 \begin_layout Standard
24603 to understand the switches.
24606 \begin_layout Subsubsection
24612 \begin_layout Standard
24613 When you are finished editing a file, you commit your changes.
24614 When you do this, you are asked for a description of the changes.
24615 After that changes are committed.
24618 \begin_layout Standard
24621 git commit -q -m"<description>" <file-name>
24624 \begin_layout Subsubsection
24627 Revert To Repository Version
24630 \begin_layout Standard
24631 This will discard all changes made to the document since the last check
24633 You get a warning before changes are discarded.
24636 \begin_layout Standard
24640 \begin_inset Quotes qld
24644 \begin_inset Quotes qld
24650 \begin_layout Subsubsection
24656 \begin_layout Standard
24657 This will rename the current document including the version history.
24658 It requires a clean document without any changes since the last checkin.
24659 You are asked for a file name and a description of the rename operation.
24660 After that the document is renamed, both locally and in the repository.
24661 If the parent directories of the new and old file names differ, all relative
24662 paths of included files are adjusted (like in
24664 File\SpecialChar menuseparator
24669 Finally, the document is reloaded using the new name.
24672 \begin_layout Labeling
24673 \labelwidthstring 00.00.0000
24675 \begin_inset space ~
24679 \begin_inset space ~
24683 \begin_inset Newline newline
24687 \begin_inset Flex Code
24690 \begin_layout Plain Layout
24694 \begin_inset Quotes qld
24698 \begin_inset Quotes qld
24702 \begin_inset Quotes qld
24706 \begin_inset Quotes qld
24715 \begin_inset Newline newline
24719 \begin_inset Flex Code
24722 \begin_layout Plain Layout
24731 \begin_layout Subsubsection
24737 \begin_layout Standard
24738 This shows the complete history of the GIT document.
24742 \begin_inset Quotes qld
24746 \begin_inset Quotes qld
24751 is shown in a browser.
24754 \begin_layout Subsubsection
24758 \begin_layout Standard
24760 supports GIT hash number of the last commit to the file,
24761 \change_inserted 1119979965 1564297456
24762 its abbreviated form,
24764 author name, date and time of last commit.
24765 All those are extracted from
24767 git log -n 1 --pretty=format:%H%n
24768 \change_inserted 1119979965 1564297427
24774 Tree version information is obtained via
24776 git describe --abbrev --dirty --long
24780 \begin_inset CommandInset ref
24782 reference "subsec:VCS-Revision-Information"
24789 \begin_layout Subsection
24793 \begin_layout Standard
24794 With the recent addition of the
24795 \begin_inset Flex Code
24798 \begin_layout Plain Layout
24804 function \SpecialChar LyX
24805 power users are allowed to create their own commands for revision
24809 \begin_layout Standard
24810 As an example you can see how two TortoiseSVN commands could be integrated
24814 \begin_layout Description
24816 \begin_inset Flex Code
24819 \begin_layout Plain Layout
24820 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
24828 \begin_layout Description
24830 \begin_inset Flex Code
24833 \begin_layout Plain Layout
24834 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
24842 \begin_layout Subsection
24843 Version control and Document comparison
24846 \begin_layout Standard
24847 One of the typical uses of version control is to inspect the changes between
24848 revisions, usually by creating
24849 \begin_inset Flex Code
24852 \begin_layout Plain Layout
24859 While this is useful for plain text files, it is much less useful in the
24860 case of \SpecialChar LyX
24861 files, which have more a complicated structure.
24862 Hence we provide binding to the Document comparison feature.
24863 There are two ways of calling this feature – either by direct call of
24864 \begin_inset Flex Code
24867 \begin_layout Plain Layout
24874 function (for details see \SpecialChar LyX
24875 functions manual) or by the toolbar icon
24888 One can either compare two chosen revisions of the document or he can simply
24889 compare the current version of edited text with older revisions (where
24891 \begin_inset Flex Noun
24894 \begin_layout Plain Layout
24900 ' revisions back means comparison of the edited file with last commited
24905 \begin_layout Standard
24906 This feature is supported for SVN and RCS though due to the more complicated
24907 versioning scheme of RCS there is a constraint – when addressing the revisions
24908 in dialog, numbers always point to the last number in RCS revision number,
24911 We don't currently support GIT addressing of revisions, one can just compare
24912 edited document with its revision X steps backs, where X is addressed as
24914 \begin_inset Flex Code
24917 \begin_layout Plain Layout
24926 \begin_layout Section
24927 Literate Programming
24930 \begin_layout Standard
24935 (kayvan@sylvan.com)
24939 original documentation written by
24941 Edmar Wienskoski Jr.
24944 (edmar-w-jr@technologist.com)
24947 \begin_layout Subsection
24951 \begin_layout Standard
24952 The main purpose of this documentation is to show you how to use \SpecialChar LyX
24954 programming, where it is assumed that you are familiar with this programming
24955 technique, and know what
24956 \begin_inset Quotes eld
24960 \begin_inset Quotes erd
24964 \begin_inset Quotes eld
24968 \begin_inset Quotes erd
24972 If that is not the case, please follow the web links provided in the following
24974 There is a lot of good documentation out there covering old development
24975 history to the latest tools tips.
24978 \begin_layout Standard
24979 It is also assumed that you are familiar with \SpecialChar LyX
24980 itself to a point that you
24981 are comfortable changing your \SpecialChar LyX
24982 preferences, and X resources file.
24983 If that is not the case please refer to other \SpecialChar LyX
24984 documentation to cover your
24988 \begin_layout Subsection
24989 Literate Programming
24992 \begin_layout Standard
24993 From the Literate Programming FAQ:
24996 \begin_layout Quotation
24997 Literate programming is the combination of documentation and source together
24998 in a fashion suited for reading by human beings.
24999 In fact, literate programs should be enjoyable reading, even inviting!
25000 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
25001 and documentation in a single file.
25002 Literate programming tools then parse the file to produce either readable
25003 documentation or compilable source.
25004 The WEB style of literate programming was created by D.
25005 \begin_inset space \thinspace{}
25009 Knuth during the development of his \SpecialChar TeX
25010 typesetting software.
25014 \begin_layout Standard
25015 Another excerpt says:
25018 \begin_layout Quotation
25021 How is literate programming different from verbose commenting?
25024 \begin_layout Quotation
25025 There are three distinguishing characteristics.
25026 In order of importance, they are:
25030 \begin_layout Itemize
25031 flexible order of elaboration
25034 \begin_layout Itemize
25035 automatic support for browsing
25038 \begin_layout Itemize
25039 typeset documentation, especially diagrams and mathematics
25043 \begin_layout Standard
25044 Now that I sparked your curiosity, take a look in the references.
25047 \begin_layout Subsubsection
25051 \begin_layout Standard
25052 The complete Literate Programming FAQ can be found at:
25055 \begin_layout Quote
25056 Literate Programming FAQ
25057 \begin_inset Flex URL
25060 \begin_layout Plain Layout
25062 http://www.literateprogramming.com/lpfaq.pdf
25070 \begin_layout Standard
25071 The FAQ lists 23 (twenty three!) different literate programming tools.
25072 Where some are specialized or
25073 \begin_inset Quotes eld
25077 \begin_inset Quotes erd
25080 for particular programming languages, while other have general scope.
25085 for my own use for several reasons:
25088 \begin_layout Itemize
25089 It can generate the documentation either in \SpecialChar LaTeX
25093 \begin_layout Itemize
25094 It has a open architecture, i.
25095 \begin_inset space \thinspace{}
25099 \begin_inset space \space{}
25102 it is easy to plug in new filters
25106 \begin_layout Plain Layout
25111 are programs that read a given data stream and output a manipulated data
25113 That way, a WEB file (consisting of literate code) can be turned into a
25114 file consisting only of C program code or \SpecialChar LaTeX
25120 and to perform special processing that you may need.
25124 \begin_layout Itemize
25125 There is a good selection of filters available already (the HTML is one
25129 \begin_layout Itemize
25133 \begin_layout Standard
25134 The Noweb web page can be found at:
25137 \begin_layout Quote
25139 \begin_inset Flex URL
25142 \begin_layout Plain Layout
25144 https://www.cs.tufts.edu/~nr/noweb/
25152 \begin_layout Standard
25153 Starting from there you can reach many other interesting links and even
25154 some literate program examples.
25157 \begin_layout Subsection
25159 and Literate Programming with Noweb
25162 \begin_layout Standard
25163 The \SpecialChar LyX
25164 support for Literate Programming is provided by using the generic \SpecialChar LyX
25166 converters mechanism.
25167 This support is provided in a
25168 \begin_inset Quotes eld
25172 \begin_inset Quotes erd
25176 \begin_inset space \thinspace{}
25180 \begin_inset space \space{}
25183 you will be able to use this new \SpecialChar LyX
25184 feature with some other literate programming
25185 tool of your choice by just changing your \SpecialChar LyX
25189 \begin_layout Subsubsection
25190 Generating documents and code (weaving and tangling)
25193 \begin_layout Paragraph
25194 Using the noweb module
25197 \begin_layout Standard
25198 If you have installed Noweb and \SpecialChar LyX
25199 successfully, whenever you open a new document,
25200 after you have chosen its document class, use the
25202 Document\SpecialChar menuseparator
25206 \begin_inset Quotes eld
25210 \begin_inset Quotes erd
25214 If Noweb is correctly installed, when you click on the
25215 \begin_inset Quotes eld
25219 \begin_inset Quotes erd
25222 link, you will see the
25223 \begin_inset Quotes eld
25227 \begin_inset Quotes erd
25230 module in the available list and you can add it to your document.
25233 \begin_layout Paragraph
25237 \begin_layout Standard
25239 enables you to write code with a custom inset named
25240 \begin_inset Flex Noun
25243 \begin_layout Plain Layout
25250 Noweb delimits chunks like this:
25253 \begin_layout LyX-Code
25257 \begin_layout LyX-Code
25261 \begin_layout LyX-Code
25265 \begin_layout LyX-Code
25269 \begin_layout LyX-Code
25273 \begin_layout Standard
25274 The problem is that whatever is written in between the << and the
25278 must be taken literally, i.
25279 \begin_inset space \thinspace{}
25283 \begin_inset space \space{}
25287 should be prevented from making any special interpretation of what has
25289 This is also handled by
25290 \begin_inset Flex Noun
25293 \begin_layout Plain Layout
25299 , that works like a normal text inset but has a free spacing capability.
25302 \begin_layout Standard
25303 As a special note, you can also use the
25304 \begin_inset Quotes eld
25308 \begin_inset Quotes erd
25311 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
25315 \begin_layout LyX-Code
25319 \begin_layout LyX-Code
25320 def some_function(args):
25323 \begin_layout LyX-Code
25324 "This is the doc string for this function."
25327 \begin_layout LyX-Code
25328 print "My args: ", args
25331 \begin_layout LyX-Code
25332 @ %def some_function
25335 \begin_layout Standard
25336 For an example of this usage and the resulting cross-reference output, look
25337 at the Literate python program in
25339 LIBDIR/examples/listerrors.lyx
25341 which should make this all clear.
25344 \begin_layout Paragraph
25345 Generating the documentation
25348 \begin_layout Standard
25349 At this point you already have a new document file with a proper document
25350 class, and with some code and text on it.
25351 How do I print it? The answer is simple, you select
25353 View\SpecialChar menuseparator
25357 Just like you would do for a plain document.
25358 No special procedure is required.
25361 \begin_layout Standard
25362 To help orientate you, I will now explain what happens inside \SpecialChar LyX
25366 \begin_layout Enumerate
25369 Update\SpecialChar menuseparator
25372 menu option is chosen, a \SpecialChar LaTeX
25378 \begin_layout Standard
25379 If the document is of any literate class the generated file will be named
25380 with an extension name defined by the
25381 \begin_inset Quotes eld
25385 \begin_inset Quotes erd
25388 format (defined in the Preferences panel), otherwise the file will have
25397 \begin_layout Enumerate
25398 Note that the only difference so far is in the name of the file, no special
25399 processing is required by \SpecialChar LyX
25401 Given that you formatted the code using the
25402 \begin_inset Flex Noun
25405 \begin_layout Plain Layout
25411 inset that, by itself, takes care of the business.
25414 \begin_layout Enumerate
25415 If the document is of any literate class \SpecialChar LyX
25416 will then use the internal \SpecialChar LyX
25418 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
25423 \begin_layout Plain Layout
25424 The converters are defined in the
25426 Tools\SpecialChar menuseparator
25430 \begin_inset Quotes eld
25434 \begin_inset Quotes erd
25446 manual for general information about converters.
25451 to generate the \SpecialChar LaTeX
25456 \begin_layout Standard
25457 Otherwise it will just skip this step.
25461 \begin_layout Enumerate
25462 Finally, \SpecialChar LaTeX
25463 is invoked and the regular post processing continues as in a plain
25467 \begin_layout Standard
25468 Independence from a particular
25469 \begin_inset Quotes eld
25473 \begin_inset Quotes erd
25476 is easily achieved by changing the commands that are run by the various
25480 \begin_layout Paragraph
25481 Generating the code
25484 \begin_layout Standard
25485 When the build menu option is chosen or the corresponding button in the
25486 toolbar is pressed, a \SpecialChar LaTeX
25487 file is generated just like step 1 above.
25488 Next, \SpecialChar LyX
25494 This converter needs to be defined by the user and is not installed by
25495 default, though the Program format is.
25496 This converter (like any other converter) will have two parts:
25499 \begin_layout Enumerate
25500 The converter program itself.
25501 This program performs the conversion from the one format to the other (in
25502 this case, from the Noweb format to the Program pseudo-format).
25505 \begin_layout Enumerate
25506 The error log parser.
25507 This is a program whose sole purpose is to rewrite error messages in a
25508 format that \SpecialChar LyX
25510 This makes it possible for \SpecialChar LyX
25511 to place error boxes in the right places in
25515 \begin_layout Standard
25516 The first part, the
25517 \begin_inset Quotes eld
25521 \begin_inset Quotes erd
25524 setting, should be set to
25527 \begin_layout LyX-Code
25535 \begin_layout Standard
25536 This basically means that \SpecialChar LyX
25538 \begin_inset Quotes eld
25542 \begin_inset Quotes erd
25545 (a program or script) with the name of the Noweb file (normally a file
25546 in the \SpecialChar LyX
25547 temp directory) and the directory path of the original \SpecialChar LyX
25552 \begin_layout Standard
25553 This is an implementation of
25554 \begin_inset Quotes eld
25558 \begin_inset Quotes erd
25561 that you can place in a directory on your path:
25564 \begin_layout LyX-Code
25570 \begin_layout LyX-Code
25576 \begin_layout LyX-Code
25579 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
25582 \begin_layout Standard
25583 The next part of the converter setting is the
25584 \begin_inset Quotes eld
25588 \begin_inset Quotes erd
25591 which is to be set to
25594 \begin_layout LyX-Code
25597 parselog=$$s/scripts/listerrors
25600 \begin_layout Standard
25601 This will run any errors that are generated by the
25602 \begin_inset Quotes eld
25606 \begin_inset Quotes erd
25609 process through the
25610 \begin_inset Quotes eld
25614 \begin_inset Quotes erd
25620 \begin_layout Standard
25621 The build will normally take place in \SpecialChar LyX
25622 's temporary directory, so the files
25623 produced by the conversion will be in that directory.
25625 will copy out what it regards as the `main' file, but the
25629 conversion may produce several files, and so most of these would then be
25630 deleted when \SpecialChar LyX
25632 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
25633 the build-script chunk can place the generated files in that location.
25636 \begin_layout Paragraph
25637 Build instructions in the document
25640 \begin_layout Standard
25641 The last piece of the integration between \SpecialChar LyX
25643 \begin_inset Quotes eld
25647 \begin_inset Quotes erd
25651 Generally, the instructions for building your program should be embedded
25652 in a chunk of its own.
25654 \begin_inset Quotes eld
25658 \begin_inset Quotes erd
25661 above uses the notangle command to look for this chunk (called
25662 \begin_inset Quotes eld
25666 \begin_inset Quotes erd
25669 ) and runs its contents through
25670 \begin_inset Quotes eld
25674 \begin_inset Quotes erd
25680 \begin_layout Standard
25681 Typically, such a chunk would look something like this:
25684 \begin_layout LyX-Code
25688 \begin_layout LyX-Code
25690 \begin_inset Newline newline
25693 if [ -z "${NOWEB_SOURCE}" ]
25694 \begin_inset Newline newline
25700 \begin_layout LyX-Code
25701 NOWEB_SOURCE=myfile.nw
25702 \begin_inset Newline newline
25706 \begin_inset Newline newline
25710 code to extract files ...
25711 use NOWEB_OUTPUT_DIR here ...]
25712 \begin_inset Newline newline
25716 code to compile files ...]
25717 \begin_inset Newline newline
25723 \begin_layout Standard
25726 LIBDIR/examples/listerrors.lyx
25730 LIBDIR/examples/Literate.lyx
25732 which implement two versions of the
25733 \begin_inset Quotes eld
25737 \begin_inset Quotes erd
25740 program for some illustrations of how all of these pieces go together or
25743 LIBDIR/examples/noweb2lyx.lyx.
25746 Interestingly, these three files show off the language-indepence of the
25748 literate programming support since they are written in Python, C and Perl
25752 \begin_layout Subsubsection
25753 Configuring \SpecialChar LyX
25757 \begin_layout Standard
25758 All the Literate Programming support is configured by the
25760 Tools\SpecialChar menuseparator
25764 \begin_inset Quotes eld
25768 \begin_inset Quotes erd
25772 The important parts are:
25775 \begin_layout Description
25777 \begin_inset space ~
25781 \begin_inset Quotes eld
25785 \begin_inset Quotes erd
25789 \begin_inset space ~
25792 format Set up via the File Formats tab, this is where the Noweb-specific
25802 , the file extension is set to
25807 This tells \SpecialChar LyX
25808 to create a file with a
25812 extension in the first step of the conversion process.
25815 \begin_layout Description
25817 \begin_inset space ~
25825 \begin_inset space ~
25828 format This is an empty format whose sole purpose is to be the endpoint
25829 of a conversion (which then allows us to set up a converter for it).
25832 \begin_layout Description
25842 This converter performs the
25843 \begin_inset Quotes eld
25847 \begin_inset Quotes erd
25850 of the literate document.
25851 For Noweb, it is set to
25852 \begin_inset Quotes eld
25857 noweave -delay -index $$i > $$o
25860 \begin_inset Quotes erd
25866 \begin_layout Description
25876 \begin_inset Quotes eld
25880 \begin_inset Quotes erd
25884 As stated above, the Converter is set to
25885 \begin_inset Quotes eld
25893 \begin_inset Quotes erd
25896 , with Flags set to
25897 \begin_inset Newline newline
25901 \begin_inset Quotes eld
25906 parselog=$$s/scripts/listerrors
25909 \begin_inset Quotes erd
25915 \begin_layout Subsubsection
25919 \begin_layout Standard
25920 There is also a new function implemented in the \SpecialChar LyX
25922 \begin_inset Quotes eld
25925 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
25929 \begin_layout Standard
25930 When debugging code with ddd/gdb, it is possible to invoke a text editor
25931 at the current execution position with a single key stroke.
25932 The default ddd configuration for that is shift-ctrl-V.
25933 It happens that you can define the editor command line invocation in ddd
25936 Edit\SpecialChar menuseparator
25937 Preferences\SpecialChar menuseparator
25940 dialog and changing the "Edit Sources" entry.
25943 \begin_layout Standard
25944 I take advantage of the newly created \SpecialChar LyX
25945 server function and this ddd feature,
25947 \begin_inset Quotes eld
25951 \begin_inset Quotes erd
25957 \begin_layout LyX-Code
25958 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
25961 \begin_layout Standard
25962 With this, whenever you are using ddd and find a point in the program that
25963 you want to edit, you just press shift-ctrl-V (in the ddd window), and
25964 ddd will forward this information to \SpecialChar LyX
25965 through the \SpecialChar LyX
25966 server and then the
25968 window will show the same file with the cursor at the same position ddd
25970 No more guessing or long scrolling to locate a point in the program back
25974 \begin_layout Standard
25975 Note however that you must enable the \SpecialChar LyX
25976 server to get this feature working
25977 (it is disabled by default).
25979 \begin_inset space ~
25983 \begin_inset CommandInset ref
25985 reference "sec:Starting-the-Server"
25989 explains how to do that.
25992 \begin_layout Subsubsection
25996 \begin_layout Standard
25997 There are six new buttons that can be added to your \SpecialChar LyX
25999 Four of these buttons are short cuts to layout styles:
26017 , one for the custom inset
26022 The last one is a short cut to the
26023 \begin_inset Quotes eld
26027 \begin_inset Quotes erd
26034 \begin_layout Standard
26036 has a range of buttons that are available for tool bar customization.
26037 In my toolbar I like to combine the six short cuts above with two more:
26042 \SpecialChar menuseparator
26047 \SpecialChar menuseparator
26054 Document\SpecialChar menuseparator
26055 View\SpecialChar menuseparator
26059 Here is how it looks like:
26062 \begin_layout LyX-Code
26066 \begin_layout LyX-Code
26070 \begin_layout LyX-Code
26071 Icon "layout Standard"
26074 \begin_layout LyX-Code
26075 Icon "layout Section"
26078 \begin_layout LyX-Code
26079 Icon "layout \SpecialChar LaTeX
26083 \begin_layout LyX-Code
26084 Icon "layout \SpecialChar LyX
26088 \begin_layout LyX-Code
26089 Icon "flex.insert Chunk"
26092 \begin_layout LyX-Code
26096 \begin_layout LyX-Code
26100 \begin_layout LyX-Code
26101 Icon "buffer-typeset"
26104 \begin_layout LyX-Code
26105 Icon "build-program"
26108 \begin_layout LyX-Code
26112 \begin_layout LyX-Code
26116 \begin_layout LyX-Code
26120 \begin_layout LyX-Code
26124 \begin_layout LyX-Code
26128 \begin_layout Subsubsection
26129 Colors customization
26132 \begin_layout Standard
26133 There are a number of colors in \SpecialChar LyX
26134 that can be customized in
26139 One of the things that bothers people is the \SpecialChar LaTeX
26141 The default color is red, since the chunks uses \SpecialChar LaTeX
26142 font, and there is a lot
26143 of chunks in literate documents, you may get tired of seeing everything
26145 You can change it by going to the tabs
26154 \begin_layout Standard
26155 The next thing is the visible presence of the newline character in the screen.
26156 You can choose the color of this particular character and make it blend
26158 I recommend you choosing a color that is close to the background but not
26159 equal, that way you still can see it is there, but it is not bothering
26163 \begin_layout Subsection
26168 \begin_layout Standard
26177 is documented in the
26181 example file and in the Sweave manual (menu
26183 Help\SpecialChar menuseparator
26189 \begin_layout Chapter
26193 \begin_layout Standard
26194 You can do everything with \SpecialChar LyX
26195 that you can do with \SpecialChar LaTeX
26197 However, \SpecialChar LyX
26198 cannot support every \SpecialChar LaTeX
26200 But you can always use \SpecialChar TeX
26202 This chapter shows you some more special things you might want to use.
26203 For other special things you can do with figures, tables, floats, boxes
26204 and notes, have a look at the
26207 \begin_inset space ~
26215 \begin_layout Section
26216 Multiple Text Columns
26219 \begin_layout Standard
26220 This feature is independent of the option
26222 Two-column document
26224 in the document settings under
26229 If you want to have 2
26230 \begin_inset space ~
26233 columns for the whole document, it is recommended to use the
26235 Two-column document
26238 For all other cases use this feature.
26241 \begin_layout Standard
26242 To use multiple text columns in your document, you have to load the module
26249 Document\SpecialChar menuseparator
26250 Settings\SpecialChar menuseparator
26253 ) and must have the \SpecialChar LaTeX
26255 \begin_inset Flex Code
26258 \begin_layout Plain Layout
26267 \begin_layout Standard
26268 Footnotes within multiple columns will be placed at the bottom of the page
26269 and not under each column.
26270 Within the different columns you can use everything, with the limitation
26271 that for floats you need to use the float option
26278 \begin_layout Subsection
26282 \begin_layout Standard
26283 If you want to have 2
26284 \begin_inset space ~
26287 columns in your text, insert a multicolumn inset via the menu
26289 Insert\SpecialChar menuseparator
26291 \begin_inset space ~
26294 Insets\SpecialChar menuseparator
26296 \begin_inset space ~
26301 where the columns should start.
26302 Write all text that should be printed in 2
26303 \begin_inset space ~
26306 columns into this inset.
26309 \begin_layout Standard
26310 Here is an example:
26313 \begin_layout Standard
26315 \begin_inset Flex Multiple Columns
26318 \begin_layout Plain Layout
26323 The Adventure of the Empty House
26326 \begin_inset Newline newline
26329 by Sir Arthur Conan Doyle
26332 \begin_layout Plain Layout
26335 It was in the spring of the year 1894 that all London was interested, and
26336 the fashionable world dismayed, by the murder of the Honourable Ronald
26337 Adair under most unusual and inexplicable circumstances.
26338 The public has already learned those particulars of the crime which came
26339 out in the police investigation, but a good deal was suppressed upon that
26340 occasion, since the case for the prosecution was so overwhelmingly strong
26341 that it was not necessary to bring forward all the facts.
26342 Only now, at the end of nearly ten years, am I allowed to supply those
26343 missing links which make up the whole of that remarkable chain.
26344 The crime was of interest in itself, but that interest was as nothing to
26345 me compared to the inconceivable sequel, which afforded me the greatest
26346 shock and surprise of any event in my adventurous life.
26347 Even now, after this long interval, I find myself thrilling as I think
26348 of it, and feeling once more that sudden flood of joy, amazement, and increduli
26349 ty which utterly submerged my mind.
26350 Let me say to that public, which has shown some interest in those glimpses
26351 which I have occasionally given them of the thoughts and actions of a very
26352 remarkable man, that they are not to blame me if I have not shared my knowledge
26353 with them, for I should have considered it my first duty to do so, had
26354 I not been barred by a positive prohibition from his own lips, which was
26355 only withdrawn upon the third of last month.
26363 \begin_layout Standard
26364 To get 3 or more columns, set the cursor into the multicolumn inset and
26367 Insert\SpecialChar menuseparator
26369 \begin_inset space ~
26373 \begin_inset space ~
26379 The number of the desired columns is written into that inset (for 3
26380 \begin_inset space ~
26384 \begin_inset Quotes eld
26388 \begin_inset Quotes erd
26392 \begin_inset Newline newline
26395 Here is an example with 3
26396 \begin_inset space ~
26402 \begin_layout Standard
26403 \begin_inset Flex Multiple Columns
26406 \begin_layout Plain Layout
26409 \begin_inset Argument 1
26412 \begin_layout Plain Layout
26419 It can be imagined that my close intimacy with Sherlock Holmes had interested
26420 me deeply in crime, and that after his disappearance I never failed to
26421 read with care the various problems which came before the public.
26422 And I even attempted, more than once, for my own private satisfaction,
26423 to employ his methods in their solution, though with indifferent success.
26424 There was none, however, which appealed to me like this tragedy of Ronald
26426 As I read the evidence at the inquest, which led up to a verdict of willful
26427 murder against some person or persons unknown, I realized more clearly
26428 than I had ever done the loss which the community had sustained by the
26429 death of Sherlock Holmes.
26430 There were points about this strange business which would, I was sure,
26431 have specially appealed to him, and the efforts of the police would have
26432 been supplemented, or more probably anticipated, by the trained observation
26433 and the alert mind of the first criminal agent in Europe.
26434 All day, as I drove upon my round, I turned over the case in my mind and
26435 found no explanation which appeared to me to be adequate.
26436 At the risk of telling a twice-told tale, I will recapitulate the facts
26437 as they were known to the public at the conclusion of the inquest.
26445 \begin_layout Standard
26446 You can have up to 10
26447 \begin_inset space ~
26450 columns if you want to, but that might not be very pleasant for the readers
26454 \begin_layout Standard
26455 \begin_inset Newpage newpage
26461 \begin_layout Subsection
26462 Columns inside Columns
26465 \begin_layout Standard
26466 You can also have columns inside columns:
26469 \begin_layout Standard
26470 \begin_inset Flex Multiple Columns
26473 \begin_layout Plain Layout
26476 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
26477 at that time governor of one of the Australian colonies.
26478 Adair's mother had returned from Australia to undergo the operation for
26479 cataract, and she, her son Ronald, and her daughter Hilda were living together
26483 \begin_layout Plain Layout
26484 \begin_inset Flex Multiple Columns
26487 \begin_layout Plain Layout
26490 The youth moved in the best society
26491 \begin_inset space ~
26494 – had, so far as was known, no enemies and no particular vices.
26495 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
26496 had been broken off by mutual consent some months before, and there was
26497 no sign that it had left any very profound feeling behind it.
26498 For the rest {sic} the man's life moved in a narrow and conventional circle,
26499 for his habits were quiet and his nature unemotional.
26500 Yet it was upon this easy-going young aristocrat that death came, in most
26501 strange and unexpected form, between the hours of ten and eleven-twenty
26502 on the night of March 30, 1894.
26510 \begin_layout Plain Layout
26513 Ronald Adair was fond of cards
26514 \begin_inset space ~
26517 – playing continually, but never for such stakes as would hurt him.
26518 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
26519 It was shown that, after dinner on the day of his death, he had played
26520 a rubber of whist at the latter club.
26521 He had also played there in the afternoon.
26526 The evidence of those who had played with him
26527 \begin_inset space ~
26531 Murray, Sir John Hardy, and Colonel Moran
26532 \begin_inset space ~
26535 – showed that the game was whist, and that there was a fairly equal fall
26537 Adair might have lost five pounds, but not more.
26538 His fortune was a considerable one, and such a loss could not in any way
26540 He had played nearly every day at one club or other, but he was a cautious
26541 player, and usually rose a winner.
26542 It came out in evidence that, in partnership with Colonel Moran, he had
26543 actually won as much as four hundred and twenty pounds in a sitting, some
26544 weeks before, from Godfrey Milner and Lord Balmoral.
26545 So much for his recent history as it came out at the inquest.
26553 \begin_layout Subsection
26557 \begin_layout Standard
26558 The examples in this section show some more special features of multiple
26562 \begin_layout Standard
26563 For more features of multiple columns, have a look at the
26564 \begin_inset CommandInset href
26566 name "documentation"
26567 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
26572 of the \SpecialChar LaTeX
26574 \begin_inset Flex Code
26577 \begin_layout Plain Layout
26586 \begin_layout Subsubsection
26590 \begin_layout Standard
26591 To add a preface text for multiple columns, set the cursor into the multicolumn
26592 inset and use the menu
26594 Insert\SpecialChar menuseparator
26598 Write your preface text into that inset.
26599 \begin_inset Newline newline
26602 This is an example with some preface text:
26605 \begin_layout Standard
26606 \begin_inset VSpace bigskip
26612 \begin_layout Standard
26613 \begin_inset Flex Multiple Columns
26616 \begin_layout Plain Layout
26617 \begin_inset Argument 2
26620 \begin_layout Plain Layout
26621 And the story continues and continues and continues and continues\SpecialChar ldots
26629 On the evening of the crime, he returned from the club exactly at ten.
26630 His mother and sister were out spending the evening with a relation.
26631 The servant deposed that she heard him enter the front room on the second
26632 floor, generally used as his sitting-room.
26633 She had lit a fire there, and as it smoked she had opened the window.
26634 No sound was heard from the room until eleven-twenty, the hour of the return
26635 of Lady Maynooth and her daughter.
26636 Desiring to say good-night, she attempted to enter her son's room.
26637 The door was locked on the inside, and no answer could be got to their
26638 cries and knocking.
26639 Help was obtained, and the door forced.
26640 The unfortunate young man was found lying near the table.
26641 His head had been horribly mutilated by an expanding revolver bullet, but
26642 no weapon of any sort was to be found in the room.
26650 \begin_layout Standard
26651 You can also use a section heading as the preface if you use a section command
26652 as \SpecialChar TeX
26654 For example the command
26657 \begin_layout LyX-Code
26660 subsection{subsection title}
26663 \begin_layout Standard
26664 creates a subsection.
26665 In this example the preface is a subsubsection:
26668 \begin_layout Standard
26669 \begin_inset Flex Multiple Columns
26672 \begin_layout Plain Layout
26673 \begin_inset Argument 2
26676 \begin_layout Plain Layout
26680 \begin_layout Plain Layout
26689 This is a subsubsection heading as a preface
26693 \begin_layout Plain Layout
26707 A minute examination of the circumstances served only to make the case more
26709 In the first place, no reason could be given why the young man should have
26710 fastened the door upon the inside.
26711 There was the possibility that the murderer had done this, and had afterwards
26712 escaped by the window.
26713 The drop was at least twenty feet, however, and a bed of crocuses in full
26715 Neither the flowers nor the earth showed any sign of having been disturbed,
26716 nor were there any marks upon the narrow strip of grass which separated
26717 the house from the road.
26718 Apparently, therefore, it was the young man himself who had fastened the
26720 But how did he come by his death? No one could have climbed up to the window
26721 without leaving traces.
26722 Suppose a man had fired through the window, he would indeed be a remarkable
26723 shot who could with a revolver inflict so deadly a wound.
26724 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
26725 a hundred yards of the house.
26726 No one had heard a shot.
26734 \begin_layout Standard
26735 If there is less vertical space than 6
26736 \begin_inset space ~
26739 text lines is left on the page at the beginning of the multiple columns,
26740 a page break will be inserted before the multiple columns.
26741 Depending on the number of lines of the preface text, you might want to
26743 This is done by setting the cursor into the mulitcolumn inset behind the
26744 preface (if there is any) and using the menu
26746 Insert\SpecialChar menuseparator
26748 \begin_inset space ~
26752 \begin_inset space ~
26756 \begin_inset space ~
26762 Insert into that inset the amount of space like e.
26763 \begin_inset space \thinspace{}
26767 \begin_inset space \space{}
26771 \begin_inset Quotes eld
26775 \begin_inset Quotes erd
26779 \begin_inset Newline newline
26782 In this example the space is set to 7
26783 \begin_inset space ~
26786 text lines by using
26787 \begin_inset Flex Code
26790 \begin_layout Plain Layout
26799 \begin_inset Flex Code
26802 \begin_layout Plain Layout
26810 needs to be inserted as \SpecialChar TeX
26814 \begin_layout Standard
26815 \begin_inset Flex Multiple Columns
26818 \begin_layout Plain Layout
26819 \begin_inset Argument 3
26822 \begin_layout Plain Layout
26827 \begin_layout Plain Layout
26843 On the evening of the crime, he returned from the club exactly at ten.
26844 His mother and sister were out spending the evening with a relation.
26845 The servant deposed that she heard him enter the front room on the second
26846 floor, generally used as his sitting-room.
26847 She had lit a fire there, and as it smoked she had opened the window.
26848 No sound was heard from the room until eleven-twenty, the hour of the return
26849 of Lady Maynooth and her daughter.
26850 Desiring to say good-night, she attempted to enter her son's room.
26851 The door was locked on the inside, and no answer could be got to their
26852 cries and knocking.
26853 Help was obtained, and the door forced.
26854 The unfortunate young man was found lying near the table.
26855 His head had been horribly mutilated by an expanding revolver bullet, but
26856 no weapon of any sort was to be found in the room.
26864 \begin_layout Subsubsection
26868 \begin_layout Standard
26869 The amount of space before and after multiple columns can be changed by
26870 changing the length
26871 \begin_inset Flex Code
26874 \begin_layout Plain Layout
26883 For example the command
26886 \begin_layout LyX-Code
26894 \begin_layout Standard
26895 in \SpecialChar TeX
26896 Code changes its value to 3
26897 \begin_inset space \thinspace{}
26901 The change must be made before the multiple columns' start.
26902 The predefined value is 13
26903 \begin_inset space \thinspace{}
26909 \begin_layout Standard
26911 \begin_inset Flex Code
26914 \begin_layout Plain Layout
26923 \begin_inset space \thinspace{}
26929 \begin_layout Standard
26933 \begin_layout Plain Layout
26939 multicolsep}{2.5cm}
26947 \begin_layout Standard
26948 \begin_inset Flex Multiple Columns
26951 \begin_layout Plain Layout
26954 All day I turned these facts over in my mind, endeavouring to hit upon some
26955 theory which could reconcile them all, and to find that line of least resistanc
26956 e which my poor friend had declared to be the starting-point of every investigat
26958 I confess that I made little progress.
26959 In the evening I strolled across the Park, and found myself about six o'clock
26960 at the Oxford Street end of Park Lane.
26961 A group of loafers upon the pavements, all staring up at a particular window,
26962 directed me to the house which I had come to see.
26963 A tall, thin man with coloured glasses, whom I strongly suspected of being
26964 a plain-clothes detective, was pointing out some theory of his own, while
26965 the others crowded round to listen to what he said.
26966 I got as near him as I could, but his observations seemed to me to be absurd,
26967 so I withdrew again in some disgust.
26968 As I did so I struck against an elderly, deformed man, who had been behind
26969 me, and I knocked down several books which he was carrying.
26977 \begin_layout Standard
26978 \begin_inset Note Greyedout
26981 \begin_layout Plain Layout
26986 The values you set with
26987 \begin_inset Flex Code
26990 \begin_layout Plain Layout
26998 will be used for all following multiple columns until you change them again.
27006 \begin_layout Standard
27010 \begin_layout Plain Layout
27022 \begin_inset Note Note
27025 \begin_layout Plain Layout
27026 go back to the default
27034 \begin_layout Standard
27035 \begin_inset Newpage newpage
27041 \begin_layout Subsubsection
27045 \begin_layout Standard
27046 A column break can be forced by inserting the command
27047 \begin_inset Flex Code
27050 \begin_layout Plain Layout
27058 as \SpecialChar TeX
27059 Code to that position in the text where the column should be broken.
27060 Note that this leads in most cases to whitespace in the text.
27061 \begin_inset Newline newline
27064 Here is an example:
27067 \begin_layout Standard
27068 \begin_inset Flex Multiple Columns
27071 \begin_layout Plain Layout
27074 \begin_inset Quotes eld
27077 You're surprised to see me, sir,
27078 \begin_inset Quotes erd
27081 said he, in a strange, croaking voice.
27084 \begin_layout Plain Layout
27087 I acknowledged that I was.
27090 \begin_layout Plain Layout
27093 \begin_inset Quotes eld
27096 Well, I've a conscience, sir, and when I chanced to see you go into this
27097 house, as I came hobbling after you, I thought to myself, I'll just step
27098 in and see that kind gentleman, and tell him that if I was a bit gruff
27099 in my manner there was not any harm meant, and that I am much obliged to
27100 him for picking up my books.
27101 \begin_inset Quotes erd
27107 \begin_layout Plain Layout
27110 \begin_inset Quotes eld
27113 You make too much of a trifle,
27114 \begin_inset Quotes erd
27119 \begin_inset Quotes eld
27122 May I ask how you knew who I was?
27123 \begin_inset Quotes erd
27126 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
27130 \begin_layout Plain Layout
27142 \begin_layout Plain Layout
27145 \begin_inset Quotes eld
27148 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
27149 you'll find my little bookshop at the corner of Church Street, and very
27150 happy to see you, I am sure.
27151 Maybe you collect yourself, sir.
27155 \begin_inset space ~
27169 \begin_inset space ~
27172 – a bargain, every one of them.
27173 With five volumes you could just fill that gap on that second shelf.
27174 It looks untidy, does it not, sir?
27175 \begin_inset Quotes erd
27186 \begin_layout Subsubsection
27190 \begin_layout Standard
27191 The width of the columns is automatically calculated, but you can modify
27192 the space between the columns.
27193 This is done by changing the length
27194 \begin_inset Flex Code
27197 \begin_layout Plain Layout
27206 Its predefined value is 10
27207 \begin_inset space \thinspace{}
27211 Here is an example where
27212 \begin_inset Flex Code
27215 \begin_layout Plain Layout
27224 \begin_inset space \thinspace{}
27230 \begin_layout Standard
27234 \begin_layout Plain Layout
27248 \begin_layout Standard
27249 \begin_inset Flex Multiple Columns
27252 \begin_layout Plain Layout
27255 My observations of No.
27256 \begin_inset space \space{}
27259 427 Park Lane did little to clear up the problem in which I was interested.
27260 The house was separated from the street by a low wall and railing, the
27261 whole not more than five feet high.
27262 It was perfectly easy, therefore, for anyone to get into the garden, but
27263 the window was entirely inaccessible, since there was no water pipe or
27264 anything which could help the most active man to climb it.
27265 More puzzled than ever, I retraced my steps to Kensington.
27266 I had not been in my study five minutes when the maid entered to say that
27267 a person desired to see me.
27268 To my astonishment it was none other than my strange old book collector,
27269 his sharp, wizened face peering out from a frame of white hair, and his
27270 precious volumes, a dozen of them at least, wedged under his right arm.
27278 \begin_layout Standard
27282 \begin_layout Plain Layout
27294 \begin_inset Note Note
27297 \begin_layout Plain Layout
27298 go back to the default
27306 \begin_layout Subsubsection
27310 \begin_layout Standard
27311 Between the columns a rule with a width of the length
27312 \begin_inset Flex Code
27315 \begin_layout Plain Layout
27324 If this rule width is set to 0
27325 \begin_inset space \thinspace{}
27328 pt (this is the default), the rule is suppressed.
27329 In the following example the rule is 2
27330 \begin_inset space \thinspace{}
27336 \begin_layout Standard
27340 \begin_layout Plain Layout
27346 columnseprule}{2pt}
27354 \begin_layout Standard
27355 \begin_inset Flex Multiple Columns
27358 \begin_layout Plain Layout
27361 \begin_inset Quotes eld
27364 You're surprised to see me, sir,
27365 \begin_inset Quotes erd
27368 said he, in a strange, croaking voice.
27371 \begin_layout Plain Layout
27374 I acknowledged that I was.
27377 \begin_layout Plain Layout
27380 \begin_inset Quotes eld
27383 Well, I've a conscience, sir, and when I chanced to see you go into this
27384 house, as I came hobbling after you, I thought to myself, I'll just step
27385 in and see that kind gentleman, and tell him that if I was a bit gruff
27386 in my manner there was not any harm meant, and that I am much obliged to
27387 him for picking up my books.
27388 \begin_inset Quotes erd
27394 \begin_layout Plain Layout
27397 \begin_inset Quotes eld
27400 You make too much of a trifle,
27401 \begin_inset Quotes erd
27406 \begin_inset Quotes eld
27409 May I ask how you knew who I was?
27410 \begin_inset Quotes erd
27416 \begin_layout Plain Layout
27419 \begin_inset Quotes eld
27422 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
27423 you'll find my little bookshop at the corner of Church Street, and very
27424 happy to see you, I am sure.
27425 Maybe you collect yourself, sir.
27429 \begin_inset space ~
27443 \begin_inset space ~
27446 – a bargain, every one of them.
27447 With five volumes you could just fill that gap on that second shelf.
27448 It looks untidy, does it not, sir?
27449 \begin_inset Quotes erd
27460 \begin_layout Standard
27461 \begin_inset VSpace defskip
27467 \begin_layout Standard
27468 The rule can be colored by redefining the command
27469 \begin_inset Flex Code
27472 \begin_layout Plain Layout
27481 This is done by inserting the command
27484 \begin_layout LyX-Code
27489 columnseprulecolor}{
27494 \begin_layout Standard
27495 as \SpecialChar TeX
27496 Code before the multicolumn inset.
27498 \begin_inset Flex Code
27501 \begin_layout Plain Layout
27507 in this command by a color of your choice.
27508 You can use all pre- and self-defined colors.
27516 \begin_inset space ~
27521 for more information about pre- and self-defined colors.
27522 To go back to the default color insert the command
27525 \begin_layout LyX-Code
27530 columnseprulecolor}{
27535 \begin_layout Standard
27536 Here is the example with a cyan rule and 1
27537 \begin_inset space \thinspace{}
27540 cm column separation:
27543 \begin_layout Standard
27547 \begin_layout Plain Layout
27556 \begin_layout Plain Layout
27562 columnseprulecolor}{
27572 \begin_layout Standard
27573 \begin_inset Flex Multiple Columns
27576 \begin_layout Plain Layout
27579 \begin_inset Quotes eld
27582 You're surprised to see me, sir,
27583 \begin_inset Quotes erd
27586 said he, in a strange, croaking voice.
27589 \begin_layout Plain Layout
27592 I acknowledged that I was.
27595 \begin_layout Plain Layout
27598 \begin_inset Quotes eld
27601 Well, I've a conscience, sir, and when I chanced to see you go into this
27602 house, as I came hobbling after you, I thought to myself, I'll just step
27603 in and see that kind gentleman, and tell him that if I was a bit gruff
27604 in my manner there was not any harm meant, and that I am much obliged to
27605 him for picking up my books.
27606 \begin_inset Quotes erd
27612 \begin_layout Plain Layout
27615 \begin_inset Quotes eld
27618 You make too much of a trifle,
27619 \begin_inset Quotes erd
27624 \begin_inset Quotes eld
27627 May I ask how you knew who I was?
27628 \begin_inset Quotes erd
27634 \begin_layout Plain Layout
27637 \begin_inset Quotes eld
27640 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
27641 you'll find my little bookshop at the corner of Church Street, and very
27642 happy to see you, I am sure.
27643 Maybe you collect yourself, sir.
27647 \begin_inset space ~
27661 \begin_inset space ~
27664 – a bargain, every one of them.
27665 With five volumes you could just fill that gap on that second shelf.
27666 It looks untidy, does it not, sir?
27667 \begin_inset Quotes erd
27678 \begin_layout Standard
27682 \begin_layout Plain Layout
27688 columnseprule}{0pt}
27691 \begin_layout Plain Layout
27697 columnseprulecolor}{
27705 \begin_inset Note Note
27708 \begin_layout Plain Layout
27709 go back to the default
27717 \begin_layout Section
27718 Non-standard Paragraph Shapes
27721 \begin_layout Standard
27724 as well as any other text processor uses by default rectangular paragraphs.
27725 For special cases like for example posters, invitation cards or poems you
27726 can modify the paragraph shape to one of your choice.
27727 This can be done by using the \SpecialChar LaTeX
27729 \begin_inset Flex Code
27732 \begin_layout Plain Layout
27738 which is loaded by using in the document settings the module
27740 Custom paragraph shapes
27745 \begin_layout Subsection
27749 \begin_layout Standard
27754 provides the following shapes:
27757 \begin_layout Standard
27758 \begin_inset Tabular
27759 <lyxtabular version="3" rows="13" columns="3">
27760 <features booktabs="true" islongtable="true" longtabularalignment="center">
27761 <column alignment="left" valignment="middle" width="16col%">
27762 <column alignment="left" valignment="middle" width="40col%">
27763 <column alignment="left" valignment="middle" width="35col%">
27764 <row endhead="true">
27765 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
27768 \begin_layout Plain Layout
27777 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
27780 \begin_layout Plain Layout
27789 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
27792 \begin_layout Plain Layout
27802 <row interlinespace="default">
27803 <cell alignment="left" valignment="top" usebox="none">
27806 \begin_layout Plain Layout
27814 <cell alignment="left" valignment="top" usebox="none">
27817 \begin_layout Plain Layout
27820 Circle with circular hole (in the size of a CD/DVD)
27825 <cell alignment="left" valignment="top" usebox="none">
27828 \begin_layout Plain Layout
27831 Cannot be scaled, take care there is not too much text
27837 <row interlinespace="default">
27838 <cell alignment="left" valignment="top" usebox="none">
27841 \begin_layout Plain Layout
27849 <cell alignment="left" valignment="top" usebox="none">
27852 \begin_layout Plain Layout
27860 <cell alignment="left" valignment="top" usebox="none">
27863 \begin_layout Plain Layout
27866 Fragile, calculation might fail
27872 <row interlinespace="default">
27873 <cell alignment="left" valignment="top" usebox="none">
27876 \begin_layout Plain Layout
27884 <cell alignment="left" valignment="top" usebox="none">
27887 \begin_layout Plain Layout
27890 Rhomboid (symbolizing a
27891 \begin_inset Quotes eld
27895 \begin_inset Quotes erd
27903 <cell alignment="left" valignment="top" usebox="none">
27906 \begin_layout Plain Layout
27915 <row interlinespace="default">
27916 <cell alignment="left" valignment="top" usebox="none">
27919 \begin_layout Plain Layout
27927 <cell alignment="left" valignment="top" usebox="none">
27930 \begin_layout Plain Layout
27938 <cell alignment="left" valignment="top" usebox="none">
27941 \begin_layout Plain Layout
27950 <row interlinespace="default">
27951 <cell alignment="left" valignment="top" usebox="none">
27954 \begin_layout Plain Layout
27962 <cell alignment="left" valignment="top" usebox="none">
27965 \begin_layout Plain Layout
27973 <cell alignment="left" valignment="top" usebox="none">
27976 \begin_layout Plain Layout
27985 <row interlinespace="default">
27986 <cell alignment="left" valignment="top" usebox="none">
27989 \begin_layout Plain Layout
27997 <cell alignment="left" valignment="top" usebox="none">
28000 \begin_layout Plain Layout
28003 Nut for bolt (hexagon with circular hole)
28008 <cell alignment="left" valignment="top" usebox="none">
28011 \begin_layout Plain Layout
28020 <row interlinespace="default">
28021 <cell alignment="left" valignment="top" usebox="none">
28024 \begin_layout Plain Layout
28032 <cell alignment="left" valignment="top" usebox="none">
28035 \begin_layout Plain Layout
28043 <cell alignment="left" valignment="top" usebox="none">
28046 \begin_layout Plain Layout
28055 <row interlinespace="default">
28056 <cell alignment="left" valignment="top" usebox="none">
28059 \begin_layout Plain Layout
28067 <cell alignment="left" valignment="top" usebox="none">
28070 \begin_layout Plain Layout
28078 <cell alignment="left" valignment="top" usebox="none">
28081 \begin_layout Plain Layout
28090 <row interlinespace="default">
28091 <cell alignment="left" valignment="top" usebox="none">
28094 \begin_layout Plain Layout
28102 <cell alignment="left" valignment="top" usebox="none">
28105 \begin_layout Plain Layout
28113 <cell alignment="left" valignment="top" usebox="none">
28116 \begin_layout Plain Layout
28125 <row interlinespace="default">
28126 <cell alignment="left" valignment="top" usebox="none">
28129 \begin_layout Plain Layout
28137 <cell alignment="left" valignment="top" usebox="none">
28140 \begin_layout Plain Layout
28143 Normal/reversed rain drop
28148 <cell alignment="left" valignment="top" usebox="none">
28151 \begin_layout Plain Layout
28154 Fragile, calculation might fail
28160 <row interlinespace="default">
28161 <cell alignment="left" valignment="top" usebox="none">
28164 \begin_layout Plain Layout
28173 <cell alignment="left" valignment="top" usebox="none">
28176 \begin_layout Plain Layout
28179 The \SpecialChar TeX
28185 <cell alignment="left" valignment="top" usebox="none">
28188 \begin_layout Plain Layout
28197 <row interlinespace="default">
28198 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
28201 \begin_layout Plain Layout
28205 \begin_inset Newline newline
28213 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
28216 \begin_layout Plain Layout
28219 Triangles in different orientations
28224 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
28227 \begin_layout Plain Layout
28243 \begin_layout Standard
28244 To use a shape for your paragraph, simply select it in \SpecialChar LyX
28246 for environments in the toolbar.
28249 \begin_layout Standard
28250 \begin_inset Newpage newpage
28256 \begin_layout Standard
28257 Here is an example paragraph in the shape of a nut:
28260 \begin_layout Standard
28261 \begin_inset VSpace bigskip
28270 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28271 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28273 At vero eos et accusam et justo duo dolores et ea rebum.
28274 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
28276 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28277 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28281 \begin_layout Standard
28282 \begin_inset VSpace bigskip
28288 \begin_layout Standard
28289 \begin_inset Note Greyedout
28292 \begin_layout Plain Layout
28301 paragraphs cannot run over a page break.
28309 \begin_layout Standard
28310 \begin_inset VSpace bigskip
28316 \begin_layout Standard
28318 \begin_inset Flex Code
28321 \begin_layout Plain Layout
28327 takes care that the shape will always be preserved, no matter how much
28328 text is in the paragraph.
28329 Therefore the paragraph size changes with the amount of contained text.
28330 This can lead to paragraph sizes exceeding the page margins.
28331 To demonstrate the size scaling, here is the same example paragraph but
28332 with twice as much text:
28335 \begin_layout Standard
28336 \begin_inset Newpage newpage
28345 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28346 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28348 At vero eos et accusam et justo duo dolores et ea rebum.
28349 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
28351 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28352 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28354 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28355 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28357 At vero eos et accusam et justo duo dolores et ea rebum.
28358 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
28360 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28361 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28365 \begin_layout Standard
28366 \begin_inset VSpace bigskip
28372 \begin_layout Standard
28373 An exception is the shape
28378 It cannot be scaled because it must fit the size of a CD/DVD.
28379 Therefore the amount of text that fits into the shape is limited.
28380 \begin_inset Newline newline
28391 shape are fragile, meaning that the calculation of their size can fail,
28392 depending on the amount of text.
28393 You will then get the \SpecialChar LaTeX
28395 \begin_inset Quotes eld
28398 Arithmetic overflow
28399 \begin_inset Quotes erd
28403 In this case one can try to remove or add some text; if nothing works one
28404 has to use another shape.
28407 \begin_layout Standard
28408 \begin_inset VSpace bigskip
28414 \begin_layout Standard
28415 For shapes with tips you will maybe see that \SpecialChar LaTeX
28416 's hyphenation routine fails
28417 for text in the tips.
28418 Therefore it is often necessary to add hyphenation points
28423 arg "specialchar-insert hyphenation"
28428 ) to the corresponding text parts.
28431 \begin_layout Standard
28432 \begin_inset VSpace bigskip
28438 \begin_layout Standard
28439 Shapepar paragraphs are either always centered or placed on the page so
28440 that their left border touches the left page margin.
28441 You can therefore not use the paragraph dialog to align such paragraphs.
28442 A solution is to put the paragraph into a minipage or parbox and align
28444 The problem is hereby to find the right width for the box.
28445 Because if it is too wide and you center the box, the paragraph is not
28446 centered too because it sticks at the left side of the box.
28447 So you might have to play a bit with the width until it fits.
28448 Here are two heart-shaped paragraphs, the first one is not aligned, the
28449 second one is right-aligned:
28452 \begin_layout Standard
28453 \begin_inset Newpage newpage
28459 \begin_layout Heart
28463 Lo\SpecialChar softhyphen
28464 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28465 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28467 At vero eos et accusam et justo duo dolores et ea rebum.
28468 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
28472 \begin_layout Standard
28473 \begin_inset VSpace bigskip
28479 \begin_layout Standard
28482 \begin_inset Box Frameless
28492 height_special "totalheight"
28497 backgroundcolor "none"
28500 \begin_layout Heart
28504 Lo\SpecialChar softhyphen
28505 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28506 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28508 At vero eos et accusam et justo duo dolores et ea rebum.
28509 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
28518 \begin_layout Subsection
28522 \begin_layout Standard
28523 You can define any shape you want.
28524 Doing this manually is a lot of work because every coordinate must be specified.
28525 But there is a way to let the computer calculate the coordinates:
28528 \begin_layout Enumerate
28529 Install the program
28530 \begin_inset CommandInset href
28533 target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
28541 \begin_layout Enumerate
28548 TeX/LaTeX\SpecialChar menuseparator
28549 Settings\SpecialChar menuseparator
28552 and select the font size you are using in your document.
28553 For example this document uses the size 12
28554 \begin_inset space \thinspace{}
28560 \begin_layout Enumerate
28564 \begin_layout Enumerate
28567 TeX/LaTeX\SpecialChar menuseparator
28570 to export the shape to coordinates.
28571 In the appearing dialog use either the outline of your shape for the coordinate
28572 s or the path itself.
28576 \begin_layout Plain Layout
28577 For more information see
28578 \begin_inset CommandInset href
28580 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
28593 \begin_layout Standard
28594 The coordinates are written into a \SpecialChar TeX
28596 To use it for your \SpecialChar LyX
28600 \begin_layout Enumerate
28601 Place the cursor before the first character of your paragraph (or into a
28605 \begin_layout Enumerate
28606 Open in \SpecialChar LyX
28609 Insert\SpecialChar menuseparator
28610 File\SpecialChar menuseparator
28612 \begin_inset space ~
28617 , select the file and use
28626 \begin_layout Standard
28627 \begin_inset VSpace defskip
28633 \begin_layout Standard
28634 \begin_inset Note Greyedout
28637 \begin_layout Plain Layout
28642 : The changed shape only applies to the current paragraph; everything is
28643 reset to normal for the next paragraph.
28644 Therefore the shape definition file must be input into every paragraph
28645 with the desired shape.
28653 \begin_layout Standard
28654 \begin_inset VSpace bigskip
28660 \begin_layout Standard
28661 Here is an example:
28664 \begin_layout Standard
28665 \begin_inset VSpace bigskip
28671 \begin_layout Standard
28672 \begin_inset CommandInset include
28674 filename "SpecialParagraphShape.tex"
28681 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28682 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28684 At vero eos et accusam et justo duo dolores et ea rebum.
28685 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
28687 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28688 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28692 \begin_layout Standard
28693 \begin_inset VSpace bigskip
28699 \begin_layout Standard
28704 to draw complexer shapes in
28708 you can draw the shape in a program of your choice and import the resulting
28714 Then you only need to draw a line or spline along the outline of the image.
28717 \begin_layout Standard
28718 \begin_inset VSpace bigskip
28724 \begin_layout Standard
28727 Custom paragraph shapes
28729 also provides the two commands
28737 which can be used to define custom shapes coordinate by coordinate.
28741 \begin_layout Plain Layout
28742 These commands are internally used for all shapes described here.
28747 For information how these styles are used and about further customization
28748 possibilities, have a look at the
28749 \begin_inset CommandInset href
28751 name "documentation"
28752 target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
28758 \begin_inset Flex Code
28761 \begin_layout Plain Layout