1 #LyX 2.4 created this file. For more info see https://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 % DO NOT ALTER THIS PREAMBLE!!!
11 % This preamble is designed to ensure that the manual prints
12 % out as advertised. If you mess with this preamble,
13 % parts of the manual may not print out as expected. If you
14 % have problems LaTeXing this file, please contact
15 % the documentation team
16 % email: lyx-docs@lists.lyx.org
18 % the pages of the TOC are numbered roman
19 % and a PDF-bookmark for the TOC is added
21 \let\myTOC\tableofcontents
22 \renewcommand{\tableofcontents}{%
23 \pdfbookmark[1]{\contentsname}{}
26 \pagenumbering{arabic}}
28 % extra space for tables
29 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
31 \options bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
32 \use_default_options false
40 \maintain_unincluded_children no
42 \language_package default
45 \font_roman "lmodern" "default"
46 \font_sans "lmss" "default"
47 \font_typewriter "lmtt" "default"
48 \font_math "auto" "auto"
49 \font_default_family default
50 \use_non_tex_fonts false
54 \font_typewriter_osf false
55 \font_sf_scale 100 100
56 \font_tt_scale 100 100
58 \use_dash_ligatures true
60 \default_output_format pdf2
62 \bibtex_command default
63 \index_command default
67 \pdf_title "LyX's Additional Features manual"
68 \pdf_author "LyX Team"
69 \pdf_subject "LyX's additional features documentation"
70 \pdf_keywords "LyX, Documentation, Additional"
72 \pdf_bookmarksnumbered true
73 \pdf_bookmarksopen false
74 \pdf_bookmarksopenlevel 1
79 \pdf_pdfusetitle false
80 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
83 \use_package amsmath 1
84 \use_package amssymb 1
87 \use_package mathdots 1
88 \use_package mathtools 1
90 \use_package stackrel 1
91 \use_package stmaryrd 1
92 \use_package undertilde 1
94 \cite_engine_type default
98 \paperorientation portrait
104 \notefontcolor #0000ff
111 \paragraph_separation indent
112 \paragraph_indentation default
114 \math_indentation default
115 \math_numbering_side default
116 \quotes_style english
120 \paperpagestyle headings
122 \tracking_changes true
123 \output_changes false
125 \postpone_fragile_content false
129 \docbook_table_output 0
130 \docbook_mathml_prefix 1
131 \author -712698321 "Jürgen Spitzmüller"
134 \author 244031559 "Yuriy"
135 \author 564990737 "John Lyx"
136 \author 630872221 "Jean-Pierre Chrétien" jeanpierre.chretien@free.fr
137 \author 1075283030 "Thibaut"
138 \author 1119979965 "Joel A. Kulesza"
144 Additional \SpecialChar LyX
148 \begin_layout Subtitle
150 \change_deleted 630872221 1622909155
152 \change_inserted 630872221 1622909155
159 by the \SpecialChar LyX
164 \begin_layout Plain Layout
166 Principal maintainer of this file is
168 Richard Kimberly Heck
171 If you have comments or error corrections, please send them to the \SpecialChar LyX
174 \begin_inset Flex Code
177 \begin_layout Plain Layout
178 <lyx-docs@lists.lyx.org>
191 \begin_layout Standard
192 \begin_inset CommandInset toc
193 LatexCommand tableofcontents
200 \begin_layout Chapter
204 \begin_layout Standard
205 This manual is essentially Part II of the
207 User's Guide\SpecialChar endofsentence
210 The reason for separating the two documents is simple: the
214 is already quite lengthy, and it contains information on all of the basic
215 features one needs to know in order to prepare most documents.
216 However, the \SpecialChar LyX
217 Team has worked to make \SpecialChar LyX
218 extensible through various configuration
219 files and external packages.
220 That means that if you want to support the Fizzwizzle \SpecialChar LaTeX
222 create a layout file (or module) for it without having to alter \SpecialChar LyX
224 We've already had contributions of several new features this way, and some
225 of them are documented here.
226 There are also some more `advanced' features, such as how to control the
227 presentation of bibliographies and how to work with multi-part documents,
228 that are not covered in the
232 and are discussed here.
235 \begin_layout Standard
236 This manual also documents some special features, like fax support
237 \change_deleted 244031559 1603802929
239 \change_inserted 244031559 1603802931
243 \change_deleted 244031559 1603802954
246 , which require additional software to work properly.
247 There is also a chapter on \SpecialChar LyX
249 And lastly, there's a chapter of \SpecialChar LaTeX
250 tools and tips, things you can use to
251 spruce up your documents by directly using the powerful features of \SpecialChar LaTeX
253 After all, \SpecialChar LyX
258 only WYSIWYM and will only ever interface to some, not all, \SpecialChar LaTeX
262 \begin_layout Standard
263 If you haven't read the
267 yet, you are definitely in the wrong manual.
272 is the first place to go, since it describes the notation and format of
274 You should also be thoroughly familiar with the
278 and all of the basic features of \SpecialChar LyX
279 before attempting to read this one.
282 \begin_layout Standard
283 Since many of the topics in this manual depend heavily on \SpecialChar LyX
285 with \SpecialChar LaTeX
286 , this first chapter covers the inner workings of \SpecialChar LyX
289 to generate exactly the \SpecialChar LaTeX
291 It is obviously for more seasoned \SpecialChar LyX
295 \begin_layout Chapter
297 and \SpecialChar LaTeX
301 \begin_layout Section
303 Uses \SpecialChar LaTeX
307 \begin_layout Standard
308 This chapter is for both \SpecialChar TeX
309 -nicians and the \SpecialChar LaTeX
311 In it, we'll explain how \SpecialChar LyX
312 and \SpecialChar LaTeX
313 work together to produce printable output.
314 This is the only place in any of the manuals where we assume you know something
315 about \SpecialChar LaTeX
319 \begin_layout Standard
320 At one time, \SpecialChar LyX
322 \begin_inset Quotes eld
325 WYSIWYM frontend to \SpecialChar LaTeX
327 \begin_inset Quotes erd
330 but that's no longer true.
331 There are frontends to \SpecialChar LaTeX
336 \begin_layout Plain Layout
337 Some familar ones are \SpecialChar TeX
338 maker and kile, on Linux, and \SpecialChar TeX
340 There are also the \SpecialChar LaTeX
341 modes for vi and emacs, of course.
346 These are basically text editors with the ability to run \SpecialChar LaTeX
348 errors in the file you're editing.
349 Although \SpecialChar LyX
358 run \SpecialChar LaTeX
359 , and it also indicates errors in the file, it also does much, much
361 For one thing, you don't need to know \SpecialChar LaTeX
362 to use \SpecialChar LyX
365 has added its own extensions to \SpecialChar LaTeX
367 Try the following sometime: select
368 \begin_inset Flex Noun
371 \begin_layout Plain Layout
372 Export\SpecialChar menuseparator
379 \begin_inset Flex Noun
382 \begin_layout Plain Layout
389 \begin_inset Flex Noun
392 \begin_layout Plain Layout
393 View\SpecialChar menuseparator
403 ), then look at the preamble of the resulting
404 \begin_inset Flex Code
407 \begin_layout Plain Layout
414 You'll notice a variety of new macros defined specifically by \SpecialChar LyX
416 These macros are defined automatically, according to the features you use
420 \begin_layout Standard
421 There are several commands that automatically invoke \SpecialChar LaTeX
426 \begin_layout Itemize
427 \begin_inset Flex Noun
430 \begin_layout Plain Layout
431 Document\SpecialChar menuseparator
440 \begin_layout Itemize
441 \begin_inset Flex Noun
444 \begin_layout Plain Layout
445 Document\SpecialChar menuseparator
454 \begin_layout Standard
455 They will only invoke \SpecialChar LaTeX
456 if the file has changed since the last time \SpecialChar LaTeX
462 \begin_layout Standard
463 When \SpecialChar LyX
464 runs \SpecialChar LaTeX
465 on the file you're editing, it performs these steps:
468 \begin_layout Enumerate
469 Convert the document to \SpecialChar LaTeX
470 and save to a file with the extension
471 \begin_inset Flex Code
474 \begin_layout Plain Layout
481 \begin_inset Flex Code
484 \begin_layout Plain Layout
493 \begin_layout Enumerate
494 Run \SpecialChar LaTeX
496 \begin_inset Flex Code
499 \begin_layout Plain Layout
505 file (maybe several times), and run any other commands (such as
506 \begin_inset Flex Code
509 \begin_layout Plain Layout
516 \begin_inset Flex Code
519 \begin_layout Plain Layout
525 ) needed to compile the \SpecialChar LaTeX
529 \begin_layout Enumerate
530 If there are any errors, show the error log.
533 \begin_layout Standard
534 If you have run \SpecialChar LaTeX
536 \begin_inset Flex Noun
539 \begin_layout Plain Layout
540 View\SpecialChar menuseparator
547 then runs a DVI viewer to display the DVI-file.
549 \begin_inset Flex Noun
552 \begin_layout Plain Layout
553 View\SpecialChar menuseparator
560 performs further steps:
563 \begin_layout Enumerate
565 \begin_inset Flex Code
568 \begin_layout Plain Layout
574 to convert the DVI file to PostScript.
577 \begin_layout Enumerate
578 Run a PostScript viewer, such as
579 \begin_inset Flex Code
582 \begin_layout Plain Layout
588 , to display the PostScript file.
591 \begin_layout Standard
593 does similar things when viewing, or exporting, other formats.
596 \begin_layout Section
597 Translating \SpecialChar LaTeX
598 files into \SpecialChar LyX
602 \begin_layout Standard
603 You can import a \SpecialChar LaTeX
604 file into \SpecialChar LyX
606 \begin_inset Flex Noun
609 \begin_layout Plain Layout
610 File\SpecialChar menuseparator
611 Import\SpecialChar menuseparator
617 command in \SpecialChar LyX
619 This will call a program named
620 \begin_inset Flex Code
623 \begin_layout Plain Layout
629 which will create a file
630 \begin_inset Flex Code
633 \begin_layout Plain Layout
640 \begin_inset Flex Code
643 \begin_layout Plain Layout
651 will then open that file.
655 \begin_layout Plain Layout
656 \begin_inset Flex Code
659 \begin_layout Plain Layout
665 can also be run from the command line, of course.
673 \begin_layout Standard
674 \begin_inset Flex Code
677 \begin_layout Plain Layout
683 will translate most legal \SpecialChar LaTeX
684 , but not everything.
685 It will put things it doesn't understand into \SpecialChar TeX
686 code, so after translating
688 \begin_inset Flex Code
691 \begin_layout Plain Layout
697 , you can look for \SpecialChar TeX
698 code and hand-edit it until it looks right.
701 \begin_layout Standard
702 If you don't know what \SpecialChar TeX
703 code is, read the next section.
706 \begin_layout Section
707 \begin_inset CommandInset label
709 name "sec:Inserting-TeX-Code"
713 Inserting \SpecialChar TeX
714 Code into \SpecialChar LyX
718 \begin_layout Standard
719 Anything you can do in \SpecialChar LaTeX
720 you can do in \SpecialChar LyX
721 , for a very simple reason: You can
722 always insert \SpecialChar TeX
723 code into any \SpecialChar LyX
726 cannot, and will never be able to, display every possible \SpecialChar LaTeX
728 If ever you need to insert \SpecialChar LaTeX
729 commands into your \SpecialChar LyX
730 document, you can use the
732 \begin_inset Flex Code
735 \begin_layout Plain Layout
742 box, which you can insert into your document with
743 \begin_inset Flex Noun
746 \begin_layout Plain Layout
747 Insert\SpecialChar menuseparator
757 or the keyboard shortcut
766 \begin_layout Standard
767 Here's an example of inserting \SpecialChar LaTeX
768 commands in a \SpecialChar LyX
770 The code looks like this:
773 \begin_layout LyX-Code
777 \begin_inset Newline newline
783 \begin_inset Newline newline
786 This is an example of a minipage environment.
788 \begin_inset Newline newline
791 can put nearly everything in it, even (non-floating)
792 \begin_inset Newline newline
797 \begin_inset Newline newline
803 \begin_inset Newline newline
807 \begin_inset Newline newline
813 \begin_inset Newline newline
819 \begin_inset Newline newline
825 \begin_inset Newline newline
830 \begin_inset Newline newline
836 \begin_inset Newline newline
842 \begin_inset Newline newline
848 \begin_inset Newline newline
856 \begin_layout LyX-Code
860 \begin_layout Standard
862 \begin_inset Flex Code
865 \begin_layout Plain Layout
872 box containing this text is directly after this paragraph.
873 Those of you reading the manual in \SpecialChar LyX
874 will only see the \SpecialChar TeX
876 Those reading a printed version of the manuals will see the actual results:
877 \begin_inset VSpace bigskip
883 \begin_layout Standard
887 \begin_layout Plain Layout
894 \begin_layout Plain Layout
901 \begin_layout Plain Layout
903 This is an example of a minipage environment.
904 You can put nearly everything in it, even (non-floating) figures and tables.
908 \begin_layout Plain Layout
915 \begin_layout Plain Layout
920 \begin_layout Plain Layout
927 \begin_layout Plain Layout
934 \begin_layout Plain Layout
941 \begin_layout Plain Layout
947 \begin_layout Plain Layout
954 \begin_layout Plain Layout
961 \begin_layout Plain Layout
968 \begin_layout Plain Layout
978 \begin_inset VSpace bigskip
984 \begin_layout Standard
985 In addition to using \SpecialChar TeX
986 code, you can also create a separate file containing
987 some complex \SpecialChar LaTeX
988 structure and then use
989 \begin_inset Flex Noun
992 \begin_layout Plain Layout
993 Insert\SpecialChar menuseparator
1003 to include your file (you should select the type
1004 \begin_inset Flex Code
1007 \begin_layout Plain Layout
1014 We recommend that you only do this if you have a
1015 \begin_inset Flex Code
1018 \begin_layout Plain Layout
1029 Otherwise, you'll have a big job tracking down \SpecialChar LaTeX
1033 \begin_layout Standard
1034 There are a few last points to emphasize:
1037 \begin_layout Itemize
1043 check if your \SpecialChar LaTeX
1047 \begin_layout Itemize
1048 Beware of reinventing the wheel.
1051 \begin_layout Standard
1052 On that last point, \SpecialChar LyX
1053 does have quite a few features tucked into it, and
1055 Be sure to check the manuals to make sure that \SpecialChar LyX
1056 doesn't have such-and-such
1057 feature before you decide you have to do it by hand.
1058 Moreover, there are numerous \SpecialChar LaTeX
1059 packages out there to do all sorts of things,
1060 from labels to envelopes to fancy multipage tables.
1062 \change_inserted 244031559 1603815732
1064 \begin_inset CommandInset href
1067 target "https://www.ctan.org/"
1073 \change_deleted 244031559 1603815732
1075 \begin_inset CommandInset href
1078 target "http://www.ctan.org/"
1088 \begin_layout Standard
1089 If you do need to do some wild and fancy things within your document, be
1090 sure to check out a good \SpecialChar LaTeX
1091 book for assistance.
1092 There are a number of them listed in the bibliography of the
1099 \begin_layout Section
1101 and the \SpecialChar LaTeX
1105 \begin_layout Subsection
1106 About the \SpecialChar LaTeX
1110 \begin_layout Standard
1111 If you already know \SpecialChar LaTeX
1112 , there is no need to explain here what the preamble
1114 If you don't, the following will give you some ideas—we recommend again
1115 that you consult a \SpecialChar LaTeX
1116 book for further information.
1117 In any case, you should read the points below, because they explain what
1118 you can do and what you don't need to do in the \SpecialChar LaTeX
1119 preamble of a \SpecialChar LyX
1123 \begin_layout Standard
1124 The \SpecialChar LaTeX
1125 preamble comes at the very beginning of a document,
1133 \begin_layout Itemize
1134 Declare the document class.
1136 \begin_inset Newline newline
1140 already does this for you.
1141 If you're a seasoned \SpecialChar LaTeX
1142 -nician, and you have a custom document class you
1143 want to use, check out the
1145 Customization Manual
1147 for information on how to make \SpecialChar LyX
1151 \begin_layout Itemize
1152 Declare the usage of packages.
1154 \begin_inset Newline newline
1158 packages provide special commands, which are only available within a document
1159 when the package has been declared in the preamble.
1160 In addition to providing special commands, the inclusion of a package can
1161 change the document.
1162 For example, the package
1163 \begin_inset Flex Code
1166 \begin_layout Plain Layout
1172 forces all paragraphs to be indented.
1173 There are other packages for labels, envelopes, margins, etc.
1177 \begin_layout Itemize
1178 Set counters, variables, lengths and widths.
1180 \begin_inset Newline newline
1183 There are several \SpecialChar LaTeX
1184 counters and variables that
1188 be set globally from within the preamble in order to have the desired effect.
1189 (There are variables that you can set and reset inside the document, too.)
1190 Margins are a good example of something that must be set in the preamble.
1191 Another example is the label format for lists.
1192 You can actually set these just about anywhere, but it's best to do it
1193 just once, inside the preamble.
1196 \begin_layout Itemize
1197 Declare user defined commands (with
1198 \begin_inset Flex Code
1201 \begin_layout Plain Layout
1210 \begin_inset Flex Code
1213 \begin_layout Plain Layout
1222 \begin_inset Newline newline
1225 These are abbreviations for \SpecialChar LaTeX
1226 commands which appear very often inside a document.
1227 Although the preamble is a good place to declare such commands, they
1231 be declared anywhere (before they are used for the first time, of course).
1232 This can be useful if there is a lot of raw \SpecialChar LaTeX
1233 code in your document, which
1234 normally should not be the case.
1237 \begin_layout Standard
1239 adds its own set of definitions to the preamble of the
1240 \begin_inset Flex Code
1243 \begin_layout Plain Layout
1250 This makes \SpecialChar LaTeX
1251 files generated by \SpecialChar LyX
1255 \begin_layout Subsection
1256 Changing the Preamble
1259 \begin_layout Standard
1260 The commands which \SpecialChar LyX
1261 adds to the preamble of a \SpecialChar LaTeX
1262 file are fixed; you can't
1263 change them without patching \SpecialChar LyX
1265 You can, however, add your own stuff to the preamble by selecting
1266 \begin_inset Flex Noun
1269 \begin_layout Plain Layout
1272 \begin_inset space ~
1281 \begin_inset Flex Noun
1284 \begin_layout Plain Layout
1285 Document\SpecialChar menuseparator
1293 adds anything in the
1294 \begin_inset Flex Noun
1297 \begin_layout Plain Layout
1303 dialog to its own built-in preamble.
1304 Before adding your own declarations in the preamble, you should make sure
1305 that \SpecialChar LyX
1306 doesn't already support what you want to do.
1307 (Remember what we said about reinventing the wheel?) Also,
1309 make sure your preamble code is correct
1313 doesn't check it for you.
1314 If there is an error, you're likely to get an error like
1315 \begin_inset Quotes eld
1319 \begin_inset Flex Code
1322 \begin_layout Plain Layout
1331 \begin_inset Quotes erd
1335 If you see this error, check your preamble.
1338 \begin_layout Subsection
1342 \begin_layout Standard
1343 Here are some examples of what you can add to a preamble, and what they
1347 \begin_layout Subsubsection
1351 \begin_layout Standard
1352 There are two variables under \SpecialChar LaTeX
1353 that control page position:
1354 \begin_inset Flex Code
1357 \begin_layout Plain Layout
1366 \begin_inset Flex Code
1369 \begin_layout Plain Layout
1378 Their names should be self-explanatory.
1379 These variables are useful if you think for a moment about computer labels.
1380 Sometimes, the size of a print medium and the area of the medium that you
1381 can actually print on aren't the same.
1383 \begin_inset Flex Code
1386 \begin_layout Plain Layout
1395 \begin_inset Flex Code
1398 \begin_layout Plain Layout
1409 \begin_layout Standard
1410 The default values for
1411 \begin_inset Flex Code
1414 \begin_layout Plain Layout
1423 \begin_inset Flex Code
1426 \begin_layout Plain Layout
1435 \begin_inset space \thinspace{}
1439 \begin_inset space \thinspace{}
1443 \begin_inset space \space{}
1446 the page isn't shifted.
1447 Unfortunately, some DVI drivers always seem to shift the page.
1448 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1449 If you're using \SpecialChar LyX
1450 on a system that you don't personally maintain, and your
1451 sysadmin is a doofus,
1452 \begin_inset Flex Code
1455 \begin_layout Plain Layout
1464 \begin_inset Flex Code
1467 \begin_layout Plain Layout
1476 Suppose your left and top margins are always 0.5
1477 \begin_inset space \thinspace{}
1481 You can add this to the preamble:
1484 \begin_layout LyX-Code
1492 \begin_layout LyX-Code
1500 \begin_layout Standard
1501 and your margins should now be correct.
1504 \begin_layout Subsubsection
1508 \begin_layout Standard
1509 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1510 There's a rather nice package, available at your nearest CTAN archive,
1511 for printing sheets of labels:
1512 \begin_inset Flex Code
1515 \begin_layout Plain Layout
1522 Now, your system may not have this package installed by default.
1523 We leave that up to you to check.
1524 You'll also want to read the documentation for it; we're not going to do
1526 Since this is an example, however, we'll give you an example of how you
1530 \begin_layout Standard
1531 First, make sure you're using the
1532 \begin_inset Flex Code
1535 \begin_layout Plain Layout
1542 Next, you need to put the following in your preamble:
1545 \begin_layout LyX-Code
1551 \begin_layout LyX-Code
1557 \begin_layout LyX-Code
1563 \begin_layout LyX-Code
1569 \begin_layout LyX-Code
1575 \begin_layout LyX-Code
1581 \begin_layout LyX-Code
1587 \begin_layout Standard
1588 This sets things up for Avery label sheets, stock #5360.
1589 You're now ready to print labels, but you'll need to insert \SpecialChar LaTeX
1592 \begin_inset Flex Code
1595 \begin_layout Plain Layout
1604 \begin_inset Flex Code
1607 \begin_layout Plain Layout
1615 around each label text.
1616 This and other special features of
1617 \begin_inset Flex Code
1620 \begin_layout Plain Layout
1626 are explained in its documentation.
1629 \begin_layout Standard
1630 Someday, someone may write a \SpecialChar LyX
1631 layout file to support this package directly.
1632 Maybe that someone is you.
1635 \begin_layout Subsubsection
1636 Example #3: Paragraph Indentation
1639 \begin_layout Standard
1640 Americans are trained to indent the first line of
1645 As with all of their other weird quirks, most Americans will whine and
1646 moan until they can have their way and indent the first line of all paragraphs.
1655 \begin_layout Standard
1656 Of course, this behavior isn't standard typography.
1657 In books, you typically only indent the first line of a paragraph
1661 it follows another one.
1662 The idea behind indenting the first line of a paragraph is to distinguish
1663 neighboring paragraphs from one another.
1664 If there is no previous paragraph—for example, if it follows a figure or
1665 is the first paragraph in a section—then there is no need for indentation.
1669 \begin_layout Standard
1670 If you're a typical American (we're still joking!), though, you don't care
1671 about such esoteric things; you want your indentation! Add this to the
1675 \begin_layout LyX-Code
1678 usepackage{indentfirst}
1681 \begin_layout Standard
1682 If your \SpecialChar TeX
1683 distribution isn't braindead, you'll have this package, and all
1684 of your paragraphs will get the indentation the Founding Fathers intended
1688 \begin_layout Subsubsection
1689 Example #4: This Document
1692 \begin_layout Standard
1693 You can also check out the preamble of this document to get an idea of some
1694 of the advanced things you can do.
1697 \begin_layout Section
1699 and \SpecialChar LaTeX
1703 \begin_layout Standard
1704 When \SpecialChar LyX
1705 calls \SpecialChar LaTeX
1706 , it tells \SpecialChar LaTeX
1707 to blithely ignore any errors and keep going.
1708 It then uses the logfile from the \SpecialChar LaTeX
1709 run to do a post-mortem.
1710 After analyzing the logfile, \SpecialChar LyX
1711 displays a dialog listing the errors.
1712 Clicking on any one of them will take you to the position in your \SpecialChar LyX
1714 where the error occurred.
1718 \begin_layout Plain Layout
1720 Analyzing the logfile is a tough job, and \SpecialChar LyX
1721 doesn't always go to the right
1723 There are also cases where \SpecialChar LaTeX
1724 reports the error on one line, but the actual
1726 This is not unlike forgetting a closing brace in a program: You'll get
1727 an error, but only later.
1735 \begin_layout Standard
1736 Some folks also like to look at the log file directly: It is available from
1738 \begin_inset Flex Noun
1741 \begin_layout Plain Layout
1742 Document\SpecialChar menuseparator
1744 \begin_inset space ~
1753 There are some fairly common error messages and warnings.
1754 We'll cover those here.
1755 You should look at a good \SpecialChar LaTeX
1756 book for a complete listing.
1759 \begin_layout Itemize
1760 \begin_inset Flex Code
1763 \begin_layout Plain Layout
1770 \begin_inset Newline newline
1773 Anything beginning with these words is a warning message for the purpose
1775 \begin_inset Quotes eld
1779 \begin_inset Quotes erd
1782 the \SpecialChar LaTeX
1784 You'll get messages like this if you added or changed cross-references
1785 or bibliography entries, in which case, \SpecialChar LaTeX
1786 is trying to tell you that you
1787 need to make another run.
1788 You can by-and-large ignore these.
1791 \begin_layout Itemize
1792 \begin_inset Flex Code
1795 \begin_layout Plain Layout
1802 \begin_inset Newline newline
1805 Another warning message, this time about fonts which \SpecialChar LaTeX
1807 The rest of the message will often say something about a replacement font
1808 that \SpecialChar LaTeX
1810 You can safely ignore these, too.
1813 \begin_layout Itemize
1814 \begin_inset Flex Code
1817 \begin_layout Plain Layout
1826 \begin_inset Newline newline
1835 It seems to generate at least one of these messages for just about any
1837 They are warnings about lines that were too long and run past the right
1839 This happens if \SpecialChar LaTeX
1840 does not find a reasonable way to break the lines (notoriously
1841 often with typewriter font, since this does not allow for automatic break
1843 In many cases, this is unnoticeable in the final output.
1844 (It can be just a point or two.) Sometimes, however, the lines run rather
1845 visibly into the margin; something you will not want to have in your final
1848 \begin_inset Newline newline
1851 There are several global ways to try to minimize the overfull lines.
1854 Enable micro-typographic extensions
1858 Document\SpecialChar menuseparator
1859 Settings\SpecialChar menuseparator
1862 might already improve things a lot.
1863 Furthermore, \SpecialChar LaTeX
1864 code such as the following in
1866 Document\SpecialChar menuseparator
1867 Settings\SpecialChar menuseparator
1870 usually reduces the overfull lines drastically (we use this in the preamble
1875 \begin_layout LyX-Code
1879 \begin_inset Newline newline
1885 \begin_inset Newline newline
1890 emergencystretch 1.5em
1891 \begin_inset Newline newline
1899 \begin_layout Standard
1900 In some cases, however, you eventually have to rewrite the text to get the
1901 line breaking right.
1905 \begin_layout Plain Layout
1906 For more information, see
1907 \begin_inset Flex URL
1910 \begin_layout Plain Layout
1912 http://www.tex.ac.uk/FAQ-overfull.html
1925 \begin_layout Standard
1926 In any case, you should check the respective lines, at least for the final
1927 version of your document.
1928 Your eyes will tell you if there's a problem with something that's too
1933 \begin_layout Plain Layout
1934 You can also enable the `draft' option in
1935 \begin_inset Flex Noun
1938 \begin_layout Plain Layout
1939 Document\SpecialChar menuseparator
1945 , and then \SpecialChar LaTeX
1946 will draw a black box in the margin of lines that are overfull.
1955 \begin_layout Itemize
1956 \begin_inset Flex Code
1959 \begin_layout Plain Layout
1968 \begin_inset Newline newline
1971 Not quite as common as its cousin.
1972 This happens again if \SpecialChar LaTeX
1973 does not find a reasonable break point and consequently
1974 generates too loose lines.
1975 As with the overfull lines, you should check if this is a visible problem.
1978 \begin_layout Itemize
1979 \begin_inset Flex Code
1982 \begin_layout Plain Layout
1991 \begin_inset Flex Code
1994 \begin_layout Plain Layout
2003 \begin_inset Newline newline
2006 Warnings about troubles breaking the page.
2007 Once again, just look at the output.
2008 Your eyes will tell you where something has gone wrong.
2011 \begin_layout Itemize
2012 \begin_inset Flex Code
2015 \begin_layout Plain Layout
2017 \begin_inset Quotes els
2021 \begin_inset Quotes ers
2030 \begin_inset Newline newline
2034 \begin_inset Quotes eld
2038 \begin_inset Quotes erd
2041 isn't installed on this system.
2042 This usually appears because some package your document needs isn't installed.
2043 If you didn't touch the preamble or didn't use the
2044 \begin_inset Flex Code
2047 \begin_layout Plain Layout
2055 command, then one of the packages \SpecialChar LyX
2056 tried to load is missing.
2058 \begin_inset Flex Noun
2061 \begin_layout Plain Layout
2062 Help\SpecialChar menuseparator
2069 to get a list of packages that \SpecialChar LyX
2071 This file is updated whenever you reconfigure \SpecialChar LyX
2073 \begin_inset Flex Noun
2076 \begin_layout Plain Layout
2077 Tools\SpecialChar menuseparator
2083 ) and tells you which packages have been detected and what they do.
2084 \begin_inset Newline newline
2088 \begin_inset Flex Code
2091 \begin_layout Plain Layout
2099 command and the package in question isn't installed, then you'll need to
2100 install it yourself.
2103 \begin_layout Itemize
2104 \begin_inset Flex Code
2107 \begin_layout Plain Layout
2108 LaTeX Error: Unknown option
2114 \begin_inset Newline newline
2117 Error messages beginning with this are trying to tell you that you specified
2118 a bad or undefined option to a package.
2119 Check the package's documentation.
2122 \begin_layout Itemize
2123 \begin_inset Flex Code
2126 \begin_layout Plain Layout
2127 Undefined control sequence
2133 \begin_inset Newline newline
2136 If you've inserted \SpecialChar LaTeX
2137 code into your document, but made a typo, you'll get
2139 You may have forgotten to load a package.
2140 In any case, this error message usually means that you used an undefined
2145 \begin_layout Standard
2146 There are other error and warning messages.
2147 Some are self-explanatory.
2148 These are usually \SpecialChar LaTeX
2150 Others are downright cryptic.
2151 These are usually \SpecialChar TeX
2152 error messages, and we really have
2156 what they mean or how to decipher them.
2160 \begin_layout Standard
2161 There's a general sequence you should follow if you get error messages:
2164 \begin_layout Enumerate
2165 Look at the \SpecialChar LaTeX
2166 code you inserted for typos.
2169 \begin_layout Enumerate
2170 If there are no typos, check that you used the command(s) correctly.
2173 \begin_layout Enumerate
2174 If you get a bunch of error boxes piled up at the very top of the document—and
2175 especially if you see a
2176 \begin_inset Quotes eld
2180 \begin_inset Flex Code
2183 \begin_layout Plain Layout
2192 \begin_inset Quotes erd
2195 error—it means that there are errors in the preamble.
2196 Start debugging your preamble.
2199 \begin_layout Enumerate
2200 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2202 document, the first suspect is your \SpecialChar LaTeX
2203 distribution itself.
2204 Check for missing packages and install them.
2207 \begin_layout Enumerate
2208 Okay, so there are no missing packages.
2209 Did you use any of the fine-tuning options in \SpecialChar LyX
2210 ? Specifically, did you
2214 any of them, like trying to manually insert lots of
2215 \begin_inset Flex Code
2218 \begin_layout Plain Layout
2220 \change_deleted 177693 1654669036
2222 \change_inserted 177693 1654669038
2226 \begin_inset space ~
2230 \change_deleted 177693 1654669040
2232 \change_inserted 177693 1654669041
2241 \begin_inset Flex Code
2244 \begin_layout Plain Layout
2251 \begin_inset Flex Code
2254 \begin_layout Plain Layout
2260 ? Did you try to kludge something together with these instead of using the
2261 appropriate paragraph environment?
2264 \begin_layout Enumerate
2265 All right, you didn't use any of the fine-tuning options, you played by
2267 Did you try to pull a fancy maneuver? Did you do something funky inside
2268 a table or an equation, like inserting a graphic into a table cell?
2271 \begin_layout Enumerate
2272 Do you have long sections of text where \SpecialChar LaTeX
2273 cannot find a place to break a
2274 line? By default, \SpecialChar LaTeX
2275 is rather strict about how much extra inter-word spacing
2276 it will add in order to break a line.
2277 Preferably, you should rework the paragraph to avoid the problem.
2280 \begin_layout Enumerate
2281 Did you go overboard with the nesting? \SpecialChar LyX
2282 (currently) doesn't check to make
2283 sure you're in the limits for nesting environments.
2284 If you nested a bunch of environments to the
2285 \begin_inset Formula $17^{\mathrm{th}}$
2288 level, that's the problem.
2289 (The limit in \SpecialChar LaTeX
2293 \begin_layout Enumerate
2294 Okay, you didn't get any error messages, but your output looks awful.
2295 If you have a table or figure that's too wide or long for the page, you
2300 \begin_layout Enumerate
2301 rescale the figure so it fits.
2304 \begin_layout Enumerate
2305 trim down the table so it fits.
2309 \begin_layout Enumerate
2310 If something else is wrong with the output, and you didn't try to pull anything
2311 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2314 \begin_layout Standard
2315 If all this doesn't help—well, then
2319 you might have found a bug in \SpecialChar LyX
2324 \begin_layout Chapter
2326 \change_inserted 564990737 1670439508
2330 \begin_layout Section
2332 \change_inserted 564990737 1670439533
2333 \begin_inset CommandInset label
2335 name "sec:Collections"
2342 \begin_layout Subsection
2343 AMS \SpecialChar LaTeX
2347 \begin_layout Standard
2354 Richard Kimberly Heck
2357 \begin_layout Standard
2358 \begin_inset VSpace bigskip
2364 \begin_layout Standard
2366 The AMS \SpecialChar LaTeX
2367 layouts are set up to conform to suggested styles for mathematical
2368 papers to be submitted to American Mathematical Society publications.
2369 The layouts are not tailored to a specific journal, but easily can be.
2370 You should refer to the AMS documentation for specific instructions for
2371 each journal (usually it will entail only changing a single line in the
2374 That documentation is available on the Web at
2375 \begin_inset Flex URL
2378 \begin_layout Plain Layout
2386 \begin_inset Flex URL
2389 \begin_layout Plain Layout
2391 ftp://ftp.ams.org/pub/tex/amslatex/
2397 These layouts are appropriate, and useful, for any mathematical writing.
2401 \begin_layout Standard
2402 There are two basic AMS \SpecialChar LaTeX
2406 \begin_layout Itemize
2407 amsart: The standard AMS article format.
2410 \begin_layout Itemize
2411 amsbook: the standard AMS book (really, monograph) format.
2415 \begin_layout Standard
2416 The layouts themselves contain only the minimum necessary to use the AMS
2418 They do not, in particular, contain any of the `theorem' environments used
2419 for setting theorems, lemmas, and the like.
2420 These are contained, instead, in the
2421 \begin_inset Flex Code
2424 \begin_layout Plain Layout
2430 module, which is loaded by default when you select one of the AMS classes.
2431 (It can also be used with other classes and can be removed, if you would
2432 rather use something else.) Less commonly used environments are in the
2433 \begin_inset Flex Code
2436 \begin_layout Plain Layout
2437 Theorems (AMS-Extended)
2442 module, which must be loaded manually.
2445 \begin_layout Standard
2446 By default, theorems and the like are numbered consecutively throughout
2447 the document, but this may be modified by loading the module
2448 \begin_inset Flex Code
2451 \begin_layout Plain Layout
2452 Theorems (Order by Section)
2457 or, if you are using
2458 \begin_inset Flex Code
2461 \begin_layout Plain Layout
2468 \begin_inset Flex Code
2471 \begin_layout Plain Layout
2472 Theorems (Order by Chapter)
2478 These will number the results as
2479 \begin_inset Formula $n.m$
2482 , where the first number refers to the section (or chapter) and the second
2483 refers to the total number of results so far in that section (or chapter).
2484 Many environments are also available unnumbered.
2485 These are indicated by an asterisk at the end.
2486 If you happen to want
2490 unnumbered results, the module
2491 \begin_inset Flex Code
2494 \begin_layout Plain Layout
2500 provides that option.
2503 \begin_layout Standard
2504 Note that these modules do not
2508 to be used with the AMS classes.
2509 It is perfectly possible to use the
2510 \begin_inset Flex Code
2513 \begin_layout Plain Layout
2519 module, and the others mentioned, with other classes, such as
2520 \begin_inset Flex Code
2523 \begin_layout Plain Layout
2530 \begin_inset Flex Code
2533 \begin_layout Plain Layout
2540 \begin_inset Flex Code
2543 \begin_layout Plain Layout
2552 \begin_layout Subsubsection
2553 What these layouts provide
2556 \begin_layout Standard
2557 There is a long list of included environments provided by these layouts.
2558 In AMS-\SpecialChar LaTeX
2559 , there is, in fact, an opportunity to define an unlimited variety
2560 of `theorem' environments.
2561 However, the AMS recommends the environments that are available in \SpecialChar LyX
2566 \begin_layout Standard
2567 The following environments—as well as the standard environments, such as
2569 \begin_inset Flex Noun
2572 \begin_layout Plain Layout
2579 \begin_inset Flex Noun
2582 \begin_layout Plain Layout
2589 \begin_inset Flex Noun
2592 \begin_layout Plain Layout
2599 \begin_inset Flex Noun
2602 \begin_layout Plain Layout
2609 \begin_inset Flex Noun
2612 \begin_layout Plain Layout
2619 \begin_inset Flex Code
2622 \begin_layout Plain Layout
2629 \begin_inset Flex Code
2632 \begin_layout Plain Layout
2641 \begin_layout Description
2642 Address This should be the author's permanent address.
2645 \begin_layout Description
2647 \begin_inset space ~
2650 Address This should be the author's temporary address at the time of submission,
2651 if different from the Address.
2654 \begin_layout Description
2655 Email Author's e-mail address
2658 \begin_layout Description
2659 URL Author's Web address, if desired.
2662 \begin_layout Description
2663 Keywords Key words or phrases used to identify specific topics discussed
2667 \begin_layout Description
2668 Subjectclass These refer to the AMS Subject Classifications, published and
2671 Mathematical Reviews
2674 These are also available online at the AMS cites listed above.
2677 \begin_layout Description
2681 \begin_layout Description
2685 \begin_layout Description
2689 \begin_layout Standard
2690 The following environments are provided by both the
2691 \begin_inset Flex Code
2694 \begin_layout Plain Layout
2701 \begin_inset Flex Code
2704 \begin_layout Plain Layout
2710 modules, in the latter case in both starred (unnumbered) and unstarred
2711 (numbered) versions.
2712 These same environments are provided only in the starred versions by the
2714 \begin_inset Flex Code
2717 \begin_layout Plain Layout
2726 \begin_layout Theorem
2727 This is typically used for the statements of major results.
2731 \begin_layout Corollary*
2732 This is used for statements which follow fairly directly from previous statement
2734 Again, these can be major results.
2739 These are smaller results needed to prove other statements.
2742 \begin_layout Proposition
2743 These are less major results which (hopefully) add to the general theory
2747 \begin_layout Conjecture
2748 These are statements provided without justification, which the author does
2749 not know how to prove, but which seem to be true (to the author, at least).
2752 \begin_layout Definition*
2753 Guess what this is for.
2754 The font is different for this environment than for the previous ones.
2758 \begin_layout Example*
2759 Used for examples illustrating proven results.
2762 \begin_layout Problem
2763 It's not really known what this is for.
2764 You should figure it out.
2767 \begin_layout Exercise*
2768 Write a description for this one.
2771 \begin_layout Remark
2772 This environment is also a type of theorem, usually a lesser sort of observation.
2775 \begin_layout Claim*
2776 Often used in the course of giving a proof of a larger result.
2780 Generally, these are used to break up long arguments, using specific instances
2786 The numbering scheme for cases is on its own, not together with other numbered
2792 At the end of this environment, a QED symbol (usually a square, but it can
2793 vary with different styles) is placed.
2794 If you want to have other environments within this one—for example, Case
2795 environments—and have the QED symbol appear only after them, then the other
2796 environments need to be nested within the proof environment.
2799 Nesting Environments
2805 for information on nesting.
2808 \begin_layout Standard
2809 And these environments are provided by
2810 \begin_inset Flex Code
2813 \begin_layout Plain Layout
2814 Theorems (AMS-Extended)
2822 \begin_layout Criterion*
2823 A required condition.
2826 \begin_layout Algorithm*
2827 A general procedure to be used.
2830 \begin_layout Axiom*
2831 This is a property or statement taken as true within the system being discussed.
2834 \begin_layout Condition*
2835 Sometimes used to state a condition assumed within the present context of
2840 Similar to a Remark.
2843 \begin_layout Notation*
2844 Used for the explanation of, yes, notation.
2847 \begin_layout Summary
2848 Do we really need to tell you?
2851 \begin_layout Acknowledgement*
2855 \begin_layout Conclusion*
2856 Sometimes used at the end of a long train of argument.
2860 Used in a way similar to Proposition, though perhaps lower on the scale.
2863 \begin_layout Standard
2864 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
2867 They need to be available on your system in order to use these environments.
2870 \begin_layout Subsection
2872 \change_inserted 564990737 1671383236
2875 \begin_inset CommandInset label
2877 name "subsec:Extra-font-sizes"
2884 \begin_layout Standard
2886 \change_inserted 564990737 1671383236
2889 The “Extra font sizes” collection provides the document classes
2892 \begin_inset space \thinspace{}
2895 (with extra font sizes)
2900 \begin_inset space \thinspace{}
2903 (with extra font sizes)
2908 \begin_inset space \thinspace{}
2911 (with extra font sizes)
2916 \begin_inset space \thinspace{}
2919 (with extra font sizes)
2937 document classes respectively but offer the additional
2943 \begin_inset space ~
2948 options 8, 9, 14, 17 and 20 in the
2953 ocument\SpecialChar menuseparator
2958 ettings\SpecialChar menuseparator
2964 \begin_layout Subsection
2966 \change_inserted 564990737 1671383236
2972 \begin_layout Standard
2974 \change_inserted 564990737 1671383236
2977 The document classes
2980 \begin_inset space \thinspace{}
2988 \begin_inset space \thinspace{}
3003 document classes to facilitate the use of Hebrew in \SpecialChar LyX
3007 \begin_layout Subsection
3009 \change_inserted 564990737 1671383236
3012 \begin_inset CommandInset label
3014 name "subsec:Japanese"
3021 \begin_layout Standard
3023 \change_inserted 564990737 1671383236
3026 The document classes
3029 \begin_inset space \thinspace{}
3037 \begin_inset space \thinspace{}
3040 (Japanese Standard Class Vertical Writing)
3045 \begin_inset space \thinspace{}
3048 (Japanese Standard Class)
3053 \begin_inset space \thinspace{}
3061 \begin_inset space \thinspace{}
3064 (Japanese Standard Class Vertical Writing)
3069 \begin_inset space \thinspace{}
3072 (Japanese Standard Class)
3077 \begin_inset space \thinspace{}
3080 (Japanese Vertical Writing)
3085 \begin_inset space \thinspace{}
3088 (Japanese Standard Class)
3090 provide document classes for the Japanese language.
3093 \begin_layout Subsection
3097 \begin_layout Standard
3103 \begin_layout Subsubsection
3107 \begin_layout Standard
3108 The \SpecialChar LyX
3111 article (koma-script)
3115 report (koma-script)
3133 correspond to the \SpecialChar LaTeX
3151 \begin_inset space ~
3154 of the Koma-Script family.
3155 They are replacements for the standard document classes
3171 , resp., and fit better to European typography conventions in a number of
3175 \begin_layout Itemize
3176 Standard character size is 11pt in
3178 article (koma-script)
3182 report (koma-script)
3190 letter (koma-script)
3195 \begin_layout Itemize
3196 Headings, labels of the description environment, and a number of elements
3199 letter (koma-script)
3201 document class are set in a bold sans serif font.
3205 \begin_layout Plain Layout
3206 There is a big difference between the bold sans serif old cm fonts and new
3207 ec fonts, especially in the appearance of headings.
3208 In comparison, the ec bold sans serif fonts look a bit thin.
3209 Here the \SpecialChar LaTeX
3218 helps to produce the
3219 \begin_inset Quotes eld
3223 \begin_inset Quotes erd
3226 appearance when using the ec fonts.
3231 The numbering of chapter headings is made in the same way as the numbering
3232 of section headings, that is without the extra line
3233 \begin_inset Quotes eld
3236 Chapter\SpecialChar ldots
3238 \begin_inset Quotes erd
3242 In addition, the appearance of the headings can be modified by using a
3243 number of options (in \SpecialChar LyX
3244 to be entered in the field
3247 \begin_inset space ~
3254 Layout\SpecialChar menuseparator
3261 \begin_layout Itemize
3262 The main means in the Koma-Script document classes to design the type area
3271 (in \SpecialChar LyX
3272 to be entered in the extra class options field in the dialog
3274 Document\SpecialChar menuseparator
3278 They make a clearer modification of page margins possible as do the options
3281 Document\SpecialChar menuseparator
3288 \begin_layout Itemize
3289 The \SpecialChar LaTeX
3290 document classes of the Koma-Script family define a number of additional
3292 Those part of it which makes sense in \SpecialChar LyX
3293 is implemented in corresponding
3297 \begin_layout Standard
3298 Detailed descriptions of the \SpecialChar LaTeX
3299 document classes of the Koma-Script family
3300 can be found in the Koma-Script documentation
3311 \begin_layout Subsubsection
3312 article (koma-script), report (koma-script), and book (koma-script)
3315 \begin_layout Standard
3316 The document classes
3318 article (koma-script)
3322 report (koma-script)
3332 are implemented in the layout files
3345 They contain all the paragraph types of the corresponding standard document
3358 , resp., partly modified, with the exception of the \SpecialChar LyX
3363 -type, which is replaced by the new
3367 -type having the same functionality.
3372 -Type there is a number of new paragraph types added.
3379 letter (koma-script)
3384 \begin_layout Itemize
3393 : are equivalents to
3401 , resp., additionally inserting an entry in the table of contents.
3410 are not contained in
3412 article (koma-script)
3417 \begin_layout Itemize
3434 , resp., additionally clearing running heads.
3441 article (koma-script)
3447 \begin_layout Plain Layout
3460 report (koma-script)
3462 , but since this is identical to
3466 , is has not been implemented in \SpecialChar LyX
3475 \begin_layout Itemize
3480 : generates a heading directly above the following paragraph in the standard
3481 character size without affecting the structure of the document.
3484 \begin_layout Itemize
3493 are special captions which respect the different space settings needed
3494 for captions placed above or below an element (if you follow strict typographic
3495 rules, you might want to place table captions always above the table).
3496 You can also use the class option
3513 You need at least Koma-Script version 2.8q to use this.
3516 \begin_layout Itemize
3521 : can be used to set a bonmot, e.
3522 \begin_inset space \thinspace{}
3526 \begin_inset space \space{}
3529 at the beginning of a chapter.
3530 If you use the optional argument (
3532 Insert\SpecialChar menuseparator
3534 \begin_inset space ~
3539 ), you can insert the dictum's author there.
3540 Dictum and author are separated by a line.
3541 You need at least Koma-Script version 2.8q to use this.
3548 article (koma-script)
3553 \begin_layout Standard
3554 The following types, together with the standard types
3566 , form the title area of the document.
3567 They must be entered ahead of the first
3568 \begin_inset Quotes eld
3572 \begin_inset Quotes erd
3579 \begin_layout Plain Layout
3580 The corresponding \SpecialChar LaTeX
3581 commands must appear before the
3592 When such a type is used more than once, the latter usage overwrites the
3593 former one, that means, for every type only the latest usage is valid.
3594 The order of the different types however has, like
3606 , no effect on the appearance of the produced document.
3609 \begin_layout Itemize
3614 : produces a centered paragraph above the ordinary title (
3626 ) for the subject of the document.
3629 \begin_layout Itemize
3634 : produces a centered paragraph below the ordinary title (
3646 ) for the publishers' name.
3649 \begin_layout Itemize
3656 report (koma-script)
3662 produces a centered paragraph on its own page behind the title page, or
3665 article (koma-script)
3667 produces a centered paragraph below the ordinary title (
3686 \begin_layout Itemize
3691 : produces a left aligned paragraph above the ordinary title (
3707 ) for a document`s head.
3710 \begin_layout Itemize
3715 : produces in a double-sided print in
3717 report (koma-script)
3723 a left-aligned paragraph at the top of the title page`s back or has no
3724 effect in a single-sided print or in
3726 article (koma-script)
3731 \begin_layout Itemize
3736 : produces in a double-sided print in
3738 report (koma-script)
3744 a left-aligned paragraph at the bottom of the title page`s back or has
3745 no effect in a single-sided print or in
3747 article (koma-script)
3752 \begin_layout Itemize
3757 : produces a special
3758 \begin_inset Quotes eld
3762 \begin_inset Quotes erd
3765 page ahead of the actual document containing a paragraph without special
3769 \begin_layout Standard
3770 The layout files for the document classes
3772 article (koma-script)
3776 report (koma-script)
3787 This is thought of as a place to define your own types.
3792 in your personal layout directory and edit the file!
3795 \begin_layout Subsubsection
3796 letter (koma-script)
3799 \begin_layout Description
3800 Note: This section discusses the obsolete
3802 KOMA-Script-Letter (v.
3803 \begin_inset space ~
3808 , which is not even included anymore in recent KOMA releases.
3809 Please refer to the next section for the current KOMA-Script-Letter class
3811 \begin_inset space ~
3817 \begin_layout Standard
3821 letter (koma-script)
3823 is implemented in the layout file
3828 It contains all the paragraph types of the corresponding standard document
3833 , partly modified, with the exception of the \SpecialChar LyX
3847 type, which is replaced by the new
3852 In addition, it contains, in contrast to the standard document class, the
3871 Furthermore, there are a number of new letter specific types.
3874 \begin_layout Standard
3875 The appearance of the letter produced by this document class can be controlled
3876 by a number of \SpecialChar LaTeX
3877 commands, which you can put in the \SpecialChar LaTeX
3882 \begin_layout Plain Layout
3883 For example, the standard appearance of the letter`s heading, consisting
3884 of name and address, is quite self-willed.
3886 \begin_inset Quotes eld
3890 \begin_inset Quotes erd
3893 heading is produced by the following \SpecialChar LaTeX
3894 commands in the preamble:
3897 \begin_layout LyX-Code
3907 \begin_layout LyX-Code
3923 \begin_layout LyX-Code
3933 \begin_layout LyX-Code
3953 A detailed German description of such \SpecialChar LaTeX
3954 commands can be found in the Koma-Script
3960 With it, the letter's author can produce his personal letter layout.
3963 \begin_layout Standard
3972 define the beginning of the letter and must be used in every letter.
3973 To emphasize them in the \SpecialChar LyX
3974 document class, they are marked with the letter
3984 \begin_inset space ~
3988 It is possible to write any number of letters in one file.
3993 type produces a new letter using the same addressee and a
3997 type produces a new addressee.
4014 are ordinary paragraph types and can also be used several times in one
4015 and the same letter.
4018 \begin_layout Itemize
4023 : produces a paragraph for the addressee and implicitly defines the beginning
4027 \begin_layout Itemize
4032 : produces a paragraph for the form of address and implicitly produces a
4036 \begin_layout Itemize
4041 : produces a paragraph for a close.
4044 \begin_layout Itemize
4049 : produces a paragraph for a postscript.
4052 \begin_layout Itemize
4057 : produces a paragraph for a distribution list.
4060 \begin_layout Itemize
4065 : produces a paragraph for enclosures.
4068 \begin_layout Standard
4109 are input types provided with a label to enter information, which will
4110 be processed by the document class.
4114 \begin_layout Plain Layout
4115 It could be seen as a matter of inconsequence, that the types
4123 described above are not such input types as well.
4124 Because of the special meaning of those types, however, I have implemented
4125 them as ordinary paragraph types with a one letter mark in the left margin.
4126 Moreover, it would affect my feeling of symmetry, if the
4134 type had such a serious different appearance.
4139 The types must be used ahead of the corresponding
4146 \begin_layout Standard
4147 An implementation of these types in a WYSIWYG fashion does not seem to make
4148 sense, because the real appearance of the produced letter does not only
4149 depend on the usage of the particular type, but also on other factors.
4150 For example, a signature entered in the
4154 type will in the standard behavior appear in the produced letter only,
4155 when in the same letter also a
4160 The entered value of the
4164 type will in the standard behavior not appear in the produced letter at
4166 The possibility to design the letter`s heading freely is already indicated
4167 in a footnote above.
4170 \begin_layout Standard
4171 The input types can also be used as empty paragraphs.
4173 \begin_inset space \thinspace{}
4177 \begin_inset space \space{}
4189 type is not used at all, in the standard behavior the value of the
4193 type is used as signature, whereas if an empty
4197 type is used, no signature value is defined.
4200 \begin_layout Standard
4201 By using the input types it is possible to write a letter template, containing
4202 filled input types with your personal dates (name, address, etc.) and empty
4203 input types for other dates you want to enter.
4206 \begin_layout Itemize
4211 : sender's name, in the standard behavior appears as a centered paragraph
4212 in small caps in the letter`s heading.
4215 \begin_layout Itemize
4220 : sender's signature, in the standard behavior appears below the
4229 type is used, the value of the
4233 type appears instead.
4236 \begin_layout Itemize
4241 : sender's address, in the standard behavior appears in a centered paragraph
4242 in the letter`s heading below the sender's name.
4245 \begin_layout Itemize
4250 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
4261 \begin_layout Itemize
4266 : place of the letter`s making.
4269 \begin_layout Itemize
4274 : date of the letter`s making.
4283 , in the standard behavior, produce the place and the date in a right-aligned
4284 line below the addressee's field.
4289 type is used, neither place nor date appear, independent of the value of
4299 type is used, the date of the letter `s production is used.
4302 \begin_layout Itemize
4307 : sender`s back address, in the standard behavior appears above the addressee's
4308 field in a small sans serif font.
4311 \begin_layout Itemize
4316 : special mail information, in the standard behavior appears underlined
4317 above the addressee's field below the back address.
4320 \begin_layout Itemize
4325 : additional information, in the standard behavior appears on right side
4326 below the addressee`s field.
4329 \begin_layout Itemize
4334 : the letter's title, in the standard behavior appears in a big, bold, sans
4335 serif font above the subject.
4338 \begin_layout Itemize
4343 : the letter's subject, in the standard behavior appears in a bold font
4351 \begin_layout Standard
4372 produce a business letter like line above the
4376 line containing the fields
4377 \begin_inset Quotes eld
4381 \begin_inset Quotes erd
4385 \begin_inset Quotes eld
4389 \begin_inset Quotes erd
4393 \begin_inset Quotes eld
4397 \begin_inset Quotes erd
4401 \begin_inset Quotes eld
4405 \begin_inset Quotes erd
4409 \begin_inset Quotes eld
4413 \begin_inset Quotes erd
4417 \begin_inset Quotes eld
4421 \begin_inset Quotes erd
4425 For the date field, the value of the
4431 \begin_inset Quotes eld
4434 business letter types
4435 \begin_inset Quotes erd
4438 is used, the value of the
4442 type however does not appear, but only the \SpecialChar LaTeX
4450 The ordinary output of place and date in a right-aligned line below the
4451 addressee`s field is suppressed.
4452 The types are implemented as input types provided with a label and must
4453 be used ahead of the corresponding
4460 \begin_layout Itemize
4468 \begin_layout Itemize
4476 \begin_layout Itemize
4484 \begin_layout Itemize
4492 \begin_layout Itemize
4500 \begin_layout Subsubsection
4501 The new letter class: letter (koma-script v.2)
4504 \begin_layout Standard
4510 \begin_layout Standard
4511 \begin_inset VSpace medskip
4517 \begin_layout Standard
4519 Koma-Script version 2.8 has introduced a new letter class
4523 which supersedes the now unsupported
4528 It has — on the \SpecialChar LaTeX
4529 side — a completely new interface and is not compatible
4531 Therefore, \SpecialChar LyX
4532 supports both, though it is recommended you use the new class.
4535 \begin_layout Standard
4536 This class covers the same functionality as
4538 letter (koma-script),
4545 (receiver's address, same as
4562 will start a new letter (i.
4563 \begin_inset space \thinspace{}
4567 \begin_inset space \space{}
4570 you can write several letters per document).
4571 New elements are sender's
4587 and the possibility to use a
4593 Insert\SpecialChar menuseparator
4599 \begin_layout Standard
4600 The biggest improvement is, though, that the letter's layout is configurable
4601 to meet almost any needs.
4602 This can be done via the preamble or with a special style file (Letter
4603 Class Option, extension
4607 ), that will be read in as a class option.
4611 \begin_layout Plain Layout
4612 The KOMA package comes with some default
4617 There is, for instance, a
4621 file that follows german typesetting rules, or a
4625 that provides the default layout of the old
4630 The latter can be loaded with the class option
4636 Layout\SpecialChar menuseparator
4637 Document\SpecialChar menuseparator
4646 \change_deleted 564990737 1671617922
4654 \change_deleted 564990737 1671617938
4655 that is included in \SpecialChar LyX
4657 \change_inserted 564990737 1671617997
4664 ile\SpecialChar menuseparator
4666 \begin_inset space ~
4674 \begin_inset space ~
4677 Template\SpecialChar menuseparator
4680 \SpecialChar menuseparator
4681 KOMA-Script Letter (V.2)
4686 A detailed description is to be found in the Koma-Script documentation
4694 \begin_layout Subsubsection
4698 \begin_layout Standard
4699 Visualizing the Koma-Script document classes in \SpecialChar LyX
4700 , the \SpecialChar LyX
4701 internals cause some
4705 \begin_layout Itemize
4706 The chapter number of a
4710 type appears on a line of its own above the chapter heading instead of
4711 appearing in the same line ahead of it.
4712 The cause for that is the \SpecialChar LyX
4713 internal behavior for the labeltype
4720 \begin_layout Itemize
4721 The headings of the types
4730 \begin_inset Quotes eld
4734 \begin_inset Quotes erd
4738 table of contents, but not in the \SpecialChar LyX
4741 Document\SpecialChar menuseparator
4743 \begin_inset space ~
4747 \begin_inset space ~
4755 \begin_layout Itemize
4760 document class appear in a skip separation mode, not indented.
4761 This is the standard behavior, no special \SpecialChar LaTeX
4762 commands are needed for that.
4765 Document\SpecialChar menuseparator
4768 dialog the corresponding radio button indicates
4777 value always has the effect that extra \SpecialChar LaTeX
4778 commands are inserted in the document
4779 to produce the gap, which is not what is wanted in this case.
4782 \begin_layout Subsection
4784 \change_inserted 564990737 1670924924
4786 \begin_inset space \thinspace{}
4790 \begin_inset space \space{}
4794 \change_deleted 564990737 1670924933
4795 Article (mwart), book (mwbk) and report (mwrep)
4796 \begin_inset Argument status
4799 \begin_layout Plain Layout
4814 \begin_layout Standard
4820 \begin_layout Standard
4821 The \SpecialChar LyX
4838 correspond to the \SpecialChar LaTeX
4852 They are replacements for the standard document classes
4864 , resp., and fit better to Polish typography conventions in a number of points.
4868 \begin_layout Standard
4872 \begin_layout Itemize
4873 Unnumbered titles (with star, e.
4874 \begin_inset space \thinspace{}
4878 \begin_inset space \space{}
4885 ) are added into table of contents,
4888 \begin_layout Itemize
4889 Additional page styles:
4893 \begin_layout Description
4894 uheadings header with separated lines,
4897 \begin_layout Description
4898 myheadings custom header, contents headers via commands:
4913 \begin_layout Description
4914 myuheadings custom header with separated lines,
4917 \begin_layout Description
4918 outer page number is placed on outer side of page
4922 \begin_layout Itemize
4927 \begin_layout Description
4928 rmheadings serif titles — default,
4931 \begin_layout Description
4932 sfheadings sansserif titles,
4935 \begin_layout Description
4936 authortitle on title page first placed is author next title — default,
4939 \begin_layout Description
4940 titleauthor on title page first placed is title next author,
4943 \begin_layout Description
4944 withmarginpar reserve place on page for margins.
4948 \begin_layout Section
4950 \change_inserted 564990737 1670439534
4954 \begin_layout Standard
4956 \change_inserted 564990737 1670794710
4957 See also the document classes in the Collections (section
4958 \begin_inset space ~
4962 \begin_inset CommandInset ref
4964 reference "sec:Collections"
4971 \begin_layout Subsection
4973 \change_inserted 564990737 1670794716
4979 \begin_layout Standard
4981 \change_inserted 564990737 1670794716
4988 ; updated by the \SpecialChar LyX
4992 \begin_layout Subsubsection
4994 \change_inserted 564990737 1670794716
5000 \begin_layout Standard
5002 \change_inserted 564990737 1670794716
5005 This section describes how \SpecialChar LyX
5006 can be used to write articles for submission
5007 to the scientific journal
5009 Astronomy and Astrophysics
5012 \begin_inset CommandInset href
5015 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
5020 ) using Version 9.1 of the document class
5024 ; information about it is available at
5025 \begin_inset Flex URL
5028 \begin_layout Plain Layout
5030 \change_inserted 564990737 1670794716
5032 https://www.aanda.org/for-authors/latex-issues/texnical-background-information
5042 \begin_layout Standard
5044 \change_inserted 564990737 1670794716
5047 A manual comes together with the package and should be consulted before
5048 installing this document class as described in the
5050 Installing New Document Classe
5060 \begin_layout Standard
5062 \change_inserted 564990737 1670794716
5065 \begin_inset Note Greyedout
5068 \begin_layout Plain Layout
5070 \change_inserted 564990737 1670794716
5073 Please note that the publisher of the journal was changed from Springer
5074 to EDP Sciences starting January 1, 2001.
5075 That change also involved some slight changes to the style files, namely
5076 the removal of the thesaurus command.
5077 If you have an older version installed, please upgrade.
5078 For information about compatibility with the old (version 4) layout, please
5079 refer to the comments in
5082 Dir/layouts/aapaper.layout
5092 \begin_layout Subsubsection
5094 \change_inserted 564990737 1670794716
5100 \begin_layout Standard
5102 \change_inserted 564990737 1671617129
5105 It is recommended you start from the template in the menu
5110 ile\SpecialChar menuseparator
5112 \begin_inset space ~
5120 \begin_inset space ~
5125 \SpecialChar menuseparator
5126 Articles\SpecialChar menuseparator
5127 Astronomy & Astrophysics
5131 If you are not using the template, note the following settings:
5134 \begin_layout Itemize
5136 \change_inserted 564990737 1670794716
5148 ocument\SpecialChar menuseparator
5153 ettings\SpecialChar menuseparator
5155 \begin_inset space ~
5160 dialog (OK, that one was obvious).
5163 \begin_layout Itemize
5165 \change_inserted 564990737 1670794716
5171 \begin_inset space ~
5183 \begin_inset space ~
5188 dialog: leave it set to
5193 The whole layout is done by the macros, you shouldn't change anything.
5196 \begin_layout Subsubsection
5198 \change_inserted 564990737 1670794716
5204 \begin_layout Standard
5206 \change_inserted 564990737 1670794716
5209 First thing to enter is the header information.
5210 It consists of five entries, of which one is optional.
5214 \begin_layout Itemize
5216 \change_inserted 564990737 1670794716
5225 \begin_layout Itemize
5227 \change_inserted 564990737 1670794716
5236 \begin_layout Itemize
5238 \change_inserted 564990737 1670794716
5247 \begin_layout Itemize
5249 \change_inserted 564990737 1670794716
5258 \begin_layout Itemize
5260 \change_inserted 564990737 1670794716
5269 Received: <date>; Accepted <date>
5272 \begin_layout Standard
5274 \change_inserted 564990737 1670794716
5277 Although the order of the single header entries doesn't matter it is advised
5278 to keep the above sequence, just to get the best optics and meets the layout
5279 of the real document.
5282 \begin_layout Standard
5284 \change_inserted 564990737 1670794716
5287 If you want to place footnotes in the header block, e.
5288 \begin_inset space \thinspace{}
5292 \begin_inset space \space{}
5295 to state your present address, just use the standard footnote via the menu
5301 nsert\SpecialChar menuseparator
5310 will automagically use the term
5319 \begin_layout Standard
5321 \change_inserted 564990737 1670794716
5324 In addition to these topics, the macros use three additional \SpecialChar LaTeX
5326 have no counterpart in \SpecialChar LyX
5330 \begin_layout Itemize
5332 \change_inserted 564990737 1670794716
5340 to separate different names for more than one author and institute, respectivel
5344 \begin_layout Itemize
5346 \change_inserted 564990737 1670794716
5354 to mark corresponding author/institute pairs.
5355 The institutes are numbered sequentially as they appear in the
5359 field, so you have to put a marker to each author.
5362 \begin_layout Itemize
5364 \change_inserted 564990737 1670794716
5372 to supply an email address for fast contact.
5375 \begin_layout Standard
5377 \change_inserted 564990737 1671642374
5380 In all cases, the appropriate command has to be entered as \SpecialChar TeX
5381 code in \SpecialChar LyX
5383 See the examples in the template and in
5386 File\SpecialChar menuseparator
5387 Open Example\SpecialChar menuseparator
5388 Articles\SpecialChar menuseparator
5389 Astronomy & Astrophysics
5397 \begin_layout Subsubsection
5399 \change_inserted 564990737 1670794716
5405 \begin_layout Standard
5407 \change_inserted 564990737 1670794716
5410 The abstract should immediately follow the header block and must contain
5420 \begin_layout Enumerate
5422 \change_inserted 564990737 1670794716
5428 (optional) {} leave it empty if necessary
5431 \begin_layout Enumerate
5433 \change_inserted 564990737 1670794716
5442 \begin_layout Enumerate
5444 \change_inserted 564990737 1670794716
5453 \begin_layout Enumerate
5455 \change_inserted 564990737 1670794716
5464 \begin_layout Enumerate
5466 \change_inserted 564990737 1670794716
5472 (optional) {} leave it empty if necessary
5475 \begin_layout Standard
5477 \change_inserted 564990737 1670794716
5481 This structure not shown in
5488 \begin_layout Subsubsection
5490 \change_inserted 564990737 1670794716
5493 Supported environments
5496 \begin_layout Standard
5498 \change_inserted 564990737 1670794716
5501 The A&A paper layout supports the following environments for structuring
5505 \begin_layout Itemize
5507 \change_inserted 564990737 1670794716
5514 \begin_layout Itemize
5516 \change_inserted 564990737 1670794716
5523 \begin_layout Itemize
5525 \change_inserted 564990737 1670794716
5532 \begin_layout Itemize
5534 \change_inserted 564990737 1670794716
5541 \begin_layout Itemize
5543 \change_inserted 564990737 1670794716
5550 \begin_layout Itemize
5552 \change_inserted 564990737 1670794716
5559 \begin_layout Itemize
5561 \change_inserted 564990737 1670794716
5568 \begin_layout Itemize
5570 \change_inserted 564990737 1670794716
5577 \begin_layout Itemize
5579 \change_inserted 564990737 1670794716
5586 \begin_layout Itemize
5588 \change_inserted 564990737 1670794716
5595 \begin_layout Itemize
5597 \change_inserted 564990737 1670794716
5604 \begin_layout Itemize
5606 \change_inserted 564990737 1670794716
5614 \begin_layout Subsubsection
5616 \change_inserted 564990737 1670794716
5619 Commands not supported by \SpecialChar LyX
5623 \begin_layout Standard
5625 \change_inserted 564990737 1670794716
5628 Some commands are not yet supported by the
5632 layout for \SpecialChar LyX
5634 Some have already been mentioned.
5635 For the sake of completeness, they are listed all together here:
5638 \begin_layout Itemize
5640 \change_inserted 564990737 1670794716
5649 \begin_layout Itemize
5651 \change_inserted 564990737 1670794716
5660 \begin_layout Itemize
5662 \change_inserted 564990737 1670794716
5671 \begin_layout Itemize
5673 \change_inserted 564990737 1670794716
5682 \begin_layout Itemize
5684 \change_inserted 564990737 1670794716
5693 \begin_layout Standard
5695 \change_inserted 564990737 1670794716
5698 If you want to use any of these commands, you have to enter them yourself.
5701 Do not forget to use
5707 nsert\SpecialChar menuseparator
5710 \begin_inset space ~
5719 \begin_layout Subsubsection
5721 \change_inserted 564990737 1670794716
5724 Figure and Table Floats
5727 \begin_layout Standard
5729 \change_inserted 564990737 1670794716
5733 provides support for the necessary float environments
5735 figure, figure*, table
5741 , therefore we won't tell much about it here.
5745 \begin_inset space ~
5751 Just remember that tables should be left-aligned.
5752 For that, select the table and change the alignment in
5757 dit\SpecialChar menuseparator
5763 \begin_inset space ~
5769 \begin_layout Standard
5771 \change_inserted 564990737 1670794716
5774 There is only one special thing: the figures with a caption beside the figure.
5775 To create such a figure, you have to do the following:
5778 \begin_layout Enumerate
5780 \change_inserted 564990737 1670794716
5783 Create a wide figure float:
5788 nsert\SpecialChar menuseparator
5793 t\SpecialChar menuseparator
5796 , then, from within the float, use the menu
5801 dit\SpecialChar menuseparator
5807 \begin_inset space ~
5818 \begin_inset space ~
5830 \begin_layout Enumerate
5832 \change_inserted 564990737 1670794716
5835 Enter your caption text.
5838 \begin_layout Enumerate
5840 \change_inserted 564990737 1670794716
5847 to move the cursor above the caption.
5850 \begin_layout Enumerate
5852 \change_inserted 564990737 1670794716
5858 \begin_layout Enumerate
5860 \change_inserted 564990737 1670794716
5863 Position the cursor after the figure and insert a horizontal fill by using
5869 nsert\SpecialChar menuseparator
5874 rmatting\SpecialChar menuseparator
5880 \begin_inset space ~
5889 dialog and select the
5903 \begin_layout Enumerate
5905 \change_inserted 564990737 1670794716
5908 Switch to \SpecialChar LaTeX
5912 \begin_inset space ~
5920 \begin_layout Enumerate
5922 \change_inserted 564990737 1670794716
5933 Do not close the brace!
5936 \begin_layout Enumerate
5938 \change_inserted 564990737 1670794716
5941 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
5946 \begin_inset space ~
5958 \begin_layout Standard
5960 \change_inserted 564990737 1671642458
5963 Also, refer to the figures in the file in
5966 File\SpecialChar menuseparator
5967 Open Example\SpecialChar menuseparator
5968 Articles\SpecialChar menuseparator
5969 Astronomy & Astrophysics
5975 \begin_layout Subsubsection
5977 \change_inserted 564990737 1670794716
5983 \begin_layout Standard
5985 \change_inserted 564990737 1670794716
5988 For submission, the paper has to be formatted in a special double-spacing
5990 For this purpose, you have to add the option
6001 \begin_inset space ~
6011 ocument\SpecialChar menuseparator
6016 ettings\SpecialChar menuseparator
6018 \begin_inset space ~
6027 \begin_layout Subsubsection
6029 \change_inserted 564990737 1670794716
6035 \begin_layout Standard
6037 \change_inserted 564990737 1671642520
6043 File\SpecialChar menuseparator
6044 Open Example\SpecialChar menuseparator
6045 Articles\SpecialChar menuseparator
6046 Astronomy & Astrophysics
6049 was written with \SpecialChar LyX
6051 It is the example paper from the original macro package,
6056 \begin_inset CommandInset href
6059 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
6064 , but translated to \SpecialChar LyX
6065 using the older unstructured abstract type.
6066 Use it for inspiration, and compare the \SpecialChar LaTeX
6071 with the \SpecialChar LyX
6075 \begin_layout Subsection
6080 \begin_layout Standard
6086 \begin_layout Subsubsection
6090 \begin_layout Standard
6092 is a set of macros produced by the American Astronomical Society to
6093 facilitate electronic manuscript submission to the three journals they
6094 publish: the Astrophysical Journal (including the Letters and Supplement),
6095 the Astronomical Journal, and the Publications of the Astronomical Society
6098 has proven to be an excellent tool for generating these documents, especially
6099 given its equation, citation, and figure handling capabilities.
6101 requires version 5.0 (or higher) of these macros; preferably 6.0, which
6102 is the version described here, or higher.
6103 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
6104 2.09 and are fundamentally
6105 incompatible with \SpecialChar LyX
6107 The AAS\SpecialChar TeX
6108 package may be downloaded from the AAS\SpecialChar TeX
6112 \begin_layout Standard
6113 \begin_inset VSpace medskip
6119 \begin_layout Standard
6121 \begin_inset Flex URL
6124 \begin_layout Plain Layout
6126 https://aas.org/aastex/aastex-downloads
6134 \begin_layout Standard
6135 \begin_inset VSpace medskip
6141 \begin_layout Standard
6142 A complete user guide is contained in that package and you should familiarize
6143 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
6146 will not reduce the need to figure out all the AAS\SpecialChar TeX
6147 commands, it will only
6148 reduce the drudgery of typing everything in.
6149 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
6151 completely to the requirements of the journal to which you are submitting
6155 \begin_layout Subsubsection
6156 Starting a New Paper
6159 \begin_layout Standard
6160 I strongly suggest that you start with the AAS\SpecialChar TeX
6164 File\SpecialChar menuseparator
6170 \change_inserted 564990737 1671617265
6171 \SpecialChar menuseparator
6172 Articles\SpecialChar menuseparator
6173 American Astronomical Society
6174 \change_deleted 564990737 1671617310
6177 , enter the new file name, then choose the
6184 This will show the most common fields found in a manuscript.
6185 Simply overwrite the existing text (including the brackets,
6189 ) with the correct information.
6190 Many of the AAS\SpecialChar TeX
6191 commands and environments can be implemented directly in
6194 For commands such as these, the \SpecialChar LaTeX
6195 code must be entered directly and marked
6197 Such commands are referred to as \SpecialChar TeX
6198 code, or Evil Red Text.
6199 I tried to minimize the amount of \SpecialChar TeX
6200 code needed in an AAS\SpecialChar TeX
6204 \begin_layout Subsubsection
6205 Finishing Your Paper
6208 \begin_layout Standard
6209 When the paper is finished to your satisfaction and previews/prints correctly,
6211 \begin_inset Quotes eld
6215 \begin_inset Quotes erd
6218 actions which need to be done before you submit it to the journals.
6222 \begin_layout Enumerate
6223 Export your paper as a \SpecialChar LaTeX
6226 File\SpecialChar menuseparator
6227 Export\SpecialChar menuseparator
6235 \begin_layout Enumerate
6240 file with your favorite text editor
6244 \begin_layout Enumerate
6245 remove the comment lines before the
6254 \begin_layout Enumerate
6259 usepackage...{fontenc}
6261 line if it appears (usually just after
6276 \begin_layout Enumerate
6277 remove everything between (and including) the
6289 commands, except for any commands you specifically put into the \SpecialChar LaTeX
6291 (which should appear immediately after the
6292 \begin_inset Quotes eld
6295 User specified \SpecialChar LaTeX
6297 \begin_inset Quotes erd
6308 \begin_layout Enumerate
6309 Run the resulting file through \SpecialChar LaTeX
6310 to make sure it still processes correctly.
6313 \begin_layout Enumerate
6314 Reread the journal requirements to make sure your filenames and formats
6318 \begin_layout Enumerate
6322 \begin_layout Subsubsection
6323 Comments On Specific Commands
6326 \begin_layout Standard
6327 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
6334 ) gives a good description of each.
6335 Thus it's probably easiest for me to go down the list as found in the guide
6336 and offer comments where necessary.
6337 So let's begin \SpecialChar ldots
6341 \begin_layout Paragraph
6342 Things that work as expected
6345 \begin_layout Standard
6346 Because they work as you might expect, I simply list them and the section
6447 begin{thebibliography}
6455 (2.13.2), all the cite commands and their variations (2.13.2), the generic
6456 graphicx figure commands (2.14.1),
6480 (2.15.4, amongst other places),
6507 \begin_layout Standard
6508 The following style options also work correctly:
6529 Simply put them in the
6535 Layout\SpecialChar menuseparator
6541 \begin_layout Paragraph
6542 Things that work, but require more comment
6545 \begin_layout Standard
6546 The following items work, but require a little more discussion:
6549 \begin_layout Itemize
6550 These items are reserved for use by the journal editors, but you can put
6551 them into the \SpecialChar LaTeX
6552 preamble if you feel compelled to do so:
6585 \begin_layout Itemize
6586 These items may be placed in the \SpecialChar LaTeX
6587 preamble, and are included as blanks in
6609 \begin_layout Itemize
6616 (2.3) – can only be used
6617 \begin_inset Quotes eld
6621 \begin_inset Quotes erd
6624 , not in the middle of a paragraph.
6625 Use \SpecialChar TeX
6626 code if you need to embed it.
6629 \begin_layout Itemize
6636 (2.3) – will have extra {} after it.
6637 This should not cause an error.
6640 \begin_layout Itemize
6647 (2.6) – can only be used
6648 \begin_inset Quotes eld
6652 \begin_inset Quotes erd
6655 , not in the middle of a paragraph.
6656 Use \SpecialChar TeX
6657 code if you need to embed it.
6660 \begin_layout Itemize
6667 (2.8) – can't insert a cross-reference tag, you must type the tag name by
6671 \begin_layout Itemize
6685 \begin_layout Itemize
6692 (2.9) – will have extra {} after it.
6693 This should not cause an error.
6696 \begin_layout Itemize
6703 (2.11) – will have extra {} after it.
6704 This should not cause an error.
6707 \begin_layout Itemize
6714 (2.14.2) – you can insert an optional filename argument by placing the cursor
6715 at the beginning of the text and selecting
6717 Insert\SpecialChar menuseparator
6722 \begin_inset Quotes eld
6726 \begin_inset Quotes erd
6729 inserts an optional argument of the type needed by
6736 Hopefully it will be renamed someday.
6739 \begin_layout Itemize
6752 for the catalog ID optional parameter
6755 \begin_layout Itemize
6768 for the catalog ID optional parameter
6771 \begin_layout Paragraph
6772 Things not implemented, use \SpecialChar TeX
6776 \begin_layout Standard
6787 setcounter{equation}
6789 (2.12), Journal name abbreviations (2.13.4),
6825 (2.15.4, insert it as the first element in the lefthand cell after where
6827 Don't use any of \SpecialChar LyX
6828 's rules in the table),
6840 (2.15.5), much of Misc (2.17, except
6891 \begin_layout Paragraph
6892 Things that cannot be implemented
6895 \begin_layout Standard
6897 at least in any meaningful sort of way, so I suggest ignoring them.
6898 They are the references environment (2.13.3), and the deluxetable environment
6900 If you really, really need to use deluxetable, I suggest editing it in
6901 a separate file with a text editor, then using
6903 Insert\SpecialChar menuseparator
6905 \begin_inset space ~
6910 to include it in your \SpecialChar LyX
6913 \change_deleted 564990737 1671642564
6919 \change_inserted 564990737 1671642618
6923 File\SpecialChar menuseparator
6924 Open Example\SpecialChar menuseparator
6925 Articles\SpecialChar menuseparator
6926 American Astronomical Society
6932 \change_inserted 564990737 1671642621
6938 \begin_layout Subsubsection
6939 FAQs, Tips, Tricks, and Other Ruminations
6942 \begin_layout Paragraph
6943 Getting \SpecialChar LyX
6944 and AAS\SpecialChar TeX
6948 \begin_layout Standard
6949 It can be a bit tricky to get \SpecialChar LyX
6950 to recognize a new layout and document class.
6951 When all else fails, do this:
6954 \begin_layout Enumerate
6955 Make certain that \SpecialChar LaTeX
6956 can find AAS\SpecialChar TeX
6958 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
6960 directory completely unrelated to \SpecialChar LaTeX
6961 or AAS\SpecialChar TeX
6962 and run \SpecialChar LaTeX
6970 \begin_layout Enumerate
6975 appears in \SpecialChar LyX
6983 \begin_layout Enumerate
6986 Tools\SpecialChar menuseparator
6990 , then restart \SpecialChar LyX
6994 \begin_layout Enumerate
6995 Open a regular new file, not from a template.
6996 Does AAS\SpecialChar TeX
6997 appear in the class list in
6999 Document\SpecialChar menuseparator
7005 \begin_layout Standard
7006 If you get a warning from an existing AAS\SpecialChar TeX
7007 document about not being able
7008 to find the AAS\SpecialChar TeX
7009 layout or a message about
7010 \begin_inset Quotes eld
7013 You should not mix title layouts with normal ones
7014 \begin_inset Quotes erd
7017 , things haven't been installed correctly.
7020 \begin_layout Paragraph
7022 error processing a table
7025 \begin_layout Standard
7027 , by default, attempts to center the table caption/title.
7028 This seems to produce a bad interaction in AAS\SpecialChar TeX
7029 so you should click somewhere
7030 in the caption/title, then select
7032 Edit\SpecialChar menuseparator
7034 \begin_inset space ~
7048 This took care of it for me.
7051 \begin_layout Paragraph
7055 \begin_layout Standard
7056 A couple of things: 1) I have noticed some funny spacing in the reference
7057 entries in the text.
7058 When you enter the bibliography item data, make sure their is
7062 space between the last author and the parenthesis setting off the year;
7066 \begin_inset space \thinspace{}
7070 \begin_inset space \space{}
7084 2) Entering the references at all is not obvious.
7085 The easiest thing is to start typing your first reference at the end of
7086 the document, then mark it as type
7091 That will put a small gray box in front of what you just typed.
7092 Click on the box to fill in the rest of the information.
7093 For new references, go to the end of an existing reference and press return.
7094 That will create a new line with its own box, etc.
7097 \begin_layout Paragraph
7101 \begin_layout Standard
7102 Even though AAS\SpecialChar TeX
7103 provides its own figure commands (
7109 , for example), I much prefer \SpecialChar LaTeX
7110 's standard figure commands (with the default
7119 \begin_inset space ~
7122 commands as \SpecialChar TeX
7123 code into a Figure Float box if you desire, but I never have
7124 much luck getting the layout right.
7125 With the standard graphics, \SpecialChar LyX
7130 usepackage{graphicx}
7132 command into the \SpecialChar LaTeX
7133 preamble and handle the figures in the standard \SpecialChar LaTeX2e
7135 interspersing the figures in the text.
7136 I believe ApJ accepts figures exactly this way now; AJ might still use
7138 \begin_inset Quotes eld
7141 stack everything at the end
7142 \begin_inset Quotes erd
7148 \begin_layout Paragraph
7149 Things I could have done, but didn't
7152 \begin_layout Standard
7154 \begin_inset Quotes eld
7158 \begin_inset Quotes erd
7161 things I could have implemented, but chose not to.
7162 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
7164 even though it is double-spaced in the paper manuscript.
7165 Also, I chose not to make separate layouts for the preprint and preprint2
7167 Since I assume you will spend most of your time in the plain manuscript
7168 mode anyway, I decided not to chew up more disk space with this.
7172 \begin_layout Subsubsection
7176 \begin_layout Standard
7177 Your mileage may vary.
7178 I've now had papers published by both ApJ and AJ that have had 98% of the
7179 effort done in \SpecialChar LyX
7180 ; the last 2% was the \SpecialChar LaTeX
7181 post-processing and a few cleanups.
7182 I have had no trouble with the submission process, and I'm sure the journals
7183 were never aware that there might be a difference.
7184 So, go forth and publish!
7187 \begin_layout Subsection
7189 \change_inserted 564990737 1671442131
7195 \begin_layout Standard
7197 \change_inserted 564990737 1671642768
7203 \begin_inset space \thinspace{}
7212 document class together with the style
7216 to facilitate the description of chess games.
7220 File\SpecialChar menuseparator
7223 \SpecialChar menuseparator
7224 Articles\SpecialChar menuseparator
7243 \begin_layout Subsection
7245 \change_inserted 564990737 1671042028
7251 \begin_layout Standard
7253 \change_inserted 564990737 1671617396
7259 \begin_inset space \thinspace{}
7269 This provides the following additional environments:
7272 \begin_inset space ~
7280 \begin_inset space ~
7288 \begin_inset space ~
7306 A template is available in the menu
7311 ile\SpecialChar menuseparator
7313 \begin_inset space ~
7321 \begin_inset space ~
7326 \SpecialChar menuseparator
7327 Articles\SpecialChar menuseparator
7332 It has been customized with further environments and contains all the informati
7334 However, the documentation is also available from
7335 \begin_inset CommandInset href
7338 target "http://mirrors.ctan.org/macros/latex/contrib/elsarticle/doc/elsdoc.pdf"
7346 \begin_layout Subsection
7348 \change_inserted 564990737 1671042046
7354 \begin_layout Standard
7356 \change_inserted 564990737 1671042046
7362 \begin_inset space \thinspace{}
7367 provides an alternative to the
7372 It provides similar functionality, but you might prefer this layout with
7373 sans serif sections, headings, and more.
7376 \begin_layout Subsection
7381 \begin_layout Standard
7387 \begin_layout Standard
7388 \begin_inset VSpace bigskip
7394 \begin_layout Standard
7399 \begin_inset space ~
7404 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
7406 \begin_inset Formula $\beta$
7409 release of May, 1999) class.
7412 \begin_layout Standard
7418 textclass, which works with Rev\SpecialChar TeX
7420 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
7422 That means that it doesn't interact very well with \SpecialChar LyX
7423 , which requires \SpecialChar LaTeX2e
7425 it has been kludged to work.
7426 Since Rev\SpecialChar TeX
7427 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
7434 \begin_inset space ~
7439 textclass should also be pretty easy to use.
7442 \begin_layout Standard
7443 These documents are supposed to be used in
7447 to the Rev\SpecialChar TeX
7448 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
7450 and assume you'll know what to put in the preamble if necessary.
7453 \begin_layout Subsubsection
7457 \begin_layout Standard
7458 All you need to do is install Rev\SpecialChar TeX
7459 4, as described in the package's README
7461 The package can be found at The Rev\SpecialChar TeX
7463 \begin_inset Flex URL
7466 \begin_layout Plain Layout
7468 http://publish.aps.org/revtex4/
7474 Install it somewhere that \SpecialChar LaTeX
7476 Test it by trying to \SpecialChar LaTeX
7477 a short Rev\SpecialChar TeX
7478 4 document in some random directory (i.
7479 \begin_inset space \thinspace{}
7483 \begin_inset space \space{}
7486 not the directory where you installed the class file.) Then, if you reconfigure
7488 , it will find the class file and let you use the Rev\SpecialChar TeX
7492 \begin_layout Standard
7493 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
7502 \begin_inset space ~
7507 template, found in the templates directory.
7510 \begin_layout Subsubsection
7514 \begin_layout Standard
7515 Optional arguments to
7522 \begin_inset Quotes eld
7526 \begin_inset Quotes erd
7530 \begin_inset Quotes eld
7534 \begin_inset Quotes erd
7540 \begin_inset space ~
7548 \begin_inset space ~
7554 Remember that in Rev\SpecialChar TeX
7555 , at least one optional argument is required!
7558 \begin_layout Standard
7559 Other preamble matter, like
7566 \begin_inset space ~
7573 \begin_inset space ~
7578 dialog, also as usual.
7581 \begin_layout Subsubsection
7585 \begin_layout Standard
7586 The layouts basically correspond to the commands in Rev\SpecialChar TeX
7588 For example, the Email layout corresponds to
7595 Note that (at least as of Rev\SpecialChar TeX
7604 layouts are exactly equivalent, so you shouldn't need to use both.
7608 \begin_layout Plain Layout
7609 In case you're curious, both were included so that
7613 would be able to translate both
7633 \begin_layout Subsubsection
7637 \begin_layout Standard
7638 There are a couple of important unique aspects of Rev\SpecialChar TeX
7640 bugs that will be even more confusing in \SpecialChar LyX
7644 \begin_layout Standard
7645 In Rev\SpecialChar TeX
7663 The \SpecialChar LyX
7664 equivalent is that there is a separate Thanks layout.
7669 write footnotes in the
7673 layout, or weird things may happen.
7674 See the Rev\SpecialChar TeX
7675 4 documentation for more details.
7678 \begin_layout Standard
7682 \begin_inset space ~
7690 \begin_inset space ~
7699 layouts must be placed
7707 layout and the corresponding
7724 , the \SpecialChar LaTeX
7728 \begin_layout Subsection
7730 \change_inserted 564990737 1671042072
7736 \begin_layout Standard
7738 \change_inserted 564990737 1671042072
7745 classes were replaced in 2013 with a completely new
7750 This package provides a \SpecialChar LaTeX
7751 class and templates for books to be published
7752 at Springer Gabler Research, Springer Vieweg Research, Springer Spektrum
7753 Research, Springer VS Research, or Springer VS Forschung.
7754 The documentation is available in German from
7755 \begin_inset CommandInset href
7758 target "http://mirrors.ctan.org/macros/latex/contrib/springer/sr-vorl/sr-vorl.pdf"
7766 \begin_layout Section
7768 \change_inserted 564990737 1670439560
7772 \begin_layout Standard
7774 \change_inserted 564990737 1670439581
7775 See also the document classes in the Collections (section
7776 \begin_inset space ~
7780 \begin_inset CommandInset ref
7782 reference "sec:Collections"
7789 \begin_layout Subsection
7793 \begin_layout Standard
7799 \begin_layout Subsubsection
7803 \begin_layout Standard
7804 Memoir is a very powerful and constantly evolving class.
7805 It has been designed with regard to fictional and non-fictional literature.
7806 Its aim is to let the user have maximum control over the typesetting of
7808 Memoir is based on the standard book class, but it can also emulate the
7809 article class (see below).
7812 \begin_layout Standard
7813 Peter Wilson, the developer of Memoir, is known as the author of lots of
7814 useful packages in the \SpecialChar LaTeX
7816 Most of them have been merged with Memoir.
7817 Therefore, it is much easier to layout the table of contents, appendices,
7818 chapter designs and such.
7820 , though, does not support all of these goodies natively.
7821 Some of them might be added to forthcoming releases
7825 \begin_layout Plain Layout
7826 You are invited to send suggestions to
7827 \begin_inset Flex URL
7830 \begin_layout Plain Layout
7832 lyx-devel@lists.lyx.org
7842 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
7844 Of course you can still use all features with the help of some native \SpecialChar LaTeX
7846 commands (\SpecialChar TeX
7851 \begin_layout Plain Layout
7856 \begin_layout Plain Layout
7866 \begin_inset space ~
7870 \begin_inset CommandInset ref
7872 reference "sec:Inserting-TeX-Code"
7882 In this section, we can only list those features that are natively supported
7885 For detailed descriptions (and for the rest of features) we recommend you
7886 have a look at the detailed manual of the Memoir class
7890 \begin_layout Plain Layout
7895 \begin_layout Plain Layout
7905 \begin_inset Flex URL
7908 \begin_layout Plain Layout
7910 CTAN:/macros/latex/memoir/memman.pdf
7920 , which is not only a user guide for the class, but also both a comprehensive
7921 description on good typesetting and a superb example for good typesetting
7925 \begin_layout Subsubsection
7926 Basic features and restrictions
7929 \begin_layout Standard
7930 Memoir supports basically all features of the standard book classes.
7931 There are, however, some differences, as follows:
7934 \begin_layout Description
7936 \begin_inset space ~
7939 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
7942 \begin_layout Description
7944 \begin_inset space ~
7947 style: The fancy page style is not supported, due to a command clash between
7948 Memoir and the fancyhdr package (they both define a command with the same
7949 name, which confuses \SpecialChar LaTeX
7951 Instead, Memoir comes with a number of its own page styles (see
7953 Document\SpecialChar menuseparator
7954 Settings\SpecialChar menuseparator
7956 \begin_inset space ~
7962 If you want to use these for the chapter pages, you have to use the command
7969 in the main text or in preamble (e.
7970 \begin_inset space \thinspace{}
7974 \begin_inset space \space{}
7981 chapterstyle{companion}
7986 \begin_layout Description
7987 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
7988 optional argument in the standard classes.
7989 With this, you can specify an alternative version of the title for the
7990 table of contents and the headers (for instance, if the title is too long).
7992 , you can do this via
7994 Insert\SpecialChar menuseparator
7996 \begin_inset space ~
8001 at the beginning of a chapter/section.
8002 Memoir features a second optional argument and thus separates the table
8003 of contents from the header.
8004 You can define three variants of a title with this: one for the main text,
8005 one for the table of contents, and one for the headers.
8007 makes these available in form of specific
8018 \begin_layout Description
8019 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
8020 of contents, the list of figures and the list of table start a new page
8022 Memoir does not follow this route.
8023 You have to insert a page break yourself, if you want to have one.
8026 \begin_layout Description
8027 Titlepage: For some unknown reason, Memoir uses pagination on the title
8028 page (in the standard classes, title pages are
8029 \begin_inset Quotes eld
8033 \begin_inset Quotes erd
8037 If you want an empty title page, type
8041 aliaspagestyle{title}{empty}
8046 \begin_layout Description
8047 Article: With the class option
8053 Document\SpecialChar menuseparator
8054 Settings\SpecialChar menuseparator
8055 Class Settings\SpecialChar menuseparator
8057 \begin_inset space ~
8062 ), you can emulate article style.
8063 That is, counters (footnotes, figures, tables etc.) will not be reset on
8064 new chapters, chapters don't start a new page (but are—in contrary to
8065 \begin_inset Quotes eld
8069 \begin_inset Quotes erd
8072 article classes—still allowed), parts, though, use their own page, as in
8076 \begin_layout Description
8077 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
8078 font commands, which have been used in the old \SpecialChar LaTeX
8080 \begin_inset space \thinspace{}
8084 \begin_inset space \space{}
8100 It produces an error and stops \SpecialChar LaTeX
8101 whenever such a command appears.
8106 reallows the commands and spits out warnings instead (which does at least
8107 not stop \SpecialChar LaTeX
8109 Since a lot of packages and particularly Bib\SpecialChar TeX
8110 style files are still using
8111 those commands, we have decided to use this option by default.
8114 \begin_layout Subsubsection
8118 \begin_layout Standard
8119 We will only describe the features supported by \SpecialChar LyX
8120 (which is not much currently).
8121 Please consult the Memoir manual
8125 \begin_layout Plain Layout
8130 \begin_layout Plain Layout
8140 \begin_inset Flex URL
8143 \begin_layout Plain Layout
8145 CTAN:/macros/latex/memoir/memman.pdf
8158 \begin_layout Description
8159 Abstract: You may wonder why an abstract is an extra feature.
8160 Well, it is in book class.
8161 Usually books don't have abstracts.
8162 Memoir, however, has.
8163 You can use it wherever and how often you like.
8166 \begin_layout Description
8167 Chapterprecis: You may know this older typesetting style: The contents of
8168 a chapter are summarized below the title and also in the table of contents
8170 \begin_inset space \thinspace{}
8174 \begin_inset space \space{}
8179 Our hero arrives in Troia; he loses some friends; he finds others
8182 Chapterprecis does exactly this.
8183 It is therefore only sensible below a chapter.
8186 \begin_layout Description
8187 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
8188 The epigraph environment provides an elegant way of typesetting such a
8190 The motto itself (text) and its (optional) author (source) are divided
8192 The author (source) can be inserted via
8194 Insert\SpecialChar menuseparator
8201 \begin_layout Description
8202 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
8203 complex figurative poems).
8205 can only support a few of them.
8206 One is poemtitle, which is a centered title for poems, which will also
8207 be added to the table of contents (verse is the standard environment for
8209 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
8211 because they have to be nested inside regular verse environments, which
8212 is not possible with \SpecialChar LyX
8216 \begin_layout Description
8217 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
8220 \begin_layout Subsection
8222 \change_inserted 564990737 1671442175
8228 \begin_layout Standard
8230 \change_inserted 564990737 1671442175
8240 \begin_inset space \thinspace{}
8245 document class but adds two environments:
8248 \begin_layout Description
8250 \change_inserted 564990737 1671442175
8253 Recipe a numbered section environment at the
8257 level which generates a bold centered heading above a double horizontal
8261 \begin_layout Description
8263 \change_inserted 564990737 1671442175
8276 are what are being described and the environment ends with a horizontal
8280 \begin_layout Standard
8282 \change_inserted 564990737 1671642866
8286 File\SpecialChar menuseparator
8287 Open Example\SpecialChar menuseparator
8288 Books\SpecialChar menuseparator
8292 illustrates its use.
8295 \begin_layout Standard
8297 \change_inserted 564990737 1671442175
8300 It is designed for typesetting one or two recipes per page, with dimensions
8302 \begin_inset Quotes qrd
8306 \begin_inset Quotes qrd
8310 The hyperlinked table of contents (ToC) and page numbers make browsing
8311 recipes convenient, and the pages can be joined together or printed 2 per
8312 page to normal letterpaper easily.
8313 The size was chosen to work in half-page 3-ring binder cover sheets, because
8314 un-laminated paper just doesn't last in the kitchen.
8317 \begin_layout Standard
8319 \change_inserted 564990737 1671442175
8322 The half-letter pages can be printed two per page using your printer driver,
8323 or bound together using
8325 pdfjam --nup 2x1 --papersize '{11in,8.5in}'
8335 is the compiled version of your recipes.
8338 \begin_layout Section
8340 \change_inserted 564990737 1671442207
8344 \begin_layout Subsection
8346 \change_inserted 564990737 1671442208
8352 \begin_layout Standard
8354 \change_inserted 564990737 1671642942
8360 \begin_inset space \space{}
8364 \begin_inset space \thinspace{}
8373 document class, an unofficial implementation of the ‘Europass CV’ recommended
8374 by the European Commission in 2013.
8378 File\SpecialChar menuseparator
8379 Open Example\SpecialChar menuseparator
8380 Curricula Vitae\SpecialChar menuseparator
8384 offers guidance on its use.
8385 Its documentation is available from
8386 \begin_inset CommandInset href
8389 target "http://mirrors.ctan.org/macros/latex/contrib/europasscv/europasscv.pdf"
8397 \begin_layout Subsection
8399 \change_inserted 564990737 1671442208
8405 \begin_layout Standard
8407 \change_inserted 564990737 1671642984
8413 \begin_inset space \space{}
8417 \begin_inset space \thinspace{}
8426 document class, an unofficial implementation of the “Europass CV” recommended
8427 by the European Commission in 2002.
8431 File\SpecialChar menuseparator
8432 Open Example\SpecialChar menuseparator
8433 Curricula Vitae\SpecialChar menuseparator
8437 offers guidance on its use.
8438 Its documentation is available from
8439 \begin_inset CommandInset href
8442 target "http://mirrors.ctan.org/macros/latex/contrib/europecv/europecv.pdf"
8450 \begin_layout Subsection
8452 \change_inserted 564990737 1671442208
8458 \begin_layout Standard
8460 \change_inserted 564990737 1671643003
8466 \begin_inset space \space{}
8470 \begin_inset space \thinspace{}
8480 This allows the creation of customizable CVs.
8484 File\SpecialChar menuseparator
8485 Open Example\SpecialChar menuseparator
8486 Curricula Vitae\SpecialChar menuseparator
8490 offers guidance on its use.
8491 Its documentation is available from
8492 \begin_inset CommandInset href
8495 target "http://mirrors.ctan.org/macros/latex/contrib/moderncv/manual/moderncv_userguide.pdf"
8503 \begin_layout Subsection
8505 \change_inserted 564990737 1671442208
8511 \begin_layout Standard
8513 \change_inserted 564990737 1671643024
8519 \begin_inset space \space{}
8523 \begin_inset space \thinspace{}
8532 document class, originally developed for use with \SpecialChar LyX
8537 File\SpecialChar menuseparator
8538 Open Example\SpecialChar menuseparator
8539 Curricula Vitae\SpecialChar menuseparator
8543 offers guidance on its use.
8544 Its documentation is available from
8545 \begin_inset CommandInset href
8548 target "http://mirrors.ctan.org/macros/latex/contrib/simplecv/simplecv.pdf"
8556 \begin_layout Section
8558 \change_inserted 564990737 1671041968
8562 \begin_layout Subsection
8564 \change_inserted 564990737 1671041970
8570 \begin_layout Standard
8572 \change_inserted 564990737 1671617528
8583 document class for writing letters according to the
8585 Deutsches Institut für Normung
8588 The file in the menu
8593 ile\SpecialChar menuseparator
8595 \begin_inset space ~
8603 \begin_inset space ~
8606 Template\SpecialChar menuseparator
8607 Letters\SpecialChar menuseparator
8610 offers guidance on its use.
8611 The documentation is available from
8612 \begin_inset CommandInset href
8615 target "http://mirrors.ctan.org/macros/latex/contrib/dinbrief/liesmich"
8623 \begin_layout Subsection
8625 \change_inserted 564990737 1671458835
8631 \begin_layout Standard
8633 \change_inserted 564990737 1671617591
8644 document class for English letters and to create mailing labels.
8645 The file in the menu
8650 ile\SpecialChar menuseparator
8652 \begin_inset space ~
8660 \begin_inset space ~
8663 Template\SpecialChar menuseparator
8664 Letters\SpecialChar menuseparator
8665 Letter (Standard Class)
8667 offers guidance on its use.
8670 \begin_layout Section
8672 \change_inserted 564990737 1670439660
8676 \begin_layout Subsection
8678 \change_inserted 564990737 1671458922
8684 \begin_layout Standard
8686 \change_inserted 564990737 1671617655
8692 \begin_inset space \thinspace{}
8701 document class for creating presentations.
8702 The file in the menu
8707 ile\SpecialChar menuseparator
8709 \begin_inset space ~
8717 \begin_inset space ~
8720 Template\SpecialChar menuseparator
8721 Presentations\SpecialChar menuseparator
8724 offers guidance on its use.
8725 The documentation is available from
8726 \begin_inset CommandInset href
8729 target "http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf"
8737 \begin_layout Subsection
8740 Foil\SpecialChar TeX
8744 \begin_inset CommandInset label
8753 \begin_layout Standard
8759 \begin_layout Subsubsection
8763 \begin_layout Standard
8764 This section describes how to use \SpecialChar LyX
8765 to make slides for overhead projectors.
8766 There are two document classes that can do this: the default slides class
8769 Foil\SpecialChar TeX
8773 This section documents the latter.
8776 \begin_layout Standard
8777 I'm going to say this again, nice and clear, so that there's no misunderstanding
8781 \begin_layout Standard
8782 \begin_inset VSpace bigskip
8788 \begin_layout Standard
8792 This section documents the class
8793 \begin_inset Quotes eld
8801 \begin_inset Quotes erd
8809 \begin_layout Standard
8810 \begin_inset VSpace bigskip
8816 \begin_layout Standard
8817 If you're looking for the documentation for
8818 \begin_inset Quotes eld
8826 \begin_inset Quotes erd
8830 \begin_inset space ~
8834 \begin_inset CommandInset ref
8836 reference "sec:slitex"
8841 If your machine doesn't have the
8849 installed, you'll probably have to use the default
8853 class, which isn't quite as good as
8858 \begin_layout Standard
8863 class is designed for use with version
8864 \begin_inset space ~
8872 class file which is now an integral part of \SpecialChar LaTeX2e
8876 \begin_layout Subsubsection
8880 \begin_layout Standard
8881 Obviously, to use this document class, you need to select
8892 \begin_inset space ~
8898 There are some settings in the
8901 \begin_inset space ~
8906 dialog that you should know about that are specific to this class:
8909 \begin_layout Itemize
8910 Don't change the options
8921 \begin_inset space ~
8927 They're ignored by the
8934 \begin_layout Itemize
8935 The default font size is 20
8936 \begin_inset space \thinspace{}
8939 pt with the other options being 17
8940 \begin_inset space \thinspace{}
8944 \begin_inset space \thinspace{}
8948 \begin_inset space \thinspace{}
8954 \begin_layout Itemize
8963 but all math equations are still typeset in the usual roman font.
8966 \begin_layout Itemize
8969 Foil\SpecialChar TeX
8972 supports A4 and Letter paper sizes as well as a special size for working
8974 \begin_inset space \thinspace{}
8978 It doesn't support A5, B5, legal or executive paper sizes.
8981 \begin_layout Itemize
8982 Don't bother changing the
8986 settings because they are ignored anyway.
8987 All floats appear where they are defined in the text.
8990 \begin_layout Itemize
8995 setting behaves a bit differently for this class.
8998 Foil\SpecialChar TeX
9001 provides extensive footer and header capabilities including a user-defined
9004 \begin_inset space ~
9008 \begin_inset CommandInset ref
9010 reference "sec:foilfoot"
9015 The title page is treated differently to all other pages in the document
9024 has the logo centered at the bottom of the page (if one is defined).
9025 The possible page style choices and what they do are as follows:
9029 \begin_layout Labeling
9030 \labelwidthstring MMMMMMM
9037 The final output contains no page numbers, or other headers or footers
9038 (except footnotes of course).
9042 \begin_layout Labeling
9043 \labelwidthstring MMMMMMM
9050 The final output contains page numbers centered at the bottom of the page.
9051 No other headings or footers (other than footnotes).
9054 \begin_layout Labeling
9055 \labelwidthstring MMMMMMM
9060 Page numbers in lower right corner.
9061 Additional headers and footers are also shown.
9062 This is also the default.
9065 \begin_layout Labeling
9066 \labelwidthstring MMMMMMM
9071 Gives you access to the
9075 package although its use with
9077 Foil\SpecialChar TeX
9080 is discouraged by the writer of the
9082 Foil\SpecialChar TeX
9085 package because of some potential page layout clashes.
9089 \begin_layout Paragraph
9093 \begin_layout Standard
9094 The following options may be used in the extra class options in the
9096 Document\SpecialChar menuseparator
9102 \begin_layout Labeling
9103 \labelwidthstring MMMMMMx
9108 This sets up the page layout for 7.33
9109 \begin_inset space \thinspace{}
9113 \begin_inset space \thinspace{}
9116 in paper, which is about the same aspect ratio as a 35
9117 \begin_inset space \thinspace{}
9120 mm slide, making it a bit easier to work with this medium.
9123 \begin_layout Labeling
9124 \labelwidthstring MMMMMMx
9129 Places a rule across the page below the header on every page except the
9133 \begin_layout Labeling
9134 \labelwidthstring MMMMMMx
9139 Places a rule across the page above the footer on every page except the
9143 \begin_layout Labeling
9144 \labelwidthstring MMMMMMx
9149 This is automatically set each time you create a new
9156 Foil\SpecialChar TeX
9159 to use the dvips driver to rotate those pages that are set as landscape
9163 \begin_layout Labeling
9164 \labelwidthstring MMMMMMx
9169 Simply changes the page dimensions to those of a landscape page but doesn't
9171 Thus if you use this option you need to use an external program to rotate
9172 each page or feed your paper through your printer as landscape.
9173 Note that this option effectively reverses the roles of the
9181 environments (don't worry these are described in the next section).
9184 \begin_layout Labeling
9185 \labelwidthstring MMMMMMx
9190 Equation numbers on the left.
9193 \begin_layout Labeling
9194 \labelwidthstring MMMMMMx
9199 Flush-left equations.
9202 \begin_layout Subsubsection
9203 Supported Environments
9206 \begin_layout Standard
9207 Most of the environments commonly supported in other classes are also supported
9213 There are several additional environments provided by
9215 Foil\SpecialChar TeX
9218 as well as a couple added by \SpecialChar LyX
9220 The following environments are shared with other classes:
9223 \begin_layout Standard
9224 \begin_inset Flex Multiple Columns
9227 \begin_layout Itemize
9233 \begin_layout Itemize
9239 \begin_layout Itemize
9245 \begin_layout Itemize
9251 \begin_layout Itemize
9257 \begin_layout Itemize
9264 \begin_layout Itemize
9270 \begin_layout Itemize
9276 \begin_layout Itemize
9282 \begin_layout Itemize
9288 \begin_layout Itemize
9294 \begin_layout Itemize
9300 \begin_layout Itemize
9306 \begin_layout Itemize
9312 \begin_layout Itemize
9323 \begin_layout Standard
9324 That is, all the major environments apart from the sectioning environments.
9325 Since foils are essentially self-contained sections, with a title and body,
9328 Foil\SpecialChar TeX
9331 provides specific commands for starting new foils and these are:
9334 \begin_layout Itemize
9340 \begin_layout Itemize
9346 \begin_layout Standard
9348 also provides slightly modified versions of these two environments called:
9351 \begin_layout Itemize
9357 \begin_layout Itemize
9363 \begin_layout Standard
9364 and the differences will be explained in the next section.
9367 \begin_layout Standard
9368 Since foils are often used in presenting ideas or new theorems and such
9371 Foil\SpecialChar TeX
9374 also provides a comprehensive box of goodies for presenting them:
9377 \begin_layout Standard
9378 \begin_inset Flex Multiple Columns
9381 \begin_layout Itemize
9387 \begin_layout Itemize
9393 \begin_layout Itemize
9399 \begin_layout Itemize
9405 \begin_layout Itemize
9411 \begin_layout Itemize
9417 \begin_layout Itemize
9423 \begin_layout Itemize
9429 \begin_layout Itemize
9435 \begin_layout Itemize
9441 \begin_layout Itemize
9452 \begin_layout Standard
9453 The starred versions are unnumbered while the unstarred versions are numbered.
9454 There are also two list environments added by \SpecialChar LyX
9458 \begin_layout Itemize
9464 \begin_layout Itemize
9470 \begin_layout Standard
9473 Foil\SpecialChar TeX
9476 provides some powerful header and footer capabilities that are best set
9477 in the preamble although they may be set at any point in a document.
9478 If you want to change these settings in your document the best place to
9479 do so is at the very top of a foil, i.
9480 \begin_inset space \thinspace{}
9486 \begin_inset space \space{}
9491 straight after the foilhead.
9494 \begin_layout Standard
9495 For this purpose, the following command styles are provided [
9502 \begin_layout Standard
9503 \begin_inset Flex Multiple Columns
9506 \begin_layout Itemize
9510 \begin_inset space ~
9516 \begin_layout Itemize
9522 \begin_layout Itemize
9526 \begin_inset space ~
9532 \begin_layout Itemize
9536 \begin_inset space ~
9542 \begin_layout Itemize
9546 \begin_inset space ~
9553 \begin_layout Plain Layout
9554 \begin_inset space ~
9566 \begin_layout Standard
9567 There are also a few commands provided by
9569 Foil\SpecialChar TeX
9572 that aren't directly supported by \SpecialChar LyX
9573 but I'll tell you what they do and how
9574 to use them in section
9575 \begin_inset space ~
9579 \begin_inset CommandInset ref
9581 reference "sec:unsuppfoils"
9588 \begin_layout Subsubsection
9589 Building a Set of Foils
9592 \begin_layout Standard
9593 This section will give a simple introduction to using the different environments
9594 to build a set of foils.
9595 If you want to see an example set of foils, take a look at
9596 \change_deleted 564990737 1671643085
9601 file you find in \SpecialChar LyX
9607 \change_inserted 564990737 1671643099
9611 File\SpecialChar menuseparator
9614 \SpecialChar menuseparator
9615 Presentations\SpecialChar menuseparator
9623 \begin_layout Paragraph
9624 Give It a Title Page
9627 \begin_layout Standard
9628 Unlike other classes that provide
9648 creates the title on a page of its own.
9649 If you leave out the
9653 environment \SpecialChar LaTeX
9654 will substitute the current date (every time you regenerate
9658 \begin_layout Paragraph
9662 \begin_layout Standard
9663 As I mentioned earlier, there are four ways of starting a new foil.
9664 For portrait foils you should use
9673 The difference between these two environments is the amount of space between
9674 the title of the foil (the foilhead) and the body of the foil.
9677 \begin_layout Standard
9678 Landscape foils are generated using the
9687 Again the only difference is the spacing between foilhead and body.
9688 Both of the short versions have 0.5
9689 \begin_inset space ~
9692 inches less separation between the foilhead and the body.
9696 \begin_layout Standard
9697 One problem with the support for landscape foils is the requirement that
9702 driver to generate the PostScript output otherwise the foils won't be rotated.
9703 It is possible to get landscape foils even if you haven't got the
9707 driver provided you can feed your foils sideways through your printer ;-)
9710 \begin_layout Paragraph
9711 Theorems, Lemmas, Proofs and more
9714 \begin_layout Standard
9715 You can't have two of the same type of these environments directly following
9717 If you use a normal paragraph break, , you will just be extending the previous
9718 environment as if you had merged the two environments together.
9719 Rather than that, you need to insert a so-called separator.
9720 Please refer to the section entitled
9731 \begin_layout Paragraph
9735 \begin_layout Standard
9736 You get all the commonly supported list styles found in other classes as
9737 well as two new ones.
9738 I'll only describe the new ones here.
9739 If you want to find out more about the other list environments check out
9745 If you intend to use itemized lists you might also want to read about the
9749 \begin_inset space ~
9753 \begin_inset space ~
9758 dialog described above in section
9759 \begin_inset space ~
9763 \change_inserted 564990737 1671355684
9765 \begin_inset CommandInset ref
9767 reference "chap:bullets"
9772 \change_deleted 564990737 1671355684
9774 \begin_inset CommandInset ref
9776 reference "sec:bullet"
9785 \begin_layout Standard
9786 The two new list styles,
9794 , are designed to make it easier for you to create lists of do's and don'ts
9795 or right and wrong by providing dedicated environments that use a tick
9796 or a cross as the label of the list.
9797 These lists are in fact dedicated variants of the
9802 They do however require that you have the
9809 \begin_layout Paragraph
9813 \begin_layout Standard
9816 Foil\SpecialChar TeX
9819 redefines the floating tables and figures so that they appear exactly where
9820 they are in the text rather than pushing them to the top of the page or
9821 to some user specified location.
9822 In fact if you change the float placement settings they are simply ignored.
9825 \begin_layout Paragraph
9826 Page Headers and Footers
9827 \begin_inset CommandInset label
9836 \begin_layout Standard
9840 \begin_inset space ~
9849 are two commands used to control the left-footer text string.
9850 The first is meant to allow you to include a graphic logo on your foils
9852 \begin_inset Quotes eld
9857 Foil\SpecialChar TeX
9861 \begin_inset Quotes erd
9865 While the second is meant to provide a classification for the audience,
9869 \begin_inset space \thinspace{}
9875 \begin_inset space \space{}
9879 It is empty by default.
9882 \begin_layout Standard
9883 The remaining page corners can be filled by
9886 \begin_inset space ~
9891 (which defaults to page numbers),
9894 \begin_inset space ~
9902 \begin_inset space ~
9910 \begin_layout Subsubsection
9913 Foil\SpecialChar TeX
9917 \begin_inset CommandInset label
9919 name "sec:unsuppfoils"
9926 \begin_layout Standard
9927 All the commands mentioned below need to be set in a
9937 within another environment.
9940 \begin_layout Paragraph
9944 \begin_layout Standard
9945 All lengths are adjusted using the
9968 should be replaced by the name given to the length you want to change and
9973 is the length value.
9974 All lengths should be specified in units of length such as inches (
9986 ) or relative to some document or font-based length such as
9996 \begin_layout Standard
9997 It's possible to change the spacing between a foilhead and the body of the
9998 foil by adjusting the length specified by
10005 For example, to make
10010 \begin_inset space \space{}
10013 in closer to their bodies put the following in the preamble:
10019 foilheadskip}{-0.5in}
10022 \begin_layout Standard
10023 The spacings around floats can be adjusted by setting these lengths:
10026 \begin_layout Labeling
10027 \labelwidthstring MMMMMMMMMMM
10034 Separation between the text and the top of the float
10037 \begin_layout Labeling
10038 \labelwidthstring MMMMMMMMMMM
10045 Separation between the float and the caption
10048 \begin_layout Labeling
10049 \labelwidthstring MMMMMMMMMMM
10056 Separation between the caption and the following text
10059 \begin_layout Labeling
10060 \labelwidthstring MMMMMMMMMMM
10067 You can make the captions narrower than the surrounding text by adjusting
10069 Best done relative to
10078 \begin_layout Standard
10079 There are also several title page related lengths that you may find useful
10080 if you have a long title or several authors:
10083 \begin_layout Labeling
10084 \labelwidthstring MMMMMMMMMMM
10091 Separation from headers to
10096 \begin_layout Labeling
10097 \labelwidthstring MMMMMMMMMMM
10115 \begin_layout Labeling
10116 \labelwidthstring MMMMMMMMMMM
10130 \begin_layout Labeling
10131 \labelwidthstring MMMMMMMMMMM
10147 \begin_layout Labeling
10148 \labelwidthstring MMMMMMMMMMM
10164 \begin_layout Standard
10165 The last length related command affects all the list environments.
10176 a list environment then all the vertical spacing between the list items
10178 Note that this is a command not a length so it doesn't require
10184 like the stuff mentioned above.
10187 \begin_layout Paragraph
10188 Headers and Footers
10191 \begin_layout Standard
10204 commands control whether the logo in the
10208 definition appear on a given page.
10215 in the preamble then none of the foils will have the logo on them.
10216 If you don't want the logo on a particular page place the
10222 directly after the foilhead of that page and the
10228 directly after the next foilhead.
10231 \begin_layout Standard
10232 If you decide to use the
10236 page style setting in the
10239 \begin_inset space ~
10244 dialog you should probably add
10254 to your preamble so headers and footers on landscape pages are correctly
10255 placed when rotated.
10256 This is due to some clashes between the page layouts provided by the
10267 \begin_layout Subsection
10269 \change_inserted 564990737 1671459032
10275 \begin_layout Standard
10277 \change_inserted 564990737 1671643165
10283 \begin_inset space \thinspace{}
10292 document class for creating presentations.
10296 File\SpecialChar menuseparator
10297 Open Example\SpecialChar menuseparator
10298 Presentations\SpecialChar menuseparator
10302 offers guidance on its use.
10303 The documentation is available from
10304 \begin_inset CommandInset href
10307 target "http://mirrors.ctan.org/macros/latex/contrib/powerdot/doc/powerdot.pdf"
10315 \begin_layout Subsection
10317 \change_inserted 564990737 1671459032
10320 \begin_inset CommandInset label
10322 name "subsec:Seminar"
10331 \begin_layout Standard
10333 \change_inserted 564990737 1671643194
10339 \begin_inset space \thinspace{}
10348 document class for creating presentations.
10352 File\SpecialChar menuseparator
10353 Open Example\SpecialChar menuseparator
10354 Presentations\SpecialChar menuseparator
10358 offers guidance on its use.
10359 The documentation is available from
10360 \begin_inset CommandInset href
10363 target "http://mirrors.ctan.org/macros/latex/contrib/seminar/doc/seminar-doc.pdf"
10371 \begin_layout Subsection
10374 Sli\SpecialChar TeX
10378 \begin_inset CommandInset label
10387 \begin_layout Standard
10395 \begin_layout Subsubsection
10399 \begin_layout Standard
10400 This section describes how to use \SpecialChar LyX
10401 to make slides for overhead projectors.
10402 There are two document classes that can do this: the default slides class
10405 Foil\SpecialChar TeX
10409 This section documents the former.
10412 \begin_layout Standard
10413 I'm going to say this again, nice and clear, so that there's no misunderstanding
10417 \begin_layout Standard
10418 \begin_inset VSpace bigskip
10424 \begin_layout Standard
10428 This section documents the class
10429 \begin_inset Quotes eld
10437 \begin_inset Quotes erd
10445 \begin_layout Standard
10446 \begin_inset VSpace bigskip
10452 \begin_layout Standard
10453 If you're looking for the documentation for
10454 \begin_inset Quotes eld
10459 slides (Foil\SpecialChar TeX
10463 \begin_inset Quotes erd
10466 , check out section
10467 \begin_inset space ~
10471 \begin_inset CommandInset ref
10473 reference "sec:foiltex"
10483 \begin_inset Quotes eld
10488 slides (Foil\SpecialChar TeX
10492 \begin_inset Quotes erd
10495 ] is actually somewhat better than the default
10503 \begin_layout Plain Layout
10505 or so I've been told repeatedly by its advocates.
10506 Having never used it, I have no idea if this claim is true or not.
10511 which this section documents.
10514 \begin_layout Standard
10515 This class is the \SpecialChar LaTeX2e
10516 improvement of the old
10518 Sli\SpecialChar TeX
10522 Every \SpecialChar LaTeX2e
10523 distribution includes this class [which I'll just refer to as
10524 \begin_inset Quotes eld
10532 \begin_inset Quotes erd
10535 from now on], so you're bound to have it.
10536 As I noted earlier, there are other classes, such as
10540 , which also produce slides for overhead projectors and do a better job
10542 However, there are some things which
10546 can do which the others can't, such as generate overlays.
10547 Read on to learn more!
10550 \begin_layout Subsubsection
10552 \begin_inset CommandInset label
10554 name "sec:slidesetup"
10561 \begin_layout Standard
10562 Obviously, to use this document class, you need to select
10563 \begin_inset Quotes eld
10571 \begin_inset Quotes erd
10574 from the class list in the
10576 Document\SpecialChar menuseparator
10580 There are some other special things you should know about this class:
10583 \begin_layout Itemize
10584 Don't bother changing the options
10589 They're not supported by the
10596 \begin_layout Itemize
10600 \begin_inset space ~
10605 behaves a bit differently for this class.
10606 The possible choices and what they do are as follows:
10610 \begin_layout Description
10615 The final output contains page numbers in the lower right corner.
10618 \begin_layout Description
10627 , but also prints out any time markers you've put in.
10628 This is the default.
10631 \begin_layout Description
10636 The final output contains no page numbers, time markers, or alignment markers.
10640 \begin_layout Itemize
10645 class has an extra option:
10651 \begin_inset Quotes eld
10659 \begin_inset Quotes erd
10662 in the extra class options.
10666 \begin_layout Standard
10667 Using this options allows you to add time markers to
10673 \begin_inset space ~
10677 \begin_inset CommandInset ref
10679 reference "sec:slideNote"
10687 \begin_layout Standard
10688 You can also use the template file
10689 \change_deleted 564990737 1671617694
10691 \begin_inset Quotes eld
10699 \begin_inset Quotes erd
10704 to automatically set up a document to use the
10709 \change_deleted 564990737 1671617699
10714 File\SpecialChar menuseparator
10716 \begin_inset space ~
10720 \begin_inset space ~
10724 \change_inserted 564990737 1671617723
10725 \SpecialChar menuseparator
10726 Presentations\SpecialChar menuseparator
10731 to open your new document
10732 \change_deleted 564990737 1671617728
10736 The template file also contains some examples of the special paragraph
10737 environments used by this class.
10738 I'll describe those next.
10741 \begin_layout Subsubsection
10742 Paragraph Environments
10745 \begin_layout Paragraph
10746 Supported Environments
10749 \begin_layout Standard
10750 The first thing you'll notice when you start up a new
10754 document is the font size and type: it's the equivalent of the size
10755 \begin_inset Quotes eld
10763 \begin_inset Quotes erd
10769 \begin_inset space ~
10775 This is also what's used in the output.
10777 \begin_inset Quotes eld
10781 \begin_inset Quotes erd
10784 to remind you that this is a slide.
10785 Your final slides will use a larger font; ergo, you'll have less space.
10786 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
10789 \begin_layout Standard
10790 The next thing that becomes obvious is the changes to the paragraph environment
10791 pull-down box [at the far-left end of the toolbar].
10792 Most of the paragraph environments you're used to seeing are missing.
10793 There are also five new ones.
10798 class itself only supports certain paragraph environments:
10801 \begin_layout Itemize
10807 \begin_layout Itemize
10813 \begin_layout Itemize
10819 \begin_layout Itemize
10825 \begin_layout Itemize
10831 \begin_layout Itemize
10837 \begin_layout Itemize
10843 \begin_layout Itemize
10849 \begin_layout Itemize
10855 \begin_layout Itemize
10862 \begin_layout Standard
10863 All of the other standard environments, including the section-heading environmen
10864 ts, aren't used in the
10871 \begin_layout Standard
10872 On the other hand, you'll notice the following new environments:
10875 \begin_layout Itemize
10881 \begin_layout Itemize
10887 \begin_layout Itemize
10893 \begin_layout Itemize
10899 \begin_layout Itemize
10905 \begin_layout Standard
10906 These five are kind of quirky, due to a
10907 \begin_inset Quotes eld
10911 \begin_inset Quotes erd
10914 in \SpecialChar LyX
10916 You see, \SpecialChar LyX
10917 doesn't permit you to nest any other paragraph environment into
10918 an empty environment.
10919 Now, that's fine and dandy, but it means that you wouldn't be able to start
10920 a slide with anything except plain text.
10921 To deal with this, I've performed a little
10922 \begin_inset Quotes eld
10927 \begin_inset Quotes erd
10933 \begin_layout Paragraph
10934 Quirks of the New Environments
10935 \begin_inset CommandInset label
10937 name "sec:slideQuirk"
10944 \begin_layout Standard
10945 All five of the new paragraph environments are somewhat quirky due to inherent
10946 limitiations in the current version of \SpecialChar LyX
10948 As I just mentioned, \SpecialChar LyX
10949 forbids environments that begin with another environment.
10950 To get around this, the
10954 environment isn't a paragraph environment as described in the
10962 \begin_layout Standard
10963 You should consider
10976 \begin_inset Quotes eld
10979 pseudo-environments.
10980 \begin_inset Quotes erd
10983 They look like a section heading or a
10984 \begin_inset Quotes eld
10992 \begin_inset Quotes erd
10995 but really begin a [and, if necessary, end the previous] paragraph environment.
11005 \begin_inset Quotes eld
11009 \begin_inset Quotes erd
11012 These two perform some action.
11015 \begin_layout Standard
11016 A common feature of all five environments,
11036 , is a rather long-ish label.
11037 The text following this label — ordinarily the contents of the paragraph
11038 environment — is utterly irrelevant for
11060 completely ignores it.
11061 In fact, you can leave these five environments completely empty.
11065 \begin_layout Standard
11070 to put any text after the rather long-ish label, you might want to.
11071 This could be a short description of the contents of the
11076 In that case, enter your descriptive comment and hit
11080 as you normally would.
11083 \begin_layout Standard
11084 If, on the other hand, you don't want to enter any descriptive text, you'll
11085 hit another \SpecialChar LyX
11088 , like nature, abhors a vacuum, and will not let you start a new paragraph
11089 environment until you put something in the old one.
11093 \begin_layout Itemize
11094 Start entering the text that will
11122 \begin_layout Itemize
11123 Now move to the beginning of that paragraph.
11127 \begin_layout Itemize
11136 \begin_layout Itemize
11137 Finally, change this new, empty paragraph to a
11161 \begin_layout Standard
11162 Some future version of \SpecialChar LyX
11163 will, hopefully, resolve this quirkiness\SpecialChar ldots
11167 \begin_layout Subsubsection
11168 Making a Presentation with
11181 \begin_layout Paragraph
11189 \begin_layout Standard
11190 If you're expecting this section to teach you how to actually make a presentatio
11191 n, you'll be sorely disappointed.
11192 Naturally, I'll describe all of the ways the
11196 class can assist you in preparing the materials for a presentation.
11197 Filling in the contents, however, is up to you.
11202 the \SpecialChar LyX
11206 \begin_layout Standard
11211 environment [in the manner described in section
11212 \begin_inset space ~
11216 \begin_inset CommandInset ref
11218 reference "sec:slideQuirk"
11222 ] tells \SpecialChar LyX
11223 to begin a new slide [duh].
11224 The label for this environment/
11225 \begin_inset Quotes erd
11229 \begin_inset Quotes erd
11233 \begin_inset Quotes eld
11237 \begin_inset Quotes erd
11240 in cool blue, followed by the label,
11241 \begin_inset Quotes eld
11245 \begin_inset Quotes erd
11249 Any text or paragraph environments that follow this one go on the new slide.
11253 \begin_layout Standard
11254 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
11256 (this can be specified in the
11261 In fact, you'll want to, once you finish entering the contents of one slide.
11262 If you've entered more text than can physically fit on a slide, the extra
11263 overflows onto a new slide.
11264 I don't recommend doing this, however, since the overflow slide won't have
11265 any page number on it.
11266 Furthermore, it may interfere with any
11270 you've made to accompany the oversized
11277 \begin_layout Standard
11286 environments work the same way as the
11291 They both create an
11292 \begin_inset Quotes eld
11296 \begin_inset Quotes erd
11299 followed by a label [
11300 \begin_inset Quotes eld
11304 \begin_inset Quotes erd
11308 \begin_inset Quotes eld
11312 \begin_inset Quotes erd
11316 The color is a stunning magenta instead of blue, and the
11317 \begin_inset Quotes eld
11321 \begin_inset Quotes erd
11324 will look different, in style and in length.
11325 The label fonts of all three also differ from one another.
11328 \begin_layout Standard
11333 , if the contents of a
11341 exceed the physical size of a slide or sheet of paper, the extra will overflow
11343 Again, you should avoid this.
11344 It defeats the whole purpose of
11355 \begin_layout Paragraph
11365 \begin_layout Standard
11370 is a slide that sits atop another slide.
11371 Perhaps you wish to discuss a figure on the main
11375 before displaying the text associated with it.
11376 One way to accomplish this is tape a flap of dark paper over the part of
11381 you want to display later.
11382 This method fails, however, if you wish to overlap one graph with another,
11384 You would then have to fumble while speaking to align the two separate,
11389 s to align the two graphs.
11394 environment in both cases makes life much easier.
11397 \begin_layout Standard
11402 receives the page number of its
11403 \begin_inset Quotes eld
11407 \begin_inset Quotes erd
11415 \begin_inset Quotes eld
11423 \begin_inset Quotes erd
11430 \begin_layout Plain Layout
11431 Presumably, mutliple
11436 \begin_inset Quotes eld
11444 \begin_inset Quotes erd
11448 \begin_inset Quotes eld
11456 \begin_inset Quotes erd
11460 \begin_inset Quotes eld
11468 \begin_inset Quotes erd
11472 \begin_inset space ~
11475 appended to the page number of the parent
11485 Clearly, you want the contents of both the
11493 to each fit on a single physical slide! You should probably consider an
11499 \begin_inset Quotes eld
11503 \begin_inset Quotes erd
11511 Indeed, the \SpecialChar LyX
11516 class provides a visual cue for this: the label at the start of an
11520 is shorter than that at the start of a
11525 Lastly, when you generate printable output, you'll find alignment markers
11526 in all four corners of both the
11530 page and its parent
11535 These will assist you in lining up the two physical slides.
11538 \begin_layout Standard
11539 The major problem in overlaying two slides is aligning the contents of the
11540 two transparencies.
11541 How much space should you leave for that graph on the second slide? Worse
11542 still, what if you want a graph and a sentence on second slide, but there
11543 is text on the main transparency that goes in between them? You could try
11544 and insert vertical space of the right size.
11545 The better way is to use
11556 \begin_layout Standard
11557 As their names imply,
11565 are two command-like paragraph environments that make all subsequent text
11566 invisible and visible, respectively.
11568 \begin_inset space ~
11572 \begin_inset CommandInset ref
11574 reference "sec:slideQuirk"
11578 that you don't place anything
11582 these two environments, however.
11587 , it inserts a centered, sky-blue label into the page reading
11588 \begin_inset Quotes eld
11591 <Invisible Text Follows>
11592 \begin_inset Quotes erd
11596 For paragraphs following this label, the parts of the
11604 ; it doesn't matter which] where they would be contain instead blank space.
11608 \begin_layout Standard
11613 , the corresponding centered label is
11614 \begin_inset Quotes eld
11617 <Visible Text Follows>
11618 \begin_inset Quotes erd
11622 Paragraphs following this label behave normally.
11623 Note that the beginning of a new
11635 automatically shuts off an
11640 It's therefore not necessary to use
11651 \begin_layout Standard
11652 By now, it should be obvious how to create overlay transparencies using
11653 the proper combination of
11672 \begin_layout Enumerate
11677 , including everything that will appear on it, whether on the main slide
11685 \begin_layout Enumerate
11686 Before each figure or paragraph that will appear only on the
11695 If necessary, insert a
11699 environment after the
11706 \begin_layout Enumerate
11711 immediately following the
11718 \begin_layout Enumerate
11719 Copy the contents of this
11730 \begin_layout Enumerate
11735 , change all of the
11746 \begin_layout Standard
11748 You've just made an
11755 \begin_layout Standard
11756 There's one problem with the way I've designed the \SpecialChar LyX
11761 class: you can't make text in the middle of a paragraph invisible, nor
11762 make text in the middle of an invisible paragraph visible again.
11763 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
11768 \begin_layout Plain Layout
11769 The commands of interest are:
11772 \begin_layout Itemize
11777 invisible \SpecialChar ldots
11781 \begin_layout Itemize
11786 visible \SpecialChar ldots
11790 \begin_layout Plain Layout
11792 and need to be marked as \SpecialChar TeX
11795 \begin_inset Quotes eld
11799 \begin_inset Quotes erd
11802 you wish to change goes in between the brackets [and after the
11815 If you don't know how to mark text as \SpecialChar TeX
11816 , see the appropriate section of
11829 \begin_layout Paragraph
11839 \begin_inset CommandInset label
11841 name "sec:slideNote"
11848 \begin_layout Standard
11857 is associated with a
11858 \begin_inset Quotes eld
11862 \begin_inset Quotes erd
11870 Here, too, the \SpecialChar LyX
11875 class provides visual cues.
11880 is shorter than that of a
11884 [yet longer than that of an
11888 ] and, like the label of an
11892 is shockingly magenta.
11893 Additionally, the printed
11897 has the page number of its
11898 \begin_inset Quotes eld
11902 \begin_inset Quotes erd
11910 \begin_inset Quotes eld
11918 \begin_inset Quotes erd
11922 \begin_inset Quotes eld
11930 \begin_inset Quotes erd
11934 \begin_inset Quotes eld
11942 \begin_inset Quotes erd
11946 You can have multiple
11950 s associated with a single
11962 , you'll probably want to break up long
11966 s so that they fit on a single sheet of paper.
11969 \begin_layout Standard
11974 is obvious: it contains anything additional you might want to say about
11980 It could also be used as a sheet of reminders for a particular
11985 In the case of the latter, you might want to make use of time markers.
11986 Currently, the \SpecialChar LyX
11992 \begin_inset Quotes eld
11996 \begin_inset Quotes erd
11999 support for time markers, a
12001 Sli\SpecialChar TeX
12005 So, you'll have to resort to using the \SpecialChar LaTeX
12009 \begin_layout Standard
12010 To use time markers, you'll need to specify the extra class option
12011 \begin_inset Quotes eld
12019 \begin_inset Quotes erd
12023 \begin_inset space ~
12027 \begin_inset CommandInset ref
12029 reference "sec:slidesetup"
12034 This option turns on timing marks, which will appear in the lower-left-hand
12040 To set what appears in the time marker, you use the \SpecialChar LaTeX
12042 \begin_inset Quotes eld
12052 \begin_inset Quotes erd
12056 \begin_inset Quotes eld
12066 \begin_inset Quotes erd
12070 The arguments of both commands are time measured in seconds.
12072 \begin_inset Quotes eld
12082 \begin_inset Quotes erd
12085 sets the time marker to a given time.
12087 \begin_inset Quotes eld
12097 \begin_inset Quotes erd
12100 increments the time marker by the specified amount.
12101 Using time markers and
12105 s in this fashion, you can remind yourself how much time to spend on a particula
12113 \begin_layout Standard
12114 There's one last feature to describe.
12115 Clearly, you'd like to print out all of your
12123 s on transparencies while printing all of your
12140 with which it is associated.
12141 What's a person to do?
12144 \begin_layout Standard
12145 Luckily, there are two \SpecialChar LaTeX
12146 commands that allow you to select what to print
12148 Both must be placed into the preamble of your document.
12150 \begin_inset Quotes eld
12162 \begin_inset Quotes erd
12165 will cause the output to contain only the
12174 Correspondingly, the command
12175 \begin_inset Quotes eld
12187 \begin_inset Quotes erd
12190 prevents the output of anything but
12195 I'd advise placing both commands in the preamble and initially comment
12197 You can then preview your entire presentation as you write.
12198 When you're done writing, you can then uncomment one of the two to select
12199 what you want to print.
12200 I like to uncomment
12201 \begin_inset Quotes eld
12213 \begin_inset Quotes erd
12216 , print to a file with
12217 \begin_inset Quotes eld
12225 \begin_inset Quotes erd
12228 in its name, comment it back out, then uncomment
12229 \begin_inset Quotes eld
12241 \begin_inset Quotes erd
12245 \begin_inset Quotes eld
12253 \begin_inset Quotes erd
12257 I can then send either file to a printer, loading transparencies or plain
12258 paper as appropriate.
12261 \begin_layout Standard
12262 You can also provide other arguments to the
12263 \begin_inset Quotes eld
12273 \begin_inset Quotes erd
12277 \begin_inset Quotes eld
12287 \begin_inset Quotes erd
12291 See a good \SpecialChar LaTeX
12295 \begin_layout Subsubsection
12300 Class Template File
12303 \begin_layout Standard
12304 I have also provided a template file
12305 \change_deleted 564990737 1671617750
12307 \begin_inset Quotes eld
12315 \begin_inset Quotes erd
12325 To use it, begin your new presentation with
12327 File\SpecialChar menuseparator
12329 \begin_inset space ~
12333 \begin_inset space ~
12337 \change_inserted 564990737 1671616988
12338 \SpecialChar menuseparator
12339 Presentations\SpecialChar menuseparator
12345 Your new \SpecialChar LyX
12346 presentation file will contain an example
12367 additionally contain an example of the use of
12376 Lastly, the preamble will contain:
12379 \begin_layout LyX-Code
12380 % Uncomment to print out only slides and overlays
12383 \begin_layout LyX-Code
12387 \begin_layout LyX-Code
12393 \begin_inset Newline newline
12399 \begin_layout LyX-Code
12400 % Uncomment to print out only notes
12403 \begin_layout LyX-Code
12407 \begin_layout LyX-Code
12415 \begin_layout Standard
12416 One final thing: I created this class to support the \SpecialChar LaTeX2e
12418 \begin_inset Quotes eld
12423 Sli\SpecialChar TeX
12427 \begin_inset Quotes erd
12430 class, one of the built-in \SpecialChar LaTeX2e
12432 Neither I nor the rest of the \SpecialChar LyX
12433 Team endorse or oppose the use of this built-in
12435 It's here if you want it or need it.
12436 There exist other \SpecialChar LaTeX2e
12437 classes for creating presentations, such as the
12442 \begin_inset space ~
12446 \begin_inset CommandInset ref
12448 reference "sec:foiltex"
12453 \begin_inset Quotes eld
12461 \begin_inset Quotes erd
12464 package [present on some \SpecialChar TeX
12466 The latter is not yet supported under \SpecialChar LyX
12471 \begin_layout Plain Layout
12472 Perhaps you can take on the task\SpecialChar ldots
12478 I know nothing about these other classes.
12479 Try them out to see what sort of alternative they provide.
12482 \begin_layout Section
12484 \change_inserted 564990737 1670439661
12488 \begin_layout Subsection
12490 \change_inserted 564990737 1670439661
12494 \begin_layout Standard
12496 \change_inserted 564990737 1670439661
12505 document class for preparing reports.
12510 document class, this provides parts, chapters and sections but does not
12511 provide the paragraph styles needed for a book; like the
12515 document class, it provides the abstract paragraph style.
12516 In two-sided mode, it does not start a new chapter on the right hand page.
12519 \begin_layout Standard
12521 \change_inserted 564990737 1670439674
12526 document classes are described in the Collections (section
12527 \begin_inset space ~
12531 \begin_inset CommandInset ref
12533 reference "sec:Collections"
12540 \begin_layout Section
12542 \change_inserted 564990737 1670439674
12546 \begin_layout Subsection
12550 \begin_layout Standard
12556 \begin_layout Subsubsection
12560 \begin_layout Standard
12561 Broadway is for writing plays.
12562 The format is more decorative than Hollywood, and much less standardized.
12563 This format should be suitable for workshops.
12566 \begin_layout Subsubsection
12570 \begin_layout Standard
12571 The same as in Hollywood.
12574 \begin_layout Subsubsection
12578 \begin_layout Standard
12583 names as labels then cross-reference the label to insert the name.
12584 The cross-reference dialog will show the current cast of characters.
12587 \begin_layout Subsubsection
12588 Paper size and Margins
12591 \begin_layout Standard
12592 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12595 \begin_layout Subsubsection
12599 \begin_layout Standard
12600 The following environments are available.
12601 You can use broadway.bind to get the bind keys shown at the right.
12604 \begin_layout Itemize
12608 \begin_inset Newline newline
12613 You should not have to use this, but it is here for anything that does not
12617 \begin_layout Itemize
12621 \begin_inset space \hfill{}
12625 \begin_inset Newline newline
12630 Used to describe stage setting and the action.
12631 First use of speaker names in all CAPs.
12634 \begin_layout Itemize
12638 \begin_inset space \hfill{}
12642 \begin_inset Newline newline
12647 Automatically numbered.
12648 On screen it will be arabic, but will print as Roman.
12651 \begin_layout Itemize
12655 \begin_inset space \hfill{}
12659 \begin_inset Newline newline
12669 It is just centered text.
12672 \begin_layout Itemize
12676 \begin_inset space \hfill{}
12680 \begin_inset Newline newline
12685 Not automatically numbered.
12686 You supply the number.
12687 This is because I couldn't figure out how.
12690 \begin_layout Itemize
12694 \begin_inset space \hfill{}
12698 \begin_inset Newline newline
12703 A special case of Narrative to describe the setting and action as the curtain
12707 \begin_layout Itemize
12711 \begin_inset space \hfill{}
12715 \begin_inset Newline newline
12720 The speaker's (actor's) title, centered in all CAPS.
12723 \begin_layout Itemize
12727 \begin_inset space \hfill{}
12731 \begin_inset Newline newline
12736 Instructions to the speaker.
12737 The parentheses are automatically inserted.
12738 The ( will appear on screen, but both will be in the printed play.
12739 This environment is only used within
12746 \begin_layout Itemize
12750 \begin_inset space \hfill{}
12754 \begin_inset Newline newline
12759 What the Speaker says.
12762 \begin_layout Itemize
12766 \begin_inset space \hfill{}
12770 \begin_inset Newline newline
12775 The curtain comes down.
12778 \begin_layout Itemize
12782 \begin_inset space \hfill{}
12788 \begin_layout Itemize
12792 \begin_inset space \hfill{}
12798 \begin_layout Itemize
12802 \begin_inset space \hfill{}
12808 \begin_layout Standard
12812 \begin_layout Subsection
12813 Hollywood (Hollywood spec scripts)
12816 \begin_layout Standard
12822 \begin_layout Subsubsection
12826 \begin_layout Standard
12827 Getting the format of a Hollywood script right is a
12828 \begin_inset Quotes eld
12832 \begin_inset Quotes erd
12835 It is designed to make the readers focus on content and to be easy and
12836 familiar for the actors to read.
12837 Each page of a script should be one minute of film.
12838 Nothing goes in a script that you cannot see or hear on screen.
12839 The courier 12 pt font should be used throughout.
12843 \begin_layout Subsubsection
12847 \begin_layout Standard
12848 Speakers' lines should NEVER break in mid-sentence.
12849 If a speaker's lines continue over a page break, repeat the
12853 title followed by (Cont'd).
12856 \begin_layout Subsubsection
12860 \begin_layout Standard
12865 names as labels then cross-reference the label to insert the name.
12866 The cross-reference dialog will show the current cast of characters.
12867 You can use this to insert the speaker name in narratives also.
12870 \begin_layout Subsubsection
12871 Paper size and Margins
12874 \begin_layout Standard
12875 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12878 \begin_layout Subsubsection
12882 \begin_layout Standard
12883 The following environments are available.
12884 You can use hollywood.bind to get the bind keys shown at the right.
12887 \begin_layout Itemize
12891 \begin_inset Newline newline
12896 Used where nothing else works.
12900 \begin_layout Itemize
12906 \begin_inset space \hfill{}
12914 \begin_inset Newline newline
12917 Usually followed by something like
12918 \begin_inset Quotes eld
12921 on Sally waking up.
12922 \begin_inset Quotes erd
12928 \begin_layout Itemize
12932 \begin_inset space \hfill{}
12936 \begin_inset Newline newline
12941 Introduces a new INTERIOR camera set-up.
12942 Always followed by DAY or NIGHT, or something similar to define the lighting
12944 Everthing on this line in CAPS.
12947 \begin_layout Itemize
12951 \begin_inset space \hfill{}
12955 \begin_inset Newline newline
12960 Introduces a new EXTERIOR camera set-up.
12961 Everthing on this line in CAPS.
12964 \begin_layout Itemize
12968 \begin_inset space \hfill{}
12972 \begin_inset Newline newline
12977 The character speaking.
12980 \begin_layout Itemize
12984 \begin_inset space \hfill{}
12988 \begin_inset Newline newline
12993 Instructions to the speaker.
12994 The () are automatically inserted.
12997 \begin_layout Itemize
13001 \begin_inset space \hfill{}
13005 \begin_inset Newline newline
13017 \begin_layout Itemize
13021 \begin_inset space \hfill{}
13025 \begin_inset Newline newline
13030 Camera movement instruction.
13032 \begin_inset space \thinspace{}
13036 \begin_inset space \space{}
13042 \begin_layout Itemize
13046 \begin_inset space \hfill{}
13052 \begin_layout Itemize
13056 \begin_inset space \hfill{}
13062 \begin_layout Itemize
13066 \begin_inset space \hfill{}
13072 \begin_layout Itemize
13076 \begin_inset space \hfill{}
13082 \begin_layout Subsubsection
13086 \begin_layout Itemize
13090 \begin_layout Itemize
13094 \begin_layout Itemize
13096 \begin_inset space \thinspace{}
13103 \begin_layout Itemize
13108 \begin_layout Itemize
13109 PAN — camera movement
13112 \begin_layout Itemize
13113 INSERT — cut to close-up of
13116 \begin_layout Chapter
13118 \change_inserted 564990737 1671185876
13122 \begin_layout Section
13123 Multiple Text Columns
13126 \begin_layout Standard
13127 This feature is independent of the option
13129 Two-column document
13131 in the document settings under
13136 If you want to have 2
13137 \begin_inset space ~
13140 columns for the whole document, it is recommended to use the
13142 Two-column document
13145 For all other cases use this feature.
13148 \begin_layout Standard
13149 To use multiple text columns in your document, you have to load the module
13156 Document\SpecialChar menuseparator
13157 Settings\SpecialChar menuseparator
13160 ) and must have the \SpecialChar LaTeX
13162 \begin_inset Flex Code
13165 \begin_layout Plain Layout
13174 \begin_layout Standard
13175 Footnotes within multiple columns will be placed at the bottom of the page
13176 and not under each column.
13177 Within the different columns you can use everything, with the limitation
13178 that for floats you need to use the float option
13185 \begin_layout Subsection
13189 \begin_layout Standard
13190 If you want to have 2
13191 \begin_inset space ~
13194 columns in your text, insert a multicolumn inset via the menu
13196 Insert\SpecialChar menuseparator
13198 \begin_inset space ~
13201 Insets\SpecialChar menuseparator
13203 \begin_inset space ~
13208 where the columns should start.
13209 Write all text that should be printed in 2
13210 \begin_inset space ~
13213 columns into this inset.
13216 \begin_layout Standard
13217 Here is an example:
13220 \begin_layout Standard
13222 \begin_inset Flex Multiple Columns
13225 \begin_layout Plain Layout
13230 The Adventure of the Empty House
13233 \begin_inset Newline newline
13236 by Sir Arthur Conan Doyle
13239 \begin_layout Plain Layout
13242 It was in the spring of the year 1894 that all London was interested, and
13243 the fashionable world dismayed, by the murder of the Honourable Ronald
13244 Adair under most unusual and inexplicable circumstances.
13245 The public has already learned those particulars of the crime which came
13246 out in the police investigation, but a good deal was suppressed upon that
13247 occasion, since the case for the prosecution was so overwhelmingly strong
13248 that it was not necessary to bring forward all the facts.
13249 Only now, at the end of nearly ten years, am I allowed to supply those
13250 missing links which make up the whole of that remarkable chain.
13251 The crime was of interest in itself, but that interest was as nothing to
13252 me compared to the inconceivable sequel, which afforded me the greatest
13253 shock and surprise of any event in my adventurous life.
13254 Even now, after this long interval, I find myself thrilling as I think
13255 of it, and feeling once more that sudden flood of joy, amazement, and increduli
13256 ty which utterly submerged my mind.
13257 Let me say to that public, which has shown some interest in those glimpses
13258 which I have occasionally given them of the thoughts and actions of a very
13259 remarkable man, that they are not to blame me if I have not shared my knowledge
13260 with them, for I should have considered it my first duty to do so, had
13261 I not been barred by a positive prohibition from his own lips, which was
13262 only withdrawn upon the third of last month.
13270 \begin_layout Standard
13271 To get 3 or more columns, set the cursor into the multicolumn inset and
13274 Insert\SpecialChar menuseparator
13276 \begin_inset space ~
13280 \begin_inset space ~
13286 The number of the desired columns is written into that inset (for 3
13287 \begin_inset space ~
13291 \begin_inset Quotes eld
13295 \begin_inset Quotes erd
13299 \begin_inset Newline newline
13302 Here is an example with 3
13303 \begin_inset space ~
13309 \begin_layout Standard
13310 \begin_inset Flex Multiple Columns
13313 \begin_layout Plain Layout
13316 \begin_inset Argument 1
13319 \begin_layout Plain Layout
13326 It can be imagined that my close intimacy with Sherlock Holmes had interested
13327 me deeply in crime, and that after his disappearance I never failed to
13328 read with care the various problems which came before the public.
13329 And I even attempted, more than once, for my own private satisfaction,
13330 to employ his methods in their solution, though with indifferent success.
13331 There was none, however, which appealed to me like this tragedy of Ronald
13333 As I read the evidence at the inquest, which led up to a verdict of willful
13334 murder against some person or persons unknown, I realized more clearly
13335 than I had ever done the loss which the community had sustained by the
13336 death of Sherlock Holmes.
13337 There were points about this strange business which would, I was sure,
13338 have specially appealed to him, and the efforts of the police would have
13339 been supplemented, or more probably anticipated, by the trained observation
13340 and the alert mind of the first criminal agent in Europe.
13341 All day, as I drove upon my round, I turned over the case in my mind and
13342 found no explanation which appeared to me to be adequate.
13343 At the risk of telling a twice-told tale, I will recapitulate the facts
13344 as they were known to the public at the conclusion of the inquest.
13352 \begin_layout Standard
13353 You can have up to 10
13354 \begin_inset space ~
13357 columns if you want to, but that might not be very pleasant for the readers
13361 \begin_layout Standard
13362 \begin_inset Newpage newpage
13368 \begin_layout Subsection
13369 Columns inside Columns
13372 \begin_layout Standard
13373 You can also have columns inside columns:
13376 \begin_layout Standard
13377 \begin_inset Flex Multiple Columns
13380 \begin_layout Plain Layout
13383 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
13384 at that time governor of one of the Australian colonies.
13385 Adair's mother had returned from Australia to undergo the operation for
13386 cataract, and she, her son Ronald, and her daughter Hilda were living together
13390 \begin_layout Plain Layout
13391 \begin_inset Flex Multiple Columns
13394 \begin_layout Plain Layout
13397 The youth moved in the best society
13398 \begin_inset space ~
13401 – had, so far as was known, no enemies and no particular vices.
13402 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
13403 had been broken off by mutual consent some months before, and there was
13404 no sign that it had left any very profound feeling behind it.
13405 For the rest {sic} the man's life moved in a narrow and conventional circle,
13406 for his habits were quiet and his nature unemotional.
13407 Yet it was upon this easy-going young aristocrat that death came, in most
13408 strange and unexpected form, between the hours of ten and eleven-twenty
13409 on the night of March 30, 1894.
13417 \begin_layout Plain Layout
13420 Ronald Adair was fond of cards
13421 \begin_inset space ~
13424 – playing continually, but never for such stakes as would hurt him.
13425 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
13426 It was shown that, after dinner on the day of his death, he had played
13427 a rubber of whist at the latter club.
13428 He had also played there in the afternoon.
13433 The evidence of those who had played with him
13434 \begin_inset space ~
13438 Murray, Sir John Hardy, and Colonel Moran
13439 \begin_inset space ~
13442 – showed that the game was whist, and that there was a fairly equal fall
13444 Adair might have lost five pounds, but not more.
13445 His fortune was a considerable one, and such a loss could not in any way
13447 He had played nearly every day at one club or other, but he was a cautious
13448 player, and usually rose a winner.
13449 It came out in evidence that, in partnership with Colonel Moran, he had
13450 actually won as much as four hundred and twenty pounds in a sitting, some
13451 weeks before, from Godfrey Milner and Lord Balmoral.
13452 So much for his recent history as it came out at the inquest.
13460 \begin_layout Subsection
13464 \begin_layout Standard
13465 The examples in this section show some more special features of multiple
13469 \begin_layout Standard
13470 For more features of multiple columns, have a look at the
13471 \begin_inset CommandInset href
13473 name "documentation"
13474 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
13479 of the \SpecialChar LaTeX
13481 \begin_inset Flex Code
13484 \begin_layout Plain Layout
13493 \begin_layout Subsubsection
13497 \begin_layout Standard
13498 To add a preface text for multiple columns, set the cursor into the multicolumn
13499 inset and use the menu
13501 Insert\SpecialChar menuseparator
13505 Write your preface text into that inset.
13506 \begin_inset Newline newline
13509 This is an example with some preface text:
13512 \begin_layout Standard
13513 \begin_inset VSpace bigskip
13519 \begin_layout Standard
13520 \begin_inset Flex Multiple Columns
13523 \begin_layout Plain Layout
13524 \begin_inset Argument 2
13527 \begin_layout Plain Layout
13528 And the story continues and continues and continues and continues\SpecialChar ldots
13536 On the evening of the crime, he returned from the club exactly at ten.
13537 His mother and sister were out spending the evening with a relation.
13538 The servant deposed that she heard him enter the front room on the second
13539 floor, generally used as his sitting-room.
13540 She had lit a fire there, and as it smoked she had opened the window.
13541 No sound was heard from the room until eleven-twenty, the hour of the return
13542 of Lady Maynooth and her daughter.
13543 Desiring to say good-night, she attempted to enter her son's room.
13544 The door was locked on the inside, and no answer could be got to their
13545 cries and knocking.
13546 Help was obtained, and the door forced.
13547 The unfortunate young man was found lying near the table.
13548 His head had been horribly mutilated by an expanding revolver bullet, but
13549 no weapon of any sort was to be found in the room.
13557 \begin_layout Standard
13558 You can also use a section heading as the preface if you use a section command
13559 as \SpecialChar TeX
13561 For example the command
13564 \begin_layout LyX-Code
13567 subsection{subsection title}
13570 \begin_layout Standard
13571 creates a subsection.
13572 In this example the preface is a subsubsection:
13575 \begin_layout Standard
13576 \begin_inset Flex Multiple Columns
13579 \begin_layout Plain Layout
13580 \begin_inset Argument 2
13583 \begin_layout Plain Layout
13587 \begin_layout Plain Layout
13596 This is a subsubsection heading as a preface
13600 \begin_layout Plain Layout
13614 A minute examination of the circumstances served only to make the case more
13616 In the first place, no reason could be given why the young man should have
13617 fastened the door upon the inside.
13618 There was the possibility that the murderer had done this, and had afterwards
13619 escaped by the window.
13620 The drop was at least twenty feet, however, and a bed of crocuses in full
13622 Neither the flowers nor the earth showed any sign of having been disturbed,
13623 nor were there any marks upon the narrow strip of grass which separated
13624 the house from the road.
13625 Apparently, therefore, it was the young man himself who had fastened the
13627 But how did he come by his death? No one could have climbed up to the window
13628 without leaving traces.
13629 Suppose a man had fired through the window, he would indeed be a remarkable
13630 shot who could with a revolver inflict so deadly a wound.
13631 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
13632 a hundred yards of the house.
13633 No one had heard a shot.
13641 \begin_layout Standard
13642 If there is less vertical space than 6
13643 \begin_inset space ~
13646 text lines is left on the page at the beginning of the multiple columns,
13647 a page break will be inserted before the multiple columns.
13648 Depending on the number of lines of the preface text, you might want to
13650 This is done by setting the cursor into the mulitcolumn inset behind the
13651 preface (if there is any) and using the menu
13653 Insert\SpecialChar menuseparator
13655 \begin_inset space ~
13659 \begin_inset space ~
13663 \begin_inset space ~
13669 Insert into that inset the amount of space like e.
13670 \begin_inset space \thinspace{}
13674 \begin_inset space \space{}
13678 \begin_inset Quotes eld
13682 \begin_inset Quotes erd
13686 \begin_inset Newline newline
13689 In this example the space is set to 7
13690 \begin_inset space ~
13693 text lines by using
13694 \begin_inset Flex Code
13697 \begin_layout Plain Layout
13706 \begin_inset Flex Code
13709 \begin_layout Plain Layout
13717 needs to be inserted as \SpecialChar TeX
13721 \begin_layout Standard
13722 \begin_inset Flex Multiple Columns
13725 \begin_layout Plain Layout
13726 \begin_inset Argument 3
13729 \begin_layout Plain Layout
13734 \begin_layout Plain Layout
13750 On the evening of the crime, he returned from the club exactly at ten.
13751 His mother and sister were out spending the evening with a relation.
13752 The servant deposed that she heard him enter the front room on the second
13753 floor, generally used as his sitting-room.
13754 She had lit a fire there, and as it smoked she had opened the window.
13755 No sound was heard from the room until eleven-twenty, the hour of the return
13756 of Lady Maynooth and her daughter.
13757 Desiring to say good-night, she attempted to enter her son's room.
13758 The door was locked on the inside, and no answer could be got to their
13759 cries and knocking.
13760 Help was obtained, and the door forced.
13761 The unfortunate young man was found lying near the table.
13762 His head had been horribly mutilated by an expanding revolver bullet, but
13763 no weapon of any sort was to be found in the room.
13771 \begin_layout Subsubsection
13775 \begin_layout Standard
13776 The amount of space before and after multiple columns can be changed by
13777 changing the length
13778 \begin_inset Flex Code
13781 \begin_layout Plain Layout
13790 For example the command
13793 \begin_layout LyX-Code
13801 \begin_layout Standard
13802 in \SpecialChar TeX
13803 Code changes its value to 3
13804 \begin_inset space \thinspace{}
13808 The change must be made before the multiple columns' start.
13809 The predefined value is 13
13810 \begin_inset space \thinspace{}
13816 \begin_layout Standard
13818 \begin_inset Flex Code
13821 \begin_layout Plain Layout
13830 \begin_inset space \thinspace{}
13836 \begin_layout Standard
13840 \begin_layout Plain Layout
13846 multicolsep}{2.5cm}
13854 \begin_layout Standard
13855 \begin_inset Flex Multiple Columns
13858 \begin_layout Plain Layout
13861 All day I turned these facts over in my mind, endeavouring to hit upon some
13862 theory which could reconcile them all, and to find that line of least resistanc
13863 e which my poor friend had declared to be the starting-point of every investigat
13865 I confess that I made little progress.
13866 In the evening I strolled across the Park, and found myself about six o'clock
13867 at the Oxford Street end of Park Lane.
13868 A group of loafers upon the pavements, all staring up at a particular window,
13869 directed me to the house which I had come to see.
13870 A tall, thin man with coloured glasses, whom I strongly suspected of being
13871 a plain-clothes detective, was pointing out some theory of his own, while
13872 the others crowded round to listen to what he said.
13873 I got as near him as I could, but his observations seemed to me to be absurd,
13874 so I withdrew again in some disgust.
13875 As I did so I struck against an elderly, deformed man, who had been behind
13876 me, and I knocked down several books which he was carrying.
13884 \begin_layout Standard
13885 \begin_inset Note Greyedout
13888 \begin_layout Plain Layout
13893 The values you set with
13894 \begin_inset Flex Code
13897 \begin_layout Plain Layout
13905 will be used for all following multiple columns until you change them again.
13913 \begin_layout Standard
13917 \begin_layout Plain Layout
13929 \begin_inset Note Note
13932 \begin_layout Plain Layout
13933 go back to the default
13941 \begin_layout Standard
13942 \begin_inset Newpage newpage
13948 \begin_layout Subsubsection
13952 \begin_layout Standard
13953 A column break can be forced by inserting the command
13954 \begin_inset Flex Code
13957 \begin_layout Plain Layout
13965 as \SpecialChar TeX
13966 Code to that position in the text where the column should be broken.
13967 Note that this leads in most cases to whitespace in the text.
13968 \begin_inset Newline newline
13971 Here is an example:
13974 \begin_layout Standard
13975 \begin_inset Flex Multiple Columns
13978 \begin_layout Plain Layout
13981 \begin_inset Quotes eld
13984 You're surprised to see me, sir,
13985 \begin_inset Quotes erd
13988 said he, in a strange, croaking voice.
13991 \begin_layout Plain Layout
13994 I acknowledged that I was.
13997 \begin_layout Plain Layout
14000 \begin_inset Quotes eld
14003 Well, I've a conscience, sir, and when I chanced to see you go into this
14004 house, as I came hobbling after you, I thought to myself, I'll just step
14005 in and see that kind gentleman, and tell him that if I was a bit gruff
14006 in my manner there was not any harm meant, and that I am much obliged to
14007 him for picking up my books.
14008 \begin_inset Quotes erd
14014 \begin_layout Plain Layout
14017 \begin_inset Quotes eld
14020 You make too much of a trifle,
14021 \begin_inset Quotes erd
14026 \begin_inset Quotes eld
14029 May I ask how you knew who I was?
14030 \begin_inset Quotes erd
14033 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
14037 \begin_layout Plain Layout
14049 \begin_layout Plain Layout
14052 \begin_inset Quotes eld
14055 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
14056 you'll find my little bookshop at the corner of Church Street, and very
14057 happy to see you, I am sure.
14058 Maybe you collect yourself, sir.
14062 \begin_inset space ~
14076 \begin_inset space ~
14079 – a bargain, every one of them.
14080 With five volumes you could just fill that gap on that second shelf.
14081 It looks untidy, does it not, sir?
14082 \begin_inset Quotes erd
14093 \begin_layout Subsubsection
14097 \begin_layout Standard
14098 The width of the columns is automatically calculated, but you can modify
14099 the space between the columns.
14100 This is done by changing the length
14101 \begin_inset Flex Code
14104 \begin_layout Plain Layout
14113 Its predefined value is 10
14114 \begin_inset space \thinspace{}
14118 Here is an example where
14119 \begin_inset Flex Code
14122 \begin_layout Plain Layout
14131 \begin_inset space \thinspace{}
14137 \begin_layout Standard
14141 \begin_layout Plain Layout
14155 \begin_layout Standard
14156 \begin_inset Flex Multiple Columns
14159 \begin_layout Plain Layout
14162 My observations of No.
14163 \begin_inset space \space{}
14166 427 Park Lane did little to clear up the problem in which I was interested.
14167 The house was separated from the street by a low wall and railing, the
14168 whole not more than five feet high.
14169 It was perfectly easy, therefore, for anyone to get into the garden, but
14170 the window was entirely inaccessible, since there was no water pipe or
14171 anything which could help the most active man to climb it.
14172 More puzzled than ever, I retraced my steps to Kensington.
14173 I had not been in my study five minutes when the maid entered to say that
14174 a person desired to see me.
14175 To my astonishment it was none other than my strange old book collector,
14176 his sharp, wizened face peering out from a frame of white hair, and his
14177 precious volumes, a dozen of them at least, wedged under his right arm.
14185 \begin_layout Standard
14189 \begin_layout Plain Layout
14201 \begin_inset Note Note
14204 \begin_layout Plain Layout
14205 go back to the default
14213 \begin_layout Subsubsection
14217 \begin_layout Standard
14218 Between the columns a rule with a width of the length
14219 \begin_inset Flex Code
14222 \begin_layout Plain Layout
14231 If this rule width is set to 0
14232 \begin_inset space \thinspace{}
14235 pt (this is the default), the rule is suppressed.
14236 In the following example the rule is 2
14237 \begin_inset space \thinspace{}
14243 \begin_layout Standard
14247 \begin_layout Plain Layout
14253 columnseprule}{2pt}
14261 \begin_layout Standard
14262 \begin_inset Flex Multiple Columns
14265 \begin_layout Plain Layout
14268 \begin_inset Quotes eld
14271 You're surprised to see me, sir,
14272 \begin_inset Quotes erd
14275 said he, in a strange, croaking voice.
14278 \begin_layout Plain Layout
14281 I acknowledged that I was.
14284 \begin_layout Plain Layout
14287 \begin_inset Quotes eld
14290 Well, I've a conscience, sir, and when I chanced to see you go into this
14291 house, as I came hobbling after you, I thought to myself, I'll just step
14292 in and see that kind gentleman, and tell him that if I was a bit gruff
14293 in my manner there was not any harm meant, and that I am much obliged to
14294 him for picking up my books.
14295 \begin_inset Quotes erd
14301 \begin_layout Plain Layout
14304 \begin_inset Quotes eld
14307 You make too much of a trifle,
14308 \begin_inset Quotes erd
14313 \begin_inset Quotes eld
14316 May I ask how you knew who I was?
14317 \begin_inset Quotes erd
14323 \begin_layout Plain Layout
14326 \begin_inset Quotes eld
14329 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
14330 you'll find my little bookshop at the corner of Church Street, and very
14331 happy to see you, I am sure.
14332 Maybe you collect yourself, sir.
14336 \begin_inset space ~
14350 \begin_inset space ~
14353 – a bargain, every one of them.
14354 With five volumes you could just fill that gap on that second shelf.
14355 It looks untidy, does it not, sir?
14356 \begin_inset Quotes erd
14367 \begin_layout Standard
14368 \begin_inset VSpace defskip
14374 \begin_layout Standard
14375 The rule can be colored by redefining the command
14376 \begin_inset Flex Code
14379 \begin_layout Plain Layout
14388 This is done by inserting the command
14391 \begin_layout LyX-Code
14396 columnseprulecolor}{
14401 \begin_layout Standard
14402 as \SpecialChar TeX
14403 Code before the multicolumn inset.
14405 \begin_inset Flex Code
14408 \begin_layout Plain Layout
14414 in this command by a color of your choice.
14415 You can use all pre- and self-defined colors.
14423 \begin_inset space ~
14428 for more information about pre- and self-defined colors.
14429 To go back to the default color insert the command
14432 \begin_layout LyX-Code
14437 columnseprulecolor}{
14442 \begin_layout Standard
14443 Here is the example with a cyan rule and 1
14444 \begin_inset space \thinspace{}
14447 cm column separation:
14450 \begin_layout Standard
14454 \begin_layout Plain Layout
14463 \begin_layout Plain Layout
14469 columnseprulecolor}{
14479 \begin_layout Standard
14480 \begin_inset Flex Multiple Columns
14483 \begin_layout Plain Layout
14486 \begin_inset Quotes eld
14489 You're surprised to see me, sir,
14490 \begin_inset Quotes erd
14493 said he, in a strange, croaking voice.
14496 \begin_layout Plain Layout
14499 I acknowledged that I was.
14502 \begin_layout Plain Layout
14505 \begin_inset Quotes eld
14508 Well, I've a conscience, sir, and when I chanced to see you go into this
14509 house, as I came hobbling after you, I thought to myself, I'll just step
14510 in and see that kind gentleman, and tell him that if I was a bit gruff
14511 in my manner there was not any harm meant, and that I am much obliged to
14512 him for picking up my books.
14513 \begin_inset Quotes erd
14519 \begin_layout Plain Layout
14522 \begin_inset Quotes eld
14525 You make too much of a trifle,
14526 \begin_inset Quotes erd
14531 \begin_inset Quotes eld
14534 May I ask how you knew who I was?
14535 \begin_inset Quotes erd
14541 \begin_layout Plain Layout
14544 \begin_inset Quotes eld
14547 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
14548 you'll find my little bookshop at the corner of Church Street, and very
14549 happy to see you, I am sure.
14550 Maybe you collect yourself, sir.
14554 \begin_inset space ~
14568 \begin_inset space ~
14571 – a bargain, every one of them.
14572 With five volumes you could just fill that gap on that second shelf.
14573 It looks untidy, does it not, sir?
14574 \begin_inset Quotes erd
14585 \begin_layout Standard
14589 \begin_layout Plain Layout
14595 columnseprule}{0pt}
14598 \begin_layout Plain Layout
14604 columnseprulecolor}{
14612 \begin_inset Note Note
14615 \begin_layout Plain Layout
14616 go back to the default
14624 \begin_layout Section
14626 \change_inserted 564990737 1671270380
14630 \begin_layout Subsection
14632 \change_inserted 564990737 1671270398
14634 \change_deleted 564990737 1671270396
14640 \begin_layout Standard
14643 as well as any other text processor uses by default rectangular paragraphs.
14644 For special cases like for example posters, invitation cards or poems you
14645 can modify the paragraph shape to one of your choice.
14646 This can be done by using the \SpecialChar LaTeX
14648 \begin_inset Flex Code
14651 \begin_layout Plain Layout
14657 which is loaded by using in the document settings the module
14659 Custom paragraph shapes
14664 \begin_layout Subsubsection
14668 \begin_layout Standard
14673 provides the following shapes:
14676 \begin_layout Standard
14677 \begin_inset Tabular
14678 <lyxtabular version="3" rows="13" columns="3">
14679 <features booktabs="true" islongtable="true" longtabularalignment="center">
14680 <column alignment="left" valignment="middle" width="16col%">
14681 <column alignment="left" valignment="middle" width="40col%">
14682 <column alignment="left" valignment="middle" width="35col%">
14683 <row endhead="true">
14684 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
14687 \begin_layout Plain Layout
14696 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
14699 \begin_layout Plain Layout
14708 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
14711 \begin_layout Plain Layout
14721 <row interlinespace="default">
14722 <cell alignment="left" valignment="top" usebox="none">
14725 \begin_layout Plain Layout
14733 <cell alignment="left" valignment="top" usebox="none">
14736 \begin_layout Plain Layout
14739 Circle with circular hole (in the size of a CD/DVD)
14744 <cell alignment="left" valignment="top" usebox="none">
14747 \begin_layout Plain Layout
14750 Cannot be scaled, take care there is not too much text
14756 <row interlinespace="default">
14757 <cell alignment="left" valignment="top" usebox="none">
14760 \begin_layout Plain Layout
14768 <cell alignment="left" valignment="top" usebox="none">
14771 \begin_layout Plain Layout
14779 <cell alignment="left" valignment="top" usebox="none">
14782 \begin_layout Plain Layout
14785 Fragile, calculation might fail
14791 <row interlinespace="default">
14792 <cell alignment="left" valignment="top" usebox="none">
14795 \begin_layout Plain Layout
14803 <cell alignment="left" valignment="top" usebox="none">
14806 \begin_layout Plain Layout
14809 Rhomboid (symbolizing a
14810 \begin_inset Quotes eld
14814 \begin_inset Quotes erd
14822 <cell alignment="left" valignment="top" usebox="none">
14825 \begin_layout Plain Layout
14834 <row interlinespace="default">
14835 <cell alignment="left" valignment="top" usebox="none">
14838 \begin_layout Plain Layout
14846 <cell alignment="left" valignment="top" usebox="none">
14849 \begin_layout Plain Layout
14857 <cell alignment="left" valignment="top" usebox="none">
14860 \begin_layout Plain Layout
14869 <row interlinespace="default">
14870 <cell alignment="left" valignment="top" usebox="none">
14873 \begin_layout Plain Layout
14881 <cell alignment="left" valignment="top" usebox="none">
14884 \begin_layout Plain Layout
14892 <cell alignment="left" valignment="top" usebox="none">
14895 \begin_layout Plain Layout
14904 <row interlinespace="default">
14905 <cell alignment="left" valignment="top" usebox="none">
14908 \begin_layout Plain Layout
14916 <cell alignment="left" valignment="top" usebox="none">
14919 \begin_layout Plain Layout
14922 Nut for bolt (hexagon with circular hole)
14927 <cell alignment="left" valignment="top" usebox="none">
14930 \begin_layout Plain Layout
14939 <row interlinespace="default">
14940 <cell alignment="left" valignment="top" usebox="none">
14943 \begin_layout Plain Layout
14951 <cell alignment="left" valignment="top" usebox="none">
14954 \begin_layout Plain Layout
14962 <cell alignment="left" valignment="top" usebox="none">
14965 \begin_layout Plain Layout
14974 <row interlinespace="default">
14975 <cell alignment="left" valignment="top" usebox="none">
14978 \begin_layout Plain Layout
14986 <cell alignment="left" valignment="top" usebox="none">
14989 \begin_layout Plain Layout
14997 <cell alignment="left" valignment="top" usebox="none">
15000 \begin_layout Plain Layout
15009 <row interlinespace="default">
15010 <cell alignment="left" valignment="top" usebox="none">
15013 \begin_layout Plain Layout
15021 <cell alignment="left" valignment="top" usebox="none">
15024 \begin_layout Plain Layout
15032 <cell alignment="left" valignment="top" usebox="none">
15035 \begin_layout Plain Layout
15044 <row interlinespace="default">
15045 <cell alignment="left" valignment="top" usebox="none">
15048 \begin_layout Plain Layout
15056 <cell alignment="left" valignment="top" usebox="none">
15059 \begin_layout Plain Layout
15062 Normal/reversed rain drop
15067 <cell alignment="left" valignment="top" usebox="none">
15070 \begin_layout Plain Layout
15073 Fragile, calculation might fail
15079 <row interlinespace="default">
15080 <cell alignment="left" valignment="top" usebox="none">
15083 \begin_layout Plain Layout
15092 <cell alignment="left" valignment="top" usebox="none">
15095 \begin_layout Plain Layout
15098 The \SpecialChar TeX
15104 <cell alignment="left" valignment="top" usebox="none">
15107 \begin_layout Plain Layout
15116 <row interlinespace="default">
15117 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
15120 \begin_layout Plain Layout
15124 \begin_inset Newline newline
15132 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
15135 \begin_layout Plain Layout
15138 Triangles in different orientations
15143 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
15146 \begin_layout Plain Layout
15162 \begin_layout Standard
15163 To use a shape for your paragraph, simply select it in \SpecialChar LyX
15165 for environments in the toolbar.
15168 \begin_layout Standard
15169 \begin_inset Newpage newpage
15175 \begin_layout Standard
15176 Here is an example paragraph in the shape of a nut:
15179 \begin_layout Standard
15180 \begin_inset VSpace bigskip
15189 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
15190 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
15192 At vero eos et accusam et justo duo dolores et ea rebum.
15193 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
15195 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
15196 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
15200 \begin_layout Standard
15201 \begin_inset VSpace bigskip
15207 \begin_layout Standard
15208 \begin_inset Note Greyedout
15211 \begin_layout Plain Layout
15220 paragraphs cannot run over a page break.
15228 \begin_layout Standard
15229 \begin_inset VSpace bigskip
15235 \begin_layout Standard
15237 \begin_inset Flex Code
15240 \begin_layout Plain Layout
15246 takes care that the shape will always be preserved, no matter how much
15247 text is in the paragraph.
15248 Therefore the paragraph size changes with the amount of contained text.
15249 This can lead to paragraph sizes exceeding the page margins.
15250 To demonstrate the size scaling, here is the same example paragraph but
15251 with twice as much text:
15254 \begin_layout Standard
15255 \begin_inset Newpage newpage
15264 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
15265 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
15267 At vero eos et accusam et justo duo dolores et ea rebum.
15268 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
15270 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
15271 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
15273 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
15274 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
15276 At vero eos et accusam et justo duo dolores et ea rebum.
15277 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
15279 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
15280 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
15284 \begin_layout Standard
15285 \begin_inset VSpace bigskip
15291 \begin_layout Standard
15292 An exception is the shape
15297 It cannot be scaled because it must fit the size of a CD/DVD.
15298 Therefore the amount of text that fits into the shape is limited.
15299 \begin_inset Newline newline
15310 shape are fragile, meaning that the calculation of their size can fail,
15311 depending on the amount of text.
15312 You will then get the \SpecialChar LaTeX
15314 \begin_inset Quotes eld
15317 Arithmetic overflow
15318 \begin_inset Quotes erd
15322 In this case one can try to remove or add some text; if nothing works one
15323 has to use another shape.
15326 \begin_layout Standard
15327 \begin_inset VSpace bigskip
15333 \begin_layout Standard
15334 For shapes with tips you will maybe see that \SpecialChar LaTeX
15335 's hyphenation routine fails
15336 for text in the tips.
15337 Therefore it is often necessary to add hyphenation points
15342 arg "specialchar-insert hyphenation"
15347 ) to the corresponding text parts.
15350 \begin_layout Standard
15351 \begin_inset VSpace bigskip
15357 \begin_layout Standard
15358 Shapepar paragraphs are either always centered or placed on the page so
15359 that their left border touches the left page margin.
15360 You can therefore not use the paragraph dialog to align such paragraphs.
15361 A solution is to put the paragraph into a minipage or parbox and align
15363 The problem is hereby to find the right width for the box.
15364 Because if it is too wide and you center the box, the paragraph is not
15365 centered too because it sticks at the left side of the box.
15366 So you might have to play a bit with the width until it fits.
15367 Here are two heart-shaped paragraphs, the first one is not aligned, the
15368 second one is right-aligned:
15371 \begin_layout Standard
15372 \begin_inset Newpage newpage
15378 \begin_layout Heart
15382 Lo\SpecialChar softhyphen
15383 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
15384 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
15386 At vero eos et accusam et justo duo dolores et ea rebum.
15387 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
15391 \begin_layout Standard
15392 \begin_inset VSpace bigskip
15398 \begin_layout Standard
15401 \begin_inset Box Frameless
15411 height_special "totalheight"
15416 backgroundcolor "none"
15419 \begin_layout Heart
15423 Lo\SpecialChar softhyphen
15424 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
15425 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
15427 At vero eos et accusam et justo duo dolores et ea rebum.
15428 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
15437 \begin_layout Subsubsection
15441 \begin_layout Standard
15442 You can define any shape you want.
15443 Doing this manually is a lot of work because every coordinate must be specified.
15444 But there is a way to let the computer calculate the coordinates:
15447 \begin_layout Enumerate
15448 Install the program
15449 \begin_inset CommandInset href
15452 target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
15460 \begin_layout Enumerate
15467 TeX/LaTeX\SpecialChar menuseparator
15468 Settings\SpecialChar menuseparator
15471 and select the font size you are using in your document.
15472 For example this document uses the size 12
15473 \begin_inset space \thinspace{}
15479 \begin_layout Enumerate
15483 \begin_layout Enumerate
15486 TeX/LaTeX\SpecialChar menuseparator
15489 to export the shape to coordinates.
15490 In the appearing dialog use either the outline of your shape for the coordinate
15491 s or the path itself.
15495 \begin_layout Plain Layout
15496 For more information see
15497 \begin_inset CommandInset href
15499 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
15512 \begin_layout Standard
15513 The coordinates are written into a \SpecialChar TeX
15515 To use it for your \SpecialChar LyX
15519 \begin_layout Enumerate
15520 Place the cursor before the first character of your paragraph (or into a
15524 \begin_layout Enumerate
15525 Open in \SpecialChar LyX
15528 Insert\SpecialChar menuseparator
15529 File\SpecialChar menuseparator
15531 \begin_inset space ~
15536 , select the file and use
15545 \begin_layout Standard
15546 \begin_inset VSpace defskip
15552 \begin_layout Standard
15553 \begin_inset Note Greyedout
15556 \begin_layout Plain Layout
15561 : The changed shape only applies to the current paragraph; everything is
15562 reset to normal for the next paragraph.
15563 Therefore the shape definition file must be input into every paragraph
15564 with the desired shape.
15572 \begin_layout Standard
15573 \begin_inset VSpace bigskip
15579 \begin_layout Standard
15580 Here is an example:
15583 \begin_layout Standard
15584 \begin_inset VSpace bigskip
15590 \begin_layout Standard
15591 \begin_inset CommandInset include
15593 filename "SpecialParagraphShape.tex"
15600 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
15601 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
15603 At vero eos et accusam et justo duo dolores et ea rebum.
15604 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
15606 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
15607 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
15611 \begin_layout Standard
15612 \begin_inset VSpace bigskip
15618 \begin_layout Standard
15623 to draw complexer shapes in
15627 you can draw the shape in a program of your choice and import the resulting
15633 Then you only need to draw a line or spline along the outline of the image.
15636 \begin_layout Standard
15637 \begin_inset VSpace bigskip
15643 \begin_layout Standard
15646 Custom paragraph shapes
15648 also provides the two commands
15656 which can be used to define custom shapes coordinate by coordinate.
15660 \begin_layout Plain Layout
15661 These commands are internally used for all shapes described here.
15666 For information how these styles are used and about further customization
15667 possibilities, have a look at the
15668 \begin_inset CommandInset href
15670 name "documentation"
15671 target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
15677 \begin_inset Flex Code
15680 \begin_layout Plain Layout
15689 \begin_layout Chapter
15691 \change_deleted 564990737 1671304317
15695 \change_inserted 564990737 1671304322
15697 \change_deleted 564990737 1671304331
15698 ies with Bib\SpecialChar TeX
15704 \begin_layout Standard
15705 The most basic information about how to use Bib\SpecialChar TeX
15710 with \SpecialChar LyX
15711 is contained in the section
15713 Bibliography databases
15720 The following subsections explain special bibliography features supported
15721 by \SpecialChar LyX
15725 \begin_layout Section
15726 Alternative Citation Styles
15729 \begin_layout Standard
15730 Standard Bib\SpecialChar TeX
15732 \begin_inset space \thinspace{}
15736 \begin_inset space \space{}
15740 \begin_inset Quotes eld
15744 \begin_inset Quotes erd
15747 ) to refer to a cited work.
15748 However, in many scientific disciplines, other citation styles are in use.
15749 The most common one is the author-year style (e.
15750 \begin_inset space \thinspace{}
15754 \begin_inset space \space{}
15758 \begin_inset Quotes eld
15762 \begin_inset Quotes erd
15767 supports three packages that provide this style,
15768 \begin_inset Flex Code
15771 \begin_layout Plain Layout
15778 \begin_inset Flex Code
15781 \begin_layout Plain Layout
15788 \begin_inset Flex Code
15791 \begin_layout Plain Layout
15798 Each of these packages has their pros and cons, which cannot be listed
15800 If you only want to have simple author-year (or author-numerical) style,
15801 or if you want to use one of the countless style files for
15802 \begin_inset Flex Code
15805 \begin_layout Plain Layout
15811 , then the established
15812 \begin_inset Flex Code
15815 \begin_layout Plain Layout
15821 package is probably your choice.
15822 If you look for specific citation styles common in law studies, you might
15824 \begin_inset Flex Code
15827 \begin_layout Plain Layout
15834 If you want to have full control over the formatting or look for advanced
15835 features such as ibidem, footnote citations, full title citations, advanced
15836 date formats (such as 400 BC) or full localization to other languages than
15837 English, you should definitely consider
15838 \begin_inset Flex Code
15841 \begin_layout Plain Layout
15847 , which exceeds all other packages in terms of features, but is also quite
15848 heavy and more resource-hungry.
15851 \begin_layout Standard
15852 The handling of these packages in \SpecialChar LyX
15853 is basically the same.
15855 \begin_inset Flex Noun
15858 \begin_layout Plain Layout
15859 Document\SpecialChar menuseparator
15866 \begin_inset Flex Noun
15869 \begin_layout Plain Layout
15876 \begin_inset Flex Noun
15879 \begin_layout Plain Layout
15886 \begin_inset Flex Noun
15889 \begin_layout Plain Layout
15896 \begin_inset Flex Noun
15899 \begin_layout Plain Layout
15906 \begin_inset Flex Noun
15909 \begin_layout Plain Layout
15910 Biblatex (Natbib mode)
15916 \begin_inset Flex Noun
15919 \begin_layout Plain Layout
15926 \begin_inset Flex Noun
15929 \begin_layout Plain Layout
15936 \begin_inset space ~
15939 6.5.3 in the User's Guide for more information on these choices).
15940 With all these packages, you will get some extra features in the citation
15941 dialog and you can select the style of the reference (
15942 \begin_inset Quotes eld
15946 \begin_inset Quotes erd
15950 \begin_inset Quotes eld
15954 \begin_inset Quotes erd
15958 \begin_inset Quotes eld
15962 \begin_inset Quotes erd
15966 \begin_inset Quotes eld
15970 \begin_inset Quotes erd
15974 Note that either package needs specifically designed style files.
15975 They all ship their own, but there are lots of additional style files,
15976 and there is even an interactive style file builder
15980 \begin_layout Plain Layout
15982 \begin_inset Flex URL
15985 \begin_layout Plain Layout
15987 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
15998 \begin_inset Flex Code
16001 \begin_layout Plain Layout
16010 \begin_layout Section
16011 Subdivided Bibliographies
16014 \begin_layout Standard
16015 Sometimes you might need to divide your bibliography into several sections.
16016 If you are for instance a historian, the possibility to separate sources
16017 and scientific works is most likely a
16018 \begin_inset Quotes eld
16022 \begin_inset Quotes erd
16026 Unfortunately, Bib\SpecialChar TeX
16027 itself does not allow you to do this.
16028 But with the help of some \SpecialChar LaTeX
16029 packages, Bib\SpecialChar TeX
16030 can be extended to fit your needs.
16033 \begin_layout Standard
16035 provides native support for one of these packages,
16043 \begin_layout Plain Layout
16045 \begin_inset Flex URL
16048 \begin_layout Plain Layout
16050 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
16060 The advantage of this package (compared to other packages such as
16064 ) is that you don't need to define new citation commands.
16065 Instead, you need to prepare different bibliographic databases which include
16066 the entries for the different sections of the bibliography.
16067 For example: If you want to divide your bibliography into the sections
16069 \begin_inset Quotes eld
16073 \begin_inset Quotes erd
16077 \begin_inset Quotes eld
16081 \begin_inset Quotes erd
16084 , you first need to create two bibliographic databases, e.
16085 \begin_inset space \thinspace{}
16089 \begin_inset space \space{}
16093 \begin_inset Flex Code
16096 \begin_layout Plain Layout
16103 \begin_inset Flex Code
16106 \begin_layout Plain Layout
16116 \begin_layout Standard
16118 \begin_inset Flex Noun
16121 \begin_layout Plain Layout
16122 Document\SpecialChar menuseparator
16129 \begin_inset Flex Noun
16132 \begin_layout Plain Layout
16139 \begin_inset Flex Noun
16142 \begin_layout Plain Layout
16143 Subdivided bibliography
16149 Now you can insert multiple Bib\SpecialChar TeX
16150 bibliographies, one for each section of
16152 Returning to our example: Insert the Bib\SpecialChar TeX
16154 \begin_inset Flex Code
16157 \begin_layout Plain Layout
16163 and a second one for the database
16164 \begin_inset Flex Code
16167 \begin_layout Plain Layout
16174 You are free to use the same or different styles for each section.
16175 Additionally, you can choose if the bibliography section should contain
16177 \begin_inset Quotes eld
16180 all cited references
16181 \begin_inset Quotes erd
16184 of the specified database(s) (which is the default),
16185 \begin_inset Quotes eld
16188 all uncited references
16189 \begin_inset Quotes erd
16193 \begin_inset Quotes eld
16197 \begin_inset Quotes erd
16201 This might be useful if you would like to separate your bibliography into
16203 \begin_inset Quotes eld
16207 \begin_inset Quotes erd
16211 \begin_inset Quotes eld
16215 \begin_inset Quotes erd
16219 \begin_inset Quotes eld
16223 \begin_inset Quotes erd
16227 The titles for the sections can be added as ordinary sections or subsections.
16229 \begin_inset Flex Code
16232 \begin_layout Plain Layout
16238 removes the bibliography title, you have to manually re-add that, too (as
16239 a chapter* or section*, for instance).
16242 \begin_layout Standard
16247 , the procedure is a bit different.
16256 , the aforementioned
16257 \begin_inset Flex Noun
16260 \begin_layout Plain Layout
16261 Subdivided bibliography
16266 option is disabled if you use
16275 provides its own means to generate subdivided bibliographies.
16276 You can either add keywords to bibliography entries via the
16277 \begin_inset Flex Code
16280 \begin_layout Plain Layout
16286 entry option and then filter bibliography sections by keyword (by adding
16288 \begin_inset Flex Code
16291 \begin_layout Plain Layout
16298 \begin_inset Flex Noun
16301 \begin_layout Plain Layout
16307 field of the dialog that opens if you left-click on the
16308 \begin_inset Flex Noun
16311 \begin_layout Plain Layout
16312 Biblatex Generated Bibliography
16317 button), or you can filter by entry types (such as
16326 \begin_inset space \thinspace{}
16331 \begin_inset Flex Code
16334 \begin_layout Plain Layout
16341 \begin_inset Flex Code
16344 \begin_layout Plain Layout
16351 \begin_inset Flex Noun
16354 \begin_layout Plain Layout
16360 field, or you can create so-called
16361 \begin_inset Quotes eld
16364 Bibliography Categories
16365 \begin_inset Quotes erd
16368 to which you can assign individual entries.
16369 Please refer to the Biblatex manual, section
16371 Subdivided Bibliographies
16376 \begin_layout Section
16377 Multiple Bibliographies
16378 \begin_inset CommandInset label
16380 name "subsec:Multiple-Bibliographies"
16387 \begin_layout Standard
16388 Multiple bibliographies, e.
16389 \begin_inset space \thinspace{}
16393 \begin_inset space \space{}
16396 a bibliography for each part, chapter, section, subsection or child (sub-documen
16397 t) of the document, are also supported by \SpecialChar LyX
16399 In order to enable it, go to
16400 \begin_inset Flex Noun
16403 \begin_layout Plain Layout
16404 Document\SpecialChar menuseparator
16405 Settings\SpecialChar menuseparator
16411 and select the relevant unit (e.
16412 \begin_inset space \thinspace{}
16416 \begin_inset Quotes eld
16420 \begin_inset Quotes erd
16424 \begin_inset Flex Noun
16427 \begin_layout Plain Layout
16428 Multiple Bibliographies
16434 Then add a Bib(la)\SpecialChar TeX
16435 bibliography to each unit (e.
16436 \begin_inset space \thinspace{}
16439 g., section) of your document.
16440 In the output, a separate bibliography, containing only the references
16441 done in the current unit is generated.
16444 \begin_layout Standard
16445 If you use Bib\SpecialChar TeX
16447 \begin_inset Flex Code
16450 \begin_layout Plain Layout
16457 \begin_inset Flex Code
16460 \begin_layout Plain Layout
16466 package is used to create multiple bibliographies.
16467 The former package is used if you select
16468 \begin_inset Quotes eld
16472 \begin_inset Quotes erd
16480 \begin_inset Flex Noun
16483 \begin_layout Plain Layout
16484 Sectioned Bibliography
16490 In all other cases,
16491 \begin_inset Flex Code
16494 \begin_layout Plain Layout
16504 \begin_layout Plain Layout
16505 An alternative approach, if you are willing to use some
16506 \begin_inset Flex Noun
16509 \begin_layout Plain Layout
16517 \begin_inset space ~
16521 \begin_inset CommandInset ref
16523 reference "sec:Inserting-TeX-Code"
16528 \begin_inset Flex Code
16531 \begin_layout Plain Layout
16543 \begin_inset Flex Code
16546 \begin_layout Plain Layout
16552 is used, \SpecialChar LyX
16553 encloses the specified units in
16554 \begin_inset Flex Code
16557 \begin_layout Plain Layout
16564 \begin_inset Flex Code
16567 \begin_layout Plain Layout
16576 \begin_inset Flex Code
16579 \begin_layout Plain Layout
16587 in order to create the units.
16588 Note that this approach has some limitations.
16589 First, every citation reference has to be inside some
16590 \begin_inset Flex Code
16593 \begin_layout Plain Layout
16600 So citations outside a defined unit (e.
16601 \begin_inset space \thinspace{}
16604 g., before the first section if you use
16605 \begin_inset Quotes eld
16609 \begin_inset Quotes erd
16613 \begin_inset Quotes eld
16617 \begin_inset Quotes erd
16621 You can also create your own units by entering
16622 \begin_inset Flex Code
16625 \begin_layout Plain Layout
16634 \begin_inset Flex Code
16637 \begin_layout Plain Layout
16645 as \SpecialChar TeX
16646 code (for instance to work around the mentioned limitation).
16648 \begin_inset Flex Code
16651 \begin_layout Plain Layout
16657 s cannot be nested.
16658 A second limitation is that
16659 \begin_inset Flex Code
16662 \begin_layout Plain Layout
16668 always processes all references of a bibliography database, even if they
16670 This can result in odd labels (e.
16671 \begin_inset space \thinspace{}
16676 \begin_inset Quotes eld
16680 \begin_inset Quotes erd
16683 if two works of this author from 2014 are in the database, even if only
16687 \begin_layout Standard
16693 \begin_inset Flex Code
16696 \begin_layout Plain Layout
16702 option is used instead.
16703 If you need specific units, you can start them with the \SpecialChar TeX
16705 \begin_inset Flex Code
16708 \begin_layout Plain Layout
16717 \begin_inset Flex Code
16720 \begin_layout Plain Layout
16729 If you also want to control the end of the unit, use the environment
16730 \begin_inset Flex Code
16733 \begin_layout Plain Layout
16743 \begin_inset Flex Code
16746 \begin_layout Plain Layout
16756 \begin_inset Flex Code
16759 \begin_layout Plain Layout
16765 s cannot be nested.
16766 In addition to the individual bibliography of the current unit,
16770 also provides an easy way to output all bibliographies, subsequently, at
16772 \begin_inset space \thinspace{}
16775 g., at the end of the document).
16777 \begin_inset Quotes eld
16780 all reference units
16781 \begin_inset Quotes erd
16784 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve
16786 Please refer to the
16790 manual for more information on this topic.
16793 \begin_layout Chapter
16795 \change_deleted 564990737 1671355654
16799 \change_inserted 564990737 1671355667
16801 \change_deleted 564990737 1671355661
16803 \change_inserted 564990737 1671355684
16805 \begin_inset CommandInset label
16807 name "chap:bullets"
16812 \change_deleted 564990737 1671355684
16814 \begin_inset CommandInset label
16825 \begin_layout Standard
16831 \begin_layout Section
16835 \begin_layout Standard
16837 provides 216 bullet shapes that can be accessed from a simple dialog.
16838 Using this dialog you can easily specify what bullet shape to use at each
16839 level of an itemized list.
16840 These settings are document-wide so you won't be able to specify different
16841 sets of bullets for different paragraphs.
16845 \begin_layout Plain Layout
16846 Well, actually you can but you'll have to do it by hand.
16854 \begin_layout Section
16858 \begin_layout Standard
16859 Open the dialog by selecting the
16860 \begin_inset Flex Noun
16863 \begin_layout Plain Layout
16864 Document\SpecialChar menuseparator
16870 menu item and then select the
16871 \begin_inset Flex Noun
16874 \begin_layout Plain Layout
16883 \begin_layout Standard
16884 The dialog provides you with a table of bullet shapes.
16885 A column of buttons on the left of the table provides access to the six
16886 different panels of bullet shapes.
16887 The row of buttons across the top is used to select which bullet depth
16890 \change_deleted 244031559 1603875981
16891 A text entry under the table shows the currently selected bullet shape's
16893 equivalent and this can be edited if desired.
16894 If you do modify the text you will also need to specify any needed packages
16895 in the \SpecialChar LaTeX
16901 \begin_layout Standard
16902 The six panels are divided up by the packages they require.
16903 The following table shows the mappings from button name to \SpecialChar LaTeX
16907 \begin_layout Standard
16909 \begin_inset Tabular
16910 <lyxtabular version="3" rows="7" columns="2">
16911 <features tabularvalignment="middle">
16912 <column alignment="center" valignment="top" width="0pt">
16913 <column alignment="center" valignment="top" width="0pt">
16915 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
16918 \begin_layout Plain Layout
16933 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
16936 \begin_layout Plain Layout
16953 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
16956 \begin_layout Plain Layout
16971 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
16974 \begin_layout Plain Layout
16983 base \SpecialChar LaTeX
16991 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
16994 \begin_layout Plain Layout
17009 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
17012 \begin_layout Plain Layout
17029 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
17032 \begin_layout Plain Layout
17047 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
17050 \begin_layout Plain Layout
17067 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
17070 \begin_layout Plain Layout
17085 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
17088 \begin_layout Plain Layout
17105 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
17108 \begin_layout Plain Layout
17123 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
17126 \begin_layout Plain Layout
17143 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
17146 \begin_layout Plain Layout
17161 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
17164 \begin_layout Plain Layout
17187 \begin_layout Standard
17189 doesn't stop you using bullets from packages you don't have.
17190 If you get errors from \SpecialChar LaTeX
17191 when you try to view or print the file, then it
17192 is likely you are missing a package.
17196 \begin_layout Plain Layout
17198 doesn't restrict your use since you may be editing locally and exporting
17207 \begin_layout Section
17211 \begin_layout Standard
17212 Select which bullet depth you want to change then select the bullet shape
17214 Any changes will not be visible in \SpecialChar LyX
17215 , but are visible when viewing the document.
17218 \begin_layout Standard
17219 You can reset a bullet shape to the default simply by clicking your right
17220 mouse button on the appropriate bullet depth button.
17224 \begin_layout Plain Layout
17229 want to have multiple sets of paragraphs with different sets of bullets
17230 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
17232 The bullet selection dialog can help though because it provides you with
17233 the \SpecialChar LaTeX
17234 code for a wide range of bullet shapes.
17235 To make your own custom paragraphs you have the following options:
17238 \begin_layout Plain Layout
17242 \begin_layout Plain Layout
17258 \begin_layout Plain Layout
17262 \begin_layout Plain Layout
17284 \begin_layout Itemize
17285 Use the \SpecialChar LaTeX
17287 \begin_inset Flex Code
17290 \begin_layout Plain Layout
17298 to specify a new bullet shape for a given depth.
17299 You'll also need to save the current bullet shape so you can restore it
17301 In this itemized list the following \SpecialChar LaTeX
17302 code was used to change the bullet
17303 used for the first depth.
17307 \begin_layout LyX-Code
17317 \begin_layout LyX-Code
17334 \begin_layout Itemize
17335 Note that the itemize depth is specified in Roman numerals as part of the
17345 \begin_layout Itemize
17346 \begin_inset Argument item:1
17349 \begin_layout Plain Layout
17353 \begin_layout Plain Layout
17371 Specify each individual entry by starting each item with the bullet shape
17373 \begin_inset Quotes eld
17377 \begin_inset Quotes erd
17380 inset (available at
17382 Insert\SpecialChar menuseparator
17386 \begin_inset Flex Noun
17389 \begin_layout Plain Layout
17397 For example, this item was started with
17398 \begin_inset Flex Code
17401 \begin_layout Plain Layout
17416 \begin_layout Plain Layout
17420 \begin_layout Plain Layout
17436 \begin_layout Plain Layout
17437 You'll also need to revert the labelitem back to its previous setting for
17438 the global bullet shape settings to remain in effect.
17439 The way used here was:
17442 \begin_layout LyX-Code
17457 \begin_layout Chapter
17461 \begin_layout Section
17462 Multipart Documents
17465 \begin_layout Subsection
17469 \begin_layout Standard
17470 When you are working on a large file with many sections, it is often convenient
17471 to break up the document into several files, or perhaps you have something
17472 where a table may change from time to time, but the preceding text does
17474 In these cases, you should seriously consider using multipart documents.
17475 For example, scientific papers often have five major sections: the introduction
17476 , observations, results, discussion, and conclusion.
17477 Each of these could be its own separate \SpecialChar LyX
17479 \begin_inset Quotes eld
17483 \begin_inset Quotes erd
17486 file which contains the title, authors, abstract, references, etc., plus
17487 the five included files.
17488 It is important to note that each of these files is a full \SpecialChar LyX
17490 can be formatted and printed on its own, as well as included in a master
17492 Each of these files must have the same document class, however—don't attempt
17493 to mix book classes with article classes.
17494 You may also include \SpecialChar LaTeX
17495 files; however, these files must not have their own
17497 \begin_inset space \thinspace{}
17501 \begin_inset space \space{}
17504 everything up to and including the
17505 \begin_inset Flex Code
17508 \begin_layout Plain Layout
17516 line as well as the
17517 \begin_inset Flex Code
17520 \begin_layout Plain Layout
17528 line must be deleted) or else errors will be generated when you try to
17532 \begin_layout Standard
17534 allows you to include files quite easily with
17535 \begin_inset Flex Noun
17538 \begin_layout Plain Layout
17539 Insert\SpecialChar menuseparator
17541 \begin_inset space ~
17550 When you click on this selection a small box is inserted into the file
17551 at the current cursor location.
17552 Clicking on the box raises a dialog which allows you to select the file
17553 to be included, and the method of its inclusion.
17557 \begin_layout Standard
17558 The file selection box should by now be obvious.
17559 The three inclusion methods are
17560 \begin_inset Quotes eld
17564 \begin_inset Quotes erd
17568 \begin_inset Quotes eld
17572 \begin_inset Quotes erd
17576 \begin_inset Quotes eld
17580 \begin_inset Quotes erd
17585 \begin_inset Quotes eld
17589 \begin_inset Quotes erd
17593 \begin_inset Quotes eld
17597 \begin_inset Quotes erd
17600 are similar in many ways, but there are also some notable differences:
17603 \begin_layout Enumerate
17605 \begin_inset Quotes eld
17609 \begin_inset Quotes erd
17612 are typeset beginning on a new page, while files that are
17613 \begin_inset Quotes eld
17617 \begin_inset Quotes erd
17620 are typeset starting on the current page.
17623 \begin_layout Enumerate
17624 \begin_inset Quotes eld
17628 \begin_inset Quotes erd
17631 files cannot themselves
17632 \begin_inset Quotes eld
17636 \begin_inset Quotes erd
17640 \begin_inset Quotes eld
17644 \begin_inset Quotes erd
17649 \begin_inset Quotes eld
17653 \begin_inset Quotes erd
17656 , on the other hand, infinite sub-inputting is possible.
17659 \begin_layout Enumerate
17660 \begin_inset Quotes eld
17664 \begin_inset Quotes erd
17667 allow for the output of only selected
17668 \begin_inset Quotes eld
17672 \begin_inset Quotes erd
17675 files, while maintaining the actual counters (pagination etc.) and references
17676 (please refer to the section
17679 \begin_inset space ~
17687 \begin_inset space ~
17692 manual for details).
17695 \begin_layout Standard
17697 \begin_inset Quotes eld
17701 \begin_inset Quotes erd
17704 is the preferred method for chapters that are outsourced to child documents,
17706 \begin_inset Quotes eld
17710 \begin_inset Quotes erd
17713 is more suitable for arbitrary file inheritance.
17716 \begin_layout Standard
17718 \begin_inset Quotes eld
17722 \begin_inset Quotes erd
17725 included file allows you to include a file typeset exactly as it appears
17727 \begin_inset space \thinspace{}
17731 \begin_inset space \space{}
17735 \begin_inset Flex Code
17738 \begin_layout Plain Layout
17744 mode, with the characters set in a fixed-width typewriter font.
17745 Normally, spaces in this file are invisible, though two consecutive spaces
17746 are conserved, unlike \SpecialChar LyX
17747 's normal treatment of spaces.
17748 However, setting the
17749 \begin_inset Flex Noun
17752 \begin_layout Plain Layout
17754 \begin_inset space ~
17758 \begin_inset space ~
17762 \begin_inset space ~
17770 checkbox typesets a mark to unambiguously define the presence of a space.
17774 \begin_layout Standard
17775 Generally, the master file is converted into a full \SpecialChar LaTeX
17776 file before typesetting,
17777 while the included files are converted to \SpecialChar LaTeX
17778 files that do not have all the
17779 preamble information.
17782 \begin_layout Subsection
17783 Cross-References Between Files
17786 \begin_layout Standard
17787 \begin_inset Box Shadowbox
17797 height_special "totalheight"
17802 backgroundcolor "none"
17805 \begin_layout Plain Layout
17806 This section is somewhat out of date.
17807 Need to describe default master documents and how children are opened when
17817 \begin_layout Standard
17818 It is possible to set up cross-references between the different files.
17819 First, open all the files in question: let's call them A and B in a two
17820 file example, where B is included in A.
17821 Let's say you insert a label in A, then want to reference it in B.
17822 Open the cross-reference dialog whilst in document B, and you can select
17824 \begin_inset Quotes eld
17828 \begin_inset Quotes erd
17834 \begin_layout Subsection
17835 Bibliography Lists in all Subdocuments
17838 \begin_layout Standard
17839 If you work with child documents, you might want to have only one main bibliogra
17840 phy at the end, but still be able to have a selected bibliography for the
17841 child if you output it on its own.
17842 Here is how to achieve this.
17845 \begin_layout Standard
17846 For the main document, you just insert a bibliography inset at the place
17847 where the main bibliography has to appear (within the master file or within
17849 If the bibliography inset is in the master file, the references will be
17850 inherited by all children, so they are available in the citation dialog
17854 \begin_layout Standard
17855 For child-specific bibliographies, insert bibliography insets within the
17856 child documents, at the place where the bibliography should appear when
17857 the child is compiled separately.
17858 However, the trick is to insert them into a branch (
17860 Insert\SpecialChar menuseparator
17861 Branch\SpecialChar menuseparator
17862 Insert New Branch...
17865 \begin_inset space \thinspace{}
17870 \begin_inset Quotes eld
17874 \begin_inset Quotes erd
17878 Within the children, activate the branch (
17880 Document\SpecialChar menuseparator
17881 Settings...\SpecialChar menuseparator
17885 Within the master, deactivate the branch (
17887 Document\SpecialChar menuseparator
17888 Settings...\SpecialChar menuseparator
17892 Now the child's bibliography will be ignored by the master, but considered
17896 \begin_layout Standard
17897 If you need multiple bibliographies (e.
17898 \begin_inset space \thinspace{}
17901 g., one per child in the
17905 ), please refer to sec.
17906 \begin_inset space ~
17910 \begin_inset CommandInset ref
17912 reference "subsec:Multiple-Bibliographies"
17919 \begin_layout Section
17924 \begin_layout Standard
17925 Users sometimes need to be able to
17926 \begin_inset Quotes eld
17930 \begin_inset Quotes erd
17934 file together with all the images (and other files) on which it depends,
17935 either for sending to a publisher or for sharing with a co-author.
17937 includes a Python script (
17938 \begin_inset Flex Code
17941 \begin_layout Plain Layout
17947 ) that automates this process.
17948 To use it, you must have either the
17949 \begin_inset Flex Code
17952 \begin_layout Plain Layout
17959 \begin_inset Flex Code
17962 \begin_layout Plain Layout
17968 python modules installed on your system.
17969 By default, the script prefers the
17970 \begin_inset Flex Code
17973 \begin_layout Plain Layout
17980 \begin_inset Flex Code
17983 \begin_layout Plain Layout
17989 format on Unix-like systems and the
17990 \begin_inset Flex Code
17993 \begin_layout Plain Layout
18002 \begin_layout Standard
18004 's configuration process will set the script up to export a `\SpecialChar LyX
18006 and this format will then be available under
18007 \begin_inset Flex Code
18010 \begin_layout Plain Layout
18011 File\SpecialChar menuseparator
18020 \begin_layout Standard
18021 Independently of the platform, the generation of a particular archive format
18022 can be forced by adding either the
18023 \begin_inset Flex Code
18026 \begin_layout Plain Layout
18033 \begin_inset Flex Code
18036 \begin_layout Plain Layout
18043 \begin_inset Flex Code
18046 \begin_layout Plain Layout
18053 \begin_inset Flex Code
18056 \begin_layout Plain Layout
18062 format) switch to the
18063 \begin_inset Flex Code
18066 \begin_layout Plain Layout
18068 \SpecialChar menuseparator
18076 \begin_inset Flex Code
18079 \begin_layout Plain Layout
18080 Tools\SpecialChar menuseparator
18081 Preferences\SpecialChar menuseparator
18082 File Handling\SpecialChar menuseparator
18089 (Make sure you add the switch after the script name, not before it.)
18092 \begin_layout Section
18093 Fancy Headers and Footers
18096 \begin_layout Standard
18097 The default page layout is rather plain; for an
18098 \begin_inset Flex Code
18101 \begin_layout Plain Layout
18107 document class, all you get is a centered page number at the bottom of
18109 This document uses KOMA-script's book class, so it appears to be a bit
18111 But to really put on a show, you need to set the document page style to
18113 \begin_inset Quotes eld
18117 \begin_inset Quotes erd
18120 , as mentioned in the
18125 This section describes the \SpecialChar LaTeX
18126 code you need to insert in your \SpecialChar LaTeX
18128 order to get the desired effects.
18131 \begin_layout Standard
18132 For more information on fancy headers, see the
18133 \begin_inset Flex Code
18136 \begin_layout Plain Layout
18142 package documentation.
18144 \begin_inset Flex URL
18147 \begin_layout Plain Layout
18149 https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
18157 \begin_layout Standard
18158 The page header is divided into three fields, not surprisingly labeled
18159 \begin_inset Quotes eld
18163 \begin_inset Quotes erd
18167 \begin_inset Quotes eld
18171 \begin_inset Quotes erd
18175 \begin_inset Quotes eld
18179 \begin_inset Quotes erd
18183 The footer is also divided into these three fields.
18184 The \SpecialChar LaTeX
18185 commands to set these fields in the simplest manner are
18186 \begin_inset Flex Code
18189 \begin_layout Plain Layout
18198 \begin_inset Flex Code
18201 \begin_layout Plain Layout
18210 \begin_inset Flex Code
18213 \begin_layout Plain Layout
18222 \begin_inset Flex Code
18225 \begin_layout Plain Layout
18234 Suppose you wish to put your name in the upper left hand corner of each
18236 Simply insert the following command in the preamble:
18239 \begin_layout Standard
18248 \begin_layout Standard
18249 You will now see your name in the upper left.
18250 If a field has a default entry that you would like to get rid of (often
18251 the page number appears in the central footer) simply include a command
18252 with a blank argument, e.
18253 \begin_inset space \thinspace{}
18259 \begin_layout Standard
18267 \begin_layout Standard
18268 Let's get really fancy: lets put the section number with the word
18269 \begin_inset Quotes eld
18273 \begin_inset Quotes erd
18277 \begin_inset space \thinspace{}
18281 \begin_inset space \space{}
18284 Section 3) in the upper left, the page number (e.
18285 \begin_inset space \thinspace{}
18289 \begin_inset space \space{}
18292 Page 4) in the upper right, your name in the lower left, and the date in
18294 The following commands should now appear in the preamble:
18297 \begin_layout Standard
18307 \begin_layout Standard
18315 \begin_layout Standard
18325 \begin_layout Standard
18334 \begin_layout Standard
18342 \begin_layout Standard
18352 \begin_layout Standard
18354 \begin_inset Flex Code
18357 \begin_layout Plain Layout
18366 \begin_inset Flex Code
18369 \begin_layout Plain Layout
18377 access \SpecialChar LaTeX
18378 's section and page counters, and so print out the current section
18381 \begin_inset Flex Code
18384 \begin_layout Plain Layout
18392 simply prints out today's date.
18395 \begin_layout Standard
18396 The thicknesses of the horizontal rules drawn beneath the header and above
18397 the footer can also be modified.
18398 If you don't want one of the rules, set its thickness to 0.
18399 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
18405 \begin_inset Flex Code
18408 \begin_layout Plain Layout
18413 headrulewidth}{0.4pt}
18419 \begin_inset Flex Code
18422 \begin_layout Plain Layout
18427 footrulewidth}{0.4pt}
18432 to set the thicknesses.
18435 \begin_layout Standard
18436 You can switch the header/footer settings on and off for individual pages
18437 using commands like
18438 \begin_inset Flex Code
18441 \begin_layout Plain Layout
18444 thispagestyle{empty}
18450 \begin_inset Flex Code
18453 \begin_layout Plain Layout
18456 thispagestyle{plain}
18462 \begin_inset Flex Code
18465 \begin_layout Plain Layout
18468 thispagestyle{fancy}
18474 Simply insert them in the text on the page you want changed and mark them
18475 as \SpecialChar TeX
18477 In fact, title pages are marked as plain by default, while following pages
18478 are marked fancy when using the global fancy setting.
18481 \begin_layout Standard
18482 As a final example, it is possible to include an image in the header or
18484 Suppose you want to put a company logo in the upper lefthand corner.
18485 You might try something like
18488 \begin_layout Standard
18497 includegraphics{logo.eps}}}
18500 \begin_layout Standard
18502 (you may need to preface this with
18503 \begin_inset Flex Code
18506 \begin_layout Plain Layout
18509 usepackage{graphics}
18514 if you don't include graphics elsewhere in your document).
18517 \begin_layout Chapter
18519 and the World Wide Web
18522 \begin_layout Standard
18524 has long supported the export of documents to various web-friendly formats,
18526 Before version 2.0, however, HTML export was always accomplished by the
18527 use of external converters.
18531 \begin_layout Plain Layout
18532 For details on the use of external converters with \SpecialChar LyX
18537 section of the Customization manual.
18542 These fall into two large groups: there are converters that use \SpecialChar LaTeX
18544 intermediate format, such as
18545 \begin_inset Flex Code
18548 \begin_layout Plain Layout
18555 \begin_inset Flex Code
18558 \begin_layout Plain Layout
18565 \begin_inset Flex Code
18568 \begin_layout Plain Layout
18574 , relying upon \SpecialChar LyX
18575 to produce the \SpecialChar LaTeX
18576 ; and there is a converter that works directly
18577 on \SpecialChar LyX
18579 \begin_inset Flex Code
18582 \begin_layout Plain Layout
18590 All of these have different advantages and disadvantages.
18594 \begin_layout Standard
18595 The \SpecialChar LaTeX
18596 -based converters have the advantage that, in principle, they know everythin
18597 g about the exported document that \SpecialChar LaTeX
18599 Such converters do not care, for example, if a certain block of code was
18600 produced by \SpecialChar LyX
18601 or was Evil Red Text.
18602 These converters know about
18603 \begin_inset Flex Code
18606 \begin_layout Plain Layout
18612 files, counters, and references, and can often make use of the
18613 \begin_inset Flex Code
18616 \begin_layout Plain Layout
18622 files generated by Bib\SpecialChar TeX
18624 On the other hand, \SpecialChar LaTeX
18625 is a very hard language to parse—it is sometimes said
18626 that only \SpecialChar TeX
18627 itself understands \SpecialChar TeX
18628 —and \SpecialChar LaTeX
18629 -based converters will often choke on
18630 what seem to be quite simple constructs; complex ones can throw them completely
18631 , and as of this writing, for example, the
18635 manual will not export with
18636 \begin_inset Flex Code
18639 \begin_layout Plain Layout
18645 , though the others will.
18646 The other issue concerns how math is handled.
18647 These converters typically convert the formulae into little pictures that
18648 are then linked from the HTML document.
18649 Since these are actually generated by \SpecialChar LaTeX
18650 , they are accurate.
18651 But they do not scale well, and just getting them to look as if they are
18652 actually meant to be in your document—so that the font sizes seem to be
18653 roughly the same—can be a challenge.
18656 \begin_layout Standard
18658 \begin_inset Flex Code
18661 \begin_layout Plain Layout
18669 \begin_inset CommandInset href
18671 name "http://pinchito.es/elyxer/"
18672 target "http://pinchito.es/elyxer/"
18677 ) solves some of these problems.
18678 In particular, the formulae it produces scale perfectly, since it renders
18679 math using a combination of HTML and CSS rather than converting the formulae
18681 But even moderately complex formula are rendered less well than with
18682 \begin_inset Flex Code
18685 \begin_layout Plain Layout
18691 ; this reflects the limitations of HTML.
18695 \begin_layout Plain Layout
18697 \begin_inset Flex Code
18700 \begin_layout Plain Layout
18707 can also use jsMath and MathJax for equations, but this setting is only
18708 available globally and requires one to have access to a server that runs
18714 More importantly (as of version 1.1.1, at least),
18715 \begin_inset Flex Code
18718 \begin_layout Plain Layout
18725 has limited support for math macros and no support for user-defined paragraph
18726 or character styles.
18727 These limitations make
18728 \begin_inset Flex Code
18731 \begin_layout Plain Layout
18738 unsuitable for many of the documents \SpecialChar LyX
18740 In principle, of course, these problems could be solved, but the \SpecialChar LyX
18742 have decided to follow a different path and have made \SpecialChar LyX
18744 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
18745 , DocBook, and plaintext.
18748 \begin_layout Standard
18749 As of this writing, XHTML output remains under development and should probably
18751 \begin_inset Quotes eld
18755 \begin_inset Quotes erd
18762 \begin_layout Plain Layout
18764 \begin_inset Flex Code
18767 \begin_layout Plain Layout
18768 development/HTML/HTML.notes
18773 , which can be found in the \SpecialChar LyX
18775 \begin_inset CommandInset href
18777 name "accessed online"
18778 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
18783 , usually contains up-to-date information about the state of XHTML output.
18784 See also the list of XHTML bugs on
18785 \begin_inset CommandInset href
18787 name "the bug tracker"
18788 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"
18798 Still, the developers have chosen this approach because it has several
18799 potential advantages over the other two.
18802 \begin_layout Standard
18803 These advantages are primarily due to the fact that the XHTML output routines,
18804 since they are part of \SpecialChar LyX
18805 , know everything \SpecialChar LyX
18806 knows about the document being
18811 \begin_layout Plain Layout
18812 Another advantage is that, since these routines are internal to \SpecialChar LyX
18814 immune to changes in \SpecialChar LyX
18815 's file format, or to changes in the semantics of
18821 So they know about the table of contents (as displayed in the outline),
18822 about the counters associated with different paragraph styles, and about
18823 user-defined styles.
18824 The XHTML output routines know what \SpecialChar LyX
18825 knows about internationalization,
18826 too, so they will output
18827 \begin_inset Quotes eld
18831 \begin_inset Quotes erd
18835 \begin_inset Quotes eld
18843 \begin_inset Quotes erd
18846 , depending upon the language in effect at the time.
18850 \begin_layout Standard
18851 Quite generally, the output routines know what \SpecialChar LyX
18852 knows about document layout,
18853 that is, about how the document is to be rendered on screen.
18854 We use this information when we output the document as XHTML.
18855 In particular, \SpecialChar LyX
18860 generates CSS style information corresponding to the layout information
18861 it uses to render the document on screen: if section headings are supposed
18862 to be sans-serif and bold as seen in \SpecialChar LyX
18863 , then (by default) they will be sans-seri
18864 f and bold when viewed in a web browser, too.
18865 And this is true not just for pre-defined styles, like Section, but for
18866 any style, including user-defined styles.
18867 Indeed, the XHTML output routines make no distinction between user-defined
18869 \change_deleted 244031559 1603876931
18871 \change_inserted 244031559 1603876940
18874 styles and \SpecialChar LyX
18875 's own pre-defined styles: in each case, everything \SpecialChar LyX
18877 the styles is contained in the layout files.
18878 And much the same is true as regards pre-defined textual insets, such as
18879 footnotes, and various custom insets.
18883 \begin_layout Standard
18884 The result is that XHTML output can be customized and extended in exactly
18885 the same way \SpecialChar LaTeX
18886 output can be customized and extended: through layout files
18888 See chapter five of the
18892 manual for the details.
18895 \begin_layout Standard
18896 The remainder of this chapter contains more detailed information on XHTML
18897 output, its limitations, and ways to work around those limitations.
18900 \begin_layout Section
18901 Math Output in XHTML
18904 \begin_layout Standard
18906 offers four choices for how math is rendered.
18907 These have various advantages and disadvantages:
18910 \begin_layout Itemize
18912 \begin_inset Newline newline
18915 MathML is a dialect of XML designed specifically for mathematics on the
18916 web, and it typically renders very well in browsers that support it.
18917 The disadvantage is that not all browsers support MathML, and support is
18918 not complete even in the Gecko-based browsers, such as Firefox.
18919 \begin_inset Newline newline
18922 If \SpecialChar LyX
18923 is unable to render a formula as MathML—for example, if the formula
18925 \begin_inset Flex Code
18928 \begin_layout Plain Layout
18934 package or ERT—then it will instead output the formula as an image.
18938 \begin_layout Itemize
18940 \begin_inset Newline newline
18943 As mentioned above,
18944 \begin_inset Flex Code
18947 \begin_layout Plain Layout
18953 outputs math as HTML, styled by CSS.
18957 \begin_layout Plain Layout
18959 has borrowed some of the CSS for its HTML output from
18960 \begin_inset Flex Code
18963 \begin_layout Plain Layout
18974 For simple formulae, this can work quite well, though with more complicated
18975 formulae it tends to break down.
18976 Still, this method has the advantage that it is very widely supported and
18977 so it may be appropriate for documents that contain only a little, fairly
18979 \begin_inset Newline newline
18982 If Lyx is unable to render a formula as HTML—for example, if the formula
18984 \begin_inset Flex Code
18987 \begin_layout Plain Layout
18993 package or ERT—then it will instead output the formula as an image.
18997 \begin_layout Itemize
18999 \begin_inset Newline newline
19003 \begin_inset Flex Code
19006 \begin_layout Plain Layout
19013 will output formulae as images, the very same images, in fact, that are
19014 used for instant preview.
19018 \begin_layout Plain Layout
19019 Instant preview does
19023 have to be on for images to be output, however.
19028 The advantage to this method is that the images are simply generated by
19030 , so they are very accurate.
19031 The disadvantage, as mentioned earlier, is that these are bitmapped images,
19032 so they do not scale terribly well, and one cannot copy them, etc.
19033 \begin_inset Newline newline
19036 The size of the images can be controlled by setting the
19037 \begin_inset Quotes eld
19040 Math Images Scaling
19041 \begin_inset Quotes erd
19045 \begin_inset Flex Noun
19048 \begin_layout Plain Layout
19049 Document\SpecialChar menuseparator
19050 Settings\SpecialChar menuseparator
19060 \begin_layout Plain Layout
19061 For those who want to know, this controls the resolution of the image in
19062 dots per inch and is based upon a default of 75 dpi.
19068 \begin_inset Newline newline
19071 If \SpecialChar LyX
19072 for some reason fails to create an image for a formula (e.g., if a required
19074 package is not installed), then it will fall back to outputing the raw
19079 \begin_layout Itemize
19082 \begin_inset Newline newline
19085 Finally, \SpecialChar LyX
19086 will happily output math as \SpecialChar LaTeX
19088 As well as being the output of last resort, this method can be used with
19090 \begin_inset CommandInset href
19093 target "http://www.math.union.edu/~dpvc/jsMath/"
19098 , which uses JavaScript to render \SpecialChar LaTeX
19099 embedded in HTML documents.
19101 wraps the \SpecialChar LaTeX
19103 \begin_inset Flex Code
19106 \begin_layout Plain Layout
19112 (for inline formulas) or
19113 \begin_inset Flex Code
19116 \begin_layout Plain Layout
19122 (for displayed formulas) with
19123 \begin_inset Flex Code
19126 \begin_layout Plain Layout
19132 , as is required for jsMath.
19135 \begin_layout Standard
19136 One of these output methods must be selected under
19137 \begin_inset Flex Noun
19140 \begin_layout Plain Layout
19141 Document\SpecialChar menuseparator
19142 Settings\SpecialChar menuseparator
19149 By default, \SpecialChar LyX
19151 This is a document-wide setting, therefore.
19154 \begin_layout Standard
19155 Eventually, \SpecialChar LyX
19156 will offer the user the option to select an alternate output
19157 method for a particular inset, say, one that isn't being rendered very
19162 \begin_layout Plain Layout
19163 That said, since \SpecialChar LyX
19164 falls back to images if the inset contains ERT, then one
19165 can force output as an image by putting some harmless ERT into the math,
19167 \begin_inset Formula $a=b\relax$
19178 \begin_layout Section
19179 Bibliography and Citations
19182 \begin_layout Standard
19183 XHTML output fully supports bibliographies and citations.
19187 \begin_layout Standard
19188 Citation labels are generated by the same machinery that generates \SpecialChar LyX
19190 labels, so the labels will look in the output much as they do in \SpecialChar LyX
19193 If you are using numerical citations, then \SpecialChar LyX
19194 will output numerical labels,
19195 such as [1] or [17], rather than simply showing the citation key in square
19196 brackets, as it does on-screen.
19197 If you are using author-year citations, then \SpecialChar LyX
19198 will add lowercase letters
19199 to the years, just as Bib\SpecialChar TeX
19200 does, if it finds more than one citation for
19201 a given author-year combination.
19202 The labels will be printed with the bibliography entries.
19203 Note that there is, at present, no way to customize the appearance of the
19204 labels, for example, to choose between square brackets and parentheses.
19207 \begin_layout Standard
19208 Bibliography output is handled by the same machinery that handles the presentati
19209 on of reference information in the citation dialog, so you will see in the
19210 XHTML output pretty much what you would see if you were to look at a given
19211 entry in the citation dialog.
19212 The formatting can be customized in your layout file or, preferably, in
19218 manual for the details.
19221 \begin_layout Standard
19222 The main defect at present is that cross-referenced information is printed
19223 with every entry with which it is associated.
19224 So you can see things like this:
19227 \begin_layout Quote
19229 \begin_inset Quotes eld
19232 Context and Logical Form
19233 \begin_inset Quotes erd
19238 Language in Context: Selected Essays
19240 (Oxford: Oxford University Press, 2007), pp.
19244 \begin_layout Quote
19246 \begin_inset Quotes eld
19249 Semantics in Context
19250 \begin_inset Quotes erd
19255 Language in Context: Selected Essays
19257 (Oxford: Oxford University Press, 2007), pp.
19261 \begin_layout Standard
19262 This should be fixed before long.
19265 \begin_layout Standard
19266 There is no support at present for sectioned bibliographies.
19267 If you have multiple bibliographies, then \SpecialChar LyX
19268 will print the same bibliography
19272 \begin_layout Section
19276 \begin_layout Standard
19278 will happily export indexes as XHTML, but with certain limitations at the
19282 \begin_layout Standard
19283 Index export will be most reliable when you do not attempt to use the fancy
19284 constructs that are described in the section on indexes in the
19292 \begin_layout Plain Layout
19293 The main issue here is that \SpecialChar LyX
19294 itself does not really handle these.
19295 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
19301 We'll describe how they are handled using the subsection headings from
19305 \begin_layout Itemize
19306 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
19307 makes an effort to support these,
19308 but the entries must be separated by
19309 \begin_inset Quotes eld
19313 \begin_inset Quotes erd
19316 , that is, there must be spaces around the exclamation point.
19317 This is because it is otherwise too difficult to check for escaped exclamation
19318 points, ones in math, and so forth.
19321 \begin_layout Itemize
19322 Page Ranges: There is no support at all for page ranges, since these make
19323 no sense with XHMTL.
19324 Instead, you will just get two index entries, one at either end.
19327 \begin_layout Itemize
19328 Cross-referencing: There is no support for cross-referencing.
19329 If \SpecialChar LyX
19330 finds an entry containing the
19331 \begin_inset Quotes eld
19334 |see\SpecialChar ldots
19336 \begin_inset Quotes erd
19339 construct, it is just dropped, and the rest is treated as an ordinary index
19343 \begin_layout Itemize
19344 Index Entry Order: \SpecialChar LyX
19345 does support attempts to fix the sorting order.
19346 It will take what is before the first `@' it finds and use that for sorting,
19347 taking what follows the first `@' to be the actual entry.
19348 At present, \SpecialChar LyX
19349 does not check for escaped `@', so do not try to index email
19353 \begin_layout Itemize
19354 Index Entry Layout: You can format entries by using the text style dialog,
19355 or by using any other method available within \SpecialChar LyX
19357 There is no support for constructs like:
19358 \begin_inset Quotes eld
19362 \begin_inset Quotes erd
19366 Indeed, if \SpecialChar LyX
19367 finds a pipe symbol, `|', in an entry, it will delete it and
19368 everything that follows it.
19371 \begin_layout Itemize
19372 Multiple Indexes: There is no support for multiple indexes.
19373 Rather, all index entries will be printed as one large index.
19374 To avoid our printing several versions of the index, we print only the
19375 main index, so make sure you have one.
19378 \begin_layout Section
19379 Nomenclature and Glossary
19382 \begin_layout Standard
19383 There is at present no support for glossaries.
19384 Adding it would be fairly trivial, and welcome.
19387 \begin_layout Chapter
19389 \change_inserted 1075283030 1616534180
19393 \begin_layout Standard
19395 \change_inserted 1075283030 1616534386
19396 Apart from HTML, \SpecialChar LyX
19397 can generate documents in the DocBook XML vocabulary.
19398 With versions 2.3 and before, only select templates could be used to generate
19399 DocBook documents (only version 4).
19400 Starting with \SpecialChar LyX
19401 2.4, most \SpecialChar LyX
19402 layouts can generate valid DocBook documents (only
19404 This feature is built into \SpecialChar LyX
19405 and does not require the use of external tools.
19408 \begin_layout Standard
19410 \change_inserted 1075283030 1616534437
19411 The result is that the DocBook output can be customized and extended in
19412 exactly the same way \SpecialChar LaTeX
19413 output can be customized and extended: through layout
19415 See chapter five of the
19419 manual for the details.
19422 \begin_layout Standard
19424 \change_inserted 1075283030 1616534475
19425 Most \SpecialChar LyX
19426 features are supported with DocBook, like math output.
19429 \begin_layout Itemize
19431 \change_inserted 1075283030 1616534741
19432 Math output is performed mostly in MathML (the major exception being constructio
19433 ns not supported by \SpecialChar LyX
19436 All formulae are also available in raw \SpecialChar TeX
19437 in the DocBook output for further
19441 \begin_layout Itemize
19443 \change_inserted 1075283030 1616534852
19444 Bibliographies and citations are implemented, including with an external
19446 Bibliography entries are not prerendered when the detailed information
19447 are available, but rather output with the standard DocBook constructs.
19448 The external DocBook processor is expected to handle the rendering of entries.
19451 \begin_layout Itemize
19453 \change_inserted 1075283030 1616534863
19454 Indexes are supported, including multiple indices.
19459 ), page ranges, and cross-references (
19463 ) are supported, with the exception of the same symbols escaped.
19472 ) are not supported.
19473 There is no support for escaping of index entries.
19476 \begin_layout Itemize
19478 \change_inserted 1075283030 1616534884
19479 Glossaries are implemented.
19482 \begin_layout Standard
19484 \change_inserted 1075283030 1616534894
19485 Two major parameters can be set at the document level.
19488 \begin_layout Itemize
19490 \change_inserted 1075283030 1616534948
19491 Format for tables: \SpecialChar LyX
19492 can generate tables either as HTML (default value) or
19493 CALS, depending on the user's requirements.
19494 Most DocBook processors accept both formats.
19497 \begin_layout Itemize
19499 \change_inserted 1075283030 1616535006
19500 MathML prefix: in DocBook, MathML is included within its own name space,
19502 The implication is that there must be an indication of the tags belonging
19503 to the MathML standard.
19504 Three choices are offered:
19508 \begin_layout Itemize
19510 \change_inserted 1075283030 1616535044
19511 Inline: the MathML name space is defined for each formula (using the
19515 attribute on each formula)
19518 \begin_layout Itemize
19520 \change_inserted 1075283030 1616535090
19525 prefix (default): the MathML name space is defined at the document level
19530 attribute on the root element).
19531 Each MathML is prefixed with
19540 \begin_layout Itemize
19542 \change_inserted 1075283030 1616620405
19547 prefix: similar to the
19556 \begin_layout Standard
19558 \change_inserted 1075283030 1616620470
19559 This option is especially useful if you want \SpecialChar LyX
19560 to match your personal style
19561 or to work with buggy software that only accepts one prefix for MathML.
19567 \begin_layout Chapter
19568 The \SpecialChar LyX
19572 \begin_layout Section
19576 \begin_layout Standard
19577 The `\SpecialChar LyX
19578 server' allows other programs to talk to \SpecialChar LyX
19579 , invoke \SpecialChar LyX
19580 commands, and retrieve
19581 information about the \SpecialChar LyX
19583 This is only intended for advanced users, but they should find it useful.
19584 It is by writing to the \SpecialChar LyX
19585 server, for example, that bibliography managers,
19586 such as JabRef, are able to
19587 \begin_inset Quotes eld
19591 \begin_inset Quotes erd
19594 citations to \SpecialChar LyX
19598 \begin_layout Section
19599 Starting the \SpecialChar LyX
19601 \begin_inset CommandInset label
19603 name "sec:Starting-the-Server"
19610 \begin_layout Standard
19611 The \SpecialChar LyX
19612 server works through the use of a pair of named pipes.
19613 These are usually located in
19614 \begin_inset Flex Code
19617 \begin_layout Plain Layout
19623 , (except on Windows, where
19627 named pipes are special objects located in
19628 \begin_inset Flex Code
19631 \begin_layout Plain Layout
19643 ) and have the names
19644 \begin_inset Quotes eld
19648 \begin_inset Flex Code
19651 \begin_layout Plain Layout
19658 \begin_inset Quotes erd
19662 \begin_inset Quotes eld
19666 \begin_inset Flex Code
19669 \begin_layout Plain Layout
19676 \begin_inset Quotes erd
19680 External programs write into
19681 \begin_inset Flex Code
19684 \begin_layout Plain Layout
19690 and read back data from
19691 \begin_inset Flex Code
19694 \begin_layout Plain Layout
19701 The stem of the pipe names can be defined in the
19702 \begin_inset Flex Noun
19705 \begin_layout Plain Layout
19706 Tools\SpecialChar menuseparator
19712 dialog, for example
19713 \begin_inset Flex Code
19716 \begin_layout Plain Layout
19717 "/home/myhome/lyxpipe"
19723 \begin_inset Flex Code
19726 \begin_layout Plain Layout
19740 on Windows (where any working path instead of lyxpipe can be used, for
19742 \begin_inset Flex Code
19745 \begin_layout Plain Layout
19768 configure this manually in order for the server to start.
19771 \begin_layout Standard
19774 \begin_inset Flex Code
19777 \begin_layout Plain Layout
19784 \begin_inset Flex Code
19787 \begin_layout Plain Layout
19793 ' to create the pipes.
19794 If one of the pipes already exists, \SpecialChar LyX
19795 will assume that another \SpecialChar LyX
19797 is already running and will not start the server.
19798 On POSIX (Unix like) systems, if for some other reason, an unused
19799 \begin_inset Quotes eld
19803 \begin_inset Quotes erd
19806 pipe is left in existence when \SpecialChar LyX
19807 closes, then \SpecialChar LyX
19808 will try to delete it.
19809 If this fails for some reason, you will need to delete the pipes manually
19810 and then restart \SpecialChar LyX
19812 On Windows, pipes are deleted by the OS on program termination or crash,
19814 \begin_inset Quotes eld
19818 \begin_inset Quotes erd
19821 pipes should not be possible.
19824 \begin_layout Standard
19825 To have several \SpecialChar LyX
19826 processes with servers at the same time, you have to use
19827 different configurations, perhaps by using separate user directories, each
19829 \begin_inset Flex Code
19832 \begin_layout Plain Layout
19838 file, for each process.
19841 \begin_layout Standard
19842 If you are developing a client program, you might find it useful to enable
19843 debugging information from the \SpecialChar LyX
19845 Do this by starting \SpecialChar LyX
19847 \begin_inset Flex Code
19850 \begin_layout Plain Layout
19859 \begin_layout Standard
19860 You can find a complete example client written in C++ in the source distribution
19862 \begin_inset Flex Code
19865 \begin_layout Plain Layout
19866 development/lyxserver/server_monitor.cpp
19874 \begin_layout Standard
19875 Another useful tool is the command-line based client found in
19876 \begin_inset Flex Code
19879 \begin_layout Plain Layout
19880 src/client/lyxclient
19888 \begin_layout Section
19889 Normal communication
19892 \begin_layout Standard
19893 To issue a \SpecialChar LyX
19894 call, the client writes a line of ASCII text into the input
19896 This line has the following format:
19899 \begin_layout Quote
19913 \begin_layout Description
19914 clientname is a name that the client can choose arbitrarily.
19915 Its only use is that \SpecialChar LyX
19916 will echo it if it sends an answer—so a client can
19917 dispatch results from different requesters.
19920 \begin_layout Description
19921 function is the function you want \SpecialChar LyX
19923 It is the same as the commands you'd use in the minibuffer.
19926 \begin_layout Description
19927 argument is an optional argument which is meaningful only to some functions
19929 \begin_inset Quotes eld
19933 \begin_inset Quotes erd
19936 LFUN will insert the argument as text at the cursor position).
19939 \begin_layout Standard
19940 The answer from \SpecialChar LyX
19941 will arrive in the output pipe and be of the form
19944 \begin_layout Quote
19958 \begin_layout Standard
19967 are just echoed from the command request, while
19971 is more or less useful information filled according to how the command
19972 execution worked out.
19973 Some commands, such as
19974 \begin_inset Quotes eld
19978 \begin_inset Quotes erd
19981 , will return information about the internal state of \SpecialChar LyX
19983 return an empty data-response.
19984 This means that the command execution went fine.
19987 \begin_layout Standard
19988 In case of errors, the response from \SpecialChar LyX
19989 will have this form
19992 \begin_layout Quote
20006 \begin_layout Standard
20011 should contain an explanation of why the command failed.
20014 \begin_layout Standard
20018 \begin_layout LyX-Code
20019 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
20020 \begin_inset Newline newline
20023 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
20024 \begin_inset Newline newline
20027 read a <~/.lyxpipe.out
20028 \begin_inset Newline newline
20034 \begin_layout Subsection
20035 AppleScript (Mac OS X)
20038 \begin_layout Standard
20039 Since \SpecialChar LyX
20040 2.1, \SpecialChar LyX
20041 supports basic interactions with AppleScript for normal communicatio
20042 n through the command run.
20043 This command takes a direct argument (the
20047 to perform) and an optional argument.
20048 It either returns the output of the function or triggers an error with
20049 the error message and code.
20052 \begin_layout Standard
20056 \begin_layout LyX-Code
20057 tell application "\SpecialChar LyX
20061 \begin_layout LyX-Code
20065 \begin_layout LyX-Code
20066 -- Stores the current file name into f
20069 \begin_layout LyX-Code
20070 set f to (run "server-get-filename" with argument "")
20073 \begin_layout LyX-Code
20074 on error the error_message number the error_number
20077 \begin_layout LyX-Code
20078 display dialog "Error: " & the error_number & ".
20082 \begin_layout LyX-Code
20083 & the error_message buttons {"OK"} default button 1
20086 \begin_layout LyX-Code
20090 \begin_layout LyX-Code
20094 \begin_layout Section
20098 \begin_layout Standard
20100 can notify clients of events going on asynchronously.
20101 Currently it will only do this if the user binds a key sequence with the
20103 \begin_inset Quotes eld
20107 \begin_inset Quotes erd
20111 The format of the string \SpecialChar LyX
20112 sends is as follows:
20115 \begin_layout Quote
20116 \begin_inset Flex Code
20119 \begin_layout Plain Layout
20130 \begin_layout Standard
20135 is the printed representation of the key sequence that was actually typed
20139 \begin_layout Standard
20140 This mechanism can be used to extend \SpecialChar LyX
20141 's command set and implement macros.
20142 Bind some key sequence to
20143 \begin_inset Quotes eld
20147 \begin_inset Quotes erd
20151 Then start a client that listens on the output pipe, dispatches the command
20152 according to the sequence, and starts a function that may use \SpecialChar LyX
20155 requests to issue a command or a series of commands to \SpecialChar LyX
20159 \begin_layout Section
20160 The simple \SpecialChar LyX
20164 \begin_layout Standard
20166 implements a simple protocol that can be used for session management.
20167 All messages are of the form
20170 \begin_layout Quote
20180 \begin_layout Standard
20186 \begin_inset Quotes eld
20190 \begin_inset Quotes erd
20194 \begin_inset Quotes eld
20198 \begin_inset Quotes erd
20203 \begin_inset Quotes eld
20207 \begin_inset Quotes erd
20210 is received from a client, \SpecialChar LyX
20211 will report back to inform the client that
20212 it's listening to it's messages, while
20213 \begin_inset Quotes eld
20217 \begin_inset Quotes erd
20220 sent from \SpecialChar LyX
20221 will inform clients that \SpecialChar LyX
20225 \begin_layout Section
20226 Reverse DVI/PDF search
20229 \begin_layout Standard
20230 Some DVI/PDF viewers
20234 \begin_layout Plain Layout
20235 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
20236 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
20245 facility (also called
20250 This means that you can tell \SpecialChar LyX
20251 to put the cursor to a specific line in the
20252 document by clicking at the respective position in the DVI/PDF output.
20253 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
20255 This is done via the \SpecialChar LyX
20256 server either by using the named pipe (
20260 ), or the UNIX domain socket (
20264 ) that \SpecialChar LyX
20265 creates in its temporary directory (this is the way the
20266 \begin_inset Flex Code
20269 \begin_layout Plain Layout
20275 program communicates with \SpecialChar LyX
20277 In some cases, you need a helper script that mediates between the viewer
20278 and \SpecialChar LyX
20279 , in others, the viewer can communicate with \SpecialChar LyX
20281 This depends on the selected viewer and on your operating system.
20282 The same applies to the way viewers need to be configured and the way the
20283 reverse search is actually performed.
20284 In what follows, we will thus describe how to setup reverse search for
20286 Before we turn to this, though, we will explain what needs to be done generally
20287 to enable reverse search in the DVI/PDF output.
20290 \begin_layout Subsection
20292 \begin_inset CommandInset label
20294 name "subsec:rev-search"
20301 \begin_layout Standard
20302 In most cases \SpecialChar LyX
20303 will do the work for you by pressing the following button
20307 arg "buffer-toggle-output-sync"
20311 Alternatively, you can also enable the feature by checking
20313 Synchronize with Output
20316 \begin_inset Flex Noun
20319 \begin_layout Plain Layout
20320 Document\SpecialChar menuseparator
20321 Settings\SpecialChar menuseparator
20328 In such a case \SpecialChar LyX
20329 will automatically insert the necessary Sync\SpecialChar TeX
20331 PDF) or load the srcltx package (for DVI) respectively.
20332 This option can be easily reached also on
20333 \begin_inset Flex Code
20336 \begin_layout Plain Layout
20345 \begin_layout Standard
20346 If you need a different setting, you can select or input a custom macro
20347 from the drop down box just below
20348 \begin_inset Flex Noun
20351 \begin_layout Plain Layout
20352 Document\SpecialChar menuseparator
20353 Settings\SpecialChar menuseparator
20354 Output\SpecialChar menuseparator
20355 Synchronize with Output
20363 \begin_layout Standard
20364 Note that the method
20365 \begin_inset Flex Code
20368 \begin_layout Plain Layout
20376 enables gzip compression.
20377 If your viewer does not support it, you should instead use
20378 \begin_inset Flex Code
20381 \begin_layout Plain Layout
20392 \begin_layout Standard
20393 Please also note that including the
20394 \begin_inset Flex Code
20397 \begin_layout Plain Layout
20404 \begin_inset Flex Code
20407 \begin_layout Plain Layout
20413 sometimes has an undesired impact on the typesetting.
20414 Thus, you should switch output synchronization off for the final typesetting
20416 \begin_inset Flex Code
20419 \begin_layout Plain Layout
20426 \begin_inset Flex Code
20429 \begin_layout Plain Layout
20439 \begin_layout Standard
20440 In case you need some more special settings that are not covered by the
20441 automatic settings, read the next section about how to set up output synchroniz
20443 If the automatic setup suits your needs, you can readily jump to section
20444 \begin_inset space ~
20448 \begin_inset CommandInset ref
20450 reference "subsec:configuring-viewers"
20454 , where the necessary configuration steps in your viewer – needed both with
20455 the automatic and the manual setup – are described.
20458 \begin_layout Subsection
20462 \begin_layout Standard
20464 provides several different methods for reverse search.
20465 Some are built-in in the
20466 \begin_inset Flex Code
20469 \begin_layout Plain Layout
20475 program, some are provided by external packages.
20476 Your choice depends on whether your \SpecialChar LaTeX
20477 distribution already provides a given
20478 method (the built-in methods are rather new) and whether your viewer can
20480 The available methods are described in the following.
20483 \begin_layout Subsubsection*
20484 Built-in DVI-search via src-specials (DVI only)
20487 \begin_layout Standard
20488 This method provides the DVI file with the necessary information for reverse
20490 It is available in \SpecialChar LaTeX
20491 since quite some time (any somewhat recent \SpecialChar LaTeX
20493 should include it), and it works reliably.
20494 To enable it, change the
20495 \begin_inset Flex Noun
20498 \begin_layout Plain Layout
20509 \begin_inset Flex Noun
20512 \begin_layout Plain Layout
20523 \begin_inset Flex Noun
20526 \begin_layout Plain Layout
20527 Preferences\SpecialChar menuseparator
20528 File Handling\SpecialChar menuseparator
20535 \begin_inset Flex Code
20538 \begin_layout Plain Layout
20539 latex -src-specials $$i
20545 If this doesn't work, check if your \SpecialChar TeX
20546 engine needs different options (the
20547 syntax might differ in some distributions).
20550 \begin_layout Subsubsection*
20551 External Packages (PDFSync and scrltx)
20554 \begin_layout Standard
20563 provide reverse search facility for PDF output (via pdflatex) and DVI output,
20565 In order to enable it, load the packages in the \SpecialChar LyX
20569 \begin_layout Itemize
20570 \begin_inset Flex Code
20573 \begin_layout Plain Layout
20576 usepackage{pdfsync}
20581 for reverse PDF search,
20584 \begin_layout Itemize
20585 \begin_inset Flex Code
20588 \begin_layout Plain Layout
20591 usepackage[active]{srcltx}
20596 for reverse DVI search.
20599 \begin_layout Standard
20600 If you want to be able to perform both DVI and PDF reverse searches, you
20601 can also insert in the preamble the following lines
20604 \begin_layout LyX-Code
20608 \begin_inset Newline newline
20614 \begin_inset Newline newline
20619 usepackage{pdfsync}
20620 \begin_inset Newline newline
20626 \begin_inset Newline newline
20631 usepackage[active]{srcltx}
20632 \begin_inset Newline newline
20640 \begin_layout Standard
20641 This way, you can preview the file as either DVI or PDF (pdflatex) and the
20642 right package will be used.
20645 \begin_layout Standard
20646 Note that PDFSync might affect the output layout of your document.
20647 It is therefore advised to disable PDFsync for final documents.
20650 \begin_layout Subsubsection*
20651 Built-in reverse search via Sync\SpecialChar TeX
20655 \begin_layout Standard
20657 \begin_inset Flex Code
20660 \begin_layout Plain Layout
20666 have built-in support for both PDF and DVI reverse search.
20669 Sync\SpecialChar TeX
20672 facility is basically the result of the integration of the PDFSync package
20673 to the pdftex program and its merge with the
20678 You need at least \SpecialChar TeX
20679 Live 2008 or a recent Mik\SpecialChar TeX
20680 distribution in order to use
20685 \begin_layout Plain Layout
20686 For some reason, Mik\SpecialChar TeX
20687 does not understand/obey the command \SpecialChar LyX
20689 the preamble when you check the "Enable Forward/Reverse Search" button
20690 in the toolbar and does not generate the necessary info.
20693 \begin_layout Plain Layout
20694 The generation of the required info can be forced by changing the converter
20695 "\SpecialChar LaTeX
20696 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
20697 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
20698 the -synctex=1 switch).
20703 Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
20704 Skim on the Mac, SumatraPDF on Windows; see the next section for details)
20705 already provide Sync\SpecialChar TeX
20709 \begin_layout Standard
20710 To enable Sync\SpecialChar TeX
20711 for DVI output, change the
20712 \begin_inset Flex Noun
20715 \begin_layout Plain Layout
20726 \begin_inset Flex Noun
20729 \begin_layout Plain Layout
20734 (plain) -> DraftDVI
20740 \begin_inset Flex Noun
20743 \begin_layout Plain Layout
20744 Preferences\SpecialChar menuseparator
20745 File Handling\SpecialChar menuseparator
20752 \begin_inset Flex Code
20755 \begin_layout Plain Layout
20756 latex -synctex=1 $$i
20761 , and for PDF output, change the
20762 \begin_inset Flex Noun
20765 \begin_layout Plain Layout
20770 (pdflatex) -> PDF (pdflatex)
20776 \begin_inset Flex Code
20779 \begin_layout Plain Layout
20780 pdflatex -synctex=1 $$i
20786 Should your viewer not be considered in the following description, or in
20787 case of missing success, please check the documentation of your viewer
20788 whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
20793 \begin_layout Plain Layout
20794 Note that the option
20795 \begin_inset Flex Code
20798 \begin_layout Plain Layout
20804 option enables gzip compression.
20805 If your viewer does not support it, you should instead use
20806 \begin_inset Flex Code
20809 \begin_layout Plain Layout
20823 \begin_layout Subsection
20824 Configuring and using specific viewers
20825 \begin_inset CommandInset label
20827 name "subsec:configuring-viewers"
20834 \begin_layout Subsubsection*
20835 Xdvi (all platforms)
20838 \begin_layout Standard
20840 \begin_inset Flex Code
20843 \begin_layout Plain Layout
20849 , you don't need to do anything else for performing a reverse DVI search,
20850 as \SpecialChar LyX
20851 already provides the necessary hooks for automatically using the
20852 \begin_inset Flex Code
20855 \begin_layout Plain Layout
20862 Just setup your document as described above (reverse search is triggered
20863 by Ctrl-click or Alt-click on Mac OSX, respectively).
20866 \begin_layout Standard
20867 However, if for whatever reason you want to use the named pipe instead of
20868 the socket for communicating with \SpecialChar LyX
20869 , simply change the DVI viewer in
20870 \begin_inset Flex Noun
20873 \begin_layout Plain Layout
20874 Preferences\SpecialChar menuseparator
20875 File Handling\SpecialChar menuseparator
20885 \begin_layout Plain Layout
20886 On Mac OSX you have to use
20887 \begin_inset Flex Code
20890 \begin_layout Plain Layout
20891 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
20902 \begin_inset Flex Code
20905 \begin_layout Plain Layout
20906 xdvi -editor "lyxeditor.sh %f %l"
20912 \begin_inset Flex Code
20915 \begin_layout Plain Layout
20921 is a suitable script.
20922 For example, a minimal shell script is the following one:
20925 \begin_layout LyX-Code
20927 \begin_inset Newline newline
20930 LYXPIPE="/path/to/lyxpipe"
20931 \begin_inset Newline newline
20934 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
20935 \begin_inset Newline newline
20938 echo "$COMMAND" > "${LYXPIPE}".in || exit
20939 \begin_inset Newline newline
20942 read TMP < "${LYXPIPE}".out || exit
20945 \begin_layout Standard
20947 \begin_inset Flex Code
20950 \begin_layout Plain Layout
20956 is the LyXServer pipe path specified in
20957 \begin_inset Flex Noun
20960 \begin_layout Plain Layout
20961 Preferences\SpecialChar menuseparator
20971 \begin_layout Plain Layout
20973 \begin_inset Flex Code
20976 \begin_layout Plain Layout
20982 folder of a source distribution you can find a
20983 \begin_inset Flex Code
20986 \begin_layout Plain Layout
20992 script which is able to locate the
20996 based on your preferences.
21004 \begin_layout Subsubsection*
21008 \begin_layout Standard
21010 \begin_inset Flex Code
21013 \begin_layout Plain Layout
21014 /Applications/MacDviX_Folder/calleditor.script
21019 , add the following lines:
21022 \begin_layout LyX-Code
21023 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
21024 \begin_inset Newline newline
21030 \begin_layout Standard
21031 Modify the lines accordingly if you install \SpecialChar LyX
21032 somewhere else than in the
21033 Applications folder.
21036 \begin_layout Standard
21037 Reverse search is triggered by Alt-click (OPTION-click).
21040 \begin_layout Subsubsection*
21044 \begin_layout Standard
21046 \begin_inset Flex Code
21049 \begin_layout Plain Layout
21050 open -a Skim.app $$i
21055 to the viewer setting in
21056 \begin_inset Flex Noun
21059 \begin_layout Plain Layout
21060 Preferences\SpecialChar menuseparator
21061 File Handling\SpecialChar menuseparator
21062 File formats\SpecialChar menuseparator
21069 \begin_inset Flex Noun
21072 \begin_layout Plain Layout
21073 Skim\SpecialChar menuseparator
21074 Preferences\SpecialChar menuseparator
21081 \begin_inset Flex Noun
21084 \begin_layout Plain Layout
21090 preset and enter command
21091 \begin_inset Flex Noun
21094 \begin_layout Plain Layout
21095 /Applications/\SpecialChar LyX
21096 .app/Contents/MacOS/lyxeditor
21104 \begin_layout Standard
21105 Reverse search is triggered by COMMAND-SHIFT-click
21108 \begin_layout Subsubsection*
21112 \begin_layout Standard
21113 Reverse search with evince does not work out of the box, but it can be achieved
21114 by means of some third party helper scripts.
21116 \begin_inset CommandInset href
21118 target "https://wiki.lyx.org/LyX/SyncTeX"
21126 \begin_layout Subsubsection*
21130 \begin_layout Standard
21132 \begin_inset Flex Noun
21135 \begin_layout Plain Layout
21136 Settings\SpecialChar menuseparator
21137 Configure Okular\SpecialChar menuseparator
21144 \begin_inset Quotes erd
21148 This inserts the appropriate command (
21149 \begin_inset Flex Code
21152 \begin_layout Plain Layout
21161 \begin_layout Standard
21162 Reverse search is triggered by SHIFT-click.
21164 \change_inserted -712698321 1578211026
21165 Note that this only works if Okular is in
21166 \begin_inset Quotes eld
21170 \begin_inset Quotes erd
21174 \begin_inset space \thinspace{}
21177 e., the hand symbol is clicked).
21182 \begin_layout Subsubsection*
21186 \begin_layout Standard
21187 Qpdfview supports Sync\SpecialChar TeX
21188 since version 0.3.5.
21190 \begin_inset Flex Noun
21193 \begin_layout Plain Layout
21194 Edit\SpecialChar menuseparator
21195 Settings\SpecialChar menuseparator
21201 , click on the input field of the
21202 \begin_inset Quotes eld
21206 \begin_inset Quotes erd
21209 item and add the command
21210 \begin_inset Flex Code
21213 \begin_layout Plain Layout
21222 \begin_layout Standard
21223 Reverse search is triggered by double-click or, in more recent versions,
21227 \begin_layout Subsubsection*
21231 \begin_layout Standard
21232 Launch yap, choose its
21233 \begin_inset Flex Noun
21236 \begin_layout Plain Layout
21237 View\SpecialChar menuseparator
21243 menu and select the
21244 \begin_inset Quotes eld
21248 \begin_inset Quotes erd
21253 \begin_inset Quotes eld
21256 New\SpecialChar ldots
21258 \begin_inset Quotes erd
21261 button and, in the window that opens, enter
21262 \begin_inset Quotes eld
21267 \begin_inset Quotes erd
21270 (or any other name you like) in the
21271 \begin_inset Quotes eld
21275 \begin_inset Quotes erd
21279 Now click on the button labeled
21280 \begin_inset Quotes eld
21285 \begin_inset Quotes erd
21288 to open a file dialog and navigate to the directory containing the batch
21290 \begin_inset Flex Code
21293 \begin_layout Plain Layout
21301 \begin_inset Flex Code
21304 \begin_layout Plain Layout
21310 and then specify the program arguments as
21311 \begin_inset Flex Code
21314 \begin_layout Plain Layout
21322 \begin_inset Flex Code
21325 \begin_layout Plain Layout
21331 wrapper is used for communicating with \SpecialChar LyX
21339 \begin_layout LyX-Code
21341 \begin_inset Newline newline
21344 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
21353 \begin_inset Newline newline
21367 \begin_layout Standard
21368 Make sure that the \SpecialChar LyX
21369 Server pipe path you specified in \SpecialChar LyX
21371 \begin_inset Flex Code
21374 \begin_layout Plain Layout
21388 , otherwise change the
21389 \begin_inset Flex Code
21392 \begin_layout Plain Layout
21398 wrapper accordingly.
21401 \begin_layout Standard
21402 In yap, reverse search is triggered by double-click.
21405 \begin_layout Subsubsection*
21406 SumatraPDF (Windows)
21409 \begin_layout Standard
21410 In order to use SumatraPDF for inverse search, enter
21411 \begin_inset Flex Code
21414 \begin_layout Plain Layout
21415 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
21420 in the viewer setting in
21421 \begin_inset Flex Noun
21424 \begin_layout Plain Layout
21425 Preferences\SpecialChar menuseparator
21426 File Handling\SpecialChar menuseparator
21427 File formats\SpecialChar menuseparator
21434 \begin_inset Flex Code
21437 \begin_layout Plain Layout
21443 is the previous wrapper.
21444 If SumatraPDF.exe is not in your command PATH, use its full file name.
21447 \begin_layout Standard
21448 Reverse search is triggered by double-click.
21451 \begin_layout Subsubsection*
21455 \begin_layout Standard
21456 First of all, make sure that yap is your default DVI viewer in the Windows
21457 environment, then launch it, choose its
21458 \begin_inset Flex Noun
21461 \begin_layout Plain Layout
21462 View\SpecialChar menuseparator
21468 menu and select the
21469 \begin_inset Quotes eld
21473 \begin_inset Quotes erd
21478 \begin_inset Quotes eld
21481 New\SpecialChar ldots
21483 \begin_inset Quotes erd
21486 button and, in the window that opens, enter
21487 \begin_inset Quotes eld
21492 \begin_inset Quotes erd
21495 (or any other name you like) in the
21496 \begin_inset Quotes eld
21500 \begin_inset Quotes erd
21504 Now click on the button labeled
21505 \begin_inset Quotes eld
21510 \begin_inset Quotes erd
21513 to open a file dialog and navigate to the directory containing the
21514 \begin_inset Flex Code
21517 \begin_layout Plain Layout
21523 program (which is installed by default on Cygwin along with the \SpecialChar LyX
21526 \begin_inset Flex Code
21529 \begin_layout Plain Layout
21535 and then specify the program arguments as
21536 \begin_inset Flex Code
21539 \begin_layout Plain Layout
21546 In this way, you will be using the
21550 for communicating with \SpecialChar LyX
21552 If, for whatever reason, you want to use the
21557 \begin_inset Flex Code
21560 \begin_layout Plain Layout
21566 option and be sure to specify the \SpecialChar LyX
21567 Server pipe path in the \SpecialChar LyX
21571 \begin_layout Standard
21572 In yap, reverse search is triggered by double-click.
21575 \begin_layout Subsubsection*
21576 SumatraPDF (Cygwin)
21579 \begin_layout Standard
21580 In order to use SumatraPDF for inverse search, enter
21581 \begin_inset Flex Code
21584 \begin_layout Plain Layout
21585 SumatraPDF -inverse-search "lyxeditor -g %f %l"
21590 in the viewer setting in
21591 \begin_inset Flex Noun
21594 \begin_layout Plain Layout
21595 Preferences\SpecialChar menuseparator
21596 File Handling\SpecialChar menuseparator
21597 File formats\SpecialChar menuseparator
21604 If SumatraPDF.exe is not in your command PATH, use its full posix path.
21606 \begin_inset Flex Code
21609 \begin_layout Plain Layout
21615 enables communication via the
21621 \begin_inset Flex Code
21624 \begin_layout Plain Layout
21630 option if you want to use the
21634 , and be sure to specify the \SpecialChar LyX
21635 Server pipe path in the \SpecialChar LyX
21639 \begin_layout Standard
21640 Reverse search is triggered by double-click.
21643 \begin_layout Section
21647 \begin_layout Standard
21648 Forward search is, as the name implies, in a sense the
21649 \begin_inset Quotes eld
21653 \begin_inset Quotes erd
21657 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
21659 If forward search is set up (as described in what follows), you can put
21660 the cursor anywhere in your \SpecialChar LyX
21662 \begin_inset Flex Noun
21665 \begin_layout Plain Layout
21666 Navigate\SpecialChar menuseparator
21673 \begin_inset Flex Noun
21676 \begin_layout Plain Layout
21682 in the context menu via right mouse click), and then the viewer will jump
21683 to that position as well.
21684 This implies, of course, that your viewer supports this function.
21687 \begin_layout Standard
21688 To make forward search possible, you first need to provide the generated
21689 output PDF/DVI file with additional information about the \SpecialChar TeX
21691 This can be done via the methods described in the section
21692 \begin_inset CommandInset ref
21694 reference "subsec:rev-search"
21701 \begin_layout Standard
21702 Additionally, you need to configure \SpecialChar LyX
21703 for using your viewers in
21704 \begin_inset Flex Noun
21707 \begin_layout Plain Layout
21708 Tools\SpecialChar menuseparator
21709 Preferences\SpecialChar menuseparator
21710 Output\SpecialChar menuseparator
21717 We provide a range of tested configurations for some viewers, which you
21718 can select from the drop down list.
21719 If none of these configurations suits you, you have to find out and enter
21720 a suitable configuration yourself.
21721 The definition syntax uses the following placeholders:
21724 \begin_layout Itemize
21726 \begin_inset Flex Code
21729 \begin_layout Plain Layout
21738 \begin_layout Itemize
21740 \begin_inset Flex Code
21743 \begin_layout Plain Layout
21749 : name of the (temporary) exported .tex file (without path)
21752 \begin_layout Itemize
21754 \begin_inset Flex Code
21757 \begin_layout Plain Layout
21763 : name of the (temporary) exported .tex file (including path)
21766 \begin_layout Itemize
21768 \begin_inset Flex Code
21771 \begin_layout Plain Layout
21777 : name of the exported output file (either dvi or pdf, depending on which
21778 one exists in the temporary directory)
21781 \begin_layout Standard
21782 Note that only some of the viewers provide full and usable forward search
21783 functionality out of the box, among them yap, xdvi, okular
21787 \begin_layout Plain Layout
21788 You might want to set
21789 \begin_inset Flex Code
21792 \begin_layout Plain Layout
21799 \begin_inset Flex Noun
21802 \begin_layout Plain Layout
21803 Tools\SpecialChar menuseparator
21804 Preferences\SpecialChar menuseparator
21805 File Handling\SpecialChar menuseparator
21807 \begin_inset space ~
21820 , qpdfview, and SumatraPDF
21824 \begin_layout Plain Layout
21825 SumatraPDF can also use DDE commands through the external program CMCDDE
21826 — downloadable from
21827 \begin_inset CommandInset href
21829 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
21840 Others, such as evince
21844 \begin_layout Plain Layout
21845 Forward search with evince can be achieved by means of third party helper
21848 \begin_inset CommandInset href
21850 target "https://wiki.lyx.org/LyX/SyncTeX"
21860 , require some extra tools in order to use forward search.
21861 While many of the widespread PDF viewers (most notably Adobe Reader) do
21862 not support forward search at all, some other viewers – e.
21863 \begin_inset space \thinspace{}
21867 xpdf – allow at least to reload the document and jump to a specific page
21868 of the file, so you can at least navigate
21869 \begin_inset Quotes eld
21873 \begin_inset Quotes erd
21877 This latter functionality is provided by an external call of synctex (see
21878 the predefined example configurations).
21882 \begin_layout Standard
21883 Forward search works both with DVI and PDF output.
21885 simply checks which preview format you have used before (i.
21886 \begin_inset space \thinspace{}
21889 e., which format is already there in the temporary directory) and chooses
21890 the appropriate configuration for the respective format.
21893 \begin_layout Chapter
21895 \change_deleted 564990737 1671097409
21896 Special Document Classes
21901 \begin_layout Section
21903 \change_deleted 564990737 1669742044
21907 \begin_layout Standard
21909 \change_deleted 564990737 1669742044
21915 \begin_layout Subsection
21917 \change_deleted 564990737 1669742044
21921 \begin_layout Standard
21923 \change_deleted 564990737 1669742044
21924 This section describes how \SpecialChar LyX
21925 can be used to write articles for submission
21926 to the scientific journal
21928 Astronomy and Astrophysics
21931 \begin_inset Flex URL
21934 \begin_layout Plain Layout
21936 https://www.aanda.org/
21941 ) using Version 5.01 of the document class
21946 This package can be downloaded from the ftp site
21949 \begin_layout Standard
21951 \change_deleted 564990737 1669742044
21952 \begin_inset VSpace medskip
21958 \begin_layout Standard
21961 \change_deleted 564990737 1669742044
21962 \begin_inset Flex URL
21965 \begin_layout Plain Layout
21967 ftp://ftp.edpsciences.org/pub/aa/readme.html
21975 \begin_layout Standard
21977 \change_deleted 564990737 1669742044
21978 \begin_inset VSpace medskip
21984 \begin_layout Standard
21986 \change_deleted 564990737 1669742044
21987 A manual comes together with that package, and this text is not meant to
21988 replace the original manual but is merely a short guide in how to realize
21989 the correct form of your paper.
21993 \begin_layout Standard
21995 \change_deleted 564990737 1669742044
21996 Please note that the publisher of the journal was changed from Springer
21997 to EDP Sciences starting January 1, 2001.
21998 That change involved also some slight changes to the style files, namely
21999 the removal of the thesaurus command.
22000 The \SpecialChar LyX
22001 class aa supports the newest version of these style files, V 5.01.
22002 If you have an older version installed, please upgrade.
22003 For compatibility, the old (version 4) layout has been kept as
22008 Please refer to the comments in
22011 Dir/layouts/aapaper.layout
22016 \begin_layout Subsection
22018 \change_deleted 564990737 1669742044
22022 \begin_layout Standard
22024 \change_deleted 564990737 1669742044
22025 It is recommended you start from the example template distributed with \SpecialChar LyX
22027 If you are not using a template, note the following settings:
22030 \begin_layout Itemize
22032 \change_deleted 564990737 1669742044
22039 Document\SpecialChar menuseparator
22042 dialog (OK, that one was obvious).
22045 \begin_layout Itemize
22047 \change_deleted 564990737 1669742044
22048 Don't change the option
22051 \begin_inset space ~
22061 The whole layout is done by the macros, you shouldn't change anything.
22064 \begin_layout Subsection
22066 \change_deleted 564990737 1669742044
22070 \begin_layout Standard
22072 \change_deleted 564990737 1669742044
22073 First thing to enter is the header information.
22074 It consists of seven entries, of which some are optional.
22078 \begin_layout Itemize
22080 \change_deleted 564990737 1669742044
22088 \begin_layout Itemize
22090 \change_deleted 564990737 1669742044
22098 \begin_layout Itemize
22100 \change_deleted 564990737 1669742044
22108 \begin_layout Itemize
22110 \change_deleted 564990737 1669742044
22118 \begin_layout Itemize
22120 \change_deleted 564990737 1669742044
22125 : [optional] if more than one author: whom to contact for offprint requests.
22128 \begin_layout Itemize
22130 \change_deleted 564990737 1669742044
22135 : [optional] mail address for contacts.
22138 \begin_layout Itemize
22140 \change_deleted 564990737 1669742044
22146 Suggested format is
22148 Received: <date>; Accepted <date>
22151 \begin_layout Standard
22153 \change_deleted 564990737 1669742044
22154 There is no need to issue the
22160 command, this is done automatically by \SpecialChar LyX
22161 when the header is finished.
22162 Although the order of the single header entries doesn't matter it is advised
22163 to keep the above sequence, just to get the best optics and meets the layout
22164 of the real document.
22167 \begin_layout Standard
22169 \change_deleted 564990737 1669742044
22170 If you want to place footnotes in the header block, e.
22171 \begin_inset space \thinspace{}
22175 \begin_inset space \space{}
22178 to state your present address, just use the standard footnote via the menu
22181 Insert\SpecialChar menuseparator
22186 will automagically use the term
22195 \begin_layout Standard
22197 \change_deleted 564990737 1669742044
22200 Edit\SpecialChar menuseparator
22203 , you'll find two insets which are relevant for the titling:
22206 \begin_layout Itemize
22208 \change_deleted 564990737 1669742044
22215 to mark corresponding author\SpecialChar breakableslash
22217 The institutes are numbered sequentially as they appear in the
22221 field, so you have to put a marker to each author.
22224 \begin_layout Itemize
22226 \change_deleted 564990737 1669742044
22231 to supply an email address for fast contact.
22234 \begin_layout Standard
22236 \change_deleted 564990737 1669742044
22237 In addition to these topics, the macros use one additional \SpecialChar LaTeX
22239 has no counterpart in \SpecialChar LyX
22243 \begin_layout Itemize
22245 \change_deleted 564990737 1669742044
22252 to separate different names for more than one author and institute, respectivel
22256 \begin_layout Standard
22258 \change_deleted 564990737 1669742044
22259 The appropriate command has to be entered in \SpecialChar LyX
22260 and marked as \SpecialChar LaTeX
22266 \begin_layout Subsection
22268 \change_deleted 564990737 1669742044
22272 \begin_layout Standard
22274 \change_deleted 564990737 1669742044
22275 The abstract should immediately follow the header block.
22276 With version 5 the abstract environment was changed to a command, and there
22277 is now a restriction to only one paragraph.
22278 In addition, it should contain an entry with the keywords.
22279 This is done via the paragraph style
22284 Refer to the example paper.
22287 \begin_layout Subsection
22289 \change_deleted 564990737 1669742044
22290 Supported environments
22293 \begin_layout Standard
22295 \change_deleted 564990737 1669742044
22296 The A&A paper layout supports the following environments for structuring
22300 \begin_layout Itemize
22302 \change_deleted 564990737 1669742044
22308 \begin_layout Itemize
22310 \change_deleted 564990737 1669742044
22316 \begin_layout Itemize
22318 \change_deleted 564990737 1669742044
22324 \begin_layout Itemize
22326 \change_deleted 564990737 1669742044
22332 \begin_layout Itemize
22334 \change_deleted 564990737 1669742044
22340 \begin_layout Itemize
22342 \change_deleted 564990737 1669742044
22348 \begin_layout Itemize
22350 \change_deleted 564990737 1669742044
22356 \begin_layout Itemize
22358 \change_deleted 564990737 1669742044
22364 \begin_layout Itemize
22366 \change_deleted 564990737 1669742044
22372 \begin_layout Itemize
22374 \change_deleted 564990737 1669742044
22380 \begin_layout Itemize
22382 \change_deleted 564990737 1669742044
22388 \begin_layout Itemize
22390 \change_deleted 564990737 1669742044
22397 \begin_layout Subsection
22399 \change_deleted 564990737 1669742044
22400 Commands not supported by \SpecialChar LyX
22404 \begin_layout Standard
22406 \change_deleted 564990737 1669742044
22407 Some commands are not yet supported by the
22411 layout for \SpecialChar LyX
22413 Some have already been mentioned.
22414 For the sake of completeness, they are listed all together here:
22417 \begin_layout Itemize
22419 \change_deleted 564990737 1669742044
22427 \begin_layout Itemize
22429 \change_deleted 564990737 1669742044
22437 \begin_layout Itemize
22439 \change_deleted 564990737 1669742044
22447 \begin_layout Itemize
22449 \change_deleted 564990737 1669742044
22457 \begin_layout Standard
22459 \change_deleted 564990737 1669742044
22460 If you want to use any of these commands, you have to enter them yourself.
22463 Do not forget to mark them as \SpecialChar LaTeX
22467 \begin_layout Subsection
22469 \change_deleted 564990737 1669742044
22470 Figure and Table Floats
22473 \begin_layout Standard
22475 \change_deleted 564990737 1669742044
22477 provides support for the necessary float environments
22479 figure, figure*, table
22485 , therefore we won't tell much about it here.
22489 \begin_inset space ~
22495 Just remember that tables should be left-aligned.
22496 For that, select the table and change the alignment in
22498 Edit\SpecialChar menuseparator
22500 \begin_inset space ~
22506 \begin_layout Standard
22508 \change_deleted 564990737 1669742044
22509 There is only one special thing: the figures with caption besides the figure.
22510 To create such a figure, you have to do the following:
22513 \begin_layout Enumerate
22515 \change_deleted 564990737 1669742044
22516 Create a wide figure float:
22518 Insert\SpecialChar menuseparator
22519 Float\SpecialChar menuseparator
22522 , then right click in the figure and select
22525 \begin_inset space ~
22533 \begin_layout Enumerate
22535 \change_deleted 564990737 1669742044
22536 Enter your caption text.
22539 \begin_layout Enumerate
22541 \change_deleted 564990737 1669742044
22546 to move the cursor above the caption.
22549 \begin_layout Enumerate
22551 \change_deleted 564990737 1669742044
22555 \begin_layout Enumerate
22557 \change_deleted 564990737 1669742044
22558 Position the cursor behind the figure and insert a horizontal fill:
22560 Insert\SpecialChar menuseparator
22562 \begin_inset space ~
22565 Character\SpecialChar menuseparator
22567 \begin_inset space ~
22575 \begin_layout Enumerate
22577 \change_deleted 564990737 1669742044
22578 Switch to \SpecialChar LaTeX
22582 \begin_inset space ~
22590 \begin_layout Enumerate
22592 \change_deleted 564990737 1669742044
22602 Do not close the brace!
22605 \begin_layout Enumerate
22607 \change_deleted 564990737 1669742044
22608 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
22613 \begin_inset space ~
22625 \begin_layout Standard
22627 \change_deleted 564990737 1669742044
22628 Also, refer to the figures in the example paper.
22631 \begin_layout Subsection
22633 \change_deleted 564990737 1669742044
22637 \begin_layout Standard
22639 \change_deleted 564990737 1669742044
22640 For submission, the paper has to be formated in a special double-spacing
22642 For this purpose, you have to give the option
22646 to the document class.
22647 This must be done using the custom class options field in the
22649 Document\SpecialChar menuseparator
22653 Just enter the string
22660 \begin_layout Subsection
22662 \change_deleted 564990737 1669742044
22666 \begin_layout Standard
22668 \change_deleted 564990737 1669742044
22673 directory contains an example paper written with \SpecialChar LyX
22675 It is the example paper from the original macro package, translated to
22678 Use it for inspiration, and compare the original \SpecialChar LaTeX
22679 code with \SpecialChar LyX
22683 \begin_layout Section
22685 \change_deleted 564990737 1671097429
22689 \begin_layout Standard
22691 \change_deleted 564990737 1671097429
22696 can be used to type letters according to German conventions.
22697 A template file is included in
22699 .../lyx/share/templates
22701 for you to use as a starting point.
22704 \begin_layout Section
22706 \change_deleted 564990737 1671097429
22710 \begin_layout Standard
22712 \change_deleted 564990737 1671097429
22713 See the \SpecialChar LyX
22719 It contains all infos you need.
22722 \begin_layout Section
22724 \change_deleted 564990737 1669755802
22728 \begin_layout Standard
22730 \change_deleted 564990737 1669755802
22733 Panayotis Papasotiriou
22736 \begin_layout Subsection
22738 \change_deleted 564990737 1669755802
22742 \begin_layout Standard
22744 \change_deleted 564990737 1669755802
22745 The ijmpc package is a set of macros that facilitates electronic manuscript
22748 International Journal of Modern Physics C
22751 Similarly, the ijmpd package is for creating manuscripts to be submitted
22754 International Journal of Modern Physics D
22757 Both journals are published by World Scientific.
22758 The corresponding document classes are named
22767 These files, together with instructions for the authors, can be downloaded
22769 \begin_inset Flex URL
22772 \begin_layout Plain Layout
22774 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
22780 \begin_inset Flex URL
22783 \begin_layout Plain Layout
22785 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
22791 Both packages are modified versions of the standard
22792 \begin_inset Quotes eld
22796 \begin_inset Quotes erd
22799 package, and they are almost (but not exactly) identical.
22800 Most of their features are supported by \SpecialChar LyX
22802 I have used \SpecialChar LyX
22803 successfully to write articles submitted to both journals
22804 without any problem.
22807 \begin_layout Subsection
22809 \change_deleted 564990737 1669755802
22813 \begin_layout Standard
22815 \change_deleted 564990737 1669755802
22816 As usual, the easiest way to write a paper is to start with a template.
22819 File\SpecialChar menuseparator
22835 This will give an (almost) empty document that includes the most common
22836 fields found in a manuscript.
22837 Simply overwrite the existing text (including the brackets,
22842 You should keep in mind the following remarks.
22845 \begin_layout Enumerate
22847 \change_deleted 564990737 1669755802
22849 won't let you change the font size and the page style of the document,
22850 because such modifications are not allowed by both packages.
22853 \begin_layout Enumerate
22855 \change_deleted 564990737 1669755802
22856 The language of the document should not be changed.
22857 Before previewing your paper, be sure that the babel package is not used.
22858 To do this, click on
22861 arg "dialog-show document"
22866 \SpecialChar menuseparator
22870 \begin_inset Quotes eld
22874 \begin_inset Quotes erd
22884 \begin_layout Enumerate
22886 \change_deleted 564990737 1669755802
22888 \begin_inset Quotes eld
22892 \begin_inset Quotes erd
22895 style must be used to define keywords.
22898 \begin_layout Enumerate
22900 \change_deleted 564990737 1669755802
22901 The ijmpc package provides a style named
22902 \begin_inset Quotes eld
22905 Classification Codes
22906 \begin_inset Quotes erd
22909 , which can be used to define classification codes, such as PACS numbers.
22910 Note that this facility is not supported by the ijmpd package.
22913 \begin_layout Enumerate
22915 \change_deleted 564990737 1669755802
22916 Several new environments are available:
22917 \begin_inset Quotes eld
22921 \begin_inset Quotes erd
22925 \begin_inset Quotes eld
22929 \begin_inset Quotes erd
22933 \begin_inset Quotes eld
22937 \begin_inset Quotes erd
22941 \begin_inset Quotes eld
22945 \begin_inset Quotes erd
22949 \begin_inset Quotes eld
22953 \begin_inset Quotes erd
22957 \begin_inset Quotes eld
22961 \begin_inset Quotes erd
22965 \begin_inset Quotes eld
22969 \begin_inset Quotes erd
22973 \begin_inset Quotes eld
22977 \begin_inset Quotes erd
22981 \begin_inset Quotes eld
22985 \begin_inset Quotes erd
22989 \begin_inset Quotes eld
22993 \begin_inset Quotes erd
22997 \begin_inset Quotes eld
23001 \begin_inset Quotes erd
23005 \begin_inset Quotes eld
23009 \begin_inset Quotes erd
23013 \begin_inset Quotes eld
23017 \begin_inset Quotes erd
23021 \begin_inset Quotes eld
23025 \begin_inset Quotes erd
23029 Their use is more or less obvious.
23031 supports all these environments; it will use the proper label, text style,
23032 and numbering scheme for each of them.
23035 \begin_layout Enumerate
23037 \change_deleted 564990737 1669755802
23038 Both packages use basic citations; the natbib package should not be used.
23039 In \SpecialChar LyX
23040 , citation references are shown as usual; in the output, citations are
23041 shown as superscripts.
23042 If you want to use a citation as normal text, you should use the
23047 \begin_inset space \thinspace{}
23051 \begin_inset space \space{}
23055 \begin_inset Quotes eld
23059 \begin_inset space \space{}
23069 \begin_inset Quotes erd
23075 \begin_layout Enumerate
23077 \change_deleted 564990737 1669755802
23079 \begin_inset Quotes eld
23083 \begin_inset Quotes erd
23086 section in both packages.
23087 To put acknowledgments, just use the
23088 \begin_inset Quotes eld
23092 \begin_inset Quotes erd
23098 \begin_layout Enumerate
23100 \change_deleted 564990737 1669755802
23101 Appendices may be added to the paper,
23105 the Acknowledgments and
23111 provides a special environment, called
23112 \begin_inset Quotes eld
23116 \begin_inset Quotes erd
23119 which marks the beginning of the appendices.
23120 This environment should be left blank; it just sends a \SpecialChar LaTeX
23121 command, but nothing
23123 In \SpecialChar LyX
23125 \begin_inset Quotes eld
23129 \begin_inset Quotes erd
23132 is printed with blue letters, as a signal that all sections after that
23133 point are appendices.
23134 To write an appendix, use the
23135 \begin_inset Quotes eld
23139 \begin_inset Quotes erd
23144 will number each appendix with capital letters, as required by both journals.
23146 \begin_inset Quotes eld
23150 \begin_inset Quotes erd
23157 be present before the first appendix; if not, all appendices will be numbered
23158 as normal sections in the output.
23161 \begin_layout Enumerate
23163 \change_deleted 564990737 1669755802
23164 The ijmpc and the ijmpd packages use the
23168 command to implement table captions.
23169 As a result, a table created by \SpecialChar LyX
23170 is printed correctly, but its caption
23172 However, you can use some \SpecialChar TeX
23173 code to overcome this problem, so that captions
23174 are printed as expected.
23175 To do so, create a float table as usual, remove the caption, and replace
23176 it with the \SpecialChar TeX
23187 (sic); you must also the \SpecialChar TeX
23192 immediately after the tabular material.
23193 Study the example table included in the template files to see how this
23194 trick is implemented.
23195 Alternatively, If you need table captions, you should implement the whole
23200 file, then include this file to the \SpecialChar LyX
23203 Insert\SpecialChar menuseparator
23204 File\SpecialChar menuseparator
23206 \begin_inset space ~
23212 Details on how to create a table float can be found in the files
23220 , included in the corresponding packages.
23223 \begin_layout Subsection
23225 \change_deleted 564990737 1669755802
23226 Preparing a paper for submission
23229 \begin_layout Standard
23231 \change_deleted 564990737 1669755802
23232 Before you submit your paper you must export the \SpecialChar LyX
23233 document as a \SpecialChar LaTeX
23236 File\SpecialChar menuseparator
23237 Export\SpecialChar menuseparator
23245 \begin_layout Plain Layout
23246 Actually you have the choice between \SpecialChar LaTeX
23247 (plain) and pdflatex.
23248 If you intend to use pdflatex to prepare the paper, you should use the
23249 pdflatex option so that included graphics are converted to PDF format,
23250 ready for use by pdflatex.
23255 , then make the following changes to the resulting
23262 \begin_layout Enumerate
23264 \change_deleted 564990737 1669755802
23265 Remove the comment lines before the
23274 \begin_layout Enumerate
23276 \change_deleted 564990737 1669755802
23277 Remove everything between (and including) the
23289 commands, except for any commands you specifically put into the \SpecialChar LaTeX
23293 \begin_layout Standard
23295 \change_deleted 564990737 1669755802
23300 file should be saved and processed through \SpecialChar LaTeX
23301 as many times as necessary.
23302 You may also want to check the resulting
23311 \begin_layout Section
23313 \change_deleted 564990737 1669801478
23317 \begin_layout Standard
23319 \change_deleted 564990737 1669801478
23325 \begin_layout Subsection
23327 \change_deleted 564990737 1669801478
23331 \begin_layout Standard
23333 \change_deleted 564990737 1669801478
23334 The iopart package provides a document class to create electronic manuscript
23335 submission to the journals published by the Institute of Physics.
23336 Instructions for the authors how to create a paper using the iopart class
23337 can be downloaded together with the iopart package from the site
23338 \begin_inset Flex URL
23341 \begin_layout Plain Layout
23343 ftp://ftp.iop.org/pub/journals/latex2e
23351 \begin_layout Subsection
23353 \change_deleted 564990737 1669801478
23357 \begin_layout Standard
23359 \change_deleted 564990737 1669801478
23360 The easiest way to write a paper is to start with the template
23364 that is available via
23366 File\SpecialChar menuseparator
23369 The template explains how to use the special text environments.
23370 Here are the most important advices:
23373 \begin_layout Itemize
23375 \change_deleted 564990737 1669801478
23376 To be able to compile your document to a PDF, PS, or DVI, ensure that the
23377 no AMS packages are loaded in
23379 Document\SpecialChar menuseparator
23380 Settings\SpecialChar menuseparator
23386 \begin_layout Itemize
23388 \change_deleted 564990737 1669801478
23391 The title environment defines the kind of your paper.
23392 So use one of the following environments for the title:
23396 \begin_layout Itemize
23398 \change_deleted 564990737 1669801478
23407 \begin_layout Itemize
23409 \change_deleted 564990737 1669801478
23418 \begin_layout Itemize
23420 \change_deleted 564990737 1669801478
23426 for a Topical review
23429 \begin_layout Itemize
23431 \change_deleted 564990737 1669801478
23440 \begin_layout Itemize
23442 \change_deleted 564990737 1669801478
23451 \begin_layout Itemize
23453 \change_deleted 564990737 1669801478
23459 for a Paper (same as Title)
23462 \begin_layout Itemize
23464 \change_deleted 564990737 1669801478
23470 for a Preliminary communication
23473 \begin_layout Itemize
23475 \change_deleted 564990737 1669801478
23481 for a Rapid communication
23484 \begin_layout Itemize
23486 \change_deleted 564990737 1669801478
23492 for a Letter to the editor
23496 \begin_layout Itemize
23498 \change_deleted 564990737 1669801478
23501 All title environments except of
23505 can have an optional short title.
23508 \begin_layout Itemize
23510 \change_deleted 564990737 1669801478
23511 There is a general title environment
23515 which is not directly supported by \SpecialChar LyX
23517 This can be used as \SpecialChar TeX
23518 code when your document doesn't fit into one of the
23522 \begin_layout Standard
23524 \change_deleted 564990737 1669801478
23525 For more informations like hints for special table and formula formatting,
23526 look at the IOP author guidelines.
23531 \begin_layout Section
23533 \change_deleted 564990737 1670317155
23537 \begin_layout Standard
23539 \change_deleted 564990737 1670317155
23542 Panayotis Papasotiriou
23545 \begin_layout Subsection
23547 \change_deleted 564990737 1670317155
23551 \begin_layout Standard
23553 \change_deleted 564990737 1670317155
23554 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
23555 that facilitates electronic manuscript submission to the journals they
23557 Most known of them (at least in my domain of interest) are
23559 Astrophysics and Space Science
23565 , but there are many others (see a complete list at
23566 \begin_inset Flex URL
23569 \begin_layout Plain Layout
23571 http://www.wkap.nl/jrnllist.htm/JRNLHOME
23577 The Kluwer package may be downloaded from the site
23578 \begin_inset Flex URL
23581 \begin_layout Plain Layout
23583 http://www.wkap.nl/kaphtml.htm/STYLEFILES
23589 A complete user guide is contained in that package (but it can also be
23590 downloaded separately).
23593 \begin_layout Standard
23595 \change_deleted 564990737 1670317155
23597 supports many features of the package but not everything.
23598 However, the \SpecialChar TeX
23599 code needed is reduced to some
23600 \begin_inset Quotes eld
23604 \begin_inset Quotes erd
23607 commands of the package (see
23608 \begin_inset space ~
23612 \begin_inset CommandInset ref
23614 reference "subsec:kluwer_peculiarities"
23619 I have recently used \SpecialChar LyX
23620 to write an article submitted to the
23622 Astrophysics and Space Science
23624 without any problem.
23627 \begin_layout Subsection
23629 \change_deleted 564990737 1670317155
23633 \begin_layout Standard
23635 \change_deleted 564990737 1670317155
23636 The easiest way to write a paper is to start with the Kluwer template file.
23639 File\SpecialChar menuseparator
23651 This will give an (almost) empty document that includes the most common
23652 fields found in a manuscript and a short description of their use.
23653 As in most templates, simply overwrite the existing text (including the
23658 ) with the correct information.
23661 \begin_layout Subsection
23663 \change_deleted 564990737 1670317155
23664 Preparing a paper for submission
23667 \begin_layout Standard
23669 \change_deleted 564990737 1670317155
23670 As in the AAS\SpecialChar TeX
23671 package, before you submit your paper to a journal you must
23673 \begin_inset Quotes eld
23677 \begin_inset Quotes erd
23683 \begin_layout Enumerate
23685 \change_deleted 564990737 1670317155
23686 Export your paper as a \SpecialChar LaTeX
23688 To do this, click on
23690 File\SpecialChar menuseparator
23691 Export\SpecialChar menuseparator
23699 \begin_layout Enumerate
23701 \change_deleted 564990737 1670317155
23706 file with a text editor and make the following changes
23710 \begin_layout Enumerate
23712 \change_deleted 564990737 1670317155
23713 remove the comment lines before the
23722 \begin_layout Enumerate
23724 \change_deleted 564990737 1670317155
23725 remove everything between (and including) the
23737 commands, except for any commands you specifically put into the \SpecialChar LaTeX
23741 \begin_layout Standard
23743 \change_deleted 564990737 1670317155
23752 \begin_layout Enumerate
23754 \change_deleted 564990737 1670317155
23759 file through \SpecialChar LaTeX
23760 as many times as necessary (usually up to three).
23763 \begin_layout Enumerate
23765 \change_deleted 564990737 1670317155
23771 \begin_inset space \thinspace{}
23775 \begin_inset space \space{}
23782 , and check if everything is OK (it should, if you didn't make any mistake).
23785 \begin_layout Subsection
23787 \change_deleted 564990737 1670317155
23788 \begin_inset Quotes eld
23792 \begin_inset Quotes erd
23795 of the Kluwer package
23796 \begin_inset CommandInset label
23798 name "subsec:kluwer_peculiarities"
23805 \begin_layout Standard
23807 \change_deleted 564990737 1670317155
23808 The Kluwer package has the following
23809 \begin_inset Quotes eld
23813 \begin_inset Quotes erd
23819 \begin_layout Enumerate
23821 \change_deleted 564990737 1670317155
23822 It is possible to write multiple articles in the same \SpecialChar LaTeX
23827 \begin_layout Plain Layout
23828 I can't imagine any good reason to do this.
23834 Each article must be included in the environment
23835 \begin_inset Quotes eld
23839 \begin_inset Quotes erd
23843 Unfortunately, this environment cannot be omitted, even if you write just
23845 Therefore, each article starts with the command
23851 and, obviously, ends with the command
23858 Although this can be implemented in \SpecialChar LyX
23859 , I didn't included it, since it looks
23860 ugly and can confuse the novice user.
23861 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
23864 \begin_inset Quotes eld
23869 \begin_inset Quotes erd
23875 \begin_layout Enumerate
23877 \change_deleted 564990737 1670317155
23878 Information given at the beginning of the article (i.
23879 \begin_inset space \thinspace{}
23883 \begin_inset space \space{}
23886 title, subtitle, author, institution, running title, running author, abstract
23887 and keywords) must be included in an environment called
23888 \begin_inset Quotes eld
23892 \begin_inset Quotes erd
23896 This is not implemented in \SpecialChar LyX
23897 , so you must enter title, subtitle etc.
23898 \begin_inset space ~
23901 between two \SpecialChar TeX
23917 \begin_layout Enumerate
23919 \change_deleted 564990737 1670317155
23920 According to the user manual, the label of each bibliography item must be
23944 \begin_layout Standard
23946 \change_deleted 564990737 1670317155
23951 template takes care of all these
23952 \begin_inset Quotes eld
23956 \begin_inset Quotes erd
23960 If you start a new paper using this template you don't need to do anything
23965 \begin_layout Enumerate
23967 \change_deleted 564990737 1670317155
23968 don't delete the \SpecialChar TeX
23969 code included in the template, and
23972 \begin_layout Enumerate
23974 \change_deleted 564990737 1670317155
23975 copy the example bibliography item included in the template and modify it
23976 as necessary to enter new bibliography items.
23979 \begin_layout Section
23981 \change_deleted 564990737 1671097446
23985 \begin_layout Standard
23987 \change_deleted 564990737 1671097446
23992 provides an alternative to the standard
23997 It provides similar functionality, but you might prefer this layout with
23998 sans serif sections, headings, and more.
24001 \begin_layout Section
24003 \change_deleted 564990737 1671097446
24004 Springer Journals (
24011 \begin_layout Standard
24013 \change_deleted 564990737 1671097446
24019 \begin_layout Subsection
24021 \change_deleted 564990737 1671097446
24025 \begin_layout Standard
24027 \change_deleted 564990737 1671097446
24028 These are the layout files for some of the journal formats used by Springer
24029 Verlag and listed on
24030 \begin_inset Flex URL
24033 \begin_layout Plain Layout
24035 http://www.springer.de/author/tex/help-journals.html
24040 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
24042 It is a modular system: the things common to all journals are implemented
24047 , which journal-specific layout files (such as, e.
24048 \begin_inset space \thinspace{}
24052 \begin_inset space \space{}
24059 for Journal of Geodesy) can include.
24062 \begin_layout Standard
24064 \change_deleted 564990737 1671097446
24065 This means that implementing support for any other Springer journal on this
24066 list is as simple as writing your own
24074 file following the outline given in
24082 \begin_layout Standard
24084 \change_deleted 564990737 1671097446
24085 It is reasonably well tested only for the Journal of Geodesy.
24094 come with the standard \SpecialChar LyX
24096 Install the relevant class file (downloaded from Springer) in a proper
24097 directory, reconfigure \SpecialChar LaTeX
24098 (in the te\SpecialChar TeX
24103 , as root if necessary — doesn't \SpecialChar LyX
24104 take care of this?), reconfigure \SpecialChar LyX
24109 \begin_layout Subsection
24111 \change_deleted 564990737 1671097446
24115 \begin_layout Standard
24117 \change_deleted 564990737 1671097446
24118 A large number of theorem-like styles —
24130 \begin_layout Standard
24132 \change_deleted 564990737 1671097446
24135 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
24136 _Title, Author_Running, Institute,
24137 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
24140 See the Springer class file documentation for details.
24143 \begin_layout Subsection
24145 \change_deleted 564990737 1671097446
24149 \begin_layout Itemize
24151 \change_deleted 564990737 1671097446
24163 \begin_layout Itemize
24165 \change_deleted 564990737 1671097446
24168 Probability Theory and Related Fields
24174 — Jean-Marc Lasgouttes
24177 \begin_layout Standard
24179 \change_deleted 564990737 1671097446
24180 Add your own, it isn't so hard!
24183 \begin_layout Subsection
24185 \change_deleted 564990737 1671097446
24189 \begin_layout Standard
24191 \change_deleted 564990737 1671097446
24192 These files are partly based on the older
24196 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
24198 file from Springer.
24203 layout, are now defunct.
24204 Jean-Marc Lasgouttes helped out big in making me find my way around the
24206 layout file mechanism.
24209 \begin_layout Subsection
24211 \change_deleted 564990737 1671097446
24215 \begin_layout Standard
24217 \change_deleted 564990737 1671097446
24219 But probably less than in the old hacked-\SpecialChar LaTeX
24227 \begin_layout Chapter
24229 Features needing Extra Software
24232 \begin_layout Section
24233 Checking \SpecialChar TeX
24237 \begin_layout Standard
24243 \begin_layout Subsection
24247 \begin_layout Standard
24256 \begin_layout Plain Layout
24261 is not yet available when you are using the \SpecialChar LaTeX
24262 distribution MiK\SpecialChar TeX
24268 , you'll find in the
24275 \begin_inset space ~
24286 \begin_inset Newline newline
24290 \begin_inset CommandInset href
24292 target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
24300 \begin_layout Standard
24303 Chk\SpecialChar TeX
24306 package is a program that was written by
24307 \begin_inset Flex Noun
24310 \begin_layout Plain Layout
24312 \begin_inset space ~
24320 in frustration because some constructs in \SpecialChar LaTeX
24321 are sometimes non-intuitive,
24322 and easy to forget.
24323 The program runs over your \SpecialChar LaTeX
24324 file, checks the integrity of the file, and
24325 flags some common errors.
24326 In other technical words, it is
24330 for \SpecialChar LaTeX
24334 \begin_layout Standard
24335 Well, what is a syntax checker doing in \SpecialChar LyX
24336 which is supposed to produce correct
24338 anyways? The answer is simple: Just as
24342 not only checks the
24346 of C programs, but also does
24350 checks for type-errors,
24352 Chk\SpecialChar TeX
24355 catches some common
24359 errors, in addition to the syntactical ones.
24362 Chk\SpecialChar TeX
24365 is capable of detecting several common errors, such as
24368 \begin_layout Itemize
24369 Ellipsis detection:
24370 \begin_inset Newline newline
24373 Use \SpecialChar ldots
24377 \begin_layout Itemize
24378 No space in front of/after parenthesis:
24379 \begin_inset Newline newline
24385 \begin_layout Itemize
24386 Enforcement of normal space after common abbreviations:
24387 \begin_inset Newline newline
24391 \begin_inset space \thinspace{}
24395 \begin_inset space \space{}
24398 is too wide spacing.
24401 \begin_layout Itemize
24402 Enforcement of end-of-sentence space when the last sentence ends with a
24404 \begin_inset Newline newline
24408 And this is wrong spacing.
24411 \begin_layout Itemize
24412 Space in front of labels and similar commands:
24413 \begin_inset Newline newline
24416 The label should stick right up to the text to avoid falling to a wrong
24419 \begin_inset CommandInset label
24429 \begin_layout Plain Layout
24430 This footnote is in danger of falling off to a wrong page
24435 The label is separated too much.
24438 \begin_layout Itemize
24439 Space in front of references, instead of hard spaces:
24440 \begin_inset Newline newline
24443 If you have bad luck, the text will break right between the referenced text
24444 and reference number, and that's a pity.
24446 \begin_inset CommandInset ref
24448 reference "sec:chktex"
24455 \begin_layout Itemize
24457 \begin_inset Quotes eld
24461 \begin_inset Quotes erd
24465 \begin_inset Formula $\times$
24469 \begin_inset Newline newline
24472 2x2 looks cheap compared to
24473 \begin_inset Formula $2\times2$
24479 \begin_layout Standard
24480 and more \SpecialChar ldots
24481 It is an invaluable tool when you are
24482 \begin_inset Quotes eld
24486 \begin_inset Quotes erd
24489 your document before printing, and you should run it right after the obligatory
24490 spelling check, and before you go fine tuning the typesetting.
24493 \begin_layout Subsection
24497 \begin_layout Standard
24498 If you have the program installed, usage is as simple as choosing
24500 Tools\SpecialChar menuseparator
24502 \begin_inset space ~
24508 This will make \SpecialChar LyX
24509 generate a \SpecialChar LaTeX
24510 file of your document, start
24512 Chk\SpecialChar TeX
24515 to check it, and then make \SpecialChar LyX
24517 \begin_inset Quotes eld
24521 \begin_inset Quotes erd
24524 with the warnings from
24526 Chk\SpecialChar TeX
24529 , if there were any.
24530 The warnings will be placed close to the point of the mistake, and you
24531 can quickly find them by using the
24533 Navigate\SpecialChar menuseparator
24536 menu item, or the shortcut key
24545 Open the error boxes by clicking on them with the mouse, or use the shortcut
24554 bindings, or the corresponding
24563 Read the warning and correct the mistake, if it is a mistake.
24564 If you have trouble understanding what the warning is about, you can safely
24566 Remember that there is a hidden layer between the document on screen and
24567 the technical details in invoking
24569 Chk\SpecialChar TeX
24572 , and this gap can make some warnings seem arcane or just plain silly.
24575 \begin_layout Standard
24576 This document is an excellent testing bed for the feature, and it should
24577 provide quite a few warnings for you to fiddle with.
24578 Since computers are only so smart, expect most of the warnings to be false
24582 \begin_layout Subsection
24583 How to fine tune it
24586 \begin_layout Standard
24587 Sometimes, you'll find that
24589 Chk\SpecialChar TeX
24592 makes more noise than suits your mood.
24593 Then you can choose not to use it, wait until your mood changes, or try
24596 Chk\SpecialChar TeX
24599 to get better along with you.
24602 \begin_layout Standard
24605 Chk\SpecialChar TeX
24612 very configurable and extensible, you should not expect to solve all problems
24615 Chk\SpecialChar TeX
24618 in \SpecialChar LyX
24620 Since \SpecialChar LyX
24621 has to generate a somewhat special \SpecialChar LaTeX
24622 file to be able to match the
24623 line numbers from the
24625 Chk\SpecialChar TeX
24632 \begin_layout Plain Layout
24633 You can inspect the specific output from
24639 Document\SpecialChar menuseparator
24642 \begin_inset space ~
24656 to the internal document structure, some of the warnings will not appear
24658 There are two things you can do about this:
24661 \begin_layout Itemize
24664 Chk\SpecialChar TeX
24667 invocation command line in
24668 \begin_inset Flex Noun
24671 \begin_layout Plain Layout
24672 Tools\SpecialChar menuseparator
24673 Preferences\SpecialChar menuseparator
24674 Output\SpecialChar menuseparator
24675 LaTeX\SpecialChar menuseparator
24683 Chk\SpecialChar TeX
24686 installation configuration file (usually with the file
24691 See below to learn what warnings can be enabled and disabled on the command
24695 \begin_layout Itemize
24696 Export your document as a raw \SpecialChar LaTeX
24699 File\SpecialChar menuseparator
24700 Export\SpecialChar menuseparator
24709 Invoked in this way, it can be a hassle to find the corresponding place
24710 in the document inside \SpecialChar LyX
24711 , but with a little patience, you should be able
24715 \begin_layout Standard
24716 Here follows the warning messages that can be enabled and disabled in
24725 to disable a warning, and
24729 to enable a warning.
24730 The emphasized entries are disabled by default, because the default is
24733 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
24738 \begin_layout Standard
24739 Notice that you should only use the options that enable and disable warnings,
24740 because \SpecialChar LyX
24741 relies on some of the other command line parameters to be set
24742 in a specific way to have a chance to communicate with
24749 \begin_layout Enumerate
24753 Command terminated with space.
24756 \begin_layout Enumerate
24759 Non-breaking space (
24760 \begin_inset Quotes eld
24768 \begin_inset Quotes erd
24771 ) should have been used.
24774 \begin_layout Enumerate
24778 You should enclose the previous parenthesis with
24779 \begin_inset Quotes eld
24787 \begin_inset Quotes erd
24793 \begin_layout Enumerate
24796 Italic correction (
24797 \begin_inset Quotes eld
24807 \begin_inset Quotes erd
24810 ) found in non-italic buffer.
24813 \begin_layout Enumerate
24816 Italic correction (
24817 \begin_inset Quotes eld
24827 \begin_inset Quotes erd
24830 ) found more than once.
24833 \begin_layout Enumerate
24837 No italic correction (
24838 \begin_inset Quotes eld
24848 \begin_inset Quotes erd
24854 \begin_layout Enumerate
24858 \begin_inset Quotes eld
24866 \begin_inset Quotes erd
24870 \begin_inset Quotes eld
24878 \begin_inset Quotes erd
24884 \begin_layout Enumerate
24887 Wrong length of dash may have been used.
24890 \begin_layout Enumerate
24894 \begin_inset Quotes eld
24902 \begin_inset Quotes erd
24906 \begin_inset Quotes eld
24914 \begin_inset Quotes erd
24920 \begin_layout Enumerate
24924 \begin_inset Quotes eld
24932 \begin_inset Quotes erd
24938 \begin_layout Enumerate
24942 \begin_inset Quotes eld
24950 \begin_inset Quotes erd
24953 to achieve an ellipsis.
24956 \begin_layout Enumerate
24959 Inter-word spacing (
24960 \begin_inset Quotes eld
24970 \begin_inset Quotes eld
24973 ) should perhaps be used.
24976 \begin_layout Enumerate
24979 Inter-sentence spacing (
24980 \begin_inset Quotes eld
24990 \begin_inset Quotes erd
24993 ) should perhaps be used.
24996 \begin_layout Enumerate
24999 Could not find argument for command.
25002 \begin_layout Enumerate
25006 \begin_inset Quotes eld
25014 \begin_inset Quotes erd
25020 \begin_layout Enumerate
25023 Math mode still on at end of \SpecialChar LaTeX
25027 \begin_layout Enumerate
25031 \begin_inset Quotes eld
25039 \begin_inset Quotes erd
25042 doesn't match the number of
25043 \begin_inset Quotes eld
25051 \begin_inset Quotes erd
25057 \begin_layout Enumerate
25060 You should use either
25063 \begin_inset Quotes eld
25071 \begin_inset Quotes erd
25076 as an alternative to
25077 \begin_inset Quotes eld
25085 \begin_inset Quotes erd
25091 \begin_layout Enumerate
25098 " (ASCII 39) instead of "
25105 \begin_layout Enumerate
25108 User-specified pattern found.
25111 \begin_layout Enumerate
25114 This command might not be intended.
25117 \begin_layout Enumerate
25124 \begin_layout Enumerate
25142 \begin_layout Enumerate
25145 Delete this space to maintain correct page references.
25148 \begin_layout Enumerate
25152 You might wish to put this between a pair of
25153 \begin_inset Quotes eld
25161 \begin_inset Quotes erd
25167 \begin_layout Enumerate
25170 You ought to remove spaces in front of punctuation.
25173 \begin_layout Enumerate
25176 Could not execute \SpecialChar LaTeX
25180 \begin_layout Enumerate
25189 in front of small punctuation.
25192 \begin_layout Enumerate
25200 may look prettier here.
25203 \begin_layout Enumerate
25207 Multiple spaces detected in output.
25210 \begin_layout Enumerate
25213 This text may be ignored.
25216 \begin_layout Enumerate
25222 \begin_inset Quotes eld
25227 to begin quotation, not
25234 \begin_layout Enumerate
25241 to end quotation, not
25244 \begin_inset Quotes eld
25252 \begin_layout Enumerate
25258 \begin_layout Enumerate
25261 You should perhaps use
25262 \begin_inset Quotes eld
25270 \begin_inset Quotes erd
25276 \begin_layout Enumerate
25279 You should put a space in front of/after parenthesis.
25282 \begin_layout Enumerate
25285 You should avoid spaces in front of/after parenthesis.
25288 \begin_layout Enumerate
25292 You should not use punctuation in front of/after quotes.
25295 \begin_layout Enumerate
25298 Double space found.
25301 \begin_layout Enumerate
25304 You should put punctuation outside inner/inside display math mode.
25307 \begin_layout Enumerate
25310 You ought to not use primitive \SpecialChar TeX
25311 in \SpecialChar LaTeX
25315 \begin_layout Enumerate
25318 You should remove spaces in front of
25319 \begin_inset Quotes eld
25327 \begin_inset Quotes erd
25333 \begin_layout Enumerate
25336 \begin_inset Quotes eld
25344 \begin_inset Quotes erd
25347 is normally not followed by
25348 \begin_inset Quotes eld
25356 \begin_inset Quotes erd
25362 \begin_layout Standard
25363 In later versions of \SpecialChar LyX
25364 , we hope to provide a more complete interface to this
25365 tool (and it's smaller cousin
25369 ) to exploit the full power of it.
25370 But it's not exactly useless as it is now: go try it on one of your existing
25371 documents of a certain length and be surprised.
25374 \begin_layout Section
25375 Version Control in \SpecialChar LyX
25379 \begin_layout Standard
25382 Lars Gullik Bjønnes
25389 \begin_layout Subsection
25393 \begin_layout Standard
25395 supports some of the most basic RCS/CVS/SVN/GIT commands.
25396 If you need something a bit more sophisticated you will have to do that
25397 manually in a terminal.
25400 \begin_layout Standard
25401 Also note that CVS support is not as good as subversion support, so we advise
25403 A good place to start learning Subversion is the SVN Book
25407 \begin_layout Plain Layout
25408 \begin_inset CommandInset href
25410 target "http://svnbook.red-bean.com/"
25421 In the case of RCS you should read
25422 \begin_inset Quotes eld
25426 \begin_inset Quotes erd
25429 (a man file, read it with
25434 This file describes all the basic features of RCS.
25435 You should especially notice the comment about a RCS directory, and the
25436 notion of a master RCS file (the file ending in
25443 \begin_layout Standard
25444 Before you begin to use the version control features in \SpecialChar LyX
25446 familiar with RCS/CVS/SVN/GIT usage.
25447 The implementation in \SpecialChar LyX
25448 assumes a recent version of the GNU RCS or CVS/SVN
25449 package — no guarantees are made for older versions.
25450 Most of the log messages are not currently displayed after operations —
25451 you can check them in the Messages pane if you are unsure.
25452 Regular users of version control will appreciate the VC toolbar, which
25455 View\SpecialChar menuseparator
25456 Toolbars\SpecialChar menuseparator
25458 \begin_inset space ~
25466 \begin_layout Standard
25467 For introducing your own external commands consult
25468 \begin_inset Flex Code
25471 \begin_layout Plain Layout
25485 \begin_layout Standard
25486 It is strongly recommended to store documents in uncompressed format if
25487 using version control (uncheck
25489 Document\SpecialChar menuseparator
25492 if it is checked): Uncompressed LyX documents are text files and therefore
25493 for merging two different versions by version control systems.
25494 Compressed LyX documents are binary files, which cannot be merged by version
25498 \begin_layout Subsection
25499 RCS commands in \SpecialChar LyX
25503 \begin_layout Standard
25504 The following sections describe the RCS commands supported by \SpecialChar LyX
25506 You can find them in the
25508 File\SpecialChar menuseparator
25510 \begin_inset space ~
25517 was tested against RCS 5.7/5.8.
25520 \begin_layout Subsubsection
25526 \begin_layout Standard
25527 If your document is not under revision control, this is the only item shown
25529 And if it is under revision control, the
25533 item is not visible.
25537 \begin_layout Standard
25538 This command registers your document with RCS (unless you are under the
25539 directory managed by CVS)\SpecialChar endofsentence
25540 You are asked interactively to supply an initial
25541 description of the document.
25542 The document is now set in Read-Only mode and you have to
25545 \begin_inset space ~
25549 \begin_inset space ~
25553 \begin_inset space ~
25558 , before making any changes to it.
25559 A document under revision control has a
25560 \begin_inset Quotes eld
25563 [RCS:<version> <locker>]
25564 \begin_inset Quotes erd
25567 item tagged to the filename in the minibuffer.
25570 \begin_layout Standard
25571 RCS command that is run:
25574 \begin_layout LyX-Code
25577 ci -q -u -i -t-"<initial description>" <file-name>
25580 \begin_layout Standard
25585 to understand the switches.
25589 \begin_layout Subsubsection
25595 \begin_layout Standard
25596 When you are finished editing a file, you check in your changes.
25597 When you do this, you are asked for a description of the changes.
25598 This is stored in the history log.
25599 The version number is bumped, your changes are applied to the master RCS
25600 file, the document is unlocked and set to Read-Only mode.
25603 \begin_layout Itemize
25606 ci -q -u -m"<description>" <file-name>
25609 \begin_layout Subsubsection
25615 \begin_layout Standard
25616 By doing this you lock the document so that only you can edit it.
25617 This will also make the document Read-Write only for you.
25618 You will usually continue editing for a while and when you are finished
25619 you check in your changes.
25620 The status line is changed to reflect that you have locked the file.
25623 \begin_layout Itemize
25626 co -q -l <file-name>
25629 \begin_layout Subsubsection
25632 Revert To Repository Version
25635 \begin_layout Standard
25636 This will discard all changes made to the document since the last check
25638 You get a warning before changes are discarded.
25641 \begin_layout Itemize
25644 co -f -u<version> <file-name>
25647 \begin_layout Subsubsection
25653 \begin_layout Standard
25654 This will create a copy of the current document.
25655 Since RCS does not support copy operations natively, the version history
25656 is not preserved, and the copy is added as a new file.
25657 It requires a clean document without any changes since the last checkin.
25658 You are asked for a file name and a description of the copy operation.
25659 After that the copy is created, both locally and in the repository.
25660 If the parent directories of the copied and original document differ, all
25661 relative paths of included files of the copy are adjusted (like in
25663 File\SpecialChar menuseparator
25668 Finally, the copy is loaded instead of the original document.
25671 \begin_layout Labeling
25672 \labelwidthstring 00.00.0000
25674 \begin_inset space ~
25678 \begin_inset space ~
25682 \begin_inset Newline newline
25686 \begin_inset Flex Code
25689 \begin_layout Plain Layout
25692 \begin_inset Quotes qld
25696 \begin_inset Quotes qld
25705 \begin_inset Flex Code
25708 \begin_layout Plain Layout
25711 \begin_inset Quotes qld
25715 \begin_inset Quotes qld
25724 \begin_inset Newline newline
25728 \begin_inset Flex Code
25731 \begin_layout Plain Layout
25735 \begin_inset Quotes qld
25739 \begin_inset Quotes qld
25750 \begin_layout Subsubsection
25756 \begin_layout Standard
25757 This makes as if the last check in never happened.
25758 No changes are made to the document loaded into \SpecialChar LyX
25759 , but the last version
25760 is removed from the master RCS file.
25763 \begin_layout Itemize
25766 rcs -o<version> <file-name>
25769 \begin_layout Subsubsection
25775 \begin_layout Standard
25776 This shows the complete history of the RCS document.
25781 is shown in a browser.
25789 \begin_layout Subsubsection
25793 \begin_layout Standard
25795 supports RCS version number, author name, date and time of last commit.
25796 All those are extracted from
25798 rlog -r <file-name>
25802 \begin_inset CommandInset ref
25804 reference "subsec:VCS-Revision-Information"
25811 \begin_layout Subsection
25812 CVS commands in \SpecialChar LyX
25816 \begin_layout Standard
25817 A subset of CVS operations is supported by \SpecialChar LyX
25819 You can find the commands in the
25821 File\SpecialChar menuseparator
25823 \begin_inset space ~
25829 The version control system SVN is more powerful, so please use it instead
25830 of CVS if possible.
25833 \begin_layout Subsubsection
25839 \begin_layout Standard
25840 If you start from scratch with CVS you have to create your repository and
25841 checkout the working copy with external tools.
25842 If you're using a client-server setup you may need to login before doing
25843 the first repository checkout.
25846 \begin_layout Standard
25847 If your documents are under revision control and others are using the same
25848 repository problems arise when different changes to the same document at
25849 the same location happen.
25850 Standard CVS repositories don't operate with a file locking mechanism.
25851 This may be surprising, but conflicts only occur if people disagree on
25852 the proper content of the same part of a document.
25853 So, if co-workers are used to communicate regularly, these conflicts occur
25855 If they don't communicate they have a fundamental problem anyway.
25856 Nevertheless some people like to work with so called
25857 \begin_inset Quotes eld
25861 \begin_inset Quotes erd
25865 If they do so the working copy of all files is readonly when checked out
25866 first and the user starts editing after using a special command to make
25867 the working copy writable.
25868 When the changes are checked in the working copy returns to readonly state.
25869 With \SpecialChar LyX
25870 one has to edit the
25871 \begin_inset Flex Code
25874 \begin_layout Plain Layout
25880 file and add the line
25881 \begin_inset Flex Code
25884 \begin_layout Plain Layout
25890 to work with reserved checkouts.
25891 The benefit is the possibility to see who is using a writable copy of some
25893 It's not guaranteed only one user makes a copy writable.
25896 \begin_layout Standard
25898 tries to guess if you're using reserved or non-reserved checkouts.
25899 If your working copy is readonly or it is writable and an additional copy
25900 of your document exists in the CVS/Base sub-directory a reserved otherwise
25901 a non-reserved checkout is assumed.
25902 When a reserved checkout is detected you have to use
25903 \begin_inset Flex Noun
25906 \begin_layout Plain Layout
25912 to make your working copy writable if it's readonly.
25914 \begin_inset Flex Noun
25917 \begin_layout Plain Layout
25923 operation is possible and that makes your working copy readonly again after
25924 transferring your changes to the repository.
25927 \begin_layout Standard
25928 More information about CVS can be found here
25929 \begin_inset Flex URL
25932 \begin_layout Plain Layout
25934 http://www.nongnu.org/cvs
25940 \begin_inset Flex URL
25943 \begin_layout Plain Layout
25945 http://ximbiot.com/cvs
25953 \begin_layout Standard
25958 to understand the sub-commands and the switches mentioned below.
25961 \begin_layout Subsubsection
25967 \begin_layout Standard
25968 If your document is not under revision control, this is the only item shown
25970 And if it is under revision control, the
25974 item is not visible.
25978 \begin_layout Standard
25979 This command registers in CVS your document
25980 \begin_inset Flex Strong
25983 \begin_layout Plain Layout
25991 in the case you have already the documents directory under CVS control
25997 This means you have to create or checkout the archive by yourself using
25999 (In case you forget that step \SpecialChar LyX
26000 registers the document with RCS.)
26003 \begin_layout Standard
26004 Then you are asked interactively to supply an initial description of the
26006 Don't forget that registered file is not yet checked in.
26009 \begin_layout Standard
26010 CVS command that is run:
26012 cvs -q add -m"<entered message>" "<file-name>"
26015 \begin_layout Standard
26020 above and for all other CVS commands is an abbreviation for
26021 \begin_inset Quotes eld
26024 change the current working directory to file location and use the file name
26025 without path component as argument
26026 \begin_inset Quotes erd
26032 \begin_layout Subsubsection
26038 \begin_layout Standard
26039 When you are finished editing a file, you commit your changes.
26040 When you do this and you had changed the document, you are asked for a
26041 description of the changes.
26042 After that changes are written to the repository.
26043 In case you didn't change the document and a reserved checkout is detected
26044 the reservation made on
26045 \begin_inset Flex Noun
26048 \begin_layout Plain Layout
26057 \begin_layout Labeling
26058 \labelwidthstring 00.00.0000
26060 \begin_inset space ~
26064 \begin_inset space ~
26068 \begin_inset Newline newline
26072 \begin_inset Flex Code
26075 \begin_layout Plain Layout
26078 -q commit -m"<description>" "<file-name>"
26084 \begin_inset Newline newline
26088 \begin_inset Flex Code
26091 \begin_layout Plain Layout
26102 \begin_layout Subsubsection
26108 \begin_layout Standard
26109 When you are sharing a repository with others, you may have to incorporate
26110 their changes into your working copy.
26113 \begin_layout Standard
26116 cvs -q update "<file-name>"
26119 \begin_layout Standard
26120 If a readonly checkout is detected the working copy is made writable and
26124 \begin_layout Standard
26127 cvs -q edit "<file-name>"
26130 \begin_layout Subsubsection
26133 Revert To Repository Version
26136 \begin_layout Standard
26137 This will discard all changes made to the document since the last check
26139 You get a warning before changes are discarded.
26140 Firstly the file is deleted, secondly CVS update command is run.
26143 \begin_layout Standard
26146 cvs -q update "<file-name>"
26149 \begin_layout Standard
26150 If a reserved checkout is detected and the working copy has no changes only
26151 the reservation is undone.
26154 \begin_layout Standard
26157 cvs -q unedit "<file-name>"
26160 \begin_layout Subsubsection
26166 \begin_layout Standard
26167 This will create a copy of the current document.
26168 Since CVS does not support copy operations natively, the version history
26169 is not preserved, and the copy is added as a new file.
26170 It requires a clean document without any changes since the last checkin.
26171 You are asked for a file name and a description of the copy operation.
26172 After that the copy is created, both locally and in the repository.
26173 If the parent directories of the copied and original document differ, all
26174 relative paths of included files of the copy are adjusted (like in
26176 File\SpecialChar menuseparator
26181 Finally, the copy is loaded instead of the original document.
26184 \begin_layout Labeling
26185 \labelwidthstring 00.00.0000
26187 \begin_inset space ~
26191 \begin_inset space ~
26195 \begin_inset Newline newline
26199 \begin_inset Flex Code
26202 \begin_layout Plain Layout
26209 \begin_inset Flex Code
26212 \begin_layout Plain Layout
26219 \begin_inset Newline newline
26223 \begin_inset Flex Code
26226 \begin_layout Plain Layout
26227 cvs -q add "<new-file-name>"
26235 \begin_layout Subsubsection
26241 \begin_layout Standard
26242 This will rename the current document.
26243 Since CVS does not support rename operations natively, the version history
26244 is not preserved, the renamed document is added as a new file, and the
26245 original document is deleted.
26246 It requires a clean document without any changes since the last checkin.
26247 You are asked for a file name and a description of the rename operation.
26248 After that the document is renamed, both locally and in the repository.
26249 If the parent directories of the new and old file names differ, all relative
26250 paths of included files are adjusted (like in
26252 File\SpecialChar menuseparator
26257 Finally, the document is reloaded using the new name.
26260 \begin_layout Labeling
26261 \labelwidthstring 00.00.0000
26263 \begin_inset space ~
26267 \begin_inset space ~
26271 \begin_inset Newline newline
26275 \begin_inset Flex Code
26278 \begin_layout Plain Layout
26285 \begin_inset Flex Code
26288 \begin_layout Plain Layout
26295 \begin_inset Newline newline
26299 \begin_inset Flex Code
26302 \begin_layout Plain Layout
26303 cvs -q add "<new-file-name>"
26309 \begin_inset Newline newline
26313 \begin_inset Flex Code
26316 \begin_layout Plain Layout
26317 cvs -q remove "<file-name>"
26325 \begin_layout Subsubsection
26326 Update of the local directory checkout from repository
26329 \begin_layout Standard
26330 Once your documents gets more complex, containing sub-documents and pictures,
26332 \begin_inset Flex Code
26335 \begin_layout Plain Layout
26341 files and so on using version control becomes more complicated.
26343 supports updating the whole tree in which resides the document.
26344 This become especially useful once you cooperate with people which neither
26345 have detailed knowledge about CVS usage nor they have ambition to commit
26346 additional material to the repository.
26347 You have to organize the files structure so that all external files are
26348 in the same directory or subdirectories of the document.
26349 It's good practice anyway to store multipart documents in an extra directory.
26352 \begin_layout Standard
26354 \begin_inset Flex Code
26357 \begin_layout Plain Layout
26358 Update local directory from repository
26363 command updates the whole directory.
26364 If local changes are detected user is warned before update starts.
26365 In case of merge conflicts both versions of the conflicting document parts
26366 are placed in the final document.
26367 You have to review and correct the result of the merge.
26368 You'll find the conflicts enclosed in pairs of
26369 \begin_inset Flex Code
26372 \begin_layout Plain Layout
26379 \begin_inset Flex Code
26382 \begin_layout Plain Layout
26389 \begin_inset Flex Code
26392 \begin_layout Plain Layout
26399 The first part is your version as before the update operation with the
26400 document name prepended.
26401 The second one is the repository version with the version number after
26403 \begin_inset Flex Code
26406 \begin_layout Plain Layout
26415 \begin_layout Labeling
26416 \labelwidthstring 00.00.0000
26418 \begin_inset space ~
26422 \begin_inset space ~
26426 \begin_inset Newline newline
26430 \begin_inset Flex Code
26433 \begin_layout Plain Layout
26441 (Ask if changes are detected.)
26442 \begin_inset Newline newline
26446 \begin_inset Flex Code
26449 \begin_layout Plain Layout
26450 cd $path; cvs -q update
26460 \begin_layout Standard
26462 \begin_inset Flex Code
26465 \begin_layout Plain Layout
26471 stands for the path to the document.
26474 \begin_layout Subsubsection
26480 \begin_layout Standard
26481 This shows the complete history of the CVS document.
26484 cvs log "<file-name>"
26486 is shown in a browser.
26489 \begin_layout Subsubsection
26493 \begin_layout Standard
26495 supports CVS version number, author name, date and time of last commit.
26496 All those are extracted from
26498 cvs log -r <file-name>
26502 \begin_inset CommandInset ref
26504 reference "subsec:VCS-Revision-Information"
26511 \begin_layout Subsection
26512 SVN commands in \SpecialChar LyX
26516 \begin_layout Standard
26517 SVN is now partially supported by \SpecialChar LyX
26519 You can find the commands in the
26521 File\SpecialChar menuseparator
26523 \begin_inset space ~
26529 Please note that if you use password protected access to repository via
26530 ssh, you will be asked in terminal window.
26532 was tested against SVN 1.5, 1.6, 1.7 and 1.8
26536 \begin_layout Plain Layout
26537 Most of the commands will work with 1.4 too, see
26538 \begin_inset CommandInset ref
26540 reference "subsec:SVN-Repo-Update"
26545 There seems to be currently unresolved permissions problem under SVN 1.8
26546 with reverting changes when file is locked.
26554 \begin_layout Subsubsection
26560 \begin_layout Standard
26561 If your document is not under revision control, this is the only item shown
26563 And if it is under revision control, the
26567 item is not visible.
26570 \begin_layout Standard
26571 This command registers in SVN your document ONLY in case you have already
26572 the documents directory under SVN control (in particular
26577 This means you have to checkout the archive by yourself.
26580 \begin_layout Standard
26581 Then you are asked interactively to supply an initial description of the
26583 Don't forget that registered file is not yet commited.
26586 \begin_layout Standard
26587 SVN command that is run:
26590 \begin_inset Quotes qld
26594 \begin_inset Quotes qld
26600 \begin_layout Standard
26605 to understand the switches.
26608 \begin_layout Subsubsection
26614 \begin_layout Standard
26615 When you are finished editing a file, you commit your changes.
26616 When you do this, you are asked for a description of the changes.
26617 After that changes are commited.
26620 \begin_layout Standard
26625 \begin_layout Plain Layout
26626 In case locking is not enabled.
26628 \begin_inset CommandInset ref
26630 reference "subsec:SVN-File-Locking"
26641 svn commit -q -m"<description>" <file-name>
26644 \begin_layout Subsubsection
26650 \begin_layout Standard
26651 Updates the changes of this file from the repository.
26652 Be sure you understand SVN merging and conflicts resolving before using
26653 this function, because all conflicts has to be resolved manually by you!
26656 \begin_layout Standard
26661 \begin_layout Plain Layout
26669 svn update --non-interactive
26670 \begin_inset Quotes qld
26674 \begin_inset Quotes qld
26680 \begin_layout Subsubsection
26683 Revert To Repository Version
26686 \begin_layout Standard
26687 This will discard all changes made to the document since the last check
26689 You get a warning before changes are discarded.
26692 \begin_layout Standard
26696 \begin_inset Quotes qld
26700 \begin_inset Quotes qld
26706 \begin_layout Subsubsection
26712 \begin_layout Standard
26713 This will create a copy of the current document including the version history.
26714 It requires a clean document without any changes since the last checkin.
26715 You are asked for a file name and a description of the copy operation.
26716 After that the copy is created, both locally and in the repository.
26717 If the parent directories of the copied and original document differ, all
26718 relative paths of included files of the copy are adjusted (like in
26720 File\SpecialChar menuseparator
26725 Finally, the copy is loaded instead of the original document.
26728 \begin_layout Labeling
26729 \labelwidthstring 00.00.0000
26731 \begin_inset space ~
26735 \begin_inset space ~
26739 \begin_inset Newline newline
26743 \begin_inset Flex Code
26746 \begin_layout Plain Layout
26750 \begin_inset Quotes qld
26754 \begin_inset Quotes qld
26758 \begin_inset Quotes qld
26762 \begin_inset Quotes qld
26771 \begin_inset Newline newline
26775 \begin_inset Flex Code
26778 \begin_layout Plain Layout
26787 \begin_layout Subsubsection
26793 \begin_layout Standard
26794 This will rename the current document including the version history.
26795 It requires a clean document without any changes since the last checkin.
26796 You are asked for a file name and a description of the rename operation.
26797 After that the document is renamed, both locally and in the repository.
26798 If the parent directories of the new and old file names differ, all relative
26799 paths of included files are adjusted (like in
26801 File\SpecialChar menuseparator
26806 Finally, the document is reloaded using the new name.
26809 \begin_layout Labeling
26810 \labelwidthstring 00.00.0000
26812 \begin_inset space ~
26816 \begin_inset space ~
26820 \begin_inset Newline newline
26824 \begin_inset Flex Code
26827 \begin_layout Plain Layout
26831 \begin_inset Quotes qld
26835 \begin_inset Quotes qld
26839 \begin_inset Quotes qld
26843 \begin_inset Quotes qld
26852 \begin_inset Newline newline
26856 \begin_inset Flex Code
26859 \begin_layout Plain Layout
26868 \begin_layout Subsubsection
26869 \begin_inset CommandInset label
26871 name "subsec:SVN-Repo-Update"
26875 Update of the local directory checkout from repository
26879 \begin_layout Plain Layout
26880 Note that this command will work only with subversion
26881 \begin_inset Formula $\geqq1.5$
26892 \begin_layout Standard
26893 All the commands above have one shortcoming – they deal with the current
26895 Once your document contains pictures, includes external
26896 \begin_inset Flex Code
26899 \begin_layout Plain Layout
26905 files and so on administration becomes more complicated.
26907 now supports updating the whole tree in which resides the document
26911 \begin_layout Plain Layout
26912 One need to organize the files structure so that all external files are
26913 in the same directory or subdirectories of the document.
26920 This become especially useful once you cooperate with people which neither
26921 know about subversion management nor they have ambition to commit additional
26922 material to the repository.
26926 \begin_layout Standard
26927 \begin_inset Flex Code
26930 \begin_layout Plain Layout
26931 Update local directory from repository
26936 command updates the whole directory and in case of merge conflicts local
26937 version of the files are left, so no unintended data loss occurs.
26938 If local changes are detected user is warned before update starts.
26941 \begin_layout Labeling
26942 \labelwidthstring 00.00.0000
26944 \begin_inset space ~
26948 \begin_inset space ~
26952 \begin_inset Newline newline
26956 \begin_inset Flex Code
26959 \begin_layout Plain Layout
26965 (Ask if changes are detected.)
26966 \begin_inset Newline newline
26970 \begin_inset Flex Code
26973 \begin_layout Plain Layout
26974 svn update --accept mine-full $path
26982 \begin_layout Standard
26984 \begin_inset Flex Code
26987 \begin_layout Plain Layout
26993 stands for the path to the document.
26996 \begin_layout Subsubsection
27002 \begin_layout Standard
27003 This shows the complete history of the SVN document.
27007 \begin_inset Quotes qld
27011 \begin_inset Quotes qld
27016 is shown in a browser.
27019 \begin_layout Subsubsection
27021 \begin_inset CommandInset label
27023 name "subsec:SVN-File-Locking"
27030 \begin_layout Standard
27031 The file exchange through various revision control systems brings the problem
27032 of merge conflicts in case two different users try to edit the same (parts
27034 When such a conflict happens it needs manual resolving and one reasonable
27035 alternative is to provide some kind of locking mechanism, which guarantees
27036 that only one user is allowed to edit file at the given time.
27039 \begin_layout Standard
27040 SVN has two such mechanisms to provide mutual exclusivity for file access
27041 – locks and automatic setting of write permissions (see sec.
27043 \begin_inset CommandInset ref
27045 reference "subsec:Automatical-Locking-Property"
27050 \begin_inset Flex Code
27053 \begin_layout Plain Layout
27063 \begin_layout Plain Layout
27064 \begin_inset Flex URL
27067 \begin_layout Plain Layout
27069 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
27080 If this property is detected for a given document \SpecialChar LyX
27081 starts to use SVN locks
27082 for document editing automatically and the whole check-in/out mechanism
27083 switches to the same regimen as for RCS.
27084 This in particular means there are two different modes of file use in \SpecialChar LyX
27088 \begin_layout Itemize
27090 The loaded file is in the read-only mode.
27091 For editing on needs to check-out.
27096 consists of updating from the repository and gaining write lock.
27097 If the lock is not possible to obtain, we remain in unlocked state.
27100 \begin_layout Itemize
27102 The loaded file is in the
27103 \begin_inset Quotes els
27107 \begin_inset Quotes ers
27111 No other user is allowed to edit the file.
27116 consists of commiting changes and releasing write-lock.
27117 If no changes have been made to the document, no commit will be produced
27121 \begin_layout Plain Layout
27122 Don't be puzzled by the fact that you will be asked for commit message anyway.
27127 and only the write-lock will be released.
27130 \begin_layout Standard
27134 \begin_layout Labeling
27135 \labelwidthstring 00.00.0000
27138 svn commit -q -m"<description>" "<file-name>"
27139 \begin_inset Newline newline
27142 svn unlock "<file-name>"
27145 \begin_layout Labeling
27146 \labelwidthstring 00.00.0000
27149 svn update "<file-name>"
27150 \begin_inset Newline newline
27153 svn lock "<file-name>"
27156 \begin_layout Subsubsection
27159 \begin_inset CommandInset label
27161 name "subsec:Automatical-Locking-Property"
27167 Automatic Locking Property
27170 \begin_layout Standard
27171 The above mentioned automatic setting of write permissions of the .lyx file
27174 File\SpecialChar menuseparator
27176 \begin_inset space ~
27179 Control\SpecialChar menuseparator
27180 Use Locking Property
27183 This command is active only when the file is not locked on the svn server
27185 you need to check-out before proceeding).
27188 \begin_layout Labeling
27189 \labelwidthstring 00.00.0000
27191 \begin_inset space ~
27197 \begin_layout Labeling
27198 \labelwidthstring 00.00.0000
27201 svn propset svn:needs-lock ON "<file-name>"
27204 \begin_layout Labeling
27205 \labelwidthstring 00.00.0000
27208 svn propdel svn:needs-lock "<file-name>"
27211 \begin_layout Subsubsection
27212 \begin_inset CommandInset label
27214 name "subsec:VCS-Revision-Information"
27218 Revision Information in Documents
27221 \begin_layout Standard
27222 There are more possibilities how to activate revision information in our
27226 \begin_layout Itemize
27232 \begin_layout Itemize
27233 tree revision information (
27234 \begin_inset Flex Code
27237 \begin_layout Plain Layout
27244 The result is the output of the
27245 \begin_inset Flex Code
27248 \begin_layout Plain Layout
27254 command, the following table gives you an idea, how to read the results.
27257 \begin_layout Standard
27259 \begin_inset Tabular
27260 <lyxtabular version="3" rows="6" columns="2">
27261 <features tabularvalignment="middle">
27262 <column alignment="left" valignment="top">
27263 <column alignment="left" valignment="top">
27265 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
27268 \begin_layout Plain Layout
27276 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
27279 \begin_layout Plain Layout
27289 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
27292 \begin_layout Plain Layout
27298 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
27301 \begin_layout Plain Layout
27302 mixed revision working copy
27309 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
27312 \begin_layout Plain Layout
27318 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
27321 \begin_layout Plain Layout
27322 modified working copy
27329 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
27332 \begin_layout Plain Layout
27338 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
27341 \begin_layout Plain Layout
27342 switched working copy
27349 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
27352 \begin_layout Plain Layout
27358 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
27361 \begin_layout Plain Layout
27362 partial working copy, from a sparse checkout
27369 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
27372 \begin_layout Plain Layout
27378 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
27381 \begin_layout Plain Layout
27382 mixed revision, modified, switched working copy
27395 \begin_layout Itemize
27396 file revision information.
27397 The result comes from parsing the output of
27398 \begin_inset Flex Code
27401 \begin_layout Plain Layout
27403 \begin_inset space ~
27407 \begin_inset space ~
27411 \begin_inset space ~
27420 Supported flags are:
27424 \begin_layout Itemize
27425 version number of the last commit (
27426 \begin_inset Flex Code
27429 \begin_layout Plain Layout
27438 \begin_layout Itemize
27439 author of the last commit (
27440 \begin_inset Flex Code
27443 \begin_layout Plain Layout
27452 \begin_layout Itemize
27453 date of the last commit (
27454 \begin_inset Flex Code
27457 \begin_layout Plain Layout
27466 \begin_layout Itemize
27467 time of the last commit (
27468 \begin_inset Flex Code
27471 \begin_layout Plain Layout
27481 \begin_layout Standard
27482 You can obtain this info via InsetInfo (
27483 \change_inserted 5863208 1564400022
27486 Insert\SpecialChar menuseparator
27487 Field\SpecialChar menuseparator
27488 Version Control Revision
27489 \change_deleted 5863208 1564399852
27494 \begin_inset Flex Code
27497 \begin_layout Plain Layout
27498 info-insert buffer vcs-date
27506 The information will be available only when you have the file stored under
27507 svn managment (i.e.
27509 \begin_inset Flex Code
27512 \begin_layout Plain Layout
27518 directory is available with your document).
27522 \begin_layout Itemize
27523 Another—a hacking one—possibility is to use svn keywords
27527 \begin_layout Plain Layout
27528 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
27534 In short – you set file keywords property (e.g.
27537 svn propset svn:keywords 'Rev' file.lyx
27539 ) and then paste keyword \SpecialChar TeX
27544 \begin_layout Plain Layout
27545 This is an easy way how to ensure that \SpecialChar LyX
27546 won't break the line in the middle
27552 tag in your document (e.g.
27554 \begin_inset Flex Code
27557 \begin_layout Plain Layout
27564 This way svn client will automatically substitute revision number (e.g.
27566 \begin_inset Flex Code
27569 \begin_layout Plain Layout
27575 ) after each update and commit.
27576 There are more problems with this approach.
27577 Firstly, the '$' character is used in \SpecialChar TeX
27578 world for math equations, so any
27579 occurence of math formula
27580 \begin_inset Formula $Rev$
27584 \begin_inset Formula $Rev:59$
27587 in your \SpecialChar LyX
27589 Similarly for other keywords like Id, Date, Author, etc.
27590 Secondly svn output is dependent on your locales, so its very easy that
27591 svn would produce some problematic strings once Date is used.
27592 Thirdly you get the whole 'Rev: 59' string in your document instead of
27594 Until subversion implements user's custom keywords it will be hard to use
27595 this approach reliably or let \SpecialChar LyX
27596 to support it directly.
27599 \begin_layout Subsection
27600 SVN and Windows Environment
27603 \begin_layout Quote
27604 My inclination is to say that if the user cannot figure out the command
27605 line operations on their own fairly quickly, they would be well advised
27606 to use TortoiseSVN.
27612 \begin_layout Subsubsection
27616 \begin_layout Standard
27617 In addition to installing \SpecialChar LyX
27618 , and having access to a Subversion repository,
27619 the user will need to install the Subversion client program.
27620 A Windows installer for the client program is available from
27621 \begin_inset CommandInset href
27624 target "http://www.collab.net/nonav/downloads/subversion/"
27630 The user may also want to install
27631 \begin_inset CommandInset href
27634 target "http://tortoisesvn.tigris.org/"
27639 , which integrates Subversion operations into the context (rightclick) menu
27640 of Windows Explorer.
27641 Operations done outside \SpecialChar LyX
27642 will typically be more convenient using the Explorer
27644 Note that TortoiseSVN is not a replacement for the client program, which
27645 is what \SpecialChar LyX
27649 \begin_layout Subsubsection
27650 Bringing a document under Subversion control
27653 \begin_layout Standard
27654 Before a \SpecialChar LyX
27655 document can be brought under version control in Subversion, its
27656 parent directory needs to be under version control.
27657 If the document is being added to a project already in the repository,
27658 this is accomplished by checking the project out to the directory where
27659 the new document will be placed.
27660 If the project itself is not yet under version control (for instance, if
27661 this document starts a new project), the directory must be imported into
27663 This is done outside \SpecialChar LyX
27665 Both import and checkout are easily accomplished from the Explorer context
27666 menu using TortoiseSVN, or alternatively can be done using the command
27667 line client at a DOS prompt.
27668 The procedure for importing the project using TortoiseSVN is described
27669 below, assuming an existing repository and a new project being started
27677 For information on using the Subversion client program, run
27684 \begin_layout Enumerate
27691 in Windows Explorer, right click it, and select
27693 TortoiseSVN\SpecialChar menuseparator
27697 If necessary, adjust the URL for the repository, then click OK.
27700 \begin_layout Enumerate
27701 Right click the level of the repository under which you want to place the
27702 new project folder (typically the top level) and click
27706 Supply a name for the project folder and click OK.
27707 Add a message for the log file if desired, then click OK again.
27708 The new project folder should appear in the repository.
27709 Finally, click OK again to exit the repository browser.
27712 \begin_layout Enumerate
27713 Once again right click
27719 , this time selecting SVN Checkout\SpecialChar ldots
27720 Select the URL of the project folder
27721 you just created in the repository, and set the checkout directory to
27729 You will be warned about a non-empty folder; click OK to proceed.
27730 You should now have a
27741 \begin_layout Enumerate
27742 Create or open your document in \SpecialChar LyX
27745 File\SpecialChar menuseparator
27747 \begin_inset space ~
27750 Control\SpecialChar menuseparator
27754 Add a log message and click OK to commit the document to version control.
27757 \begin_layout Standard
27758 From this point onward, you should have full functionality in the
27760 File\SpecialChar menuseparator
27762 \begin_inset space ~
27768 You also have the option of checking the document in and out, viewing its
27770 using the TortoiseSVN context menu in Windows Explorer or the Subversion
27771 client program from a command prompt.
27774 \begin_layout Subsubsection
27775 SSH tunnel used with SVN under Windows
27778 \begin_layout Standard
27779 Compared with Linux setting up an svn client to communicate over ssh under
27780 Windows is a rather troublesome task.
27781 We will at least offer some hints how to setup the client side but prior
27782 knowledge about ssh and the Windows command line is needed, also be prepared
27783 for a great deal of frustration\SpecialChar ldots
27787 \begin_layout Enumerate
27788 Get an svn client for windows, as described in the previous sections.
27789 When it is a fresh install run some svn command (e.g.
27791 \begin_inset Flex Code
27794 \begin_layout Plain Layout
27800 ) to create config files, which you will need to change later on.
27803 \begin_layout Enumerate
27804 Choose an ssh client for Windows.
27805 There are several possibilities, we will use the one from Putty tools
27809 \begin_layout Plain Layout
27810 \begin_inset Flex URL
27813 \begin_layout Plain Layout
27815 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
27826 You will need to set the connection up so that the client doesn't ask for
27827 any password from you.
27828 To keep things easy we will use only keys without any additional password
27833 \begin_layout Enumerate
27835 \begin_inset Flex Code
27838 \begin_layout Plain Layout
27845 Save your private .ppk key file and put the public one on the server side.
27846 If the SVN server runs on Linux, note that the format of the public key
27847 is not compatible with Linux openssh and you will need to direcly copy-paste
27849 \begin_inset Quotes eld
27854 Public key for pasting into OpenSSH authorized_keys file
27857 \begin_inset Quotes erd
27860 edit field into the server's
27861 \begin_inset Flex Code
27864 \begin_layout Plain Layout
27865 ~/.ssh/authorized_keys
27871 \begin_inset Flex Code
27874 \begin_layout Plain Layout
27883 \begin_layout Enumerate
27885 \begin_inset Flex Code
27888 \begin_layout Plain Layout
27895 In the SVN config file
27899 \begin_layout Plain Layout
27900 Exact path depends on Windows version, usually somewhere around
27901 \begin_inset Flex Code
27904 \begin_layout Plain Layout
27907 Documents and Settings
27921 \begin_inset Flex Code
27924 \begin_layout Plain Layout
27939 , section [tunnels], setup ssh command, e.g.
27941 \begin_inset Flex Code
27944 \begin_layout Plain Layout
27945 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
27954 \begin_layout Plain Layout
27955 It will usually take a lot of time to get exact command right and it depends
27957 For example do not have some remote server saved as a default session in
27959 If things fail, try to connect via plink without SVN first.
27968 \begin_layout Enumerate
27969 Checkout the SVN archive, e.
27970 \begin_inset space \thinspace{}
27974 \begin_inset Newline newline
27978 \begin_inset Flex Code
27981 \begin_layout Plain Layout
27982 svn co svn+ssh://user@server/repository_path
27990 \begin_layout Subsubsection
27991 End-of-Line Conversions
27994 \begin_layout Standard
27995 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
27997 use different line endings inside the .lyx files.
27998 This is not a problem as far as \SpecialChar LyX
27999 functionality is concerned, but the commit
28000 diffs will be huge and merge-conflicts prone.
28001 Fortunately SVN itself knows
28005 \begin_layout Plain Layout
28006 \begin_inset Flex URL
28009 \begin_layout Plain Layout
28011 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
28021 how to deal with CR/LF problems when switching .lyx files to the
28022 \begin_inset Flex Code
28025 \begin_layout Plain Layout
28035 \begin_layout Plain Layout
28037 \begin_inset Flex Code
28040 \begin_layout Plain Layout
28041 svn propset svn:eol-style native FILE_NAME
28054 \begin_layout Subsection
28055 GIT commands in \SpecialChar LyX
28059 \begin_layout Standard
28060 A minimal subset of GIT commands is now supported by \SpecialChar LyX
28062 You can find the commands in the
28064 File\SpecialChar menuseparator
28066 \begin_inset space ~
28072 Please note that if you use password protected access to repository via
28073 ssh, you will be asked in terminal window.
28075 was tested against GIT 1.7.
28079 \begin_layout Plain Layout
28080 Windows users please note that you need to ensure that git is on the path.
28081 This can be set from within \SpecialChar LyX
28084 Tools\SpecialChar menuseparator
28085 Preferences\SpecialChar menuseparator
28086 Paths\SpecialChar menuseparator
28097 \begin_layout Standard
28098 One big difference of GIT and the other supported version control systems
28099 is the distributed nature of GIT: With traditional version control systems
28100 there is one central server which hosts the repository.
28101 Users commit their changes to the server, and get updates made by other
28103 With GIT, users commit to a local repository.
28104 The local repository can be synchronized with one or more remote repositories
28106 \begin_inset Flex Code
28109 \begin_layout Plain Layout
28116 \begin_inset Flex Code
28119 \begin_layout Plain Layout
28127 does not interact in any way with remote GIT repositories.
28128 It works exclusively with the local repository in a very similar way as
28129 with a central CVS or SVN repository.
28130 If you use remote GIT repositories you need to do the
28131 \begin_inset Flex Code
28134 \begin_layout Plain Layout
28141 \begin_inset Flex Code
28144 \begin_layout Plain Layout
28150 operations with your favourite GIT client.
28153 \begin_layout Subsubsection
28159 \begin_layout Standard
28160 If your document is not under revision control, this is the only item shown
28162 And if it is under revision control, the
28166 item is not visible.
28169 \begin_layout Standard
28170 This command registers in GIT your document ONLY in case you have already
28171 the documents directory under GIT control (in particular
28176 This means you have to checkout the archive by yourself.
28179 \begin_layout Standard
28180 Then you are asked interactively to supply an initial description of the
28182 Don't forget that registered file is not yet committed.
28185 \begin_layout Standard
28186 GIT command that is run:
28189 \begin_inset Quotes qld
28193 \begin_inset Quotes qld
28199 \begin_layout Standard
28204 to understand the switches.
28207 \begin_layout Subsubsection
28213 \begin_layout Standard
28214 When you are finished editing a file, you commit your changes.
28215 When you do this, you are asked for a description of the changes.
28216 After that changes are committed.
28219 \begin_layout Standard
28222 git commit -q -m"<description>" <file-name>
28225 \begin_layout Subsubsection
28228 Revert To Repository Version
28231 \begin_layout Standard
28232 This will discard all changes made to the document since the last check
28234 You get a warning before changes are discarded.
28237 \begin_layout Standard
28241 \begin_inset Quotes qld
28245 \begin_inset Quotes qld
28251 \begin_layout Subsubsection
28257 \begin_layout Standard
28258 This will rename the current document including the version history.
28259 It requires a clean document without any changes since the last checkin.
28260 You are asked for a file name and a description of the rename operation.
28261 After that the document is renamed, both locally and in the repository.
28262 If the parent directories of the new and old file names differ, all relative
28263 paths of included files are adjusted (like in
28265 File\SpecialChar menuseparator
28270 Finally, the document is reloaded using the new name.
28273 \begin_layout Labeling
28274 \labelwidthstring 00.00.0000
28276 \begin_inset space ~
28280 \begin_inset space ~
28284 \begin_inset Newline newline
28288 \begin_inset Flex Code
28291 \begin_layout Plain Layout
28295 \begin_inset Quotes qld
28299 \begin_inset Quotes qld
28303 \begin_inset Quotes qld
28307 \begin_inset Quotes qld
28316 \begin_inset Newline newline
28320 \begin_inset Flex Code
28323 \begin_layout Plain Layout
28332 \begin_layout Subsubsection
28338 \begin_layout Standard
28339 This shows the complete history of the GIT document.
28343 \begin_inset Quotes qld
28347 \begin_inset Quotes qld
28352 is shown in a browser.
28355 \begin_layout Subsubsection
28359 \begin_layout Standard
28361 supports GIT hash number of the last commit to the file,
28362 \change_inserted 1119979965 1564297456
28363 its abbreviated form,
28365 author name, date and time of last commit.
28366 All those are extracted from
28368 git log -n 1 --pretty=format:%H%n
28369 \change_inserted 1119979965 1564297427
28375 Tree version information is obtained via
28377 git describe --abbrev --dirty --long
28381 \begin_inset CommandInset ref
28383 reference "subsec:VCS-Revision-Information"
28390 \begin_layout Subsection
28394 \begin_layout Standard
28395 With the recent addition of the
28396 \begin_inset Flex Code
28399 \begin_layout Plain Layout
28405 function \SpecialChar LyX
28406 power users are allowed to create their own commands for revision
28410 \begin_layout Standard
28411 As an example you can see how two TortoiseSVN commands could be integrated
28415 \begin_layout Description
28417 \begin_inset Flex Code
28420 \begin_layout Plain Layout
28421 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
28429 \begin_layout Description
28431 \begin_inset Flex Code
28434 \begin_layout Plain Layout
28435 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
28443 \begin_layout Subsection
28444 Version control and Document comparison
28447 \begin_layout Standard
28448 One of the typical uses of version control is to inspect the changes between
28449 revisions, usually by creating
28450 \begin_inset Flex Code
28453 \begin_layout Plain Layout
28460 While this is useful for plain text files, it is much less useful in the
28461 case of \SpecialChar LyX
28462 files, which have more a complicated structure.
28463 Hence we provide binding to the Document comparison feature.
28464 There are two ways of calling this feature – either by direct call of
28465 \begin_inset Flex Code
28468 \begin_layout Plain Layout
28475 function (for details see \SpecialChar LyX
28476 functions manual) or by the toolbar icon
28489 One can either compare two chosen revisions of the document or he can simply
28490 compare the current version of edited text with older revisions (where
28492 \begin_inset Flex Noun
28495 \begin_layout Plain Layout
28501 ' revisions back means comparison of the edited file with last commited
28506 \begin_layout Standard
28507 This feature is supported for SVN and RCS though due to the more complicated
28508 versioning scheme of RCS there is a constraint – when addressing the revisions
28509 in dialog, numbers always point to the last number in RCS revision number,
28512 We don't currently support GIT addressing of revisions, one can just compare
28513 edited document with its revision X steps backs, where X is addressed as
28515 \begin_inset Flex Code
28518 \begin_layout Plain Layout
28527 \begin_layout Section
28528 Literate Programming
28531 \begin_layout Standard
28536 (kayvan@sylvan.com)
28540 original documentation written by
28542 Edmar Wienskoski Jr.
28545 (edmar-w-jr@technologist.com)
28548 \begin_layout Subsection
28552 \begin_layout Standard
28553 The main purpose of this documentation is to show you how to use \SpecialChar LyX
28555 programming, where it is assumed that you are familiar with this programming
28556 technique, and know what
28557 \begin_inset Quotes eld
28561 \begin_inset Quotes erd
28565 \begin_inset Quotes eld
28569 \begin_inset Quotes erd
28573 If that is not the case, please follow the web links provided in the following
28575 There is a lot of good documentation out there covering old development
28576 history to the latest tools tips.
28579 \begin_layout Standard
28580 It is also assumed that you are familiar with \SpecialChar LyX
28581 itself to a point that you
28582 are comfortable changing your \SpecialChar LyX
28583 preferences, and X resources file.
28584 If that is not the case please refer to other \SpecialChar LyX
28585 documentation to cover your
28589 \begin_layout Subsection
28590 Literate Programming
28593 \begin_layout Standard
28594 From the Literate Programming FAQ:
28597 \begin_layout Quotation
28598 Literate programming is the combination of documentation and source together
28599 in a fashion suited for reading by human beings.
28600 In fact, literate programs should be enjoyable reading, even inviting!
28601 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
28602 and documentation in a single file.
28603 Literate programming tools then parse the file to produce either readable
28604 documentation or compilable source.
28605 The WEB style of literate programming was created by D.
28606 \begin_inset space \thinspace{}
28610 Knuth during the development of his \SpecialChar TeX
28611 typesetting software.
28615 \begin_layout Standard
28616 Another excerpt says:
28619 \begin_layout Quotation
28622 How is literate programming different from verbose commenting?
28625 \begin_layout Quotation
28626 There are three distinguishing characteristics.
28627 In order of importance, they are:
28631 \begin_layout Itemize
28632 flexible order of elaboration
28635 \begin_layout Itemize
28636 automatic support for browsing
28639 \begin_layout Itemize
28640 typeset documentation, especially diagrams and mathematics
28644 \begin_layout Standard
28645 Now that I sparked your curiosity, take a look in the references.
28648 \begin_layout Subsubsection
28652 \begin_layout Standard
28653 The complete Literate Programming FAQ can be found at:
28656 \begin_layout Quote
28657 Literate Programming FAQ
28658 \begin_inset Flex URL
28661 \begin_layout Plain Layout
28663 http://www.literateprogramming.com/lpfaq.pdf
28671 \begin_layout Standard
28672 The FAQ lists 23 (twenty three!) different literate programming tools.
28673 Where some are specialized or
28674 \begin_inset Quotes eld
28678 \begin_inset Quotes erd
28681 for particular programming languages, while other have general scope.
28686 for my own use for several reasons:
28689 \begin_layout Itemize
28690 It can generate the documentation either in \SpecialChar LaTeX
28694 \begin_layout Itemize
28695 It has a open architecture, i.
28696 \begin_inset space \thinspace{}
28700 \begin_inset space \space{}
28703 it is easy to plug in new filters
28707 \begin_layout Plain Layout
28712 are programs that read a given data stream and output a manipulated data
28714 That way, a WEB file (consisting of literate code) can be turned into a
28715 file consisting only of C program code or \SpecialChar LaTeX
28721 and to perform special processing that you may need.
28725 \begin_layout Itemize
28726 There is a good selection of filters available already (the HTML is one
28730 \begin_layout Itemize
28734 \begin_layout Standard
28735 The Noweb web page can be found at:
28738 \begin_layout Quote
28740 \begin_inset Flex URL
28743 \begin_layout Plain Layout
28745 https://www.cs.tufts.edu/~nr/noweb/
28753 \begin_layout Standard
28754 Starting from there you can reach many other interesting links and even
28755 some literate program examples.
28758 \begin_layout Subsection
28760 and Literate Programming with Noweb
28763 \begin_layout Standard
28764 The \SpecialChar LyX
28765 support for Literate Programming is provided by using the generic \SpecialChar LyX
28767 converters mechanism.
28768 This support is provided in a
28769 \begin_inset Quotes eld
28773 \begin_inset Quotes erd
28777 \begin_inset space \thinspace{}
28781 \begin_inset space \space{}
28784 you will be able to use this new \SpecialChar LyX
28785 feature with some other literate programming
28786 tool of your choice by just changing your \SpecialChar LyX
28790 \begin_layout Subsubsection
28791 Generating documents and code (weaving and tangling)
28794 \begin_layout Paragraph
28795 Using the noweb module
28798 \begin_layout Standard
28799 If you have installed Noweb and \SpecialChar LyX
28800 successfully, whenever you open a new document,
28801 after you have chosen its document class, use the
28803 Document\SpecialChar menuseparator
28807 \begin_inset Quotes eld
28811 \begin_inset Quotes erd
28815 If Noweb is correctly installed, when you click on the
28816 \begin_inset Quotes eld
28820 \begin_inset Quotes erd
28823 link, you will see the
28824 \begin_inset Quotes eld
28828 \begin_inset Quotes erd
28831 module in the available list and you can add it to your document.
28834 \begin_layout Paragraph
28838 \begin_layout Standard
28840 enables you to write code with a custom inset named
28841 \begin_inset Flex Noun
28844 \begin_layout Plain Layout
28851 Noweb delimits chunks like this:
28854 \begin_layout LyX-Code
28858 \begin_layout LyX-Code
28862 \begin_layout LyX-Code
28866 \begin_layout LyX-Code
28870 \begin_layout LyX-Code
28874 \begin_layout Standard
28875 The problem is that whatever is written in between the << and the
28879 must be taken literally, i.
28880 \begin_inset space \thinspace{}
28884 \begin_inset space \space{}
28888 should be prevented from making any special interpretation of what has
28890 This is also handled by
28891 \begin_inset Flex Noun
28894 \begin_layout Plain Layout
28900 , that works like a normal text inset but has a free spacing capability.
28903 \begin_layout Standard
28904 As a special note, you can also use the
28905 \begin_inset Quotes eld
28909 \begin_inset Quotes erd
28912 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
28916 \begin_layout LyX-Code
28920 \begin_layout LyX-Code
28921 def some_function(args):
28924 \begin_layout LyX-Code
28925 "This is the doc string for this function."
28928 \begin_layout LyX-Code
28929 print "My args: ", args
28932 \begin_layout LyX-Code
28933 @ %def some_function
28936 \begin_layout Standard
28937 For an example of this usage and the resulting cross-reference output, look
28938 at the Literate python program in
28940 LIBDIR/examples/listerrors.lyx
28942 which should make this all clear.
28945 \begin_layout Paragraph
28946 Generating the documentation
28949 \begin_layout Standard
28950 At this point you already have a new document file with a proper document
28951 class, and with some code and text on it.
28952 How do I print it? The answer is simple, you select
28954 View\SpecialChar menuseparator
28958 Just like you would do for a plain document.
28959 No special procedure is required.
28962 \begin_layout Standard
28963 To help orientate you, I will now explain what happens inside \SpecialChar LyX
28967 \begin_layout Enumerate
28970 Update\SpecialChar menuseparator
28973 menu option is chosen, a \SpecialChar LaTeX
28979 \begin_layout Standard
28980 If the document is of any literate class the generated file will be named
28981 with an extension name defined by the
28982 \begin_inset Quotes eld
28986 \begin_inset Quotes erd
28989 format (defined in the Preferences panel), otherwise the file will have
28998 \begin_layout Enumerate
28999 Note that the only difference so far is in the name of the file, no special
29000 processing is required by \SpecialChar LyX
29002 Given that you formatted the code using the
29003 \begin_inset Flex Noun
29006 \begin_layout Plain Layout
29012 inset that, by itself, takes care of the business.
29015 \begin_layout Enumerate
29016 If the document is of any literate class \SpecialChar LyX
29017 will then use the internal \SpecialChar LyX
29019 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
29024 \begin_layout Plain Layout
29025 The converters are defined in the
29027 Tools\SpecialChar menuseparator
29031 \begin_inset Quotes eld
29035 \begin_inset Quotes erd
29047 manual for general information about converters.
29052 to generate the \SpecialChar LaTeX
29057 \begin_layout Standard
29058 Otherwise it will just skip this step.
29062 \begin_layout Enumerate
29063 Finally, \SpecialChar LaTeX
29064 is invoked and the regular post processing continues as in a plain
29068 \begin_layout Standard
29069 Independence from a particular
29070 \begin_inset Quotes eld
29074 \begin_inset Quotes erd
29077 is easily achieved by changing the commands that are run by the various
29081 \begin_layout Paragraph
29082 Generating the code
29085 \begin_layout Standard
29086 When the build menu option is chosen or the corresponding button in the
29087 toolbar is pressed, a \SpecialChar LaTeX
29088 file is generated just like step 1 above.
29089 Next, \SpecialChar LyX
29095 This converter needs to be defined by the user and is not installed by
29096 default, though the Program format is.
29097 This converter (like any other converter) will have two parts:
29100 \begin_layout Enumerate
29101 The converter program itself.
29102 This program performs the conversion from the one format to the other (in
29103 this case, from the Noweb format to the Program pseudo-format).
29106 \begin_layout Enumerate
29107 The error log parser.
29108 This is a program whose sole purpose is to rewrite error messages in a
29109 format that \SpecialChar LyX
29111 This makes it possible for \SpecialChar LyX
29112 to place error boxes in the right places in
29116 \begin_layout Standard
29117 The first part, the
29118 \begin_inset Quotes eld
29122 \begin_inset Quotes erd
29125 setting, should be set to
29128 \begin_layout LyX-Code
29136 \begin_layout Standard
29137 This basically means that \SpecialChar LyX
29139 \begin_inset Quotes eld
29143 \begin_inset Quotes erd
29146 (a program or script) with the name of the Noweb file (normally a file
29147 in the \SpecialChar LyX
29148 temp directory) and the directory path of the original \SpecialChar LyX
29153 \begin_layout Standard
29154 This is an implementation of
29155 \begin_inset Quotes eld
29159 \begin_inset Quotes erd
29162 that you can place in a directory on your path:
29165 \begin_layout LyX-Code
29171 \begin_layout LyX-Code
29177 \begin_layout LyX-Code
29180 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
29183 \begin_layout Standard
29184 The next part of the converter setting is the
29185 \begin_inset Quotes eld
29189 \begin_inset Quotes erd
29192 which is to be set to
29195 \begin_layout LyX-Code
29198 parselog=$$s/scripts/listerrors
29201 \begin_layout Standard
29202 This will run any errors that are generated by the
29203 \begin_inset Quotes eld
29207 \begin_inset Quotes erd
29210 process through the
29211 \begin_inset Quotes eld
29215 \begin_inset Quotes erd
29221 \begin_layout Standard
29222 The build will normally take place in \SpecialChar LyX
29223 's temporary directory, so the files
29224 produced by the conversion will be in that directory.
29226 will copy out what it regards as the `main' file, but the
29230 conversion may produce several files, and so most of these would then be
29231 deleted when \SpecialChar LyX
29233 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
29234 the build-script chunk can place the generated files in that location.
29237 \begin_layout Paragraph
29238 Build instructions in the document
29241 \begin_layout Standard
29242 The last piece of the integration between \SpecialChar LyX
29244 \begin_inset Quotes eld
29248 \begin_inset Quotes erd
29252 Generally, the instructions for building your program should be embedded
29253 in a chunk of its own.
29255 \begin_inset Quotes eld
29259 \begin_inset Quotes erd
29262 above uses the notangle command to look for this chunk (called
29263 \begin_inset Quotes eld
29267 \begin_inset Quotes erd
29270 ) and runs its contents through
29271 \begin_inset Quotes eld
29275 \begin_inset Quotes erd
29281 \begin_layout Standard
29282 Typically, such a chunk would look something like this:
29285 \begin_layout LyX-Code
29289 \begin_layout LyX-Code
29291 \begin_inset Newline newline
29294 if [ -z "${NOWEB_SOURCE}" ]
29295 \begin_inset Newline newline
29301 \begin_layout LyX-Code
29302 NOWEB_SOURCE=myfile.nw
29303 \begin_inset Newline newline
29307 \begin_inset Newline newline
29311 code to extract files ...
29312 use NOWEB_OUTPUT_DIR here ...]
29313 \begin_inset Newline newline
29317 code to compile files ...]
29318 \begin_inset Newline newline
29324 \begin_layout Standard
29327 LIBDIR/examples/listerrors.lyx
29331 LIBDIR/examples/Literate.lyx
29333 which implement two versions of the
29334 \begin_inset Quotes eld
29338 \begin_inset Quotes erd
29341 program for some illustrations of how all of these pieces go together or
29344 LIBDIR/examples/noweb2lyx.lyx.
29347 Interestingly, these three files show off the language-indepence of the
29349 literate programming support since they are written in Python, C and Perl
29353 \begin_layout Subsubsection
29354 Configuring \SpecialChar LyX
29358 \begin_layout Standard
29359 All the Literate Programming support is configured by the
29361 Tools\SpecialChar menuseparator
29365 \begin_inset Quotes eld
29369 \begin_inset Quotes erd
29373 The important parts are:
29376 \begin_layout Description
29378 \begin_inset space ~
29382 \begin_inset Quotes eld
29386 \begin_inset Quotes erd
29390 \begin_inset space ~
29393 format Set up via the File Formats tab, this is where the Noweb-specific
29403 , the file extension is set to
29408 This tells \SpecialChar LyX
29409 to create a file with a
29413 extension in the first step of the conversion process.
29416 \begin_layout Description
29418 \begin_inset space ~
29426 \begin_inset space ~
29429 format This is an empty format whose sole purpose is to be the endpoint
29430 of a conversion (which then allows us to set up a converter for it).
29433 \begin_layout Description
29443 This converter performs the
29444 \begin_inset Quotes eld
29448 \begin_inset Quotes erd
29451 of the literate document.
29452 For Noweb, it is set to
29453 \begin_inset Quotes eld
29458 noweave -delay -index $$i > $$o
29461 \begin_inset Quotes erd
29467 \begin_layout Description
29477 \begin_inset Quotes eld
29481 \begin_inset Quotes erd
29485 As stated above, the Converter is set to
29486 \begin_inset Quotes eld
29494 \begin_inset Quotes erd
29497 , with Flags set to
29498 \begin_inset Newline newline
29502 \begin_inset Quotes eld
29507 parselog=$$s/scripts/listerrors
29510 \begin_inset Quotes erd
29516 \begin_layout Subsubsection
29520 \begin_layout Standard
29521 There is also a new function implemented in the \SpecialChar LyX
29523 \begin_inset Quotes eld
29526 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
29530 \begin_layout Standard
29531 When debugging code with ddd/gdb, it is possible to invoke a text editor
29532 at the current execution position with a single key stroke.
29533 The default ddd configuration for that is shift-ctrl-V.
29534 It happens that you can define the editor command line invocation in ddd
29537 Edit\SpecialChar menuseparator
29538 Preferences\SpecialChar menuseparator
29541 dialog and changing the "Edit Sources" entry.
29544 \begin_layout Standard
29545 I take advantage of the newly created \SpecialChar LyX
29546 server function and this ddd feature,
29548 \begin_inset Quotes eld
29552 \begin_inset Quotes erd
29558 \begin_layout LyX-Code
29559 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
29562 \begin_layout Standard
29563 With this, whenever you are using ddd and find a point in the program that
29564 you want to edit, you just press shift-ctrl-V (in the ddd window), and
29565 ddd will forward this information to \SpecialChar LyX
29566 through the \SpecialChar LyX
29567 server and then the
29569 window will show the same file with the cursor at the same position ddd
29571 No more guessing or long scrolling to locate a point in the program back
29575 \begin_layout Standard
29576 Note however that you must enable the \SpecialChar LyX
29577 server to get this feature working
29578 (it is disabled by default).
29580 \begin_inset space ~
29584 \begin_inset CommandInset ref
29586 reference "sec:Starting-the-Server"
29590 explains how to do that.
29593 \begin_layout Subsubsection
29597 \begin_layout Standard
29598 There are six new buttons that can be added to your \SpecialChar LyX
29600 Four of these buttons are short cuts to layout styles:
29618 , one for the custom inset
29623 The last one is a short cut to the
29624 \begin_inset Quotes eld
29628 \begin_inset Quotes erd
29635 \begin_layout Standard
29637 has a range of buttons that are available for tool bar customization.
29638 In my toolbar I like to combine the six short cuts above with two more:
29643 \SpecialChar menuseparator
29648 \SpecialChar menuseparator
29655 Document\SpecialChar menuseparator
29656 View\SpecialChar menuseparator
29660 Here is how it looks like:
29663 \begin_layout LyX-Code
29667 \begin_layout LyX-Code
29671 \begin_layout LyX-Code
29672 Icon "layout Standard"
29675 \begin_layout LyX-Code
29676 Icon "layout Section"
29679 \begin_layout LyX-Code
29680 Icon "layout \SpecialChar LaTeX
29684 \begin_layout LyX-Code
29685 Icon "layout \SpecialChar LyX
29689 \begin_layout LyX-Code
29690 Icon "flex.insert Chunk"
29693 \begin_layout LyX-Code
29697 \begin_layout LyX-Code
29701 \begin_layout LyX-Code
29702 Icon "buffer-typeset"
29705 \begin_layout LyX-Code
29706 Icon "build-program"
29709 \begin_layout LyX-Code
29713 \begin_layout LyX-Code
29717 \begin_layout LyX-Code
29721 \begin_layout LyX-Code
29725 \begin_layout LyX-Code
29729 \begin_layout Subsubsection
29730 Colors customization
29733 \begin_layout Standard
29734 There are a number of colors in \SpecialChar LyX
29735 that can be customized in
29740 One of the things that bothers people is the \SpecialChar LaTeX
29742 The default color is red, since the chunks uses \SpecialChar LaTeX
29743 font, and there is a lot
29744 of chunks in literate documents, you may get tired of seeing everything
29746 You can change it by going to the tabs
29755 \begin_layout Standard
29756 The next thing is the visible presence of the newline character in the screen.
29757 You can choose the color of this particular character and make it blend
29759 I recommend you choosing a color that is close to the background but not
29760 equal, that way you still can see it is there, but it is not bothering
29764 \begin_layout Subsection
29769 \begin_layout Standard
29779 \change_deleted 564990737 1671643409
29785 \change_inserted 564990737 1671643443
29789 File\SpecialChar menuseparator
29790 Open Example\SpecialChar menuseparator
29791 Modules\SpecialChar menuseparator
29798 \change_deleted 564990737 1671643461
29799 the Sweave manual (menu
29801 Help\SpecialChar menuseparator
29805 \change_inserted 564990737 1671643461
29809 Help\SpecialChar menuseparator
29810 Specific Manuals\SpecialChar menuseparator
29819 \begin_layout Chapter
29821 \change_deleted 564990737 1671355343
29825 \begin_layout Standard
29827 \change_deleted 564990737 1671355343
29828 You can do everything with \SpecialChar LyX
29829 that you can do with \SpecialChar LaTeX
29831 However, \SpecialChar LyX
29832 cannot support every \SpecialChar LaTeX
29834 But you can always use \SpecialChar TeX
29836 This chapter shows you some more special things you might want to use.
29837 For other special things you can do with figures, tables, floats, boxes
29838 and notes, have a look at the
29841 \begin_inset space ~