1 #LyX 2.4 created this file. For more info see https://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 % DO NOT ALTER THIS PREAMBLE!!!
11 % This preamble is designed to ensure that the manual prints
12 % out as advertised. If you mess with this preamble,
13 % parts of the manual may not print out as expected. If you
14 % have problems LaTeXing this file, please contact
15 % the documentation team
16 % email: lyx-docs@lists.lyx.org
18 % the pages of the TOC are numbered roman
19 % and a PDF-bookmark for the TOC is added
21 \let\myTOC\tableofcontents
22 \renewcommand{\tableofcontents}{%
23 \pdfbookmark[1]{\contentsname}{}
26 \pagenumbering{arabic}}
28 % extra space for tables
29 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
31 \options bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
32 \use_default_options false
40 \maintain_unincluded_children no
42 \language_package default
45 \font_roman "lmodern" "default"
46 \font_sans "lmss" "default"
47 \font_typewriter "lmtt" "default"
48 \font_math "auto" "auto"
49 \font_default_family default
50 \use_non_tex_fonts false
54 \font_typewriter_osf false
55 \font_sf_scale 100 100
56 \font_tt_scale 100 100
58 \use_dash_ligatures true
60 \default_output_format pdf2
62 \bibtex_command default
63 \index_command default
67 \pdf_title "LyX's Additional Features manual"
68 \pdf_author "LyX Team"
69 \pdf_subject "LyX's additional features documentation"
70 \pdf_keywords "LyX, Documentation, Additional"
72 \pdf_bookmarksnumbered true
73 \pdf_bookmarksopen false
74 \pdf_bookmarksopenlevel 1
79 \pdf_pdfusetitle false
80 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
83 \use_package amsmath 1
84 \use_package amssymb 1
87 \use_package mathdots 1
88 \use_package mathtools 1
90 \use_package stackrel 1
91 \use_package stmaryrd 1
92 \use_package undertilde 1
94 \cite_engine_type default
98 \paperorientation portrait
104 \notefontcolor #0000ff
111 \paragraph_separation indent
112 \paragraph_indentation default
114 \math_indentation default
115 \math_numbering_side default
116 \quotes_style english
120 \paperpagestyle headings
122 \tracking_changes true
123 \output_changes false
125 \postpone_fragile_content false
129 \docbook_table_output 0
130 \docbook_mathml_prefix 1
131 \author -712698321 "Jürgen Spitzmüller"
134 \author 244031559 "Yuriy"
135 \author 564990737 "John Lyx"
136 \author 630872221 "Jean-Pierre Chrétien" jeanpierre.chretien@free.fr
137 \author 1075283030 "Thibaut"
138 \author 1119979965 "Joel A. Kulesza"
144 Additional \SpecialChar LyX
148 \begin_layout Subtitle
150 \change_deleted 630872221 1622909155
152 \change_inserted 630872221 1622909155
159 by the \SpecialChar LyX
164 \begin_layout Plain Layout
166 Principal maintainer of this file is
168 Richard Kimberly Heck
171 If you have comments or error corrections, please send them to the \SpecialChar LyX
174 \begin_inset Flex Code
177 \begin_layout Plain Layout
178 <lyx-docs@lists.lyx.org>
191 \begin_layout Standard
192 \begin_inset CommandInset toc
193 LatexCommand tableofcontents
200 \begin_layout Chapter
204 \begin_layout Standard
205 This manual is essentially Part II of the
207 User's Guide\SpecialChar endofsentence
210 The reason for separating the two documents is simple: the
214 is already quite lengthy, and it contains information on all of the basic
215 features one needs to know in order to prepare most documents.
216 However, the \SpecialChar LyX
217 Team has worked to make \SpecialChar LyX
218 extensible through various configuration
219 files and external packages.
220 That means that if you want to support the Fizzwizzle \SpecialChar LaTeX
222 create a layout file (or module) for it without having to alter \SpecialChar LyX
224 We've already had contributions of several new features this way, and some
225 of them are documented here.
226 There are also some more `advanced' features, such as how to control the
227 presentation of bibliographies and how to work with multi-part documents,
228 that are not covered in the
232 and are discussed here.
235 \begin_layout Standard
236 This manual also documents some special features, like fax support
237 \change_deleted 244031559 1603802929
239 \change_inserted 244031559 1603802931
243 \change_deleted 244031559 1603802954
246 , which require additional software to work properly.
247 There is also a chapter on \SpecialChar LyX
249 And lastly, there's a chapter of \SpecialChar LaTeX
250 tools and tips, things you can use to
251 spruce up your documents by directly using the powerful features of \SpecialChar LaTeX
253 After all, \SpecialChar LyX
258 only WYSIWYM and will only ever interface to some, not all, \SpecialChar LaTeX
262 \begin_layout Standard
263 If you haven't read the
267 yet, you are definitely in the wrong manual.
272 is the first place to go, since it describes the notation and format of
274 You should also be thoroughly familiar with the
278 and all of the basic features of \SpecialChar LyX
279 before attempting to read this one.
282 \begin_layout Standard
283 Since many of the topics in this manual depend heavily on \SpecialChar LyX
285 with \SpecialChar LaTeX
286 , this first chapter covers the inner workings of \SpecialChar LyX
289 to generate exactly the \SpecialChar LaTeX
291 It is obviously for more seasoned \SpecialChar LyX
295 \begin_layout Chapter
297 and \SpecialChar LaTeX
301 \begin_layout Section
303 Uses \SpecialChar LaTeX
307 \begin_layout Standard
308 This chapter is for both \SpecialChar TeX
309 -nicians and the \SpecialChar LaTeX
311 In it, we'll explain how \SpecialChar LyX
312 and \SpecialChar LaTeX
313 work together to produce printable output.
314 This is the only place in any of the manuals where we assume you know something
315 about \SpecialChar LaTeX
319 \begin_layout Standard
320 At one time, \SpecialChar LyX
322 \begin_inset Quotes eld
325 WYSIWYM frontend to \SpecialChar LaTeX
327 \begin_inset Quotes erd
330 but that's no longer true.
331 There are frontends to \SpecialChar LaTeX
336 \begin_layout Plain Layout
337 Some familar ones are \SpecialChar TeX
338 maker and kile, on Linux, and \SpecialChar TeX
340 There are also the \SpecialChar LaTeX
341 modes for vi and emacs, of course.
346 These are basically text editors with the ability to run \SpecialChar LaTeX
348 errors in the file you're editing.
349 Although \SpecialChar LyX
358 run \SpecialChar LaTeX
359 , and it also indicates errors in the file, it also does much, much
361 For one thing, you don't need to know \SpecialChar LaTeX
362 to use \SpecialChar LyX
365 has added its own extensions to \SpecialChar LaTeX
367 Try the following sometime: select
368 \begin_inset Flex Noun
371 \begin_layout Plain Layout
372 Export\SpecialChar menuseparator
379 \begin_inset Flex Noun
382 \begin_layout Plain Layout
389 \begin_inset Flex Noun
392 \begin_layout Plain Layout
393 View\SpecialChar menuseparator
403 ), then look at the preamble of the resulting
404 \begin_inset Flex Code
407 \begin_layout Plain Layout
414 You'll notice a variety of new macros defined specifically by \SpecialChar LyX
416 These macros are defined automatically, according to the features you use
420 \begin_layout Standard
421 There are several commands that automatically invoke \SpecialChar LaTeX
426 \begin_layout Itemize
427 \begin_inset Flex Noun
430 \begin_layout Plain Layout
431 Document\SpecialChar menuseparator
440 \begin_layout Itemize
441 \begin_inset Flex Noun
444 \begin_layout Plain Layout
445 Document\SpecialChar menuseparator
454 \begin_layout Standard
455 They will only invoke \SpecialChar LaTeX
456 if the file has changed since the last time \SpecialChar LaTeX
462 \begin_layout Standard
463 When \SpecialChar LyX
464 runs \SpecialChar LaTeX
465 on the file you're editing, it performs these steps:
468 \begin_layout Enumerate
469 Convert the document to \SpecialChar LaTeX
470 and save to a file with the extension
471 \begin_inset Flex Code
474 \begin_layout Plain Layout
481 \begin_inset Flex Code
484 \begin_layout Plain Layout
493 \begin_layout Enumerate
494 Run \SpecialChar LaTeX
496 \begin_inset Flex Code
499 \begin_layout Plain Layout
505 file (maybe several times), and run any other commands (such as
506 \begin_inset Flex Code
509 \begin_layout Plain Layout
516 \begin_inset Flex Code
519 \begin_layout Plain Layout
525 ) needed to compile the \SpecialChar LaTeX
529 \begin_layout Enumerate
530 If there are any errors, show the error log.
533 \begin_layout Standard
534 If you have run \SpecialChar LaTeX
536 \begin_inset Flex Noun
539 \begin_layout Plain Layout
540 View\SpecialChar menuseparator
547 then runs a DVI viewer to display the DVI-file.
549 \begin_inset Flex Noun
552 \begin_layout Plain Layout
553 View\SpecialChar menuseparator
560 performs further steps:
563 \begin_layout Enumerate
565 \begin_inset Flex Code
568 \begin_layout Plain Layout
574 to convert the DVI file to PostScript.
577 \begin_layout Enumerate
578 Run a PostScript viewer, such as
579 \begin_inset Flex Code
582 \begin_layout Plain Layout
588 , to display the PostScript file.
591 \begin_layout Standard
593 does similar things when viewing, or exporting, other formats.
596 \begin_layout Section
597 Translating \SpecialChar LaTeX
598 files into \SpecialChar LyX
602 \begin_layout Standard
603 You can import a \SpecialChar LaTeX
604 file into \SpecialChar LyX
606 \begin_inset Flex Noun
609 \begin_layout Plain Layout
610 File\SpecialChar menuseparator
611 Import\SpecialChar menuseparator
617 command in \SpecialChar LyX
619 This will call a program named
620 \begin_inset Flex Code
623 \begin_layout Plain Layout
629 which will create a file
630 \begin_inset Flex Code
633 \begin_layout Plain Layout
640 \begin_inset Flex Code
643 \begin_layout Plain Layout
651 will then open that file.
655 \begin_layout Plain Layout
656 \begin_inset Flex Code
659 \begin_layout Plain Layout
665 can also be run from the command line, of course.
673 \begin_layout Standard
674 \begin_inset Flex Code
677 \begin_layout Plain Layout
683 will translate most legal \SpecialChar LaTeX
684 , but not everything.
685 It will put things it doesn't understand into \SpecialChar TeX
686 code, so after translating
688 \begin_inset Flex Code
691 \begin_layout Plain Layout
697 , you can look for \SpecialChar TeX
698 code and hand-edit it until it looks right.
701 \begin_layout Standard
702 If you don't know what \SpecialChar TeX
703 code is, read the next section.
706 \begin_layout Section
707 \begin_inset CommandInset label
709 name "sec:Inserting-TeX-Code"
713 Inserting \SpecialChar TeX
714 Code into \SpecialChar LyX
718 \begin_layout Standard
719 Anything you can do in \SpecialChar LaTeX
720 you can do in \SpecialChar LyX
721 , for a very simple reason: You can
722 always insert \SpecialChar TeX
723 code into any \SpecialChar LyX
726 cannot, and will never be able to, display every possible \SpecialChar LaTeX
728 If ever you need to insert \SpecialChar LaTeX
729 commands into your \SpecialChar LyX
730 document, you can use the
732 \begin_inset Flex Code
735 \begin_layout Plain Layout
742 box, which you can insert into your document with
743 \begin_inset Flex Noun
746 \begin_layout Plain Layout
747 Insert\SpecialChar menuseparator
757 or the keyboard shortcut
766 \begin_layout Standard
767 Here's an example of inserting \SpecialChar LaTeX
768 commands in a \SpecialChar LyX
770 The code looks like this:
773 \begin_layout LyX-Code
777 \begin_inset Newline newline
783 \begin_inset Newline newline
786 This is an example of a minipage environment.
788 \begin_inset Newline newline
791 can put nearly everything in it, even (non-floating)
792 \begin_inset Newline newline
797 \begin_inset Newline newline
803 \begin_inset Newline newline
807 \begin_inset Newline newline
813 \begin_inset Newline newline
819 \begin_inset Newline newline
825 \begin_inset Newline newline
830 \begin_inset Newline newline
836 \begin_inset Newline newline
842 \begin_inset Newline newline
848 \begin_inset Newline newline
856 \begin_layout LyX-Code
860 \begin_layout Standard
862 \begin_inset Flex Code
865 \begin_layout Plain Layout
872 box containing this text is directly after this paragraph.
873 Those of you reading the manual in \SpecialChar LyX
874 will only see the \SpecialChar TeX
876 Those reading a printed version of the manuals will see the actual results:
877 \begin_inset VSpace bigskip
883 \begin_layout Standard
887 \begin_layout Plain Layout
894 \begin_layout Plain Layout
901 \begin_layout Plain Layout
903 This is an example of a minipage environment.
904 You can put nearly everything in it, even (non-floating) figures and tables.
908 \begin_layout Plain Layout
915 \begin_layout Plain Layout
920 \begin_layout Plain Layout
927 \begin_layout Plain Layout
934 \begin_layout Plain Layout
941 \begin_layout Plain Layout
947 \begin_layout Plain Layout
954 \begin_layout Plain Layout
961 \begin_layout Plain Layout
968 \begin_layout Plain Layout
978 \begin_inset VSpace bigskip
984 \begin_layout Standard
985 In addition to using \SpecialChar TeX
986 code, you can also create a separate file containing
987 some complex \SpecialChar LaTeX
988 structure and then use
989 \begin_inset Flex Noun
992 \begin_layout Plain Layout
993 Insert\SpecialChar menuseparator
1003 to include your file (you should select the type
1004 \begin_inset Flex Code
1007 \begin_layout Plain Layout
1014 We recommend that you only do this if you have a
1015 \begin_inset Flex Code
1018 \begin_layout Plain Layout
1029 Otherwise, you'll have a big job tracking down \SpecialChar LaTeX
1033 \begin_layout Standard
1034 There are a few last points to emphasize:
1037 \begin_layout Itemize
1043 check if your \SpecialChar LaTeX
1047 \begin_layout Itemize
1048 Beware of reinventing the wheel.
1051 \begin_layout Standard
1052 On that last point, \SpecialChar LyX
1053 does have quite a few features tucked into it, and
1055 Be sure to check the manuals to make sure that \SpecialChar LyX
1056 doesn't have such-and-such
1057 feature before you decide you have to do it by hand.
1058 Moreover, there are numerous \SpecialChar LaTeX
1059 packages out there to do all sorts of things,
1060 from labels to envelopes to fancy multipage tables.
1062 \change_inserted 244031559 1603815732
1064 \begin_inset CommandInset href
1067 target "https://www.ctan.org/"
1073 \change_deleted 244031559 1603815732
1075 \begin_inset CommandInset href
1078 target "http://www.ctan.org/"
1088 \begin_layout Standard
1089 If you do need to do some wild and fancy things within your document, be
1090 sure to check out a good \SpecialChar LaTeX
1091 book for assistance.
1092 There are a number of them listed in the bibliography of the
1099 \begin_layout Section
1101 and the \SpecialChar LaTeX
1105 \begin_layout Subsection
1106 About the \SpecialChar LaTeX
1110 \begin_layout Standard
1111 If you already know \SpecialChar LaTeX
1112 , there is no need to explain here what the preamble
1114 If you don't, the following will give you some ideas—we recommend again
1115 that you consult a \SpecialChar LaTeX
1116 book for further information.
1117 In any case, you should read the points below, because they explain what
1118 you can do and what you don't need to do in the \SpecialChar LaTeX
1119 preamble of a \SpecialChar LyX
1123 \begin_layout Standard
1124 The \SpecialChar LaTeX
1125 preamble comes at the very beginning of a document,
1133 \begin_layout Itemize
1134 Declare the document class.
1136 \begin_inset Newline newline
1140 already does this for you.
1141 If you're a seasoned \SpecialChar LaTeX
1142 -nician, and you have a custom document class you
1143 want to use, check out the
1145 Customization Manual
1147 for information on how to make \SpecialChar LyX
1151 \begin_layout Itemize
1152 Declare the usage of packages.
1154 \begin_inset Newline newline
1158 packages provide special commands, which are only available within a document
1159 when the package has been declared in the preamble.
1160 In addition to providing special commands, the inclusion of a package can
1161 change the document.
1162 For example, the package
1163 \begin_inset Flex Code
1166 \begin_layout Plain Layout
1172 forces all paragraphs to be indented.
1173 There are other packages for labels, envelopes, margins, etc.
1177 \begin_layout Itemize
1178 Set counters, variables, lengths and widths.
1180 \begin_inset Newline newline
1183 There are several \SpecialChar LaTeX
1184 counters and variables that
1188 be set globally from within the preamble in order to have the desired effect.
1189 (There are variables that you can set and reset inside the document, too.)
1190 Margins are a good example of something that must be set in the preamble.
1191 Another example is the label format for lists.
1192 You can actually set these just about anywhere, but it's best to do it
1193 just once, inside the preamble.
1196 \begin_layout Itemize
1197 Declare user defined commands (with
1198 \begin_inset Flex Code
1201 \begin_layout Plain Layout
1210 \begin_inset Flex Code
1213 \begin_layout Plain Layout
1222 \begin_inset Newline newline
1225 These are abbreviations for \SpecialChar LaTeX
1226 commands which appear very often inside a document.
1227 Although the preamble is a good place to declare such commands, they
1231 be declared anywhere (before they are used for the first time, of course).
1232 This can be useful if there is a lot of raw \SpecialChar LaTeX
1233 code in your document, which
1234 normally should not be the case.
1237 \begin_layout Standard
1239 adds its own set of definitions to the preamble of the
1240 \begin_inset Flex Code
1243 \begin_layout Plain Layout
1250 This makes \SpecialChar LaTeX
1251 files generated by \SpecialChar LyX
1255 \begin_layout Subsection
1256 Changing the Preamble
1259 \begin_layout Standard
1260 The commands which \SpecialChar LyX
1261 adds to the preamble of a \SpecialChar LaTeX
1262 file are fixed; you can't
1263 change them without patching \SpecialChar LyX
1265 You can, however, add your own stuff to the preamble by selecting
1266 \begin_inset Flex Noun
1269 \begin_layout Plain Layout
1272 \begin_inset space ~
1281 \begin_inset Flex Noun
1284 \begin_layout Plain Layout
1285 Document\SpecialChar menuseparator
1293 adds anything in the
1294 \begin_inset Flex Noun
1297 \begin_layout Plain Layout
1303 dialog to its own built-in preamble.
1304 Before adding your own declarations in the preamble, you should make sure
1305 that \SpecialChar LyX
1306 doesn't already support what you want to do.
1307 (Remember what we said about reinventing the wheel?) Also,
1309 make sure your preamble code is correct
1313 doesn't check it for you.
1314 If there is an error, you're likely to get an error like
1315 \begin_inset Quotes eld
1319 \begin_inset Flex Code
1322 \begin_layout Plain Layout
1331 \begin_inset Quotes erd
1335 If you see this error, check your preamble.
1338 \begin_layout Subsection
1342 \begin_layout Standard
1343 Here are some examples of what you can add to a preamble, and what they
1347 \begin_layout Subsubsection
1351 \begin_layout Standard
1352 There are two variables under \SpecialChar LaTeX
1353 that control page position:
1354 \begin_inset Flex Code
1357 \begin_layout Plain Layout
1366 \begin_inset Flex Code
1369 \begin_layout Plain Layout
1378 Their names should be self-explanatory.
1379 These variables are useful if you think for a moment about computer labels.
1380 Sometimes, the size of a print medium and the area of the medium that you
1381 can actually print on aren't the same.
1383 \begin_inset Flex Code
1386 \begin_layout Plain Layout
1395 \begin_inset Flex Code
1398 \begin_layout Plain Layout
1409 \begin_layout Standard
1410 The default values for
1411 \begin_inset Flex Code
1414 \begin_layout Plain Layout
1423 \begin_inset Flex Code
1426 \begin_layout Plain Layout
1435 \begin_inset space \thinspace{}
1439 \begin_inset space \thinspace{}
1443 \begin_inset space \space{}
1446 the page isn't shifted.
1447 Unfortunately, some DVI drivers always seem to shift the page.
1448 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1449 If you're using \SpecialChar LyX
1450 on a system that you don't personally maintain, and your
1451 sysadmin is a doofus,
1452 \begin_inset Flex Code
1455 \begin_layout Plain Layout
1464 \begin_inset Flex Code
1467 \begin_layout Plain Layout
1476 Suppose your left and top margins are always 0.5
1477 \begin_inset space \thinspace{}
1481 You can add this to the preamble:
1484 \begin_layout LyX-Code
1492 \begin_layout LyX-Code
1500 \begin_layout Standard
1501 and your margins should now be correct.
1504 \begin_layout Subsubsection
1508 \begin_layout Standard
1509 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1510 There's a rather nice package, available at your nearest CTAN archive,
1511 for printing sheets of labels:
1512 \begin_inset Flex Code
1515 \begin_layout Plain Layout
1522 Now, your system may not have this package installed by default.
1523 We leave that up to you to check.
1524 You'll also want to read the documentation for it; we're not going to do
1526 Since this is an example, however, we'll give you an example of how you
1530 \begin_layout Standard
1531 First, make sure you're using the
1532 \begin_inset Flex Code
1535 \begin_layout Plain Layout
1542 Next, you need to put the following in your preamble:
1545 \begin_layout LyX-Code
1551 \begin_layout LyX-Code
1557 \begin_layout LyX-Code
1563 \begin_layout LyX-Code
1569 \begin_layout LyX-Code
1575 \begin_layout LyX-Code
1581 \begin_layout LyX-Code
1587 \begin_layout Standard
1588 This sets things up for Avery label sheets, stock #5360.
1589 You're now ready to print labels, but you'll need to insert \SpecialChar LaTeX
1592 \begin_inset Flex Code
1595 \begin_layout Plain Layout
1604 \begin_inset Flex Code
1607 \begin_layout Plain Layout
1615 around each label text.
1616 This and other special features of
1617 \begin_inset Flex Code
1620 \begin_layout Plain Layout
1626 are explained in its documentation.
1629 \begin_layout Standard
1630 Someday, someone may write a \SpecialChar LyX
1631 layout file to support this package directly.
1632 Maybe that someone is you.
1635 \begin_layout Subsubsection
1636 Example #3: Paragraph Indentation
1639 \begin_layout Standard
1640 Americans are trained to indent the first line of
1645 As with all of their other weird quirks, most Americans will whine and
1646 moan until they can have their way and indent the first line of all paragraphs.
1655 \begin_layout Standard
1656 Of course, this behavior isn't standard typography.
1657 In books, you typically only indent the first line of a paragraph
1661 it follows another one.
1662 The idea behind indenting the first line of a paragraph is to distinguish
1663 neighboring paragraphs from one another.
1664 If there is no previous paragraph—for example, if it follows a figure or
1665 is the first paragraph in a section—then there is no need for indentation.
1669 \begin_layout Standard
1670 If you're a typical American (we're still joking!), though, you don't care
1671 about such esoteric things; you want your indentation! Add this to the
1675 \begin_layout LyX-Code
1678 usepackage{indentfirst}
1681 \begin_layout Standard
1682 If your \SpecialChar TeX
1683 distribution isn't braindead, you'll have this package, and all
1684 of your paragraphs will get the indentation the Founding Fathers intended
1688 \begin_layout Subsubsection
1689 Example #4: This Document
1692 \begin_layout Standard
1693 You can also check out the preamble of this document to get an idea of some
1694 of the advanced things you can do.
1697 \begin_layout Section
1699 and \SpecialChar LaTeX
1703 \begin_layout Standard
1704 When \SpecialChar LyX
1705 calls \SpecialChar LaTeX
1706 , it tells \SpecialChar LaTeX
1707 to blithely ignore any errors and keep going.
1708 It then uses the logfile from the \SpecialChar LaTeX
1709 run to do a post-mortem.
1710 After analyzing the logfile, \SpecialChar LyX
1711 displays a dialog listing the errors.
1712 Clicking on any one of them will take you to the position in your \SpecialChar LyX
1714 where the error occurred.
1718 \begin_layout Plain Layout
1720 Analyzing the logfile is a tough job, and \SpecialChar LyX
1721 doesn't always go to the right
1723 There are also cases where \SpecialChar LaTeX
1724 reports the error on one line, but the actual
1726 This is not unlike forgetting a closing brace in a program: You'll get
1727 an error, but only later.
1735 \begin_layout Standard
1736 Some folks also like to look at the log file directly: It is available from
1738 \begin_inset Flex Noun
1741 \begin_layout Plain Layout
1742 Document\SpecialChar menuseparator
1744 \begin_inset space ~
1753 There are some fairly common error messages and warnings.
1754 We'll cover those here.
1755 You should look at a good \SpecialChar LaTeX
1756 book for a complete listing.
1759 \begin_layout Itemize
1760 \begin_inset Flex Code
1763 \begin_layout Plain Layout
1770 \begin_inset Newline newline
1773 Anything beginning with these words is a warning message for the purpose
1775 \begin_inset Quotes eld
1779 \begin_inset Quotes erd
1782 the \SpecialChar LaTeX
1784 You'll get messages like this if you added or changed cross-references
1785 or bibliography entries, in which case, \SpecialChar LaTeX
1786 is trying to tell you that you
1787 need to make another run.
1788 You can by-and-large ignore these.
1791 \begin_layout Itemize
1792 \begin_inset Flex Code
1795 \begin_layout Plain Layout
1802 \begin_inset Newline newline
1805 Another warning message, this time about fonts which \SpecialChar LaTeX
1807 The rest of the message will often say something about a replacement font
1808 that \SpecialChar LaTeX
1810 You can safely ignore these, too.
1813 \begin_layout Itemize
1814 \begin_inset Flex Code
1817 \begin_layout Plain Layout
1826 \begin_inset Newline newline
1835 It seems to generate at least one of these messages for just about any
1837 They are warnings about lines that were too long and run past the right
1839 This happens if \SpecialChar LaTeX
1840 does not find a reasonable way to break the lines (notoriously
1841 often with typewriter font, since this does not allow for automatic break
1843 In many cases, this is unnoticeable in the final output.
1844 (It can be just a point or two.) Sometimes, however, the lines run rather
1845 visibly into the margin; something you will not want to have in your final
1848 \begin_inset Newline newline
1851 There are several global ways to try to minimize the overfull lines.
1854 Enable micro-typographic extensions
1858 Document\SpecialChar menuseparator
1859 Settings\SpecialChar menuseparator
1862 might already improve things a lot.
1863 Furthermore, \SpecialChar LaTeX
1864 code such as the following in
1866 Document\SpecialChar menuseparator
1867 Settings\SpecialChar menuseparator
1870 usually reduces the overfull lines drastically (we use this in the preamble
1875 \begin_layout LyX-Code
1879 \begin_inset Newline newline
1885 \begin_inset Newline newline
1890 emergencystretch 1.5em
1891 \begin_inset Newline newline
1899 \begin_layout Standard
1900 In some cases, however, you eventually have to rewrite the text to get the
1901 line breaking right.
1905 \begin_layout Plain Layout
1906 For more information, see
1907 \begin_inset Flex URL
1910 \begin_layout Plain Layout
1912 http://www.tex.ac.uk/FAQ-overfull.html
1925 \begin_layout Standard
1926 In any case, you should check the respective lines, at least for the final
1927 version of your document.
1928 Your eyes will tell you if there's a problem with something that's too
1933 \begin_layout Plain Layout
1934 You can also enable the `draft' option in
1935 \begin_inset Flex Noun
1938 \begin_layout Plain Layout
1939 Document\SpecialChar menuseparator
1945 , and then \SpecialChar LaTeX
1946 will draw a black box in the margin of lines that are overfull.
1955 \begin_layout Itemize
1956 \begin_inset Flex Code
1959 \begin_layout Plain Layout
1968 \begin_inset Newline newline
1971 Not quite as common as its cousin.
1972 This happens again if \SpecialChar LaTeX
1973 does not find a reasonable break point and consequently
1974 generates too loose lines.
1975 As with the overfull lines, you should check if this is a visible problem.
1978 \begin_layout Itemize
1979 \begin_inset Flex Code
1982 \begin_layout Plain Layout
1991 \begin_inset Flex Code
1994 \begin_layout Plain Layout
2003 \begin_inset Newline newline
2006 Warnings about troubles breaking the page.
2007 Once again, just look at the output.
2008 Your eyes will tell you where something has gone wrong.
2011 \begin_layout Itemize
2012 \begin_inset Flex Code
2015 \begin_layout Plain Layout
2017 \begin_inset Quotes els
2021 \begin_inset Quotes ers
2030 \begin_inset Newline newline
2034 \begin_inset Quotes eld
2038 \begin_inset Quotes erd
2041 isn't installed on this system.
2042 This usually appears because some package your document needs isn't installed.
2043 If you didn't touch the preamble or didn't use the
2044 \begin_inset Flex Code
2047 \begin_layout Plain Layout
2055 command, then one of the packages \SpecialChar LyX
2056 tried to load is missing.
2058 \begin_inset Flex Noun
2061 \begin_layout Plain Layout
2062 Help\SpecialChar menuseparator
2069 to get a list of packages that \SpecialChar LyX
2071 This file is updated whenever you reconfigure \SpecialChar LyX
2073 \begin_inset Flex Noun
2076 \begin_layout Plain Layout
2077 Tools\SpecialChar menuseparator
2083 ) and tells you which packages have been detected and what they do.
2084 \begin_inset Newline newline
2088 \begin_inset Flex Code
2091 \begin_layout Plain Layout
2099 command and the package in question isn't installed, then you'll need to
2100 install it yourself.
2103 \begin_layout Itemize
2104 \begin_inset Flex Code
2107 \begin_layout Plain Layout
2108 LaTeX Error: Unknown option
2114 \begin_inset Newline newline
2117 Error messages beginning with this are trying to tell you that you specified
2118 a bad or undefined option to a package.
2119 Check the package's documentation.
2122 \begin_layout Itemize
2123 \begin_inset Flex Code
2126 \begin_layout Plain Layout
2127 Undefined control sequence
2133 \begin_inset Newline newline
2136 If you've inserted \SpecialChar LaTeX
2137 code into your document, but made a typo, you'll get
2139 You may have forgotten to load a package.
2140 In any case, this error message usually means that you used an undefined
2145 \begin_layout Standard
2146 There are other error and warning messages.
2147 Some are self-explanatory.
2148 These are usually \SpecialChar LaTeX
2150 Others are downright cryptic.
2151 These are usually \SpecialChar TeX
2152 error messages, and we really have
2156 what they mean or how to decipher them.
2160 \begin_layout Standard
2161 There's a general sequence you should follow if you get error messages:
2164 \begin_layout Enumerate
2165 Look at the \SpecialChar LaTeX
2166 code you inserted for typos.
2169 \begin_layout Enumerate
2170 If there are no typos, check that you used the command(s) correctly.
2173 \begin_layout Enumerate
2174 If you get a bunch of error boxes piled up at the very top of the document—and
2175 especially if you see a
2176 \begin_inset Quotes eld
2180 \begin_inset Flex Code
2183 \begin_layout Plain Layout
2192 \begin_inset Quotes erd
2195 error—it means that there are errors in the preamble.
2196 Start debugging your preamble.
2199 \begin_layout Enumerate
2200 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2202 document, the first suspect is your \SpecialChar LaTeX
2203 distribution itself.
2204 Check for missing packages and install them.
2207 \begin_layout Enumerate
2208 Okay, so there are no missing packages.
2209 Did you use any of the fine-tuning options in \SpecialChar LyX
2210 ? Specifically, did you
2214 any of them, like trying to manually insert lots of
2215 \begin_inset Flex Code
2218 \begin_layout Plain Layout
2220 \change_deleted 177693 1654669036
2222 \change_inserted 177693 1654669038
2226 \begin_inset space ~
2230 \change_deleted 177693 1654669040
2232 \change_inserted 177693 1654669041
2241 \begin_inset Flex Code
2244 \begin_layout Plain Layout
2251 \begin_inset Flex Code
2254 \begin_layout Plain Layout
2260 ? Did you try to kludge something together with these instead of using the
2261 appropriate paragraph environment?
2264 \begin_layout Enumerate
2265 All right, you didn't use any of the fine-tuning options, you played by
2267 Did you try to pull a fancy maneuver? Did you do something funky inside
2268 a table or an equation, like inserting a graphic into a table cell?
2271 \begin_layout Enumerate
2272 Do you have long sections of text where \SpecialChar LaTeX
2273 cannot find a place to break a
2274 line? By default, \SpecialChar LaTeX
2275 is rather strict about how much extra inter-word spacing
2276 it will add in order to break a line.
2277 Preferably, you should rework the paragraph to avoid the problem.
2280 \begin_layout Enumerate
2281 Did you go overboard with the nesting? \SpecialChar LyX
2282 (currently) doesn't check to make
2283 sure you're in the limits for nesting environments.
2284 If you nested a bunch of environments to the
2285 \begin_inset Formula $17^{\mathrm{th}}$
2288 level, that's the problem.
2289 (The limit in \SpecialChar LaTeX
2293 \begin_layout Enumerate
2294 Okay, you didn't get any error messages, but your output looks awful.
2295 If you have a table or figure that's too wide or long for the page, you
2300 \begin_layout Enumerate
2301 rescale the figure so it fits.
2304 \begin_layout Enumerate
2305 trim down the table so it fits.
2309 \begin_layout Enumerate
2310 If something else is wrong with the output, and you didn't try to pull anything
2311 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2314 \begin_layout Standard
2315 If all this doesn't help—well, then
2319 you might have found a bug in \SpecialChar LyX
2324 \begin_layout Chapter
2326 \change_inserted 564990737 1670439508
2330 \begin_layout Section
2332 \change_inserted 564990737 1670439533
2333 \begin_inset CommandInset label
2335 name "sec:Collections"
2342 \begin_layout Subsection
2343 AMS \SpecialChar LaTeX
2347 \begin_layout Standard
2354 Richard Kimberly Heck
2357 \begin_layout Standard
2358 \begin_inset VSpace bigskip
2364 \begin_layout Standard
2366 The AMS \SpecialChar LaTeX
2367 layouts are set up to conform to suggested styles for mathematical
2368 papers to be submitted to American Mathematical Society publications.
2369 The layouts are not tailored to a specific journal, but easily can be.
2370 You should refer to the AMS documentation for specific instructions for
2371 each journal (usually it will entail only changing a single line in the
2374 That documentation is available on the Web at
2375 \begin_inset Flex URL
2378 \begin_layout Plain Layout
2386 \begin_inset Flex URL
2389 \begin_layout Plain Layout
2391 ftp://ftp.ams.org/pub/tex/amslatex/
2397 These layouts are appropriate, and useful, for any mathematical writing.
2401 \begin_layout Standard
2402 There are two basic AMS \SpecialChar LaTeX
2406 \begin_layout Itemize
2407 amsart: The standard AMS article format.
2410 \begin_layout Itemize
2411 amsbook: the standard AMS book (really, monograph) format.
2415 \begin_layout Standard
2416 The layouts themselves contain only the minimum necessary to use the AMS
2418 They do not, in particular, contain any of the `theorem' environments used
2419 for setting theorems, lemmas, and the like.
2420 These are contained, instead, in the
2421 \begin_inset Flex Code
2424 \begin_layout Plain Layout
2430 module, which is loaded by default when you select one of the AMS classes.
2431 (It can also be used with other classes and can be removed, if you would
2432 rather use something else.) Less commonly used environments are in the
2433 \begin_inset Flex Code
2436 \begin_layout Plain Layout
2437 Theorems (AMS-Extended)
2442 module, which must be loaded manually.
2445 \begin_layout Standard
2446 By default, theorems and the like are numbered consecutively throughout
2447 the document, but this may be modified by loading the module
2448 \begin_inset Flex Code
2451 \begin_layout Plain Layout
2452 Theorems (Order by Section)
2457 or, if you are using
2458 \begin_inset Flex Code
2461 \begin_layout Plain Layout
2468 \begin_inset Flex Code
2471 \begin_layout Plain Layout
2472 Theorems (Order by Chapter)
2478 These will number the results as
2479 \begin_inset Formula $n.m$
2482 , where the first number refers to the section (or chapter) and the second
2483 refers to the total number of results so far in that section (or chapter).
2484 Many environments are also available unnumbered.
2485 These are indicated by an asterisk at the end.
2486 If you happen to want
2490 unnumbered results, the module
2491 \begin_inset Flex Code
2494 \begin_layout Plain Layout
2500 provides that option.
2503 \begin_layout Standard
2504 Note that these modules do not
2508 to be used with the AMS classes.
2509 It is perfectly possible to use the
2510 \begin_inset Flex Code
2513 \begin_layout Plain Layout
2519 module, and the others mentioned, with other classes, such as
2520 \begin_inset Flex Code
2523 \begin_layout Plain Layout
2530 \begin_inset Flex Code
2533 \begin_layout Plain Layout
2540 \begin_inset Flex Code
2543 \begin_layout Plain Layout
2552 \begin_layout Subsubsection
2553 What these layouts provide
2556 \begin_layout Standard
2557 There is a long list of included environments provided by these layouts.
2558 In AMS-\SpecialChar LaTeX
2559 , there is, in fact, an opportunity to define an unlimited variety
2560 of `theorem' environments.
2561 However, the AMS recommends the environments that are available in \SpecialChar LyX
2566 \begin_layout Standard
2567 The following environments—as well as the standard environments, such as
2569 \begin_inset Flex Noun
2572 \begin_layout Plain Layout
2579 \begin_inset Flex Noun
2582 \begin_layout Plain Layout
2589 \begin_inset Flex Noun
2592 \begin_layout Plain Layout
2599 \begin_inset Flex Noun
2602 \begin_layout Plain Layout
2609 \begin_inset Flex Noun
2612 \begin_layout Plain Layout
2619 \begin_inset Flex Code
2622 \begin_layout Plain Layout
2629 \begin_inset Flex Code
2632 \begin_layout Plain Layout
2641 \begin_layout Description
2642 Address This should be the author's permanent address.
2645 \begin_layout Description
2647 \begin_inset space ~
2650 Address This should be the author's temporary address at the time of submission,
2651 if different from the Address.
2654 \begin_layout Description
2655 Email Author's e-mail address
2658 \begin_layout Description
2659 URL Author's Web address, if desired.
2662 \begin_layout Description
2663 Keywords Key words or phrases used to identify specific topics discussed
2667 \begin_layout Description
2668 Subjectclass These refer to the AMS Subject Classifications, published and
2671 Mathematical Reviews
2674 These are also available online at the AMS cites listed above.
2677 \begin_layout Description
2681 \begin_layout Description
2685 \begin_layout Description
2689 \begin_layout Standard
2690 The following environments are provided by both the
2691 \begin_inset Flex Code
2694 \begin_layout Plain Layout
2701 \begin_inset Flex Code
2704 \begin_layout Plain Layout
2710 modules, in the latter case in both starred (unnumbered) and unstarred
2711 (numbered) versions.
2712 These same environments are provided only in the starred versions by the
2714 \begin_inset Flex Code
2717 \begin_layout Plain Layout
2726 \begin_layout Theorem
2727 This is typically used for the statements of major results.
2731 \begin_layout Corollary*
2732 This is used for statements which follow fairly directly from previous statement
2734 Again, these can be major results.
2739 These are smaller results needed to prove other statements.
2742 \begin_layout Proposition
2743 These are less major results which (hopefully) add to the general theory
2747 \begin_layout Conjecture
2748 These are statements provided without justification, which the author does
2749 not know how to prove, but which seem to be true (to the author, at least).
2752 \begin_layout Definition*
2753 Guess what this is for.
2754 The font is different for this environment than for the previous ones.
2758 \begin_layout Example*
2759 Used for examples illustrating proven results.
2762 \begin_layout Problem
2763 It's not really known what this is for.
2764 You should figure it out.
2767 \begin_layout Exercise*
2768 Write a description for this one.
2771 \begin_layout Remark
2772 This environment is also a type of theorem, usually a lesser sort of observation.
2775 \begin_layout Claim*
2776 Often used in the course of giving a proof of a larger result.
2780 Generally, these are used to break up long arguments, using specific instances
2786 The numbering scheme for cases is on its own, not together with other numbered
2792 At the end of this environment, a QED symbol (usually a square, but it can
2793 vary with different styles) is placed.
2794 If you want to have other environments within this one—for example, Case
2795 environments—and have the QED symbol appear only after them, then the other
2796 environments need to be nested within the proof environment.
2799 Nesting Environments
2805 for information on nesting.
2808 \begin_layout Standard
2809 And these environments are provided by
2810 \begin_inset Flex Code
2813 \begin_layout Plain Layout
2814 Theorems (AMS-Extended)
2822 \begin_layout Criterion*
2823 A required condition.
2826 \begin_layout Algorithm*
2827 A general procedure to be used.
2830 \begin_layout Axiom*
2831 This is a property or statement taken as true within the system being discussed.
2834 \begin_layout Condition*
2835 Sometimes used to state a condition assumed within the present context of
2840 Similar to a Remark.
2843 \begin_layout Notation*
2844 Used for the explanation of, yes, notation.
2847 \begin_layout Summary
2848 Do we really need to tell you?
2851 \begin_layout Acknowledgement*
2855 \begin_layout Conclusion*
2856 Sometimes used at the end of a long train of argument.
2860 Used in a way similar to Proposition, though perhaps lower on the scale.
2863 \begin_layout Standard
2864 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
2867 They need to be available on your system in order to use these environments.
2870 \begin_layout Subsection
2874 \begin_layout Standard
2880 \begin_layout Subsubsection
2884 \begin_layout Standard
2885 The \SpecialChar LyX
2888 article (koma-script)
2892 report (koma-script)
2910 correspond to the \SpecialChar LaTeX
2928 \begin_inset space ~
2931 of the Koma-Script family.
2932 They are replacements for the standard document classes
2948 , resp., and fit better to European typography conventions in a number of
2952 \begin_layout Itemize
2953 Standard character size is 11pt in
2955 article (koma-script)
2959 report (koma-script)
2967 letter (koma-script)
2972 \begin_layout Itemize
2973 Headings, labels of the description environment, and a number of elements
2976 letter (koma-script)
2978 document class are set in a bold sans serif font.
2982 \begin_layout Plain Layout
2983 There is a big difference between the bold sans serif old cm fonts and new
2984 ec fonts, especially in the appearance of headings.
2985 In comparison, the ec bold sans serif fonts look a bit thin.
2986 Here the \SpecialChar LaTeX
2995 helps to produce the
2996 \begin_inset Quotes eld
3000 \begin_inset Quotes erd
3003 appearance when using the ec fonts.
3008 The numbering of chapter headings is made in the same way as the numbering
3009 of section headings, that is without the extra line
3010 \begin_inset Quotes eld
3013 Chapter\SpecialChar ldots
3015 \begin_inset Quotes erd
3019 In addition, the appearance of the headings can be modified by using a
3020 number of options (in \SpecialChar LyX
3021 to be entered in the field
3024 \begin_inset space ~
3031 Layout\SpecialChar menuseparator
3038 \begin_layout Itemize
3039 The main means in the Koma-Script document classes to design the type area
3048 (in \SpecialChar LyX
3049 to be entered in the extra class options field in the dialog
3051 Document\SpecialChar menuseparator
3055 They make a clearer modification of page margins possible as do the options
3058 Document\SpecialChar menuseparator
3065 \begin_layout Itemize
3066 The \SpecialChar LaTeX
3067 document classes of the Koma-Script family define a number of additional
3069 Those part of it which makes sense in \SpecialChar LyX
3070 is implemented in corresponding
3074 \begin_layout Standard
3075 Detailed descriptions of the \SpecialChar LaTeX
3076 document classes of the Koma-Script family
3077 can be found in the Koma-Script documentation
3088 \begin_layout Subsubsection
3089 article (koma-script), report (koma-script), and book (koma-script)
3092 \begin_layout Standard
3093 The document classes
3095 article (koma-script)
3099 report (koma-script)
3109 are implemented in the layout files
3122 They contain all the paragraph types of the corresponding standard document
3135 , resp., partly modified, with the exception of the \SpecialChar LyX
3140 -type, which is replaced by the new
3144 -type having the same functionality.
3149 -Type there is a number of new paragraph types added.
3156 letter (koma-script)
3161 \begin_layout Itemize
3170 : are equivalents to
3178 , resp., additionally inserting an entry in the table of contents.
3187 are not contained in
3189 article (koma-script)
3194 \begin_layout Itemize
3211 , resp., additionally clearing running heads.
3218 article (koma-script)
3224 \begin_layout Plain Layout
3237 report (koma-script)
3239 , but since this is identical to
3243 , is has not been implemented in \SpecialChar LyX
3252 \begin_layout Itemize
3257 : generates a heading directly above the following paragraph in the standard
3258 character size without affecting the structure of the document.
3261 \begin_layout Itemize
3270 are special captions which respect the different space settings needed
3271 for captions placed above or below an element (if you follow strict typographic
3272 rules, you might want to place table captions always above the table).
3273 You can also use the class option
3290 You need at least Koma-Script version 2.8q to use this.
3293 \begin_layout Itemize
3298 : can be used to set a bonmot, e.
3299 \begin_inset space \thinspace{}
3303 \begin_inset space \space{}
3306 at the beginning of a chapter.
3307 If you use the optional argument (
3309 Insert\SpecialChar menuseparator
3311 \begin_inset space ~
3316 ), you can insert the dictum's author there.
3317 Dictum and author are separated by a line.
3318 You need at least Koma-Script version 2.8q to use this.
3325 article (koma-script)
3330 \begin_layout Standard
3331 The following types, together with the standard types
3343 , form the title area of the document.
3344 They must be entered ahead of the first
3345 \begin_inset Quotes eld
3349 \begin_inset Quotes erd
3356 \begin_layout Plain Layout
3357 The corresponding \SpecialChar LaTeX
3358 commands must appear before the
3369 When such a type is used more than once, the latter usage overwrites the
3370 former one, that means, for every type only the latest usage is valid.
3371 The order of the different types however has, like
3383 , no effect on the appearance of the produced document.
3386 \begin_layout Itemize
3391 : produces a centered paragraph above the ordinary title (
3403 ) for the subject of the document.
3406 \begin_layout Itemize
3411 : produces a centered paragraph below the ordinary title (
3423 ) for the publishers' name.
3426 \begin_layout Itemize
3433 report (koma-script)
3439 produces a centered paragraph on its own page behind the title page, or
3442 article (koma-script)
3444 produces a centered paragraph below the ordinary title (
3463 \begin_layout Itemize
3468 : produces a left aligned paragraph above the ordinary title (
3484 ) for a document`s head.
3487 \begin_layout Itemize
3492 : produces in a double-sided print in
3494 report (koma-script)
3500 a left-aligned paragraph at the top of the title page`s back or has no
3501 effect in a single-sided print or in
3503 article (koma-script)
3508 \begin_layout Itemize
3513 : produces in a double-sided print in
3515 report (koma-script)
3521 a left-aligned paragraph at the bottom of the title page`s back or has
3522 no effect in a single-sided print or in
3524 article (koma-script)
3529 \begin_layout Itemize
3534 : produces a special
3535 \begin_inset Quotes eld
3539 \begin_inset Quotes erd
3542 page ahead of the actual document containing a paragraph without special
3546 \begin_layout Standard
3547 The layout files for the document classes
3549 article (koma-script)
3553 report (koma-script)
3564 This is thought of as a place to define your own types.
3569 in your personal layout directory and edit the file!
3572 \begin_layout Subsubsection
3573 letter (koma-script)
3576 \begin_layout Description
3577 Note: This section discusses the obsolete
3579 KOMA-Script-Letter (v.
3580 \begin_inset space ~
3585 , which is not even included anymore in recent KOMA releases.
3586 Please refer to the next section for the current KOMA-Script-Letter class
3588 \begin_inset space ~
3594 \begin_layout Standard
3598 letter (koma-script)
3600 is implemented in the layout file
3605 It contains all the paragraph types of the corresponding standard document
3610 , partly modified, with the exception of the \SpecialChar LyX
3624 type, which is replaced by the new
3629 In addition, it contains, in contrast to the standard document class, the
3648 Furthermore, there are a number of new letter specific types.
3651 \begin_layout Standard
3652 The appearance of the letter produced by this document class can be controlled
3653 by a number of \SpecialChar LaTeX
3654 commands, which you can put in the \SpecialChar LaTeX
3659 \begin_layout Plain Layout
3660 For example, the standard appearance of the letter`s heading, consisting
3661 of name and address, is quite self-willed.
3663 \begin_inset Quotes eld
3667 \begin_inset Quotes erd
3670 heading is produced by the following \SpecialChar LaTeX
3671 commands in the preamble:
3674 \begin_layout LyX-Code
3684 \begin_layout LyX-Code
3700 \begin_layout LyX-Code
3710 \begin_layout LyX-Code
3730 A detailed German description of such \SpecialChar LaTeX
3731 commands can be found in the Koma-Script
3737 With it, the letter's author can produce his personal letter layout.
3740 \begin_layout Standard
3749 define the beginning of the letter and must be used in every letter.
3750 To emphasize them in the \SpecialChar LyX
3751 document class, they are marked with the letter
3761 \begin_inset space ~
3765 It is possible to write any number of letters in one file.
3770 type produces a new letter using the same addressee and a
3774 type produces a new addressee.
3791 are ordinary paragraph types and can also be used several times in one
3792 and the same letter.
3795 \begin_layout Itemize
3800 : produces a paragraph for the addressee and implicitly defines the beginning
3804 \begin_layout Itemize
3809 : produces a paragraph for the form of address and implicitly produces a
3813 \begin_layout Itemize
3818 : produces a paragraph for a close.
3821 \begin_layout Itemize
3826 : produces a paragraph for a postscript.
3829 \begin_layout Itemize
3834 : produces a paragraph for a distribution list.
3837 \begin_layout Itemize
3842 : produces a paragraph for enclosures.
3845 \begin_layout Standard
3886 are input types provided with a label to enter information, which will
3887 be processed by the document class.
3891 \begin_layout Plain Layout
3892 It could be seen as a matter of inconsequence, that the types
3900 described above are not such input types as well.
3901 Because of the special meaning of those types, however, I have implemented
3902 them as ordinary paragraph types with a one letter mark in the left margin.
3903 Moreover, it would affect my feeling of symmetry, if the
3911 type had such a serious different appearance.
3916 The types must be used ahead of the corresponding
3923 \begin_layout Standard
3924 An implementation of these types in a WYSIWYG fashion does not seem to make
3925 sense, because the real appearance of the produced letter does not only
3926 depend on the usage of the particular type, but also on other factors.
3927 For example, a signature entered in the
3931 type will in the standard behavior appear in the produced letter only,
3932 when in the same letter also a
3937 The entered value of the
3941 type will in the standard behavior not appear in the produced letter at
3943 The possibility to design the letter`s heading freely is already indicated
3944 in a footnote above.
3947 \begin_layout Standard
3948 The input types can also be used as empty paragraphs.
3950 \begin_inset space \thinspace{}
3954 \begin_inset space \space{}
3966 type is not used at all, in the standard behavior the value of the
3970 type is used as signature, whereas if an empty
3974 type is used, no signature value is defined.
3977 \begin_layout Standard
3978 By using the input types it is possible to write a letter template, containing
3979 filled input types with your personal dates (name, address, etc.) and empty
3980 input types for other dates you want to enter.
3983 \begin_layout Itemize
3988 : sender's name, in the standard behavior appears as a centered paragraph
3989 in small caps in the letter`s heading.
3992 \begin_layout Itemize
3997 : sender's signature, in the standard behavior appears below the
4006 type is used, the value of the
4010 type appears instead.
4013 \begin_layout Itemize
4018 : sender's address, in the standard behavior appears in a centered paragraph
4019 in the letter`s heading below the sender's name.
4022 \begin_layout Itemize
4027 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
4038 \begin_layout Itemize
4043 : place of the letter`s making.
4046 \begin_layout Itemize
4051 : date of the letter`s making.
4060 , in the standard behavior, produce the place and the date in a right-aligned
4061 line below the addressee's field.
4066 type is used, neither place nor date appear, independent of the value of
4076 type is used, the date of the letter `s production is used.
4079 \begin_layout Itemize
4084 : sender`s back address, in the standard behavior appears above the addressee's
4085 field in a small sans serif font.
4088 \begin_layout Itemize
4093 : special mail information, in the standard behavior appears underlined
4094 above the addressee's field below the back address.
4097 \begin_layout Itemize
4102 : additional information, in the standard behavior appears on right side
4103 below the addressee`s field.
4106 \begin_layout Itemize
4111 : the letter's title, in the standard behavior appears in a big, bold, sans
4112 serif font above the subject.
4115 \begin_layout Itemize
4120 : the letter's subject, in the standard behavior appears in a bold font
4128 \begin_layout Standard
4149 produce a business letter like line above the
4153 line containing the fields
4154 \begin_inset Quotes eld
4158 \begin_inset Quotes erd
4162 \begin_inset Quotes eld
4166 \begin_inset Quotes erd
4170 \begin_inset Quotes eld
4174 \begin_inset Quotes erd
4178 \begin_inset Quotes eld
4182 \begin_inset Quotes erd
4186 \begin_inset Quotes eld
4190 \begin_inset Quotes erd
4194 \begin_inset Quotes eld
4198 \begin_inset Quotes erd
4202 For the date field, the value of the
4208 \begin_inset Quotes eld
4211 business letter types
4212 \begin_inset Quotes erd
4215 is used, the value of the
4219 type however does not appear, but only the \SpecialChar LaTeX
4227 The ordinary output of place and date in a right-aligned line below the
4228 addressee`s field is suppressed.
4229 The types are implemented as input types provided with a label and must
4230 be used ahead of the corresponding
4237 \begin_layout Itemize
4245 \begin_layout Itemize
4253 \begin_layout Itemize
4261 \begin_layout Itemize
4269 \begin_layout Itemize
4277 \begin_layout Subsubsection
4278 The new letter class: letter (koma-script v.2)
4281 \begin_layout Standard
4287 \begin_layout Standard
4288 \begin_inset VSpace medskip
4294 \begin_layout Standard
4296 Koma-Script version 2.8 has introduced a new letter class
4300 which supersedes the now unsupported
4305 It has — on the \SpecialChar LaTeX
4306 side — a completely new interface and is not compatible
4308 Therefore, \SpecialChar LyX
4309 supports both, though it is recommended you use the new class.
4312 \begin_layout Standard
4313 This class covers the same functionality as
4315 letter (koma-script),
4322 (receiver's address, same as
4339 will start a new letter (i.
4340 \begin_inset space \thinspace{}
4344 \begin_inset space \space{}
4347 you can write several letters per document).
4348 New elements are sender's
4364 and the possibility to use a
4370 Insert\SpecialChar menuseparator
4376 \begin_layout Standard
4377 The biggest improvement is, though, that the letter's layout is configurable
4378 to meet almost any needs.
4379 This can be done via the preamble or with a special style file (Letter
4380 Class Option, extension
4384 ), that will be read in as a class option.
4388 \begin_layout Plain Layout
4389 The KOMA package comes with some default
4394 There is, for instance, a
4398 file that follows german typesetting rules, or a
4402 that provides the default layout of the old
4407 The latter can be loaded with the class option
4413 Layout\SpecialChar menuseparator
4414 Document\SpecialChar menuseparator
4426 template that is included in \SpecialChar LyX
4428 A detailed description is to be found in the Koma-Script documentation
4436 \begin_layout Subsubsection
4440 \begin_layout Standard
4441 Visualizing the Koma-Script document classes in \SpecialChar LyX
4442 , the \SpecialChar LyX
4443 internals cause some
4447 \begin_layout Itemize
4448 The chapter number of a
4452 type appears on a line of its own above the chapter heading instead of
4453 appearing in the same line ahead of it.
4454 The cause for that is the \SpecialChar LyX
4455 internal behavior for the labeltype
4462 \begin_layout Itemize
4463 The headings of the types
4472 \begin_inset Quotes eld
4476 \begin_inset Quotes erd
4480 table of contents, but not in the \SpecialChar LyX
4483 Document\SpecialChar menuseparator
4485 \begin_inset space ~
4489 \begin_inset space ~
4497 \begin_layout Itemize
4502 document class appear in a skip separation mode, not indented.
4503 This is the standard behavior, no special \SpecialChar LaTeX
4504 commands are needed for that.
4507 Document\SpecialChar menuseparator
4510 dialog the corresponding radio button indicates
4519 value always has the effect that extra \SpecialChar LaTeX
4520 commands are inserted in the document
4521 to produce the gap, which is not what is wanted in this case.
4524 \begin_layout Subsection
4526 \change_inserted 564990737 1670924924
4528 \begin_inset space \thinspace{}
4532 \begin_inset space \space{}
4536 \change_deleted 564990737 1670924933
4537 Article (mwart), book (mwbk) and report (mwrep)
4538 \begin_inset Argument status
4541 \begin_layout Plain Layout
4556 \begin_layout Standard
4562 \begin_layout Standard
4563 The \SpecialChar LyX
4580 correspond to the \SpecialChar LaTeX
4594 They are replacements for the standard document classes
4606 , resp., and fit better to Polish typography conventions in a number of points.
4610 \begin_layout Standard
4614 \begin_layout Itemize
4615 Unnumbered titles (with star, e.
4616 \begin_inset space \thinspace{}
4620 \begin_inset space \space{}
4627 ) are added into table of contents,
4630 \begin_layout Itemize
4631 Additional page styles:
4635 \begin_layout Description
4636 uheadings header with separated lines,
4639 \begin_layout Description
4640 myheadings custom header, contents headers via commands:
4655 \begin_layout Description
4656 myuheadings custom header with separated lines,
4659 \begin_layout Description
4660 outer page number is placed on outer side of page
4664 \begin_layout Itemize
4669 \begin_layout Description
4670 rmheadings serif titles — default,
4673 \begin_layout Description
4674 sfheadings sansserif titles,
4677 \begin_layout Description
4678 authortitle on title page first placed is author next title — default,
4681 \begin_layout Description
4682 titleauthor on title page first placed is title next author,
4685 \begin_layout Description
4686 withmarginpar reserve place on page for margins.
4690 \begin_layout Section
4692 \change_inserted 564990737 1670439534
4696 \begin_layout Standard
4698 \change_inserted 564990737 1670794710
4699 See also the document classes in the Collections (section
4700 \begin_inset space ~
4704 \begin_inset CommandInset ref
4706 reference "sec:Collections"
4713 \begin_layout Subsection
4715 \change_inserted 564990737 1670794716
4721 \begin_layout Standard
4723 \change_inserted 564990737 1670794716
4730 ; updated by the \SpecialChar LyX
4734 \begin_layout Subsubsection
4736 \change_inserted 564990737 1670794716
4742 \begin_layout Standard
4744 \change_inserted 564990737 1670794716
4747 This section describes how \SpecialChar LyX
4748 can be used to write articles for submission
4749 to the scientific journal
4751 Astronomy and Astrophysics
4754 \begin_inset CommandInset href
4757 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
4762 ) using Version 9.1 of the document class
4766 ; information about it is available at
4767 \begin_inset Flex URL
4770 \begin_layout Plain Layout
4772 \change_inserted 564990737 1670794716
4774 https://www.aanda.org/for-authors/latex-issues/texnical-background-information
4784 \begin_layout Standard
4786 \change_inserted 564990737 1670794716
4789 A manual comes together with the package and should be consulted before
4790 installing this document class as described in the
4792 Installing New Document Classe
4802 \begin_layout Standard
4804 \change_inserted 564990737 1670794716
4807 \begin_inset Note Greyedout
4810 \begin_layout Plain Layout
4812 \change_inserted 564990737 1670794716
4815 Please note that the publisher of the journal was changed from Springer
4816 to EDP Sciences starting January 1, 2001.
4817 That change also involved some slight changes to the style files, namely
4818 the removal of the thesaurus command.
4819 If you have an older version installed, please upgrade.
4820 For information about compatibility with the old (version 4) layout, please
4821 refer to the comments in
4824 Dir/layouts/aapaper.layout
4834 \begin_layout Subsubsection
4836 \change_inserted 564990737 1670794716
4842 \begin_layout Standard
4844 \change_inserted 564990737 1670794716
4847 It is recommended you start from the template
4856 ile\SpecialChar menuseparator
4858 \begin_inset space ~
4866 \begin_inset space ~
4872 If you are not using the template, note the following settings:
4875 \begin_layout Itemize
4877 \change_inserted 564990737 1670794716
4889 ocument\SpecialChar menuseparator
4894 ettings\SpecialChar menuseparator
4896 \begin_inset space ~
4901 dialog (OK, that one was obvious).
4904 \begin_layout Itemize
4906 \change_inserted 564990737 1670794716
4912 \begin_inset space ~
4924 \begin_inset space ~
4929 dialog: leave it set to
4934 The whole layout is done by the macros, you shouldn't change anything.
4937 \begin_layout Subsubsection
4939 \change_inserted 564990737 1670794716
4945 \begin_layout Standard
4947 \change_inserted 564990737 1670794716
4950 First thing to enter is the header information.
4951 It consists of five entries, of which one is optional.
4955 \begin_layout Itemize
4957 \change_inserted 564990737 1670794716
4966 \begin_layout Itemize
4968 \change_inserted 564990737 1670794716
4977 \begin_layout Itemize
4979 \change_inserted 564990737 1670794716
4988 \begin_layout Itemize
4990 \change_inserted 564990737 1670794716
4999 \begin_layout Itemize
5001 \change_inserted 564990737 1670794716
5010 Received: <date>; Accepted <date>
5013 \begin_layout Standard
5015 \change_inserted 564990737 1670794716
5018 Although the order of the single header entries doesn't matter it is advised
5019 to keep the above sequence, just to get the best optics and meets the layout
5020 of the real document.
5023 \begin_layout Standard
5025 \change_inserted 564990737 1670794716
5028 If you want to place footnotes in the header block, e.
5029 \begin_inset space \thinspace{}
5033 \begin_inset space \space{}
5036 to state your present address, just use the standard footnote via the menu
5042 nsert\SpecialChar menuseparator
5051 will automagically use the term
5060 \begin_layout Standard
5062 \change_inserted 564990737 1670794716
5065 In addition to these topics, the macros use three additional \SpecialChar LaTeX
5067 have no counterpart in \SpecialChar LyX
5071 \begin_layout Itemize
5073 \change_inserted 564990737 1670794716
5081 to separate different names for more than one author and institute, respectivel
5085 \begin_layout Itemize
5087 \change_inserted 564990737 1670794716
5095 to mark corresponding author/institute pairs.
5096 The institutes are numbered sequentially as they appear in the
5100 field, so you have to put a marker to each author.
5103 \begin_layout Itemize
5105 \change_inserted 564990737 1670794716
5113 to supply an email address for fast contact.
5116 \begin_layout Standard
5118 \change_inserted 564990737 1670794716
5121 In all cases, the appropriate command has to be entered as \SpecialChar TeX
5122 code in \SpecialChar LyX
5124 See the examples in the template and in the file
5136 \begin_layout Subsubsection
5138 \change_inserted 564990737 1670794716
5144 \begin_layout Standard
5146 \change_inserted 564990737 1670794716
5149 The abstract should immediately follow the header block and must contain
5159 \begin_layout Enumerate
5161 \change_inserted 564990737 1670794716
5167 (optional) {} leave it empty if necessary
5170 \begin_layout Enumerate
5172 \change_inserted 564990737 1670794716
5181 \begin_layout Enumerate
5183 \change_inserted 564990737 1670794716
5192 \begin_layout Enumerate
5194 \change_inserted 564990737 1670794716
5203 \begin_layout Enumerate
5205 \change_inserted 564990737 1670794716
5211 (optional) {} leave it empty if necessary
5214 \begin_layout Standard
5216 \change_inserted 564990737 1670794716
5220 This structure not shown in
5227 \begin_layout Subsubsection
5229 \change_inserted 564990737 1670794716
5232 Supported environments
5235 \begin_layout Standard
5237 \change_inserted 564990737 1670794716
5240 The A&A paper layout supports the following environments for structuring
5244 \begin_layout Itemize
5246 \change_inserted 564990737 1670794716
5253 \begin_layout Itemize
5255 \change_inserted 564990737 1670794716
5262 \begin_layout Itemize
5264 \change_inserted 564990737 1670794716
5271 \begin_layout Itemize
5273 \change_inserted 564990737 1670794716
5280 \begin_layout Itemize
5282 \change_inserted 564990737 1670794716
5289 \begin_layout Itemize
5291 \change_inserted 564990737 1670794716
5298 \begin_layout Itemize
5300 \change_inserted 564990737 1670794716
5307 \begin_layout Itemize
5309 \change_inserted 564990737 1670794716
5316 \begin_layout Itemize
5318 \change_inserted 564990737 1670794716
5325 \begin_layout Itemize
5327 \change_inserted 564990737 1670794716
5334 \begin_layout Itemize
5336 \change_inserted 564990737 1670794716
5343 \begin_layout Itemize
5345 \change_inserted 564990737 1670794716
5353 \begin_layout Subsubsection
5355 \change_inserted 564990737 1670794716
5358 Commands not supported by \SpecialChar LyX
5362 \begin_layout Standard
5364 \change_inserted 564990737 1670794716
5367 Some commands are not yet supported by the
5371 layout for \SpecialChar LyX
5373 Some have already been mentioned.
5374 For the sake of completeness, they are listed all together here:
5377 \begin_layout Itemize
5379 \change_inserted 564990737 1670794716
5388 \begin_layout Itemize
5390 \change_inserted 564990737 1670794716
5399 \begin_layout Itemize
5401 \change_inserted 564990737 1670794716
5410 \begin_layout Itemize
5412 \change_inserted 564990737 1670794716
5421 \begin_layout Itemize
5423 \change_inserted 564990737 1670794716
5432 \begin_layout Standard
5434 \change_inserted 564990737 1670794716
5437 If you want to use any of these commands, you have to enter them yourself.
5440 Do not forget to use
5446 nsert\SpecialChar menuseparator
5449 \begin_inset space ~
5458 \begin_layout Subsubsection
5460 \change_inserted 564990737 1670794716
5463 Figure and Table Floats
5466 \begin_layout Standard
5468 \change_inserted 564990737 1670794716
5472 provides support for the necessary float environments
5474 figure, figure*, table
5480 , therefore we won't tell much about it here.
5484 \begin_inset space ~
5490 Just remember that tables should be left-aligned.
5491 For that, select the table and change the alignment in
5496 dit\SpecialChar menuseparator
5502 \begin_inset space ~
5508 \begin_layout Standard
5510 \change_inserted 564990737 1670794716
5513 There is only one special thing: the figures with a caption beside the figure.
5514 To create such a figure, you have to do the following:
5517 \begin_layout Enumerate
5519 \change_inserted 564990737 1670794716
5522 Create a wide figure float:
5527 nsert\SpecialChar menuseparator
5532 t\SpecialChar menuseparator
5535 , then, from within the float, use the menu
5540 dit\SpecialChar menuseparator
5546 \begin_inset space ~
5557 \begin_inset space ~
5569 \begin_layout Enumerate
5571 \change_inserted 564990737 1670794716
5574 Enter your caption text.
5577 \begin_layout Enumerate
5579 \change_inserted 564990737 1670794716
5586 to move the cursor above the caption.
5589 \begin_layout Enumerate
5591 \change_inserted 564990737 1670794716
5597 \begin_layout Enumerate
5599 \change_inserted 564990737 1670794716
5602 Position the cursor after the figure and insert a horizontal fill by using
5608 nsert\SpecialChar menuseparator
5613 rmatting\SpecialChar menuseparator
5619 \begin_inset space ~
5628 dialog and select the
5642 \begin_layout Enumerate
5644 \change_inserted 564990737 1670794716
5647 Switch to \SpecialChar LaTeX
5651 \begin_inset space ~
5659 \begin_layout Enumerate
5661 \change_inserted 564990737 1670794716
5672 Do not close the brace!
5675 \begin_layout Enumerate
5677 \change_inserted 564990737 1670794716
5680 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
5685 \begin_inset space ~
5697 \begin_layout Standard
5699 \change_inserted 564990737 1670794716
5702 Also, refer to the figures in the file
5713 \begin_layout Subsubsection
5715 \change_inserted 564990737 1670794716
5721 \begin_layout Standard
5723 \change_inserted 564990737 1670794716
5726 For submission, the paper has to be formatted in a special double-spacing
5728 For this purpose, you have to add the option
5739 \begin_inset space ~
5749 ocument\SpecialChar menuseparator
5754 ettings\SpecialChar menuseparator
5756 \begin_inset space ~
5765 \begin_layout Subsubsection
5767 \change_inserted 564990737 1670794716
5773 \begin_layout Standard
5775 \change_inserted 564990737 1670794716
5782 was written with \SpecialChar LyX
5784 It is the example paper from the original macro package,
5789 \begin_inset CommandInset href
5792 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
5797 , but translated to \SpecialChar LyX
5798 using the older unstructured abstract type.
5799 Use it for inspiration, and compare the \SpecialChar LaTeX
5804 with the \SpecialChar LyX
5808 \begin_layout Subsection
5813 \begin_layout Standard
5819 \begin_layout Subsubsection
5823 \begin_layout Standard
5825 is a set of macros produced by the American Astronomical Society to
5826 facilitate electronic manuscript submission to the three journals they
5827 publish: the Astrophysical Journal (including the Letters and Supplement),
5828 the Astronomical Journal, and the Publications of the Astronomical Society
5831 has proven to be an excellent tool for generating these documents, especially
5832 given its equation, citation, and figure handling capabilities.
5834 requires version 5.0 (or higher) of these macros; preferably 6.0, which
5835 is the version described here, or higher.
5836 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
5837 2.09 and are fundamentally
5838 incompatible with \SpecialChar LyX
5840 The AAS\SpecialChar TeX
5841 package may be downloaded from the AAS\SpecialChar TeX
5845 \begin_layout Standard
5846 \begin_inset VSpace medskip
5852 \begin_layout Standard
5854 \begin_inset Flex URL
5857 \begin_layout Plain Layout
5859 https://aas.org/aastex/aastex-downloads
5867 \begin_layout Standard
5868 \begin_inset VSpace medskip
5874 \begin_layout Standard
5875 A complete user guide is contained in that package and you should familiarize
5876 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
5879 will not reduce the need to figure out all the AAS\SpecialChar TeX
5880 commands, it will only
5881 reduce the drudgery of typing everything in.
5882 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
5884 completely to the requirements of the journal to which you are submitting
5888 \begin_layout Subsubsection
5889 Starting a New Paper
5892 \begin_layout Standard
5893 I strongly suggest that you start with the AAS\SpecialChar TeX
5897 File\SpecialChar menuseparator
5904 , enter the new file name, then choose the
5909 This will show the most common fields found in a manuscript.
5910 Simply overwrite the existing text (including the brackets,
5914 ) with the correct information.
5915 Many of the AAS\SpecialChar TeX
5916 commands and environments can be implemented directly in
5919 For commands such as these, the \SpecialChar LaTeX
5920 code must be entered directly and marked
5922 Such commands are referred to as \SpecialChar TeX
5923 code, or Evil Red Text.
5924 I tried to minimize the amount of \SpecialChar TeX
5925 code needed in an AAS\SpecialChar TeX
5929 \begin_layout Subsubsection
5930 Finishing Your Paper
5933 \begin_layout Standard
5934 When the paper is finished to your satisfaction and previews/prints correctly,
5936 \begin_inset Quotes eld
5940 \begin_inset Quotes erd
5943 actions which need to be done before you submit it to the journals.
5947 \begin_layout Enumerate
5948 Export your paper as a \SpecialChar LaTeX
5951 File\SpecialChar menuseparator
5952 Export\SpecialChar menuseparator
5960 \begin_layout Enumerate
5965 file with your favorite text editor
5969 \begin_layout Enumerate
5970 remove the comment lines before the
5979 \begin_layout Enumerate
5984 usepackage...{fontenc}
5986 line if it appears (usually just after
6001 \begin_layout Enumerate
6002 remove everything between (and including) the
6014 commands, except for any commands you specifically put into the \SpecialChar LaTeX
6016 (which should appear immediately after the
6017 \begin_inset Quotes eld
6020 User specified \SpecialChar LaTeX
6022 \begin_inset Quotes erd
6033 \begin_layout Enumerate
6034 Run the resulting file through \SpecialChar LaTeX
6035 to make sure it still processes correctly.
6038 \begin_layout Enumerate
6039 Reread the journal requirements to make sure your filenames and formats
6043 \begin_layout Enumerate
6047 \begin_layout Subsubsection
6048 Comments On Specific Commands
6051 \begin_layout Standard
6052 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
6059 ) gives a good description of each.
6060 Thus it's probably easiest for me to go down the list as found in the guide
6061 and offer comments where necessary.
6062 So let's begin \SpecialChar ldots
6066 \begin_layout Paragraph
6067 Things that work as expected
6070 \begin_layout Standard
6071 Because they work as you might expect, I simply list them and the section
6172 begin{thebibliography}
6180 (2.13.2), all the cite commands and their variations (2.13.2), the generic
6181 graphicx figure commands (2.14.1),
6205 (2.15.4, amongst other places),
6232 \begin_layout Standard
6233 The following style options also work correctly:
6254 Simply put them in the
6260 Layout\SpecialChar menuseparator
6266 \begin_layout Paragraph
6267 Things that work, but require more comment
6270 \begin_layout Standard
6271 The following items work, but require a little more discussion:
6274 \begin_layout Itemize
6275 These items are reserved for use by the journal editors, but you can put
6276 them into the \SpecialChar LaTeX
6277 preamble if you feel compelled to do so:
6310 \begin_layout Itemize
6311 These items may be placed in the \SpecialChar LaTeX
6312 preamble, and are included as blanks in
6334 \begin_layout Itemize
6341 (2.3) – can only be used
6342 \begin_inset Quotes eld
6346 \begin_inset Quotes erd
6349 , not in the middle of a paragraph.
6350 Use \SpecialChar TeX
6351 code if you need to embed it.
6354 \begin_layout Itemize
6361 (2.3) – will have extra {} after it.
6362 This should not cause an error.
6365 \begin_layout Itemize
6372 (2.6) – can only be used
6373 \begin_inset Quotes eld
6377 \begin_inset Quotes erd
6380 , not in the middle of a paragraph.
6381 Use \SpecialChar TeX
6382 code if you need to embed it.
6385 \begin_layout Itemize
6392 (2.8) – can't insert a cross-reference tag, you must type the tag name by
6396 \begin_layout Itemize
6410 \begin_layout Itemize
6417 (2.9) – will have extra {} after it.
6418 This should not cause an error.
6421 \begin_layout Itemize
6428 (2.11) – will have extra {} after it.
6429 This should not cause an error.
6432 \begin_layout Itemize
6439 (2.14.2) – you can insert an optional filename argument by placing the cursor
6440 at the beginning of the text and selecting
6442 Insert\SpecialChar menuseparator
6447 \begin_inset Quotes eld
6451 \begin_inset Quotes erd
6454 inserts an optional argument of the type needed by
6461 Hopefully it will be renamed someday.
6464 \begin_layout Itemize
6477 for the catalog ID optional parameter
6480 \begin_layout Itemize
6493 for the catalog ID optional parameter
6496 \begin_layout Paragraph
6497 Things not implemented, use \SpecialChar TeX
6501 \begin_layout Standard
6512 setcounter{equation}
6514 (2.12), Journal name abbreviations (2.13.4),
6550 (2.15.4, insert it as the first element in the lefthand cell after where
6552 Don't use any of \SpecialChar LyX
6553 's rules in the table),
6565 (2.15.5), much of Misc (2.17, except
6616 \begin_layout Paragraph
6617 Things that cannot be implemented
6620 \begin_layout Standard
6622 at least in any meaningful sort of way, so I suggest ignoring them.
6623 They are the references environment (2.13.3), and the deluxetable environment
6625 If you really, really need to use deluxetable, I suggest editing it in
6626 a separate file with a text editor, then using
6628 Insert\SpecialChar menuseparator
6630 \begin_inset space ~
6635 to include it in your \SpecialChar LyX
6641 file to see an example of this.
6644 \begin_layout Subsubsection
6645 FAQs, Tips, Tricks, and Other Ruminations
6648 \begin_layout Paragraph
6649 Getting \SpecialChar LyX
6650 and AAS\SpecialChar TeX
6654 \begin_layout Standard
6655 It can be a bit tricky to get \SpecialChar LyX
6656 to recognize a new layout and document class.
6657 When all else fails, do this:
6660 \begin_layout Enumerate
6661 Make certain that \SpecialChar LaTeX
6662 can find AAS\SpecialChar TeX
6664 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
6666 directory completely unrelated to \SpecialChar LaTeX
6667 or AAS\SpecialChar TeX
6668 and run \SpecialChar LaTeX
6676 \begin_layout Enumerate
6681 appears in \SpecialChar LyX
6689 \begin_layout Enumerate
6692 Tools\SpecialChar menuseparator
6696 , then restart \SpecialChar LyX
6700 \begin_layout Enumerate
6701 Open a regular new file, not from a template.
6702 Does AAS\SpecialChar TeX
6703 appear in the class list in
6705 Document\SpecialChar menuseparator
6711 \begin_layout Standard
6712 If you get a warning from an existing AAS\SpecialChar TeX
6713 document about not being able
6714 to find the AAS\SpecialChar TeX
6715 layout or a message about
6716 \begin_inset Quotes eld
6719 You should not mix title layouts with normal ones
6720 \begin_inset Quotes erd
6723 , things haven't been installed correctly.
6726 \begin_layout Paragraph
6728 error processing a table
6731 \begin_layout Standard
6733 , by default, attempts to center the table caption/title.
6734 This seems to produce a bad interaction in AAS\SpecialChar TeX
6735 so you should click somewhere
6736 in the caption/title, then select
6738 Edit\SpecialChar menuseparator
6740 \begin_inset space ~
6754 This took care of it for me.
6757 \begin_layout Paragraph
6761 \begin_layout Standard
6762 A couple of things: 1) I have noticed some funny spacing in the reference
6763 entries in the text.
6764 When you enter the bibliography item data, make sure their is
6768 space between the last author and the parenthesis setting off the year;
6772 \begin_inset space \thinspace{}
6776 \begin_inset space \space{}
6790 2) Entering the references at all is not obvious.
6791 The easiest thing is to start typing your first reference at the end of
6792 the document, then mark it as type
6797 That will put a small gray box in front of what you just typed.
6798 Click on the box to fill in the rest of the information.
6799 For new references, go to the end of an existing reference and press return.
6800 That will create a new line with its own box, etc.
6803 \begin_layout Paragraph
6807 \begin_layout Standard
6808 Even though AAS\SpecialChar TeX
6809 provides its own figure commands (
6815 , for example), I much prefer \SpecialChar LaTeX
6816 's standard figure commands (with the default
6825 \begin_inset space ~
6828 commands as \SpecialChar TeX
6829 code into a Figure Float box if you desire, but I never have
6830 much luck getting the layout right.
6831 With the standard graphics, \SpecialChar LyX
6836 usepackage{graphicx}
6838 command into the \SpecialChar LaTeX
6839 preamble and handle the figures in the standard \SpecialChar LaTeX2e
6841 interspersing the figures in the text.
6842 I believe ApJ accepts figures exactly this way now; AJ might still use
6844 \begin_inset Quotes eld
6847 stack everything at the end
6848 \begin_inset Quotes erd
6854 \begin_layout Paragraph
6855 Things I could have done, but didn't
6858 \begin_layout Standard
6860 \begin_inset Quotes eld
6864 \begin_inset Quotes erd
6867 things I could have implemented, but chose not to.
6868 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
6870 even though it is double-spaced in the paper manuscript.
6871 Also, I chose not to make separate layouts for the preprint and preprint2
6873 Since I assume you will spend most of your time in the plain manuscript
6874 mode anyway, I decided not to chew up more disk space with this.
6878 \begin_layout Subsubsection
6882 \begin_layout Standard
6883 Your mileage may vary.
6884 I've now had papers published by both ApJ and AJ that have had 98% of the
6885 effort done in \SpecialChar LyX
6886 ; the last 2% was the \SpecialChar LaTeX
6887 post-processing and a few cleanups.
6888 I have had no trouble with the submission process, and I'm sure the journals
6889 were never aware that there might be a difference.
6890 So, go forth and publish!
6893 \begin_layout Subsection
6895 \change_inserted 564990737 1671042028
6901 \begin_layout Standard
6903 \change_inserted 564990737 1671042028
6909 \begin_inset space \thinspace{}
6919 This provides the following additional environments:
6922 \begin_inset space ~
6930 \begin_inset space ~
6938 \begin_inset space ~
6961 is available in the menu
6966 ile\SpecialChar menuseparator
6968 \begin_inset space ~
6976 \begin_inset space ~
6982 It has been customized with further environments and contains all the informati
6984 However, the documentation is also available from
6985 \begin_inset CommandInset href
6988 target "http://mirrors.ctan.org/macros/latex/contrib/elsarticle/doc/elsdoc.pdf"
6996 \begin_layout Subsection
6998 \change_inserted 564990737 1671042046
7004 \begin_layout Standard
7006 \change_inserted 564990737 1671042046
7012 \begin_inset space \thinspace{}
7017 provides an alternative to the
7022 It provides similar functionality, but you might prefer this layout with
7023 sans serif sections, headings, and more.
7026 \begin_layout Subsection
7031 \begin_layout Standard
7037 \begin_layout Standard
7038 \begin_inset VSpace bigskip
7044 \begin_layout Standard
7049 \begin_inset space ~
7054 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
7056 \begin_inset Formula $\beta$
7059 release of May, 1999) class.
7062 \begin_layout Standard
7068 textclass, which works with Rev\SpecialChar TeX
7070 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
7072 That means that it doesn't interact very well with \SpecialChar LyX
7073 , which requires \SpecialChar LaTeX2e
7075 it has been kludged to work.
7076 Since Rev\SpecialChar TeX
7077 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
7084 \begin_inset space ~
7089 textclass should also be pretty easy to use.
7092 \begin_layout Standard
7093 These documents are supposed to be used in
7097 to the Rev\SpecialChar TeX
7098 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
7100 and assume you'll know what to put in the preamble if necessary.
7103 \begin_layout Subsubsection
7107 \begin_layout Standard
7108 All you need to do is install Rev\SpecialChar TeX
7109 4, as described in the package's README
7111 The package can be found at The Rev\SpecialChar TeX
7113 \begin_inset Flex URL
7116 \begin_layout Plain Layout
7118 http://publish.aps.org/revtex4/
7124 Install it somewhere that \SpecialChar LaTeX
7126 Test it by trying to \SpecialChar LaTeX
7127 a short Rev\SpecialChar TeX
7128 4 document in some random directory (i.
7129 \begin_inset space \thinspace{}
7133 \begin_inset space \space{}
7136 not the directory where you installed the class file.) Then, if you reconfigure
7138 , it will find the class file and let you use the Rev\SpecialChar TeX
7142 \begin_layout Standard
7143 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
7152 \begin_inset space ~
7157 template, found in the templates directory.
7160 \begin_layout Subsubsection
7164 \begin_layout Standard
7165 Optional arguments to
7172 \begin_inset Quotes eld
7176 \begin_inset Quotes erd
7180 \begin_inset Quotes eld
7184 \begin_inset Quotes erd
7190 \begin_inset space ~
7198 \begin_inset space ~
7204 Remember that in Rev\SpecialChar TeX
7205 , at least one optional argument is required!
7208 \begin_layout Standard
7209 Other preamble matter, like
7216 \begin_inset space ~
7223 \begin_inset space ~
7228 dialog, also as usual.
7231 \begin_layout Subsubsection
7235 \begin_layout Standard
7236 The layouts basically correspond to the commands in Rev\SpecialChar TeX
7238 For example, the Email layout corresponds to
7245 Note that (at least as of Rev\SpecialChar TeX
7254 layouts are exactly equivalent, so you shouldn't need to use both.
7258 \begin_layout Plain Layout
7259 In case you're curious, both were included so that
7263 would be able to translate both
7283 \begin_layout Subsubsection
7287 \begin_layout Standard
7288 There are a couple of important unique aspects of Rev\SpecialChar TeX
7290 bugs that will be even more confusing in \SpecialChar LyX
7294 \begin_layout Standard
7295 In Rev\SpecialChar TeX
7313 The \SpecialChar LyX
7314 equivalent is that there is a separate Thanks layout.
7319 write footnotes in the
7323 layout, or weird things may happen.
7324 See the Rev\SpecialChar TeX
7325 4 documentation for more details.
7328 \begin_layout Standard
7332 \begin_inset space ~
7340 \begin_inset space ~
7349 layouts must be placed
7357 layout and the corresponding
7374 , the \SpecialChar LaTeX
7378 \begin_layout Subsection
7380 \change_inserted 564990737 1671042072
7386 \begin_layout Standard
7388 \change_inserted 564990737 1671042072
7395 classes were replaced in 2013 with a completely new
7400 This package provides a \SpecialChar LaTeX
7401 class and templates for books to be published
7402 at Springer Gabler Research, Springer Vieweg Research, Springer Spektrum
7403 Research, Springer VS Research, or Springer VS Forschung.
7404 The documentation is available in German from
7405 \begin_inset CommandInset href
7408 target "http://mirrors.ctan.org/macros/latex/contrib/springer/sr-vorl/sr-vorl.pdf"
7416 \begin_layout Section
7418 \change_inserted 564990737 1670439560
7422 \begin_layout Standard
7424 \change_inserted 564990737 1670439581
7425 See also the document classes in the Collections (section
7426 \begin_inset space ~
7430 \begin_inset CommandInset ref
7432 reference "sec:Collections"
7439 \begin_layout Subsection
7443 \begin_layout Standard
7449 \begin_layout Subsubsection
7453 \begin_layout Standard
7454 Memoir is a very powerful and constantly evolving class.
7455 It has been designed with regard to fictional and non-fictional literature.
7456 Its aim is to let the user have maximum control over the typesetting of
7458 Memoir is based on the standard book class, but it can also emulate the
7459 article class (see below).
7462 \begin_layout Standard
7463 Peter Wilson, the developer of Memoir, is known as the author of lots of
7464 useful packages in the \SpecialChar LaTeX
7466 Most of them have been merged with Memoir.
7467 Therefore, it is much easier to layout the table of contents, appendices,
7468 chapter designs and such.
7470 , though, does not support all of these goodies natively.
7471 Some of them might be added to forthcoming releases
7475 \begin_layout Plain Layout
7476 You are invited to send suggestions to
7477 \begin_inset Flex URL
7480 \begin_layout Plain Layout
7482 lyx-devel@lists.lyx.org
7492 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
7494 Of course you can still use all features with the help of some native \SpecialChar LaTeX
7496 commands (\SpecialChar TeX
7501 \begin_layout Plain Layout
7506 \begin_layout Plain Layout
7516 \begin_inset space ~
7520 \begin_inset CommandInset ref
7522 reference "sec:Inserting-TeX-Code"
7532 In this section, we can only list those features that are natively supported
7535 For detailed descriptions (and for the rest of features) we recommend you
7536 have a look at the detailed manual of the Memoir class
7540 \begin_layout Plain Layout
7545 \begin_layout Plain Layout
7555 \begin_inset Flex URL
7558 \begin_layout Plain Layout
7560 CTAN:/macros/latex/memoir/memman.pdf
7570 , which is not only a user guide for the class, but also both a comprehensive
7571 description on good typesetting and a superb example for good typesetting
7575 \begin_layout Subsubsection
7576 Basic features and restrictions
7579 \begin_layout Standard
7580 Memoir supports basically all features of the standard book classes.
7581 There are, however, some differences, as follows:
7584 \begin_layout Description
7586 \begin_inset space ~
7589 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
7592 \begin_layout Description
7594 \begin_inset space ~
7597 style: The fancy page style is not supported, due to a command clash between
7598 Memoir and the fancyhdr package (they both define a command with the same
7599 name, which confuses \SpecialChar LaTeX
7601 Instead, Memoir comes with a number of its own page styles (see
7603 Document\SpecialChar menuseparator
7604 Settings\SpecialChar menuseparator
7606 \begin_inset space ~
7612 If you want to use these for the chapter pages, you have to use the command
7619 in the main text or in preamble (e.
7620 \begin_inset space \thinspace{}
7624 \begin_inset space \space{}
7631 chapterstyle{companion}
7636 \begin_layout Description
7637 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
7638 optional argument in the standard classes.
7639 With this, you can specify an alternative version of the title for the
7640 table of contents and the headers (for instance, if the title is too long).
7642 , you can do this via
7644 Insert\SpecialChar menuseparator
7646 \begin_inset space ~
7651 at the beginning of a chapter/section.
7652 Memoir features a second optional argument and thus separates the table
7653 of contents from the header.
7654 You can define three variants of a title with this: one for the main text,
7655 one for the table of contents, and one for the headers.
7657 makes these available in form of specific
7668 \begin_layout Description
7669 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
7670 of contents, the list of figures and the list of table start a new page
7672 Memoir does not follow this route.
7673 You have to insert a page break yourself, if you want to have one.
7676 \begin_layout Description
7677 Titlepage: For some unknown reason, Memoir uses pagination on the title
7678 page (in the standard classes, title pages are
7679 \begin_inset Quotes eld
7683 \begin_inset Quotes erd
7687 If you want an empty title page, type
7691 aliaspagestyle{title}{empty}
7696 \begin_layout Description
7697 Article: With the class option
7703 Document\SpecialChar menuseparator
7704 Settings\SpecialChar menuseparator
7705 Class Settings\SpecialChar menuseparator
7707 \begin_inset space ~
7712 ), you can emulate article style.
7713 That is, counters (footnotes, figures, tables etc.) will not be reset on
7714 new chapters, chapters don't start a new page (but are—in contrary to
7715 \begin_inset Quotes eld
7719 \begin_inset Quotes erd
7722 article classes—still allowed), parts, though, use their own page, as in
7726 \begin_layout Description
7727 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
7728 font commands, which have been used in the old \SpecialChar LaTeX
7730 \begin_inset space \thinspace{}
7734 \begin_inset space \space{}
7750 It produces an error and stops \SpecialChar LaTeX
7751 whenever such a command appears.
7756 reallows the commands and spits out warnings instead (which does at least
7757 not stop \SpecialChar LaTeX
7759 Since a lot of packages and particularly Bib\SpecialChar TeX
7760 style files are still using
7761 those commands, we have decided to use this option by default.
7764 \begin_layout Subsubsection
7768 \begin_layout Standard
7769 We will only describe the features supported by \SpecialChar LyX
7770 (which is not much currently).
7771 Please consult the Memoir manual
7775 \begin_layout Plain Layout
7780 \begin_layout Plain Layout
7790 \begin_inset Flex URL
7793 \begin_layout Plain Layout
7795 CTAN:/macros/latex/memoir/memman.pdf
7808 \begin_layout Description
7809 Abstract: You may wonder why an abstract is an extra feature.
7810 Well, it is in book class.
7811 Usually books don't have abstracts.
7812 Memoir, however, has.
7813 You can use it wherever and how often you like.
7816 \begin_layout Description
7817 Chapterprecis: You may know this older typesetting style: The contents of
7818 a chapter are summarized below the title and also in the table of contents
7820 \begin_inset space \thinspace{}
7824 \begin_inset space \space{}
7829 Our hero arrives in Troia; he loses some friends; he finds others
7832 Chapterprecis does exactly this.
7833 It is therefore only sensible below a chapter.
7836 \begin_layout Description
7837 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
7838 The epigraph environment provides an elegant way of typesetting such a
7840 The motto itself (text) and its (optional) author (source) are divided
7842 The author (source) can be inserted via
7844 Insert\SpecialChar menuseparator
7851 \begin_layout Description
7852 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
7853 complex figurative poems).
7855 can only support a few of them.
7856 One is poemtitle, which is a centered title for poems, which will also
7857 be added to the table of contents (verse is the standard environment for
7859 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
7861 because they have to be nested inside regular verse environments, which
7862 is not possible with \SpecialChar LyX
7866 \begin_layout Description
7867 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
7870 \begin_layout Section
7872 \change_inserted 564990737 1670439605
7876 \begin_layout Section
7878 \change_inserted 564990737 1671041968
7882 \begin_layout Subsection
7884 \change_inserted 564990737 1671041970
7890 \begin_layout Standard
7892 \change_inserted 564990737 1671041970
7903 document class for writing letters according to the
7905 Deutsches Institut für Normung
7917 ile\SpecialChar menuseparator
7919 \begin_inset space ~
7927 \begin_inset space ~
7932 offers guidance on its use.
7933 The documentation is available from
7934 \begin_inset CommandInset href
7937 target "http://mirrors.ctan.org/macros/latex/contrib/dinbrief/liesmich"
7945 \begin_layout Section
7947 \change_inserted 564990737 1670439660
7951 \begin_layout Subsection
7954 Foil\SpecialChar TeX
7958 \begin_inset CommandInset label
7967 \begin_layout Standard
7973 \begin_layout Subsubsection
7977 \begin_layout Standard
7978 This section describes how to use \SpecialChar LyX
7979 to make slides for overhead projectors.
7980 There are two document classes that can do this: the default slides class
7983 Foil\SpecialChar TeX
7987 This section documents the latter.
7990 \begin_layout Standard
7991 I'm going to say this again, nice and clear, so that there's no misunderstanding
7995 \begin_layout Standard
7996 \begin_inset VSpace bigskip
8002 \begin_layout Standard
8006 This section documents the class
8007 \begin_inset Quotes eld
8015 \begin_inset Quotes erd
8023 \begin_layout Standard
8024 \begin_inset VSpace bigskip
8030 \begin_layout Standard
8031 If you're looking for the documentation for
8032 \begin_inset Quotes eld
8040 \begin_inset Quotes erd
8044 \begin_inset space ~
8048 \begin_inset CommandInset ref
8050 reference "sec:slitex"
8055 If your machine doesn't have the
8063 installed, you'll probably have to use the default
8067 class, which isn't quite as good as
8072 \begin_layout Standard
8077 class is designed for use with version
8078 \begin_inset space ~
8086 class file which is now an integral part of \SpecialChar LaTeX2e
8090 \begin_layout Subsubsection
8094 \begin_layout Standard
8095 Obviously, to use this document class, you need to select
8106 \begin_inset space ~
8112 There are some settings in the
8115 \begin_inset space ~
8120 dialog that you should know about that are specific to this class:
8123 \begin_layout Itemize
8124 Don't change the options
8135 \begin_inset space ~
8141 They're ignored by the
8148 \begin_layout Itemize
8149 The default font size is 20
8150 \begin_inset space \thinspace{}
8153 pt with the other options being 17
8154 \begin_inset space \thinspace{}
8158 \begin_inset space \thinspace{}
8162 \begin_inset space \thinspace{}
8168 \begin_layout Itemize
8177 but all math equations are still typeset in the usual roman font.
8180 \begin_layout Itemize
8183 Foil\SpecialChar TeX
8186 supports A4 and Letter paper sizes as well as a special size for working
8188 \begin_inset space \thinspace{}
8192 It doesn't support A5, B5, legal or executive paper sizes.
8195 \begin_layout Itemize
8196 Don't bother changing the
8200 settings because they are ignored anyway.
8201 All floats appear where they are defined in the text.
8204 \begin_layout Itemize
8209 setting behaves a bit differently for this class.
8212 Foil\SpecialChar TeX
8215 provides extensive footer and header capabilities including a user-defined
8218 \begin_inset space ~
8222 \begin_inset CommandInset ref
8224 reference "sec:foilfoot"
8229 The title page is treated differently to all other pages in the document
8238 has the logo centered at the bottom of the page (if one is defined).
8239 The possible page style choices and what they do are as follows:
8243 \begin_layout Labeling
8244 \labelwidthstring MMMMMMM
8251 The final output contains no page numbers, or other headers or footers
8252 (except footnotes of course).
8256 \begin_layout Labeling
8257 \labelwidthstring MMMMMMM
8264 The final output contains page numbers centered at the bottom of the page.
8265 No other headings or footers (other than footnotes).
8268 \begin_layout Labeling
8269 \labelwidthstring MMMMMMM
8274 Page numbers in lower right corner.
8275 Additional headers and footers are also shown.
8276 This is also the default.
8279 \begin_layout Labeling
8280 \labelwidthstring MMMMMMM
8285 Gives you access to the
8289 package although its use with
8291 Foil\SpecialChar TeX
8294 is discouraged by the writer of the
8296 Foil\SpecialChar TeX
8299 package because of some potential page layout clashes.
8303 \begin_layout Paragraph
8307 \begin_layout Standard
8308 The following options may be used in the extra class options in the
8310 Document\SpecialChar menuseparator
8316 \begin_layout Labeling
8317 \labelwidthstring MMMMMMx
8322 This sets up the page layout for 7.33
8323 \begin_inset space \thinspace{}
8327 \begin_inset space \thinspace{}
8330 in paper, which is about the same aspect ratio as a 35
8331 \begin_inset space \thinspace{}
8334 mm slide, making it a bit easier to work with this medium.
8337 \begin_layout Labeling
8338 \labelwidthstring MMMMMMx
8343 Places a rule across the page below the header on every page except the
8347 \begin_layout Labeling
8348 \labelwidthstring MMMMMMx
8353 Places a rule across the page above the footer on every page except the
8357 \begin_layout Labeling
8358 \labelwidthstring MMMMMMx
8363 This is automatically set each time you create a new
8370 Foil\SpecialChar TeX
8373 to use the dvips driver to rotate those pages that are set as landscape
8377 \begin_layout Labeling
8378 \labelwidthstring MMMMMMx
8383 Simply changes the page dimensions to those of a landscape page but doesn't
8385 Thus if you use this option you need to use an external program to rotate
8386 each page or feed your paper through your printer as landscape.
8387 Note that this option effectively reverses the roles of the
8395 environments (don't worry these are described in the next section).
8398 \begin_layout Labeling
8399 \labelwidthstring MMMMMMx
8404 Equation numbers on the left.
8407 \begin_layout Labeling
8408 \labelwidthstring MMMMMMx
8413 Flush-left equations.
8416 \begin_layout Subsubsection
8417 Supported Environments
8420 \begin_layout Standard
8421 Most of the environments commonly supported in other classes are also supported
8427 There are several additional environments provided by
8429 Foil\SpecialChar TeX
8432 as well as a couple added by \SpecialChar LyX
8434 The following environments are shared with other classes:
8437 \begin_layout Standard
8438 \begin_inset Flex Multiple Columns
8441 \begin_layout Itemize
8447 \begin_layout Itemize
8453 \begin_layout Itemize
8459 \begin_layout Itemize
8465 \begin_layout Itemize
8471 \begin_layout Itemize
8478 \begin_layout Itemize
8484 \begin_layout Itemize
8490 \begin_layout Itemize
8496 \begin_layout Itemize
8502 \begin_layout Itemize
8508 \begin_layout Itemize
8514 \begin_layout Itemize
8520 \begin_layout Itemize
8526 \begin_layout Itemize
8537 \begin_layout Standard
8538 That is, all the major environments apart from the sectioning environments.
8539 Since foils are essentially self-contained sections, with a title and body,
8542 Foil\SpecialChar TeX
8545 provides specific commands for starting new foils and these are:
8548 \begin_layout Itemize
8554 \begin_layout Itemize
8560 \begin_layout Standard
8562 also provides slightly modified versions of these two environments called:
8565 \begin_layout Itemize
8571 \begin_layout Itemize
8577 \begin_layout Standard
8578 and the differences will be explained in the next section.
8581 \begin_layout Standard
8582 Since foils are often used in presenting ideas or new theorems and such
8585 Foil\SpecialChar TeX
8588 also provides a comprehensive box of goodies for presenting them:
8591 \begin_layout Standard
8592 \begin_inset Flex Multiple Columns
8595 \begin_layout Itemize
8601 \begin_layout Itemize
8607 \begin_layout Itemize
8613 \begin_layout Itemize
8619 \begin_layout Itemize
8625 \begin_layout Itemize
8631 \begin_layout Itemize
8637 \begin_layout Itemize
8643 \begin_layout Itemize
8649 \begin_layout Itemize
8655 \begin_layout Itemize
8666 \begin_layout Standard
8667 The starred versions are unnumbered while the unstarred versions are numbered.
8668 There are also two list environments added by \SpecialChar LyX
8672 \begin_layout Itemize
8678 \begin_layout Itemize
8684 \begin_layout Standard
8687 Foil\SpecialChar TeX
8690 provides some powerful header and footer capabilities that are best set
8691 in the preamble although they may be set at any point in a document.
8692 If you want to change these settings in your document the best place to
8693 do so is at the very top of a foil, i.
8694 \begin_inset space \thinspace{}
8700 \begin_inset space \space{}
8705 straight after the foilhead.
8708 \begin_layout Standard
8709 For this purpose, the following command styles are provided [
8716 \begin_layout Standard
8717 \begin_inset Flex Multiple Columns
8720 \begin_layout Itemize
8724 \begin_inset space ~
8730 \begin_layout Itemize
8736 \begin_layout Itemize
8740 \begin_inset space ~
8746 \begin_layout Itemize
8750 \begin_inset space ~
8756 \begin_layout Itemize
8760 \begin_inset space ~
8767 \begin_layout Plain Layout
8768 \begin_inset space ~
8780 \begin_layout Standard
8781 There are also a few commands provided by
8783 Foil\SpecialChar TeX
8786 that aren't directly supported by \SpecialChar LyX
8787 but I'll tell you what they do and how
8788 to use them in section
8789 \begin_inset space ~
8793 \begin_inset CommandInset ref
8795 reference "sec:unsuppfoils"
8802 \begin_layout Subsubsection
8803 Building a Set of Foils
8806 \begin_layout Standard
8807 This section will give a simple introduction to using the different environments
8808 to build a set of foils.
8809 If you want to see an example set of foils, take a look at the
8813 file you find in \SpecialChar LyX
8821 \begin_layout Paragraph
8822 Give It a Title Page
8825 \begin_layout Standard
8826 Unlike other classes that provide
8846 creates the title on a page of its own.
8847 If you leave out the
8851 environment \SpecialChar LaTeX
8852 will substitute the current date (every time you regenerate
8856 \begin_layout Paragraph
8860 \begin_layout Standard
8861 As I mentioned earlier, there are four ways of starting a new foil.
8862 For portrait foils you should use
8871 The difference between these two environments is the amount of space between
8872 the title of the foil (the foilhead) and the body of the foil.
8875 \begin_layout Standard
8876 Landscape foils are generated using the
8885 Again the only difference is the spacing between foilhead and body.
8886 Both of the short versions have 0.5
8887 \begin_inset space ~
8890 inches less separation between the foilhead and the body.
8894 \begin_layout Standard
8895 One problem with the support for landscape foils is the requirement that
8900 driver to generate the PostScript output otherwise the foils won't be rotated.
8901 It is possible to get landscape foils even if you haven't got the
8905 driver provided you can feed your foils sideways through your printer ;-)
8908 \begin_layout Paragraph
8909 Theorems, Lemmas, Proofs and more
8912 \begin_layout Standard
8913 You can't have two of the same type of these environments directly following
8915 If you use a normal paragraph break, , you will just be extending the previous
8916 environment as if you had merged the two environments together.
8917 Rather than that, you need to insert a so-called separator.
8918 Please refer to the section entitled
8929 \begin_layout Paragraph
8933 \begin_layout Standard
8934 You get all the commonly supported list styles found in other classes as
8935 well as two new ones.
8936 I'll only describe the new ones here.
8937 If you want to find out more about the other list environments check out
8943 If you intend to use itemized lists you might also want to read about the
8947 \begin_inset space ~
8951 \begin_inset space ~
8956 dialog described above in section
8957 \begin_inset space ~
8961 \begin_inset CommandInset ref
8963 reference "sec:bullet"
8970 \begin_layout Standard
8971 The two new list styles,
8979 , are designed to make it easier for you to create lists of do's and don'ts
8980 or right and wrong by providing dedicated environments that use a tick
8981 or a cross as the label of the list.
8982 These lists are in fact dedicated variants of the
8987 They do however require that you have the
8994 \begin_layout Paragraph
8998 \begin_layout Standard
9001 Foil\SpecialChar TeX
9004 redefines the floating tables and figures so that they appear exactly where
9005 they are in the text rather than pushing them to the top of the page or
9006 to some user specified location.
9007 In fact if you change the float placement settings they are simply ignored.
9010 \begin_layout Paragraph
9011 Page Headers and Footers
9012 \begin_inset CommandInset label
9021 \begin_layout Standard
9025 \begin_inset space ~
9034 are two commands used to control the left-footer text string.
9035 The first is meant to allow you to include a graphic logo on your foils
9037 \begin_inset Quotes eld
9042 Foil\SpecialChar TeX
9046 \begin_inset Quotes erd
9050 While the second is meant to provide a classification for the audience,
9054 \begin_inset space \thinspace{}
9060 \begin_inset space \space{}
9064 It is empty by default.
9067 \begin_layout Standard
9068 The remaining page corners can be filled by
9071 \begin_inset space ~
9076 (which defaults to page numbers),
9079 \begin_inset space ~
9087 \begin_inset space ~
9095 \begin_layout Subsubsection
9098 Foil\SpecialChar TeX
9102 \begin_inset CommandInset label
9104 name "sec:unsuppfoils"
9111 \begin_layout Standard
9112 All the commands mentioned below need to be set in a
9122 within another environment.
9125 \begin_layout Paragraph
9129 \begin_layout Standard
9130 All lengths are adjusted using the
9153 should be replaced by the name given to the length you want to change and
9158 is the length value.
9159 All lengths should be specified in units of length such as inches (
9171 ) or relative to some document or font-based length such as
9181 \begin_layout Standard
9182 It's possible to change the spacing between a foilhead and the body of the
9183 foil by adjusting the length specified by
9190 For example, to make
9195 \begin_inset space \space{}
9198 in closer to their bodies put the following in the preamble:
9204 foilheadskip}{-0.5in}
9207 \begin_layout Standard
9208 The spacings around floats can be adjusted by setting these lengths:
9211 \begin_layout Labeling
9212 \labelwidthstring MMMMMMMMMMM
9219 Separation between the text and the top of the float
9222 \begin_layout Labeling
9223 \labelwidthstring MMMMMMMMMMM
9230 Separation between the float and the caption
9233 \begin_layout Labeling
9234 \labelwidthstring MMMMMMMMMMM
9241 Separation between the caption and the following text
9244 \begin_layout Labeling
9245 \labelwidthstring MMMMMMMMMMM
9252 You can make the captions narrower than the surrounding text by adjusting
9254 Best done relative to
9263 \begin_layout Standard
9264 There are also several title page related lengths that you may find useful
9265 if you have a long title or several authors:
9268 \begin_layout Labeling
9269 \labelwidthstring MMMMMMMMMMM
9276 Separation from headers to
9281 \begin_layout Labeling
9282 \labelwidthstring MMMMMMMMMMM
9300 \begin_layout Labeling
9301 \labelwidthstring MMMMMMMMMMM
9315 \begin_layout Labeling
9316 \labelwidthstring MMMMMMMMMMM
9332 \begin_layout Labeling
9333 \labelwidthstring MMMMMMMMMMM
9349 \begin_layout Standard
9350 The last length related command affects all the list environments.
9361 a list environment then all the vertical spacing between the list items
9363 Note that this is a command not a length so it doesn't require
9369 like the stuff mentioned above.
9372 \begin_layout Paragraph
9376 \begin_layout Standard
9389 commands control whether the logo in the
9393 definition appear on a given page.
9400 in the preamble then none of the foils will have the logo on them.
9401 If you don't want the logo on a particular page place the
9407 directly after the foilhead of that page and the
9413 directly after the next foilhead.
9416 \begin_layout Standard
9417 If you decide to use the
9421 page style setting in the
9424 \begin_inset space ~
9429 dialog you should probably add
9439 to your preamble so headers and footers on landscape pages are correctly
9440 placed when rotated.
9441 This is due to some clashes between the page layouts provided by the
9452 \begin_layout Subsection
9459 \begin_inset CommandInset label
9468 \begin_layout Standard
9476 \begin_layout Subsubsection
9480 \begin_layout Standard
9481 This section describes how to use \SpecialChar LyX
9482 to make slides for overhead projectors.
9483 There are two document classes that can do this: the default slides class
9486 Foil\SpecialChar TeX
9490 This section documents the former.
9493 \begin_layout Standard
9494 I'm going to say this again, nice and clear, so that there's no misunderstanding
9498 \begin_layout Standard
9499 \begin_inset VSpace bigskip
9505 \begin_layout Standard
9509 This section documents the class
9510 \begin_inset Quotes eld
9518 \begin_inset Quotes erd
9526 \begin_layout Standard
9527 \begin_inset VSpace bigskip
9533 \begin_layout Standard
9534 If you're looking for the documentation for
9535 \begin_inset Quotes eld
9540 slides (Foil\SpecialChar TeX
9544 \begin_inset Quotes erd
9548 \begin_inset space ~
9552 \begin_inset CommandInset ref
9554 reference "sec:foiltex"
9564 \begin_inset Quotes eld
9569 slides (Foil\SpecialChar TeX
9573 \begin_inset Quotes erd
9576 ] is actually somewhat better than the default
9584 \begin_layout Plain Layout
9586 or so I've been told repeatedly by its advocates.
9587 Having never used it, I have no idea if this claim is true or not.
9592 which this section documents.
9595 \begin_layout Standard
9596 This class is the \SpecialChar LaTeX2e
9597 improvement of the old
9603 Every \SpecialChar LaTeX2e
9604 distribution includes this class [which I'll just refer to as
9605 \begin_inset Quotes eld
9613 \begin_inset Quotes erd
9616 from now on], so you're bound to have it.
9617 As I noted earlier, there are other classes, such as
9621 , which also produce slides for overhead projectors and do a better job
9623 However, there are some things which
9627 can do which the others can't, such as generate overlays.
9628 Read on to learn more!
9631 \begin_layout Subsubsection
9633 \begin_inset CommandInset label
9635 name "sec:slidesetup"
9642 \begin_layout Standard
9643 Obviously, to use this document class, you need to select
9644 \begin_inset Quotes eld
9652 \begin_inset Quotes erd
9655 from the class list in the
9657 Document\SpecialChar menuseparator
9661 There are some other special things you should know about this class:
9664 \begin_layout Itemize
9665 Don't bother changing the options
9670 They're not supported by the
9677 \begin_layout Itemize
9681 \begin_inset space ~
9686 behaves a bit differently for this class.
9687 The possible choices and what they do are as follows:
9691 \begin_layout Description
9696 The final output contains page numbers in the lower right corner.
9699 \begin_layout Description
9708 , but also prints out any time markers you've put in.
9709 This is the default.
9712 \begin_layout Description
9717 The final output contains no page numbers, time markers, or alignment markers.
9721 \begin_layout Itemize
9726 class has an extra option:
9732 \begin_inset Quotes eld
9740 \begin_inset Quotes erd
9743 in the extra class options.
9747 \begin_layout Standard
9748 Using this options allows you to add time markers to
9754 \begin_inset space ~
9758 \begin_inset CommandInset ref
9760 reference "sec:slideNote"
9768 \begin_layout Standard
9769 You can also use the template file
9770 \begin_inset Quotes eld
9778 \begin_inset Quotes erd
9781 to automatically set up a document to use the
9787 File\SpecialChar menuseparator
9789 \begin_inset space ~
9793 \begin_inset space ~
9798 to open your new document].
9799 The template file also contains some examples of the special paragraph
9800 environments used by this class.
9801 I'll describe those next.
9804 \begin_layout Subsubsection
9805 Paragraph Environments
9808 \begin_layout Paragraph
9809 Supported Environments
9812 \begin_layout Standard
9813 The first thing you'll notice when you start up a new
9817 document is the font size and type: it's the equivalent of the size
9818 \begin_inset Quotes eld
9826 \begin_inset Quotes erd
9832 \begin_inset space ~
9838 This is also what's used in the output.
9840 \begin_inset Quotes eld
9844 \begin_inset Quotes erd
9847 to remind you that this is a slide.
9848 Your final slides will use a larger font; ergo, you'll have less space.
9849 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
9852 \begin_layout Standard
9853 The next thing that becomes obvious is the changes to the paragraph environment
9854 pull-down box [at the far-left end of the toolbar].
9855 Most of the paragraph environments you're used to seeing are missing.
9856 There are also five new ones.
9861 class itself only supports certain paragraph environments:
9864 \begin_layout Itemize
9870 \begin_layout Itemize
9876 \begin_layout Itemize
9882 \begin_layout Itemize
9888 \begin_layout Itemize
9894 \begin_layout Itemize
9900 \begin_layout Itemize
9906 \begin_layout Itemize
9912 \begin_layout Itemize
9918 \begin_layout Itemize
9925 \begin_layout Standard
9926 All of the other standard environments, including the section-heading environmen
9927 ts, aren't used in the
9934 \begin_layout Standard
9935 On the other hand, you'll notice the following new environments:
9938 \begin_layout Itemize
9944 \begin_layout Itemize
9950 \begin_layout Itemize
9956 \begin_layout Itemize
9962 \begin_layout Itemize
9968 \begin_layout Standard
9969 These five are kind of quirky, due to a
9970 \begin_inset Quotes eld
9974 \begin_inset Quotes erd
9979 You see, \SpecialChar LyX
9980 doesn't permit you to nest any other paragraph environment into
9981 an empty environment.
9982 Now, that's fine and dandy, but it means that you wouldn't be able to start
9983 a slide with anything except plain text.
9984 To deal with this, I've performed a little
9985 \begin_inset Quotes eld
9990 \begin_inset Quotes erd
9996 \begin_layout Paragraph
9997 Quirks of the New Environments
9998 \begin_inset CommandInset label
10000 name "sec:slideQuirk"
10007 \begin_layout Standard
10008 All five of the new paragraph environments are somewhat quirky due to inherent
10009 limitiations in the current version of \SpecialChar LyX
10011 As I just mentioned, \SpecialChar LyX
10012 forbids environments that begin with another environment.
10013 To get around this, the
10017 environment isn't a paragraph environment as described in the
10025 \begin_layout Standard
10026 You should consider
10039 \begin_inset Quotes eld
10042 pseudo-environments.
10043 \begin_inset Quotes erd
10046 They look like a section heading or a
10047 \begin_inset Quotes eld
10055 \begin_inset Quotes erd
10058 but really begin a [and, if necessary, end the previous] paragraph environment.
10068 \begin_inset Quotes eld
10072 \begin_inset Quotes erd
10075 These two perform some action.
10078 \begin_layout Standard
10079 A common feature of all five environments,
10099 , is a rather long-ish label.
10100 The text following this label — ordinarily the contents of the paragraph
10101 environment — is utterly irrelevant for
10123 completely ignores it.
10124 In fact, you can leave these five environments completely empty.
10128 \begin_layout Standard
10133 to put any text after the rather long-ish label, you might want to.
10134 This could be a short description of the contents of the
10139 In that case, enter your descriptive comment and hit
10143 as you normally would.
10146 \begin_layout Standard
10147 If, on the other hand, you don't want to enter any descriptive text, you'll
10148 hit another \SpecialChar LyX
10151 , like nature, abhors a vacuum, and will not let you start a new paragraph
10152 environment until you put something in the old one.
10156 \begin_layout Itemize
10157 Start entering the text that will
10185 \begin_layout Itemize
10186 Now move to the beginning of that paragraph.
10190 \begin_layout Itemize
10199 \begin_layout Itemize
10200 Finally, change this new, empty paragraph to a
10224 \begin_layout Standard
10225 Some future version of \SpecialChar LyX
10226 will, hopefully, resolve this quirkiness\SpecialChar ldots
10230 \begin_layout Subsubsection
10231 Making a Presentation with
10244 \begin_layout Paragraph
10252 \begin_layout Standard
10253 If you're expecting this section to teach you how to actually make a presentatio
10254 n, you'll be sorely disappointed.
10255 Naturally, I'll describe all of the ways the
10259 class can assist you in preparing the materials for a presentation.
10260 Filling in the contents, however, is up to you.
10265 the \SpecialChar LyX
10269 \begin_layout Standard
10274 environment [in the manner described in section
10275 \begin_inset space ~
10279 \begin_inset CommandInset ref
10281 reference "sec:slideQuirk"
10285 ] tells \SpecialChar LyX
10286 to begin a new slide [duh].
10287 The label for this environment/
10288 \begin_inset Quotes erd
10292 \begin_inset Quotes erd
10296 \begin_inset Quotes eld
10300 \begin_inset Quotes erd
10303 in cool blue, followed by the label,
10304 \begin_inset Quotes eld
10308 \begin_inset Quotes erd
10312 Any text or paragraph environments that follow this one go on the new slide.
10316 \begin_layout Standard
10317 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
10319 (this can be specified in the
10324 In fact, you'll want to, once you finish entering the contents of one slide.
10325 If you've entered more text than can physically fit on a slide, the extra
10326 overflows onto a new slide.
10327 I don't recommend doing this, however, since the overflow slide won't have
10328 any page number on it.
10329 Furthermore, it may interfere with any
10333 you've made to accompany the oversized
10340 \begin_layout Standard
10349 environments work the same way as the
10354 They both create an
10355 \begin_inset Quotes eld
10359 \begin_inset Quotes erd
10362 followed by a label [
10363 \begin_inset Quotes eld
10367 \begin_inset Quotes erd
10371 \begin_inset Quotes eld
10375 \begin_inset Quotes erd
10379 The color is a stunning magenta instead of blue, and the
10380 \begin_inset Quotes eld
10384 \begin_inset Quotes erd
10387 will look different, in style and in length.
10388 The label fonts of all three also differ from one another.
10391 \begin_layout Standard
10396 , if the contents of a
10404 exceed the physical size of a slide or sheet of paper, the extra will overflow
10406 Again, you should avoid this.
10407 It defeats the whole purpose of
10418 \begin_layout Paragraph
10428 \begin_layout Standard
10433 is a slide that sits atop another slide.
10434 Perhaps you wish to discuss a figure on the main
10438 before displaying the text associated with it.
10439 One way to accomplish this is tape a flap of dark paper over the part of
10444 you want to display later.
10445 This method fails, however, if you wish to overlap one graph with another,
10447 You would then have to fumble while speaking to align the two separate,
10452 s to align the two graphs.
10457 environment in both cases makes life much easier.
10460 \begin_layout Standard
10465 receives the page number of its
10466 \begin_inset Quotes eld
10470 \begin_inset Quotes erd
10478 \begin_inset Quotes eld
10486 \begin_inset Quotes erd
10493 \begin_layout Plain Layout
10494 Presumably, mutliple
10499 \begin_inset Quotes eld
10507 \begin_inset Quotes erd
10511 \begin_inset Quotes eld
10519 \begin_inset Quotes erd
10523 \begin_inset Quotes eld
10531 \begin_inset Quotes erd
10535 \begin_inset space ~
10538 appended to the page number of the parent
10548 Clearly, you want the contents of both the
10556 to each fit on a single physical slide! You should probably consider an
10562 \begin_inset Quotes eld
10566 \begin_inset Quotes erd
10574 Indeed, the \SpecialChar LyX
10579 class provides a visual cue for this: the label at the start of an
10583 is shorter than that at the start of a
10588 Lastly, when you generate printable output, you'll find alignment markers
10589 in all four corners of both the
10593 page and its parent
10598 These will assist you in lining up the two physical slides.
10601 \begin_layout Standard
10602 The major problem in overlaying two slides is aligning the contents of the
10603 two transparencies.
10604 How much space should you leave for that graph on the second slide? Worse
10605 still, what if you want a graph and a sentence on second slide, but there
10606 is text on the main transparency that goes in between them? You could try
10607 and insert vertical space of the right size.
10608 The better way is to use
10619 \begin_layout Standard
10620 As their names imply,
10628 are two command-like paragraph environments that make all subsequent text
10629 invisible and visible, respectively.
10631 \begin_inset space ~
10635 \begin_inset CommandInset ref
10637 reference "sec:slideQuirk"
10641 that you don't place anything
10645 these two environments, however.
10650 , it inserts a centered, sky-blue label into the page reading
10651 \begin_inset Quotes eld
10654 <Invisible Text Follows>
10655 \begin_inset Quotes erd
10659 For paragraphs following this label, the parts of the
10667 ; it doesn't matter which] where they would be contain instead blank space.
10671 \begin_layout Standard
10676 , the corresponding centered label is
10677 \begin_inset Quotes eld
10680 <Visible Text Follows>
10681 \begin_inset Quotes erd
10685 Paragraphs following this label behave normally.
10686 Note that the beginning of a new
10698 automatically shuts off an
10703 It's therefore not necessary to use
10714 \begin_layout Standard
10715 By now, it should be obvious how to create overlay transparencies using
10716 the proper combination of
10735 \begin_layout Enumerate
10740 , including everything that will appear on it, whether on the main slide
10748 \begin_layout Enumerate
10749 Before each figure or paragraph that will appear only on the
10758 If necessary, insert a
10762 environment after the
10769 \begin_layout Enumerate
10774 immediately following the
10781 \begin_layout Enumerate
10782 Copy the contents of this
10793 \begin_layout Enumerate
10798 , change all of the
10809 \begin_layout Standard
10811 You've just made an
10818 \begin_layout Standard
10819 There's one problem with the way I've designed the \SpecialChar LyX
10824 class: you can't make text in the middle of a paragraph invisible, nor
10825 make text in the middle of an invisible paragraph visible again.
10826 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
10831 \begin_layout Plain Layout
10832 The commands of interest are:
10835 \begin_layout Itemize
10840 invisible \SpecialChar ldots
10844 \begin_layout Itemize
10849 visible \SpecialChar ldots
10853 \begin_layout Plain Layout
10855 and need to be marked as \SpecialChar TeX
10858 \begin_inset Quotes eld
10862 \begin_inset Quotes erd
10865 you wish to change goes in between the brackets [and after the
10878 If you don't know how to mark text as \SpecialChar TeX
10879 , see the appropriate section of
10892 \begin_layout Paragraph
10902 \begin_inset CommandInset label
10904 name "sec:slideNote"
10911 \begin_layout Standard
10920 is associated with a
10921 \begin_inset Quotes eld
10925 \begin_inset Quotes erd
10933 Here, too, the \SpecialChar LyX
10938 class provides visual cues.
10943 is shorter than that of a
10947 [yet longer than that of an
10951 ] and, like the label of an
10955 is shockingly magenta.
10956 Additionally, the printed
10960 has the page number of its
10961 \begin_inset Quotes eld
10965 \begin_inset Quotes erd
10973 \begin_inset Quotes eld
10981 \begin_inset Quotes erd
10985 \begin_inset Quotes eld
10993 \begin_inset Quotes erd
10997 \begin_inset Quotes eld
11005 \begin_inset Quotes erd
11009 You can have multiple
11013 s associated with a single
11025 , you'll probably want to break up long
11029 s so that they fit on a single sheet of paper.
11032 \begin_layout Standard
11037 is obvious: it contains anything additional you might want to say about
11043 It could also be used as a sheet of reminders for a particular
11048 In the case of the latter, you might want to make use of time markers.
11049 Currently, the \SpecialChar LyX
11055 \begin_inset Quotes eld
11059 \begin_inset Quotes erd
11062 support for time markers, a
11064 Sli\SpecialChar TeX
11068 So, you'll have to resort to using the \SpecialChar LaTeX
11072 \begin_layout Standard
11073 To use time markers, you'll need to specify the extra class option
11074 \begin_inset Quotes eld
11082 \begin_inset Quotes erd
11086 \begin_inset space ~
11090 \begin_inset CommandInset ref
11092 reference "sec:slidesetup"
11097 This option turns on timing marks, which will appear in the lower-left-hand
11103 To set what appears in the time marker, you use the \SpecialChar LaTeX
11105 \begin_inset Quotes eld
11115 \begin_inset Quotes erd
11119 \begin_inset Quotes eld
11129 \begin_inset Quotes erd
11133 The arguments of both commands are time measured in seconds.
11135 \begin_inset Quotes eld
11145 \begin_inset Quotes erd
11148 sets the time marker to a given time.
11150 \begin_inset Quotes eld
11160 \begin_inset Quotes erd
11163 increments the time marker by the specified amount.
11164 Using time markers and
11168 s in this fashion, you can remind yourself how much time to spend on a particula
11176 \begin_layout Standard
11177 There's one last feature to describe.
11178 Clearly, you'd like to print out all of your
11186 s on transparencies while printing all of your
11203 with which it is associated.
11204 What's a person to do?
11207 \begin_layout Standard
11208 Luckily, there are two \SpecialChar LaTeX
11209 commands that allow you to select what to print
11211 Both must be placed into the preamble of your document.
11213 \begin_inset Quotes eld
11225 \begin_inset Quotes erd
11228 will cause the output to contain only the
11237 Correspondingly, the command
11238 \begin_inset Quotes eld
11250 \begin_inset Quotes erd
11253 prevents the output of anything but
11258 I'd advise placing both commands in the preamble and initially comment
11260 You can then preview your entire presentation as you write.
11261 When you're done writing, you can then uncomment one of the two to select
11262 what you want to print.
11263 I like to uncomment
11264 \begin_inset Quotes eld
11276 \begin_inset Quotes erd
11279 , print to a file with
11280 \begin_inset Quotes eld
11288 \begin_inset Quotes erd
11291 in its name, comment it back out, then uncomment
11292 \begin_inset Quotes eld
11304 \begin_inset Quotes erd
11308 \begin_inset Quotes eld
11316 \begin_inset Quotes erd
11320 I can then send either file to a printer, loading transparencies or plain
11321 paper as appropriate.
11324 \begin_layout Standard
11325 You can also provide other arguments to the
11326 \begin_inset Quotes eld
11336 \begin_inset Quotes erd
11340 \begin_inset Quotes eld
11350 \begin_inset Quotes erd
11354 See a good \SpecialChar LaTeX
11358 \begin_layout Subsubsection
11363 Class Template File
11366 \begin_layout Standard
11367 I have also provided a template file,
11368 \begin_inset Quotes eld
11376 \begin_inset Quotes erd
11384 To use it, begin your new presentation with
11386 File\SpecialChar menuseparator
11388 \begin_inset space ~
11392 \begin_inset space ~
11398 Your new \SpecialChar LyX
11399 presentation file will contain an example
11420 additionally contain an example of the use of
11429 Lastly, the preamble will contain:
11432 \begin_layout LyX-Code
11433 % Uncomment to print out only slides and overlays
11436 \begin_layout LyX-Code
11440 \begin_layout LyX-Code
11446 \begin_inset Newline newline
11452 \begin_layout LyX-Code
11453 % Uncomment to print out only notes
11456 \begin_layout LyX-Code
11460 \begin_layout LyX-Code
11468 \begin_layout Standard
11469 One final thing: I created this class to support the \SpecialChar LaTeX2e
11471 \begin_inset Quotes eld
11476 Sli\SpecialChar TeX
11480 \begin_inset Quotes erd
11483 class, one of the built-in \SpecialChar LaTeX2e
11485 Neither I nor the rest of the \SpecialChar LyX
11486 Team endorse or oppose the use of this built-in
11488 It's here if you want it or need it.
11489 There exist other \SpecialChar LaTeX2e
11490 classes for creating presentations, such as the
11495 \begin_inset space ~
11499 \begin_inset CommandInset ref
11501 reference "sec:foiltex"
11506 \begin_inset Quotes eld
11514 \begin_inset Quotes erd
11517 package [present on some \SpecialChar TeX
11519 The latter is not yet supported under \SpecialChar LyX
11524 \begin_layout Plain Layout
11525 Perhaps you can take on the task\SpecialChar ldots
11531 I know nothing about these other classes.
11532 Try them out to see what sort of alternative they provide.
11535 \begin_layout Section
11537 \change_inserted 564990737 1670439661
11541 \begin_layout Subsection
11543 \change_inserted 564990737 1670439661
11547 \begin_layout Standard
11549 \change_inserted 564990737 1670439661
11558 document class for preparing reports.
11563 document class, this provides parts, chapters and sections but does not
11564 provide the paragraph styles needed for a book; like the
11568 document class, it provides the abstract paragraph style.
11569 In two-sided mode, it does not start a new chapter on the right hand page.
11572 \begin_layout Standard
11574 \change_inserted 564990737 1670439674
11579 document classes are described in the Collections (section
11580 \begin_inset space ~
11584 \begin_inset CommandInset ref
11586 reference "sec:Collections"
11593 \begin_layout Section
11595 \change_inserted 564990737 1670439674
11599 \begin_layout Subsection
11603 \begin_layout Standard
11609 \begin_layout Subsubsection
11613 \begin_layout Standard
11614 Broadway is for writing plays.
11615 The format is more decorative than Hollywood, and much less standardized.
11616 This format should be suitable for workshops.
11619 \begin_layout Subsubsection
11623 \begin_layout Standard
11624 The same as in Hollywood.
11627 \begin_layout Subsubsection
11631 \begin_layout Standard
11636 names as labels then cross-reference the label to insert the name.
11637 The cross-reference dialog will show the current cast of characters.
11640 \begin_layout Subsubsection
11641 Paper size and Margins
11644 \begin_layout Standard
11645 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
11648 \begin_layout Subsubsection
11652 \begin_layout Standard
11653 The following environments are available.
11654 You can use broadway.bind to get the bind keys shown at the right.
11657 \begin_layout Itemize
11661 \begin_inset Newline newline
11666 You should not have to use this, but it is here for anything that does not
11670 \begin_layout Itemize
11674 \begin_inset space \hfill{}
11678 \begin_inset Newline newline
11683 Used to describe stage setting and the action.
11684 First use of speaker names in all CAPs.
11687 \begin_layout Itemize
11691 \begin_inset space \hfill{}
11695 \begin_inset Newline newline
11700 Automatically numbered.
11701 On screen it will be arabic, but will print as Roman.
11704 \begin_layout Itemize
11708 \begin_inset space \hfill{}
11712 \begin_inset Newline newline
11722 It is just centered text.
11725 \begin_layout Itemize
11729 \begin_inset space \hfill{}
11733 \begin_inset Newline newline
11738 Not automatically numbered.
11739 You supply the number.
11740 This is because I couldn't figure out how.
11743 \begin_layout Itemize
11747 \begin_inset space \hfill{}
11751 \begin_inset Newline newline
11756 A special case of Narrative to describe the setting and action as the curtain
11760 \begin_layout Itemize
11764 \begin_inset space \hfill{}
11768 \begin_inset Newline newline
11773 The speaker's (actor's) title, centered in all CAPS.
11776 \begin_layout Itemize
11780 \begin_inset space \hfill{}
11784 \begin_inset Newline newline
11789 Instructions to the speaker.
11790 The parentheses are automatically inserted.
11791 The ( will appear on screen, but both will be in the printed play.
11792 This environment is only used within
11799 \begin_layout Itemize
11803 \begin_inset space \hfill{}
11807 \begin_inset Newline newline
11812 What the Speaker says.
11815 \begin_layout Itemize
11819 \begin_inset space \hfill{}
11823 \begin_inset Newline newline
11828 The curtain comes down.
11831 \begin_layout Itemize
11835 \begin_inset space \hfill{}
11841 \begin_layout Itemize
11845 \begin_inset space \hfill{}
11851 \begin_layout Itemize
11855 \begin_inset space \hfill{}
11861 \begin_layout Standard
11865 \begin_layout Subsection
11866 Hollywood (Hollywood spec scripts)
11869 \begin_layout Standard
11875 \begin_layout Subsubsection
11879 \begin_layout Standard
11880 Getting the format of a Hollywood script right is a
11881 \begin_inset Quotes eld
11885 \begin_inset Quotes erd
11888 It is designed to make the readers focus on content and to be easy and
11889 familiar for the actors to read.
11890 Each page of a script should be one minute of film.
11891 Nothing goes in a script that you cannot see or hear on screen.
11892 The courier 12 pt font should be used throughout.
11896 \begin_layout Subsubsection
11900 \begin_layout Standard
11901 Speakers' lines should NEVER break in mid-sentence.
11902 If a speaker's lines continue over a page break, repeat the
11906 title followed by (Cont'd).
11909 \begin_layout Subsubsection
11913 \begin_layout Standard
11918 names as labels then cross-reference the label to insert the name.
11919 The cross-reference dialog will show the current cast of characters.
11920 You can use this to insert the speaker name in narratives also.
11923 \begin_layout Subsubsection
11924 Paper size and Margins
11927 \begin_layout Standard
11928 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
11931 \begin_layout Subsubsection
11935 \begin_layout Standard
11936 The following environments are available.
11937 You can use hollywood.bind to get the bind keys shown at the right.
11940 \begin_layout Itemize
11944 \begin_inset Newline newline
11949 Used where nothing else works.
11953 \begin_layout Itemize
11959 \begin_inset space \hfill{}
11967 \begin_inset Newline newline
11970 Usually followed by something like
11971 \begin_inset Quotes eld
11974 on Sally waking up.
11975 \begin_inset Quotes erd
11981 \begin_layout Itemize
11985 \begin_inset space \hfill{}
11989 \begin_inset Newline newline
11994 Introduces a new INTERIOR camera set-up.
11995 Always followed by DAY or NIGHT, or something similar to define the lighting
11997 Everthing on this line in CAPS.
12000 \begin_layout Itemize
12004 \begin_inset space \hfill{}
12008 \begin_inset Newline newline
12013 Introduces a new EXTERIOR camera set-up.
12014 Everthing on this line in CAPS.
12017 \begin_layout Itemize
12021 \begin_inset space \hfill{}
12025 \begin_inset Newline newline
12030 The character speaking.
12033 \begin_layout Itemize
12037 \begin_inset space \hfill{}
12041 \begin_inset Newline newline
12046 Instructions to the speaker.
12047 The () are automatically inserted.
12050 \begin_layout Itemize
12054 \begin_inset space \hfill{}
12058 \begin_inset Newline newline
12070 \begin_layout Itemize
12074 \begin_inset space \hfill{}
12078 \begin_inset Newline newline
12083 Camera movement instruction.
12085 \begin_inset space \thinspace{}
12089 \begin_inset space \space{}
12095 \begin_layout Itemize
12099 \begin_inset space \hfill{}
12105 \begin_layout Itemize
12109 \begin_inset space \hfill{}
12115 \begin_layout Itemize
12119 \begin_inset space \hfill{}
12125 \begin_layout Itemize
12129 \begin_inset space \hfill{}
12135 \begin_layout Subsubsection
12139 \begin_layout Itemize
12143 \begin_layout Itemize
12147 \begin_layout Itemize
12149 \begin_inset space \thinspace{}
12156 \begin_layout Itemize
12161 \begin_layout Itemize
12162 PAN — camera movement
12165 \begin_layout Itemize
12166 INSERT — cut to close-up of
12169 \begin_layout Chapter
12171 \change_inserted 564990737 1671185876
12175 \begin_layout Section
12176 Multiple Text Columns
12179 \begin_layout Standard
12180 This feature is independent of the option
12182 Two-column document
12184 in the document settings under
12189 If you want to have 2
12190 \begin_inset space ~
12193 columns for the whole document, it is recommended to use the
12195 Two-column document
12198 For all other cases use this feature.
12201 \begin_layout Standard
12202 To use multiple text columns in your document, you have to load the module
12209 Document\SpecialChar menuseparator
12210 Settings\SpecialChar menuseparator
12213 ) and must have the \SpecialChar LaTeX
12215 \begin_inset Flex Code
12218 \begin_layout Plain Layout
12227 \begin_layout Standard
12228 Footnotes within multiple columns will be placed at the bottom of the page
12229 and not under each column.
12230 Within the different columns you can use everything, with the limitation
12231 that for floats you need to use the float option
12238 \begin_layout Subsection
12242 \begin_layout Standard
12243 If you want to have 2
12244 \begin_inset space ~
12247 columns in your text, insert a multicolumn inset via the menu
12249 Insert\SpecialChar menuseparator
12251 \begin_inset space ~
12254 Insets\SpecialChar menuseparator
12256 \begin_inset space ~
12261 where the columns should start.
12262 Write all text that should be printed in 2
12263 \begin_inset space ~
12266 columns into this inset.
12269 \begin_layout Standard
12270 Here is an example:
12273 \begin_layout Standard
12275 \begin_inset Flex Multiple Columns
12278 \begin_layout Plain Layout
12283 The Adventure of the Empty House
12286 \begin_inset Newline newline
12289 by Sir Arthur Conan Doyle
12292 \begin_layout Plain Layout
12295 It was in the spring of the year 1894 that all London was interested, and
12296 the fashionable world dismayed, by the murder of the Honourable Ronald
12297 Adair under most unusual and inexplicable circumstances.
12298 The public has already learned those particulars of the crime which came
12299 out in the police investigation, but a good deal was suppressed upon that
12300 occasion, since the case for the prosecution was so overwhelmingly strong
12301 that it was not necessary to bring forward all the facts.
12302 Only now, at the end of nearly ten years, am I allowed to supply those
12303 missing links which make up the whole of that remarkable chain.
12304 The crime was of interest in itself, but that interest was as nothing to
12305 me compared to the inconceivable sequel, which afforded me the greatest
12306 shock and surprise of any event in my adventurous life.
12307 Even now, after this long interval, I find myself thrilling as I think
12308 of it, and feeling once more that sudden flood of joy, amazement, and increduli
12309 ty which utterly submerged my mind.
12310 Let me say to that public, which has shown some interest in those glimpses
12311 which I have occasionally given them of the thoughts and actions of a very
12312 remarkable man, that they are not to blame me if I have not shared my knowledge
12313 with them, for I should have considered it my first duty to do so, had
12314 I not been barred by a positive prohibition from his own lips, which was
12315 only withdrawn upon the third of last month.
12323 \begin_layout Standard
12324 To get 3 or more columns, set the cursor into the multicolumn inset and
12327 Insert\SpecialChar menuseparator
12329 \begin_inset space ~
12333 \begin_inset space ~
12339 The number of the desired columns is written into that inset (for 3
12340 \begin_inset space ~
12344 \begin_inset Quotes eld
12348 \begin_inset Quotes erd
12352 \begin_inset Newline newline
12355 Here is an example with 3
12356 \begin_inset space ~
12362 \begin_layout Standard
12363 \begin_inset Flex Multiple Columns
12366 \begin_layout Plain Layout
12369 \begin_inset Argument 1
12372 \begin_layout Plain Layout
12379 It can be imagined that my close intimacy with Sherlock Holmes had interested
12380 me deeply in crime, and that after his disappearance I never failed to
12381 read with care the various problems which came before the public.
12382 And I even attempted, more than once, for my own private satisfaction,
12383 to employ his methods in their solution, though with indifferent success.
12384 There was none, however, which appealed to me like this tragedy of Ronald
12386 As I read the evidence at the inquest, which led up to a verdict of willful
12387 murder against some person or persons unknown, I realized more clearly
12388 than I had ever done the loss which the community had sustained by the
12389 death of Sherlock Holmes.
12390 There were points about this strange business which would, I was sure,
12391 have specially appealed to him, and the efforts of the police would have
12392 been supplemented, or more probably anticipated, by the trained observation
12393 and the alert mind of the first criminal agent in Europe.
12394 All day, as I drove upon my round, I turned over the case in my mind and
12395 found no explanation which appeared to me to be adequate.
12396 At the risk of telling a twice-told tale, I will recapitulate the facts
12397 as they were known to the public at the conclusion of the inquest.
12405 \begin_layout Standard
12406 You can have up to 10
12407 \begin_inset space ~
12410 columns if you want to, but that might not be very pleasant for the readers
12414 \begin_layout Standard
12415 \begin_inset Newpage newpage
12421 \begin_layout Subsection
12422 Columns inside Columns
12425 \begin_layout Standard
12426 You can also have columns inside columns:
12429 \begin_layout Standard
12430 \begin_inset Flex Multiple Columns
12433 \begin_layout Plain Layout
12436 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
12437 at that time governor of one of the Australian colonies.
12438 Adair's mother had returned from Australia to undergo the operation for
12439 cataract, and she, her son Ronald, and her daughter Hilda were living together
12443 \begin_layout Plain Layout
12444 \begin_inset Flex Multiple Columns
12447 \begin_layout Plain Layout
12450 The youth moved in the best society
12451 \begin_inset space ~
12454 – had, so far as was known, no enemies and no particular vices.
12455 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
12456 had been broken off by mutual consent some months before, and there was
12457 no sign that it had left any very profound feeling behind it.
12458 For the rest {sic} the man's life moved in a narrow and conventional circle,
12459 for his habits were quiet and his nature unemotional.
12460 Yet it was upon this easy-going young aristocrat that death came, in most
12461 strange and unexpected form, between the hours of ten and eleven-twenty
12462 on the night of March 30, 1894.
12470 \begin_layout Plain Layout
12473 Ronald Adair was fond of cards
12474 \begin_inset space ~
12477 – playing continually, but never for such stakes as would hurt him.
12478 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
12479 It was shown that, after dinner on the day of his death, he had played
12480 a rubber of whist at the latter club.
12481 He had also played there in the afternoon.
12486 The evidence of those who had played with him
12487 \begin_inset space ~
12491 Murray, Sir John Hardy, and Colonel Moran
12492 \begin_inset space ~
12495 – showed that the game was whist, and that there was a fairly equal fall
12497 Adair might have lost five pounds, but not more.
12498 His fortune was a considerable one, and such a loss could not in any way
12500 He had played nearly every day at one club or other, but he was a cautious
12501 player, and usually rose a winner.
12502 It came out in evidence that, in partnership with Colonel Moran, he had
12503 actually won as much as four hundred and twenty pounds in a sitting, some
12504 weeks before, from Godfrey Milner and Lord Balmoral.
12505 So much for his recent history as it came out at the inquest.
12513 \begin_layout Subsection
12517 \begin_layout Standard
12518 The examples in this section show some more special features of multiple
12522 \begin_layout Standard
12523 For more features of multiple columns, have a look at the
12524 \begin_inset CommandInset href
12526 name "documentation"
12527 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
12532 of the \SpecialChar LaTeX
12534 \begin_inset Flex Code
12537 \begin_layout Plain Layout
12546 \begin_layout Subsubsection
12550 \begin_layout Standard
12551 To add a preface text for multiple columns, set the cursor into the multicolumn
12552 inset and use the menu
12554 Insert\SpecialChar menuseparator
12558 Write your preface text into that inset.
12559 \begin_inset Newline newline
12562 This is an example with some preface text:
12565 \begin_layout Standard
12566 \begin_inset VSpace bigskip
12572 \begin_layout Standard
12573 \begin_inset Flex Multiple Columns
12576 \begin_layout Plain Layout
12577 \begin_inset Argument 2
12580 \begin_layout Plain Layout
12581 And the story continues and continues and continues and continues\SpecialChar ldots
12589 On the evening of the crime, he returned from the club exactly at ten.
12590 His mother and sister were out spending the evening with a relation.
12591 The servant deposed that she heard him enter the front room on the second
12592 floor, generally used as his sitting-room.
12593 She had lit a fire there, and as it smoked she had opened the window.
12594 No sound was heard from the room until eleven-twenty, the hour of the return
12595 of Lady Maynooth and her daughter.
12596 Desiring to say good-night, she attempted to enter her son's room.
12597 The door was locked on the inside, and no answer could be got to their
12598 cries and knocking.
12599 Help was obtained, and the door forced.
12600 The unfortunate young man was found lying near the table.
12601 His head had been horribly mutilated by an expanding revolver bullet, but
12602 no weapon of any sort was to be found in the room.
12610 \begin_layout Standard
12611 You can also use a section heading as the preface if you use a section command
12612 as \SpecialChar TeX
12614 For example the command
12617 \begin_layout LyX-Code
12620 subsection{subsection title}
12623 \begin_layout Standard
12624 creates a subsection.
12625 In this example the preface is a subsubsection:
12628 \begin_layout Standard
12629 \begin_inset Flex Multiple Columns
12632 \begin_layout Plain Layout
12633 \begin_inset Argument 2
12636 \begin_layout Plain Layout
12640 \begin_layout Plain Layout
12649 This is a subsubsection heading as a preface
12653 \begin_layout Plain Layout
12667 A minute examination of the circumstances served only to make the case more
12669 In the first place, no reason could be given why the young man should have
12670 fastened the door upon the inside.
12671 There was the possibility that the murderer had done this, and had afterwards
12672 escaped by the window.
12673 The drop was at least twenty feet, however, and a bed of crocuses in full
12675 Neither the flowers nor the earth showed any sign of having been disturbed,
12676 nor were there any marks upon the narrow strip of grass which separated
12677 the house from the road.
12678 Apparently, therefore, it was the young man himself who had fastened the
12680 But how did he come by his death? No one could have climbed up to the window
12681 without leaving traces.
12682 Suppose a man had fired through the window, he would indeed be a remarkable
12683 shot who could with a revolver inflict so deadly a wound.
12684 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
12685 a hundred yards of the house.
12686 No one had heard a shot.
12694 \begin_layout Standard
12695 If there is less vertical space than 6
12696 \begin_inset space ~
12699 text lines is left on the page at the beginning of the multiple columns,
12700 a page break will be inserted before the multiple columns.
12701 Depending on the number of lines of the preface text, you might want to
12703 This is done by setting the cursor into the mulitcolumn inset behind the
12704 preface (if there is any) and using the menu
12706 Insert\SpecialChar menuseparator
12708 \begin_inset space ~
12712 \begin_inset space ~
12716 \begin_inset space ~
12722 Insert into that inset the amount of space like e.
12723 \begin_inset space \thinspace{}
12727 \begin_inset space \space{}
12731 \begin_inset Quotes eld
12735 \begin_inset Quotes erd
12739 \begin_inset Newline newline
12742 In this example the space is set to 7
12743 \begin_inset space ~
12746 text lines by using
12747 \begin_inset Flex Code
12750 \begin_layout Plain Layout
12759 \begin_inset Flex Code
12762 \begin_layout Plain Layout
12770 needs to be inserted as \SpecialChar TeX
12774 \begin_layout Standard
12775 \begin_inset Flex Multiple Columns
12778 \begin_layout Plain Layout
12779 \begin_inset Argument 3
12782 \begin_layout Plain Layout
12787 \begin_layout Plain Layout
12803 On the evening of the crime, he returned from the club exactly at ten.
12804 His mother and sister were out spending the evening with a relation.
12805 The servant deposed that she heard him enter the front room on the second
12806 floor, generally used as his sitting-room.
12807 She had lit a fire there, and as it smoked she had opened the window.
12808 No sound was heard from the room until eleven-twenty, the hour of the return
12809 of Lady Maynooth and her daughter.
12810 Desiring to say good-night, she attempted to enter her son's room.
12811 The door was locked on the inside, and no answer could be got to their
12812 cries and knocking.
12813 Help was obtained, and the door forced.
12814 The unfortunate young man was found lying near the table.
12815 His head had been horribly mutilated by an expanding revolver bullet, but
12816 no weapon of any sort was to be found in the room.
12824 \begin_layout Subsubsection
12828 \begin_layout Standard
12829 The amount of space before and after multiple columns can be changed by
12830 changing the length
12831 \begin_inset Flex Code
12834 \begin_layout Plain Layout
12843 For example the command
12846 \begin_layout LyX-Code
12854 \begin_layout Standard
12855 in \SpecialChar TeX
12856 Code changes its value to 3
12857 \begin_inset space \thinspace{}
12861 The change must be made before the multiple columns' start.
12862 The predefined value is 13
12863 \begin_inset space \thinspace{}
12869 \begin_layout Standard
12871 \begin_inset Flex Code
12874 \begin_layout Plain Layout
12883 \begin_inset space \thinspace{}
12889 \begin_layout Standard
12893 \begin_layout Plain Layout
12899 multicolsep}{2.5cm}
12907 \begin_layout Standard
12908 \begin_inset Flex Multiple Columns
12911 \begin_layout Plain Layout
12914 All day I turned these facts over in my mind, endeavouring to hit upon some
12915 theory which could reconcile them all, and to find that line of least resistanc
12916 e which my poor friend had declared to be the starting-point of every investigat
12918 I confess that I made little progress.
12919 In the evening I strolled across the Park, and found myself about six o'clock
12920 at the Oxford Street end of Park Lane.
12921 A group of loafers upon the pavements, all staring up at a particular window,
12922 directed me to the house which I had come to see.
12923 A tall, thin man with coloured glasses, whom I strongly suspected of being
12924 a plain-clothes detective, was pointing out some theory of his own, while
12925 the others crowded round to listen to what he said.
12926 I got as near him as I could, but his observations seemed to me to be absurd,
12927 so I withdrew again in some disgust.
12928 As I did so I struck against an elderly, deformed man, who had been behind
12929 me, and I knocked down several books which he was carrying.
12937 \begin_layout Standard
12938 \begin_inset Note Greyedout
12941 \begin_layout Plain Layout
12946 The values you set with
12947 \begin_inset Flex Code
12950 \begin_layout Plain Layout
12958 will be used for all following multiple columns until you change them again.
12966 \begin_layout Standard
12970 \begin_layout Plain Layout
12982 \begin_inset Note Note
12985 \begin_layout Plain Layout
12986 go back to the default
12994 \begin_layout Standard
12995 \begin_inset Newpage newpage
13001 \begin_layout Subsubsection
13005 \begin_layout Standard
13006 A column break can be forced by inserting the command
13007 \begin_inset Flex Code
13010 \begin_layout Plain Layout
13018 as \SpecialChar TeX
13019 Code to that position in the text where the column should be broken.
13020 Note that this leads in most cases to whitespace in the text.
13021 \begin_inset Newline newline
13024 Here is an example:
13027 \begin_layout Standard
13028 \begin_inset Flex Multiple Columns
13031 \begin_layout Plain Layout
13034 \begin_inset Quotes eld
13037 You're surprised to see me, sir,
13038 \begin_inset Quotes erd
13041 said he, in a strange, croaking voice.
13044 \begin_layout Plain Layout
13047 I acknowledged that I was.
13050 \begin_layout Plain Layout
13053 \begin_inset Quotes eld
13056 Well, I've a conscience, sir, and when I chanced to see you go into this
13057 house, as I came hobbling after you, I thought to myself, I'll just step
13058 in and see that kind gentleman, and tell him that if I was a bit gruff
13059 in my manner there was not any harm meant, and that I am much obliged to
13060 him for picking up my books.
13061 \begin_inset Quotes erd
13067 \begin_layout Plain Layout
13070 \begin_inset Quotes eld
13073 You make too much of a trifle,
13074 \begin_inset Quotes erd
13079 \begin_inset Quotes eld
13082 May I ask how you knew who I was?
13083 \begin_inset Quotes erd
13086 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
13090 \begin_layout Plain Layout
13102 \begin_layout Plain Layout
13105 \begin_inset Quotes eld
13108 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
13109 you'll find my little bookshop at the corner of Church Street, and very
13110 happy to see you, I am sure.
13111 Maybe you collect yourself, sir.
13115 \begin_inset space ~
13129 \begin_inset space ~
13132 – a bargain, every one of them.
13133 With five volumes you could just fill that gap on that second shelf.
13134 It looks untidy, does it not, sir?
13135 \begin_inset Quotes erd
13146 \begin_layout Subsubsection
13150 \begin_layout Standard
13151 The width of the columns is automatically calculated, but you can modify
13152 the space between the columns.
13153 This is done by changing the length
13154 \begin_inset Flex Code
13157 \begin_layout Plain Layout
13166 Its predefined value is 10
13167 \begin_inset space \thinspace{}
13171 Here is an example where
13172 \begin_inset Flex Code
13175 \begin_layout Plain Layout
13184 \begin_inset space \thinspace{}
13190 \begin_layout Standard
13194 \begin_layout Plain Layout
13208 \begin_layout Standard
13209 \begin_inset Flex Multiple Columns
13212 \begin_layout Plain Layout
13215 My observations of No.
13216 \begin_inset space \space{}
13219 427 Park Lane did little to clear up the problem in which I was interested.
13220 The house was separated from the street by a low wall and railing, the
13221 whole not more than five feet high.
13222 It was perfectly easy, therefore, for anyone to get into the garden, but
13223 the window was entirely inaccessible, since there was no water pipe or
13224 anything which could help the most active man to climb it.
13225 More puzzled than ever, I retraced my steps to Kensington.
13226 I had not been in my study five minutes when the maid entered to say that
13227 a person desired to see me.
13228 To my astonishment it was none other than my strange old book collector,
13229 his sharp, wizened face peering out from a frame of white hair, and his
13230 precious volumes, a dozen of them at least, wedged under his right arm.
13238 \begin_layout Standard
13242 \begin_layout Plain Layout
13254 \begin_inset Note Note
13257 \begin_layout Plain Layout
13258 go back to the default
13266 \begin_layout Subsubsection
13270 \begin_layout Standard
13271 Between the columns a rule with a width of the length
13272 \begin_inset Flex Code
13275 \begin_layout Plain Layout
13284 If this rule width is set to 0
13285 \begin_inset space \thinspace{}
13288 pt (this is the default), the rule is suppressed.
13289 In the following example the rule is 2
13290 \begin_inset space \thinspace{}
13296 \begin_layout Standard
13300 \begin_layout Plain Layout
13306 columnseprule}{2pt}
13314 \begin_layout Standard
13315 \begin_inset Flex Multiple Columns
13318 \begin_layout Plain Layout
13321 \begin_inset Quotes eld
13324 You're surprised to see me, sir,
13325 \begin_inset Quotes erd
13328 said he, in a strange, croaking voice.
13331 \begin_layout Plain Layout
13334 I acknowledged that I was.
13337 \begin_layout Plain Layout
13340 \begin_inset Quotes eld
13343 Well, I've a conscience, sir, and when I chanced to see you go into this
13344 house, as I came hobbling after you, I thought to myself, I'll just step
13345 in and see that kind gentleman, and tell him that if I was a bit gruff
13346 in my manner there was not any harm meant, and that I am much obliged to
13347 him for picking up my books.
13348 \begin_inset Quotes erd
13354 \begin_layout Plain Layout
13357 \begin_inset Quotes eld
13360 You make too much of a trifle,
13361 \begin_inset Quotes erd
13366 \begin_inset Quotes eld
13369 May I ask how you knew who I was?
13370 \begin_inset Quotes erd
13376 \begin_layout Plain Layout
13379 \begin_inset Quotes eld
13382 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
13383 you'll find my little bookshop at the corner of Church Street, and very
13384 happy to see you, I am sure.
13385 Maybe you collect yourself, sir.
13389 \begin_inset space ~
13403 \begin_inset space ~
13406 – a bargain, every one of them.
13407 With five volumes you could just fill that gap on that second shelf.
13408 It looks untidy, does it not, sir?
13409 \begin_inset Quotes erd
13420 \begin_layout Standard
13421 \begin_inset VSpace defskip
13427 \begin_layout Standard
13428 The rule can be colored by redefining the command
13429 \begin_inset Flex Code
13432 \begin_layout Plain Layout
13441 This is done by inserting the command
13444 \begin_layout LyX-Code
13449 columnseprulecolor}{
13454 \begin_layout Standard
13455 as \SpecialChar TeX
13456 Code before the multicolumn inset.
13458 \begin_inset Flex Code
13461 \begin_layout Plain Layout
13467 in this command by a color of your choice.
13468 You can use all pre- and self-defined colors.
13476 \begin_inset space ~
13481 for more information about pre- and self-defined colors.
13482 To go back to the default color insert the command
13485 \begin_layout LyX-Code
13490 columnseprulecolor}{
13495 \begin_layout Standard
13496 Here is the example with a cyan rule and 1
13497 \begin_inset space \thinspace{}
13500 cm column separation:
13503 \begin_layout Standard
13507 \begin_layout Plain Layout
13516 \begin_layout Plain Layout
13522 columnseprulecolor}{
13532 \begin_layout Standard
13533 \begin_inset Flex Multiple Columns
13536 \begin_layout Plain Layout
13539 \begin_inset Quotes eld
13542 You're surprised to see me, sir,
13543 \begin_inset Quotes erd
13546 said he, in a strange, croaking voice.
13549 \begin_layout Plain Layout
13552 I acknowledged that I was.
13555 \begin_layout Plain Layout
13558 \begin_inset Quotes eld
13561 Well, I've a conscience, sir, and when I chanced to see you go into this
13562 house, as I came hobbling after you, I thought to myself, I'll just step
13563 in and see that kind gentleman, and tell him that if I was a bit gruff
13564 in my manner there was not any harm meant, and that I am much obliged to
13565 him for picking up my books.
13566 \begin_inset Quotes erd
13572 \begin_layout Plain Layout
13575 \begin_inset Quotes eld
13578 You make too much of a trifle,
13579 \begin_inset Quotes erd
13584 \begin_inset Quotes eld
13587 May I ask how you knew who I was?
13588 \begin_inset Quotes erd
13594 \begin_layout Plain Layout
13597 \begin_inset Quotes eld
13600 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
13601 you'll find my little bookshop at the corner of Church Street, and very
13602 happy to see you, I am sure.
13603 Maybe you collect yourself, sir.
13607 \begin_inset space ~
13621 \begin_inset space ~
13624 – a bargain, every one of them.
13625 With five volumes you could just fill that gap on that second shelf.
13626 It looks untidy, does it not, sir?
13627 \begin_inset Quotes erd
13638 \begin_layout Standard
13642 \begin_layout Plain Layout
13648 columnseprule}{0pt}
13651 \begin_layout Plain Layout
13657 columnseprulecolor}{
13665 \begin_inset Note Note
13668 \begin_layout Plain Layout
13669 go back to the default
13677 \begin_layout Section
13679 \change_inserted 564990737 1671270380
13683 \begin_layout Subsection
13685 \change_inserted 564990737 1671270398
13687 \change_deleted 564990737 1671270396
13693 \begin_layout Standard
13696 as well as any other text processor uses by default rectangular paragraphs.
13697 For special cases like for example posters, invitation cards or poems you
13698 can modify the paragraph shape to one of your choice.
13699 This can be done by using the \SpecialChar LaTeX
13701 \begin_inset Flex Code
13704 \begin_layout Plain Layout
13710 which is loaded by using in the document settings the module
13712 Custom paragraph shapes
13717 \begin_layout Subsubsection
13721 \begin_layout Standard
13726 provides the following shapes:
13729 \begin_layout Standard
13730 \begin_inset Tabular
13731 <lyxtabular version="3" rows="13" columns="3">
13732 <features booktabs="true" islongtable="true" longtabularalignment="center">
13733 <column alignment="left" valignment="middle" width="16col%">
13734 <column alignment="left" valignment="middle" width="40col%">
13735 <column alignment="left" valignment="middle" width="35col%">
13736 <row endhead="true">
13737 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
13740 \begin_layout Plain Layout
13749 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
13752 \begin_layout Plain Layout
13761 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
13764 \begin_layout Plain Layout
13774 <row interlinespace="default">
13775 <cell alignment="left" valignment="top" usebox="none">
13778 \begin_layout Plain Layout
13786 <cell alignment="left" valignment="top" usebox="none">
13789 \begin_layout Plain Layout
13792 Circle with circular hole (in the size of a CD/DVD)
13797 <cell alignment="left" valignment="top" usebox="none">
13800 \begin_layout Plain Layout
13803 Cannot be scaled, take care there is not too much text
13809 <row interlinespace="default">
13810 <cell alignment="left" valignment="top" usebox="none">
13813 \begin_layout Plain Layout
13821 <cell alignment="left" valignment="top" usebox="none">
13824 \begin_layout Plain Layout
13832 <cell alignment="left" valignment="top" usebox="none">
13835 \begin_layout Plain Layout
13838 Fragile, calculation might fail
13844 <row interlinespace="default">
13845 <cell alignment="left" valignment="top" usebox="none">
13848 \begin_layout Plain Layout
13856 <cell alignment="left" valignment="top" usebox="none">
13859 \begin_layout Plain Layout
13862 Rhomboid (symbolizing a
13863 \begin_inset Quotes eld
13867 \begin_inset Quotes erd
13875 <cell alignment="left" valignment="top" usebox="none">
13878 \begin_layout Plain Layout
13887 <row interlinespace="default">
13888 <cell alignment="left" valignment="top" usebox="none">
13891 \begin_layout Plain Layout
13899 <cell alignment="left" valignment="top" usebox="none">
13902 \begin_layout Plain Layout
13910 <cell alignment="left" valignment="top" usebox="none">
13913 \begin_layout Plain Layout
13922 <row interlinespace="default">
13923 <cell alignment="left" valignment="top" usebox="none">
13926 \begin_layout Plain Layout
13934 <cell alignment="left" valignment="top" usebox="none">
13937 \begin_layout Plain Layout
13945 <cell alignment="left" valignment="top" usebox="none">
13948 \begin_layout Plain Layout
13957 <row interlinespace="default">
13958 <cell alignment="left" valignment="top" usebox="none">
13961 \begin_layout Plain Layout
13969 <cell alignment="left" valignment="top" usebox="none">
13972 \begin_layout Plain Layout
13975 Nut for bolt (hexagon with circular hole)
13980 <cell alignment="left" valignment="top" usebox="none">
13983 \begin_layout Plain Layout
13992 <row interlinespace="default">
13993 <cell alignment="left" valignment="top" usebox="none">
13996 \begin_layout Plain Layout
14004 <cell alignment="left" valignment="top" usebox="none">
14007 \begin_layout Plain Layout
14015 <cell alignment="left" valignment="top" usebox="none">
14018 \begin_layout Plain Layout
14027 <row interlinespace="default">
14028 <cell alignment="left" valignment="top" usebox="none">
14031 \begin_layout Plain Layout
14039 <cell alignment="left" valignment="top" usebox="none">
14042 \begin_layout Plain Layout
14050 <cell alignment="left" valignment="top" usebox="none">
14053 \begin_layout Plain Layout
14062 <row interlinespace="default">
14063 <cell alignment="left" valignment="top" usebox="none">
14066 \begin_layout Plain Layout
14074 <cell alignment="left" valignment="top" usebox="none">
14077 \begin_layout Plain Layout
14085 <cell alignment="left" valignment="top" usebox="none">
14088 \begin_layout Plain Layout
14097 <row interlinespace="default">
14098 <cell alignment="left" valignment="top" usebox="none">
14101 \begin_layout Plain Layout
14109 <cell alignment="left" valignment="top" usebox="none">
14112 \begin_layout Plain Layout
14115 Normal/reversed rain drop
14120 <cell alignment="left" valignment="top" usebox="none">
14123 \begin_layout Plain Layout
14126 Fragile, calculation might fail
14132 <row interlinespace="default">
14133 <cell alignment="left" valignment="top" usebox="none">
14136 \begin_layout Plain Layout
14145 <cell alignment="left" valignment="top" usebox="none">
14148 \begin_layout Plain Layout
14151 The \SpecialChar TeX
14157 <cell alignment="left" valignment="top" usebox="none">
14160 \begin_layout Plain Layout
14169 <row interlinespace="default">
14170 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
14173 \begin_layout Plain Layout
14177 \begin_inset Newline newline
14185 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
14188 \begin_layout Plain Layout
14191 Triangles in different orientations
14196 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
14199 \begin_layout Plain Layout
14215 \begin_layout Standard
14216 To use a shape for your paragraph, simply select it in \SpecialChar LyX
14218 for environments in the toolbar.
14221 \begin_layout Standard
14222 \begin_inset Newpage newpage
14228 \begin_layout Standard
14229 Here is an example paragraph in the shape of a nut:
14232 \begin_layout Standard
14233 \begin_inset VSpace bigskip
14242 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
14243 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
14245 At vero eos et accusam et justo duo dolores et ea rebum.
14246 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
14248 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
14249 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
14253 \begin_layout Standard
14254 \begin_inset VSpace bigskip
14260 \begin_layout Standard
14261 \begin_inset Note Greyedout
14264 \begin_layout Plain Layout
14273 paragraphs cannot run over a page break.
14281 \begin_layout Standard
14282 \begin_inset VSpace bigskip
14288 \begin_layout Standard
14290 \begin_inset Flex Code
14293 \begin_layout Plain Layout
14299 takes care that the shape will always be preserved, no matter how much
14300 text is in the paragraph.
14301 Therefore the paragraph size changes with the amount of contained text.
14302 This can lead to paragraph sizes exceeding the page margins.
14303 To demonstrate the size scaling, here is the same example paragraph but
14304 with twice as much text:
14307 \begin_layout Standard
14308 \begin_inset Newpage newpage
14317 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
14318 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
14320 At vero eos et accusam et justo duo dolores et ea rebum.
14321 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
14323 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
14324 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
14326 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
14327 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
14329 At vero eos et accusam et justo duo dolores et ea rebum.
14330 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
14332 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
14333 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
14337 \begin_layout Standard
14338 \begin_inset VSpace bigskip
14344 \begin_layout Standard
14345 An exception is the shape
14350 It cannot be scaled because it must fit the size of a CD/DVD.
14351 Therefore the amount of text that fits into the shape is limited.
14352 \begin_inset Newline newline
14363 shape are fragile, meaning that the calculation of their size can fail,
14364 depending on the amount of text.
14365 You will then get the \SpecialChar LaTeX
14367 \begin_inset Quotes eld
14370 Arithmetic overflow
14371 \begin_inset Quotes erd
14375 In this case one can try to remove or add some text; if nothing works one
14376 has to use another shape.
14379 \begin_layout Standard
14380 \begin_inset VSpace bigskip
14386 \begin_layout Standard
14387 For shapes with tips you will maybe see that \SpecialChar LaTeX
14388 's hyphenation routine fails
14389 for text in the tips.
14390 Therefore it is often necessary to add hyphenation points
14395 arg "specialchar-insert hyphenation"
14400 ) to the corresponding text parts.
14403 \begin_layout Standard
14404 \begin_inset VSpace bigskip
14410 \begin_layout Standard
14411 Shapepar paragraphs are either always centered or placed on the page so
14412 that their left border touches the left page margin.
14413 You can therefore not use the paragraph dialog to align such paragraphs.
14414 A solution is to put the paragraph into a minipage or parbox and align
14416 The problem is hereby to find the right width for the box.
14417 Because if it is too wide and you center the box, the paragraph is not
14418 centered too because it sticks at the left side of the box.
14419 So you might have to play a bit with the width until it fits.
14420 Here are two heart-shaped paragraphs, the first one is not aligned, the
14421 second one is right-aligned:
14424 \begin_layout Standard
14425 \begin_inset Newpage newpage
14431 \begin_layout Heart
14435 Lo\SpecialChar softhyphen
14436 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
14437 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
14439 At vero eos et accusam et justo duo dolores et ea rebum.
14440 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
14444 \begin_layout Standard
14445 \begin_inset VSpace bigskip
14451 \begin_layout Standard
14454 \begin_inset Box Frameless
14464 height_special "totalheight"
14469 backgroundcolor "none"
14472 \begin_layout Heart
14476 Lo\SpecialChar softhyphen
14477 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
14478 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
14480 At vero eos et accusam et justo duo dolores et ea rebum.
14481 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
14490 \begin_layout Subsubsection
14494 \begin_layout Standard
14495 You can define any shape you want.
14496 Doing this manually is a lot of work because every coordinate must be specified.
14497 But there is a way to let the computer calculate the coordinates:
14500 \begin_layout Enumerate
14501 Install the program
14502 \begin_inset CommandInset href
14505 target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
14513 \begin_layout Enumerate
14520 TeX/LaTeX\SpecialChar menuseparator
14521 Settings\SpecialChar menuseparator
14524 and select the font size you are using in your document.
14525 For example this document uses the size 12
14526 \begin_inset space \thinspace{}
14532 \begin_layout Enumerate
14536 \begin_layout Enumerate
14539 TeX/LaTeX\SpecialChar menuseparator
14542 to export the shape to coordinates.
14543 In the appearing dialog use either the outline of your shape for the coordinate
14544 s or the path itself.
14548 \begin_layout Plain Layout
14549 For more information see
14550 \begin_inset CommandInset href
14552 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
14565 \begin_layout Standard
14566 The coordinates are written into a \SpecialChar TeX
14568 To use it for your \SpecialChar LyX
14572 \begin_layout Enumerate
14573 Place the cursor before the first character of your paragraph (or into a
14577 \begin_layout Enumerate
14578 Open in \SpecialChar LyX
14581 Insert\SpecialChar menuseparator
14582 File\SpecialChar menuseparator
14584 \begin_inset space ~
14589 , select the file and use
14598 \begin_layout Standard
14599 \begin_inset VSpace defskip
14605 \begin_layout Standard
14606 \begin_inset Note Greyedout
14609 \begin_layout Plain Layout
14614 : The changed shape only applies to the current paragraph; everything is
14615 reset to normal for the next paragraph.
14616 Therefore the shape definition file must be input into every paragraph
14617 with the desired shape.
14625 \begin_layout Standard
14626 \begin_inset VSpace bigskip
14632 \begin_layout Standard
14633 Here is an example:
14636 \begin_layout Standard
14637 \begin_inset VSpace bigskip
14643 \begin_layout Standard
14644 \begin_inset CommandInset include
14646 filename "SpecialParagraphShape.tex"
14653 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
14654 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
14656 At vero eos et accusam et justo duo dolores et ea rebum.
14657 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
14659 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
14660 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
14664 \begin_layout Standard
14665 \begin_inset VSpace bigskip
14671 \begin_layout Standard
14676 to draw complexer shapes in
14680 you can draw the shape in a program of your choice and import the resulting
14686 Then you only need to draw a line or spline along the outline of the image.
14689 \begin_layout Standard
14690 \begin_inset VSpace bigskip
14696 \begin_layout Standard
14699 Custom paragraph shapes
14701 also provides the two commands
14709 which can be used to define custom shapes coordinate by coordinate.
14713 \begin_layout Plain Layout
14714 These commands are internally used for all shapes described here.
14719 For information how these styles are used and about further customization
14720 possibilities, have a look at the
14721 \begin_inset CommandInset href
14723 name "documentation"
14724 target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
14730 \begin_inset Flex Code
14733 \begin_layout Plain Layout
14742 \begin_layout Chapter
14746 \begin_layout Section
14747 Customizing Bibliographies with Bib\SpecialChar TeX
14751 \begin_layout Standard
14752 The most basic information about how to use Bib\SpecialChar TeX
14757 with \SpecialChar LyX
14758 is contained in the section
14760 Bibliography databases
14767 The following subsections explain special bibliography features supported
14768 by \SpecialChar LyX
14772 \begin_layout Subsection
14773 Alternative Citation Styles
14776 \begin_layout Standard
14777 Standard Bib\SpecialChar TeX
14779 \begin_inset space \thinspace{}
14783 \begin_inset space \space{}
14787 \begin_inset Quotes eld
14791 \begin_inset Quotes erd
14794 ) to refer to a cited work.
14795 However, in many scientific disciplines, other citation styles are in use.
14796 The most common one is the author-year style (e.
14797 \begin_inset space \thinspace{}
14801 \begin_inset space \space{}
14805 \begin_inset Quotes eld
14809 \begin_inset Quotes erd
14814 supports three packages that provide this style,
14815 \begin_inset Flex Code
14818 \begin_layout Plain Layout
14825 \begin_inset Flex Code
14828 \begin_layout Plain Layout
14835 \begin_inset Flex Code
14838 \begin_layout Plain Layout
14845 Each of these packages has their pros and cons, which cannot be listed
14847 If you only want to have simple author-year (or author-numerical) style,
14848 or if you want to use one of the countless style files for
14849 \begin_inset Flex Code
14852 \begin_layout Plain Layout
14858 , then the established
14859 \begin_inset Flex Code
14862 \begin_layout Plain Layout
14868 package is probably your choice.
14869 If you look for specific citation styles common in law studies, you might
14871 \begin_inset Flex Code
14874 \begin_layout Plain Layout
14881 If you want to have full control over the formatting or look for advanced
14882 features such as ibidem, footnote citations, full title citations, advanced
14883 date formats (such as 400 BC) or full localization to other languages than
14884 English, you should definitely consider
14885 \begin_inset Flex Code
14888 \begin_layout Plain Layout
14894 , which exceeds all other packages in terms of features, but is also quite
14895 heavy and more resource-hungry.
14898 \begin_layout Standard
14899 The handling of these packages in \SpecialChar LyX
14900 is basically the same.
14902 \begin_inset Flex Noun
14905 \begin_layout Plain Layout
14906 Document\SpecialChar menuseparator
14913 \begin_inset Flex Noun
14916 \begin_layout Plain Layout
14923 \begin_inset Flex Noun
14926 \begin_layout Plain Layout
14933 \begin_inset Flex Noun
14936 \begin_layout Plain Layout
14943 \begin_inset Flex Noun
14946 \begin_layout Plain Layout
14953 \begin_inset Flex Noun
14956 \begin_layout Plain Layout
14957 Biblatex (Natbib mode)
14963 \begin_inset Flex Noun
14966 \begin_layout Plain Layout
14973 \begin_inset Flex Noun
14976 \begin_layout Plain Layout
14983 \begin_inset space ~
14986 6.5.3 in the User's Guide for more information on these choices).
14987 With all these packages, you will get some extra features in the citation
14988 dialog and you can select the style of the reference (
14989 \begin_inset Quotes eld
14993 \begin_inset Quotes erd
14997 \begin_inset Quotes eld
15001 \begin_inset Quotes erd
15005 \begin_inset Quotes eld
15009 \begin_inset Quotes erd
15013 \begin_inset Quotes eld
15017 \begin_inset Quotes erd
15021 Note that either package needs specifically designed style files.
15022 They all ship their own, but there are lots of additional style files,
15023 and there is even an interactive style file builder
15027 \begin_layout Plain Layout
15029 \begin_inset Flex URL
15032 \begin_layout Plain Layout
15034 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
15045 \begin_inset Flex Code
15048 \begin_layout Plain Layout
15057 \begin_layout Subsection
15058 Subdivided Bibliographies
15061 \begin_layout Standard
15062 Sometimes you might need to divide your bibliography into several sections.
15063 If you are for instance a historian, the possibility to separate sources
15064 and scientific works is most likely a
15065 \begin_inset Quotes eld
15069 \begin_inset Quotes erd
15073 Unfortunately, Bib\SpecialChar TeX
15074 itself does not allow you to do this.
15075 But with the help of some \SpecialChar LaTeX
15076 packages, Bib\SpecialChar TeX
15077 can be extended to fit your needs.
15080 \begin_layout Standard
15082 provides native support for one of these packages,
15090 \begin_layout Plain Layout
15092 \begin_inset Flex URL
15095 \begin_layout Plain Layout
15097 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
15107 The advantage of this package (compared to other packages such as
15111 ) is that you don't need to define new citation commands.
15112 Instead, you need to prepare different bibliographic databases which include
15113 the entries for the different sections of the bibliography.
15114 For example: If you want to divide your bibliography into the sections
15116 \begin_inset Quotes eld
15120 \begin_inset Quotes erd
15124 \begin_inset Quotes eld
15128 \begin_inset Quotes erd
15131 , you first need to create two bibliographic databases, e.
15132 \begin_inset space \thinspace{}
15136 \begin_inset space \space{}
15140 \begin_inset Flex Code
15143 \begin_layout Plain Layout
15150 \begin_inset Flex Code
15153 \begin_layout Plain Layout
15163 \begin_layout Standard
15165 \begin_inset Flex Noun
15168 \begin_layout Plain Layout
15169 Document\SpecialChar menuseparator
15176 \begin_inset Flex Noun
15179 \begin_layout Plain Layout
15186 \begin_inset Flex Noun
15189 \begin_layout Plain Layout
15190 Subdivided bibliography
15196 Now you can insert multiple Bib\SpecialChar TeX
15197 bibliographies, one for each section of
15199 Returning to our example: Insert the Bib\SpecialChar TeX
15201 \begin_inset Flex Code
15204 \begin_layout Plain Layout
15210 and a second one for the database
15211 \begin_inset Flex Code
15214 \begin_layout Plain Layout
15221 You are free to use the same or different styles for each section.
15222 Additionally, you can choose if the bibliography section should contain
15224 \begin_inset Quotes eld
15227 all cited references
15228 \begin_inset Quotes erd
15231 of the specified database(s) (which is the default),
15232 \begin_inset Quotes eld
15235 all uncited references
15236 \begin_inset Quotes erd
15240 \begin_inset Quotes eld
15244 \begin_inset Quotes erd
15248 This might be useful if you would like to separate your bibliography into
15250 \begin_inset Quotes eld
15254 \begin_inset Quotes erd
15258 \begin_inset Quotes eld
15262 \begin_inset Quotes erd
15266 \begin_inset Quotes eld
15270 \begin_inset Quotes erd
15274 The titles for the sections can be added as ordinary sections or subsections.
15276 \begin_inset Flex Code
15279 \begin_layout Plain Layout
15285 removes the bibliography title, you have to manually re-add that, too (as
15286 a chapter* or section*, for instance).
15289 \begin_layout Standard
15294 , the procedure is a bit different.
15303 , the aforementioned
15304 \begin_inset Flex Noun
15307 \begin_layout Plain Layout
15308 Subdivided bibliography
15313 option is disabled if you use
15322 provides its own means to generate subdivided bibliographies.
15323 You can either add keywords to bibliography entries via the
15324 \begin_inset Flex Code
15327 \begin_layout Plain Layout
15333 entry option and then filter bibliography sections by keyword (by adding
15335 \begin_inset Flex Code
15338 \begin_layout Plain Layout
15345 \begin_inset Flex Noun
15348 \begin_layout Plain Layout
15354 field of the dialog that opens if you left-click on the
15355 \begin_inset Flex Noun
15358 \begin_layout Plain Layout
15359 Biblatex Generated Bibliography
15364 button), or you can filter by entry types (such as
15373 \begin_inset space \thinspace{}
15378 \begin_inset Flex Code
15381 \begin_layout Plain Layout
15388 \begin_inset Flex Code
15391 \begin_layout Plain Layout
15398 \begin_inset Flex Noun
15401 \begin_layout Plain Layout
15407 field, or you can create so-called
15408 \begin_inset Quotes eld
15411 Bibliography Categories
15412 \begin_inset Quotes erd
15415 to which you can assign individual entries.
15416 Please refer to the Biblatex manual, section
15418 Subdivided Bibliographies
15423 \begin_layout Subsection
15424 Multiple Bibliographies
15425 \begin_inset CommandInset label
15427 name "subsec:Multiple-Bibliographies"
15434 \begin_layout Standard
15435 Multiple bibliographies, e.
15436 \begin_inset space \thinspace{}
15440 \begin_inset space \space{}
15443 a bibliography for each part, chapter, section, subsection or child (sub-documen
15444 t) of the document, are also supported by \SpecialChar LyX
15446 In order to enable it, go to
15447 \begin_inset Flex Noun
15450 \begin_layout Plain Layout
15451 Document\SpecialChar menuseparator
15452 Settings\SpecialChar menuseparator
15458 and select the relevant unit (e.
15459 \begin_inset space \thinspace{}
15463 \begin_inset Quotes eld
15467 \begin_inset Quotes erd
15471 \begin_inset Flex Noun
15474 \begin_layout Plain Layout
15475 Multiple Bibliographies
15481 Then add a Bib(la)\SpecialChar TeX
15482 bibliography to each unit (e.
15483 \begin_inset space \thinspace{}
15486 g., section) of your document.
15487 In the output, a separate bibliography, containing only the references
15488 done in the current unit is generated.
15491 \begin_layout Standard
15492 If you use Bib\SpecialChar TeX
15494 \begin_inset Flex Code
15497 \begin_layout Plain Layout
15504 \begin_inset Flex Code
15507 \begin_layout Plain Layout
15513 package is used to create multiple bibliographies.
15514 The former package is used if you select
15515 \begin_inset Quotes eld
15519 \begin_inset Quotes erd
15527 \begin_inset Flex Noun
15530 \begin_layout Plain Layout
15531 Sectioned Bibliography
15537 In all other cases,
15538 \begin_inset Flex Code
15541 \begin_layout Plain Layout
15551 \begin_layout Plain Layout
15552 An alternative approach, if you are willing to use some
15553 \begin_inset Flex Noun
15556 \begin_layout Plain Layout
15564 \begin_inset space ~
15568 \begin_inset CommandInset ref
15570 reference "sec:Inserting-TeX-Code"
15575 \begin_inset Flex Code
15578 \begin_layout Plain Layout
15590 \begin_inset Flex Code
15593 \begin_layout Plain Layout
15599 is used, \SpecialChar LyX
15600 encloses the specified units in
15601 \begin_inset Flex Code
15604 \begin_layout Plain Layout
15611 \begin_inset Flex Code
15614 \begin_layout Plain Layout
15623 \begin_inset Flex Code
15626 \begin_layout Plain Layout
15634 in order to create the units.
15635 Note that this approach has some limitations.
15636 First, every citation reference has to be inside some
15637 \begin_inset Flex Code
15640 \begin_layout Plain Layout
15647 So citations outside a defined unit (e.
15648 \begin_inset space \thinspace{}
15651 g., before the first section if you use
15652 \begin_inset Quotes eld
15656 \begin_inset Quotes erd
15660 \begin_inset Quotes eld
15664 \begin_inset Quotes erd
15668 You can also create your own units by entering
15669 \begin_inset Flex Code
15672 \begin_layout Plain Layout
15681 \begin_inset Flex Code
15684 \begin_layout Plain Layout
15692 as \SpecialChar TeX
15693 code (for instance to work around the mentioned limitation).
15695 \begin_inset Flex Code
15698 \begin_layout Plain Layout
15704 s cannot be nested.
15705 A second limitation is that
15706 \begin_inset Flex Code
15709 \begin_layout Plain Layout
15715 always processes all references of a bibliography database, even if they
15717 This can result in odd labels (e.
15718 \begin_inset space \thinspace{}
15723 \begin_inset Quotes eld
15727 \begin_inset Quotes erd
15730 if two works of this author from 2014 are in the database, even if only
15734 \begin_layout Standard
15740 \begin_inset Flex Code
15743 \begin_layout Plain Layout
15749 option is used instead.
15750 If you need specific units, you can start them with the \SpecialChar TeX
15752 \begin_inset Flex Code
15755 \begin_layout Plain Layout
15764 \begin_inset Flex Code
15767 \begin_layout Plain Layout
15776 If you also want to control the end of the unit, use the environment
15777 \begin_inset Flex Code
15780 \begin_layout Plain Layout
15790 \begin_inset Flex Code
15793 \begin_layout Plain Layout
15803 \begin_inset Flex Code
15806 \begin_layout Plain Layout
15812 s cannot be nested.
15813 In addition to the individual bibliography of the current unit,
15817 also provides an easy way to output all bibliographies, subsequently, at
15819 \begin_inset space \thinspace{}
15822 g., at the end of the document).
15824 \begin_inset Quotes eld
15827 all reference units
15828 \begin_inset Quotes erd
15831 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve
15833 Please refer to the
15837 manual for more information on this topic.
15840 \begin_layout Section
15841 Multipart Documents
15844 \begin_layout Subsection
15848 \begin_layout Standard
15849 When you are working on a large file with many sections, it is often convenient
15850 to break up the document into several files, or perhaps you have something
15851 where a table may change from time to time, but the preceding text does
15853 In these cases, you should seriously consider using multipart documents.
15854 For example, scientific papers often have five major sections: the introduction
15855 , observations, results, discussion, and conclusion.
15856 Each of these could be its own separate \SpecialChar LyX
15858 \begin_inset Quotes eld
15862 \begin_inset Quotes erd
15865 file which contains the title, authors, abstract, references, etc., plus
15866 the five included files.
15867 It is important to note that each of these files is a full \SpecialChar LyX
15869 can be formatted and printed on its own, as well as included in a master
15871 Each of these files must have the same document class, however—don't attempt
15872 to mix book classes with article classes.
15873 You may also include \SpecialChar LaTeX
15874 files; however, these files must not have their own
15876 \begin_inset space \thinspace{}
15880 \begin_inset space \space{}
15883 everything up to and including the
15884 \begin_inset Flex Code
15887 \begin_layout Plain Layout
15895 line as well as the
15896 \begin_inset Flex Code
15899 \begin_layout Plain Layout
15907 line must be deleted) or else errors will be generated when you try to
15911 \begin_layout Standard
15913 allows you to include files quite easily with
15914 \begin_inset Flex Noun
15917 \begin_layout Plain Layout
15918 Insert\SpecialChar menuseparator
15920 \begin_inset space ~
15929 When you click on this selection a small box is inserted into the file
15930 at the current cursor location.
15931 Clicking on the box raises a dialog which allows you to select the file
15932 to be included, and the method of its inclusion.
15936 \begin_layout Standard
15937 The file selection box should by now be obvious.
15938 The three inclusion methods are
15939 \begin_inset Quotes eld
15943 \begin_inset Quotes erd
15947 \begin_inset Quotes eld
15951 \begin_inset Quotes erd
15955 \begin_inset Quotes eld
15959 \begin_inset Quotes erd
15964 \begin_inset Quotes eld
15968 \begin_inset Quotes erd
15972 \begin_inset Quotes eld
15976 \begin_inset Quotes erd
15979 are similar in many ways, but there are also some notable differences:
15982 \begin_layout Enumerate
15984 \begin_inset Quotes eld
15988 \begin_inset Quotes erd
15991 are typeset beginning on a new page, while files that are
15992 \begin_inset Quotes eld
15996 \begin_inset Quotes erd
15999 are typeset starting on the current page.
16002 \begin_layout Enumerate
16003 \begin_inset Quotes eld
16007 \begin_inset Quotes erd
16010 files cannot themselves
16011 \begin_inset Quotes eld
16015 \begin_inset Quotes erd
16019 \begin_inset Quotes eld
16023 \begin_inset Quotes erd
16028 \begin_inset Quotes eld
16032 \begin_inset Quotes erd
16035 , on the other hand, infinite sub-inputting is possible.
16038 \begin_layout Enumerate
16039 \begin_inset Quotes eld
16043 \begin_inset Quotes erd
16046 allow for the output of only selected
16047 \begin_inset Quotes eld
16051 \begin_inset Quotes erd
16054 files, while maintaining the actual counters (pagination etc.) and references
16055 (please refer to the section
16058 \begin_inset space ~
16066 \begin_inset space ~
16071 manual for details).
16074 \begin_layout Standard
16076 \begin_inset Quotes eld
16080 \begin_inset Quotes erd
16083 is the preferred method for chapters that are outsourced to child documents,
16085 \begin_inset Quotes eld
16089 \begin_inset Quotes erd
16092 is more suitable for arbitrary file inheritance.
16095 \begin_layout Standard
16097 \begin_inset Quotes eld
16101 \begin_inset Quotes erd
16104 included file allows you to include a file typeset exactly as it appears
16106 \begin_inset space \thinspace{}
16110 \begin_inset space \space{}
16114 \begin_inset Flex Code
16117 \begin_layout Plain Layout
16123 mode, with the characters set in a fixed-width typewriter font.
16124 Normally, spaces in this file are invisible, though two consecutive spaces
16125 are conserved, unlike \SpecialChar LyX
16126 's normal treatment of spaces.
16127 However, setting the
16128 \begin_inset Flex Noun
16131 \begin_layout Plain Layout
16133 \begin_inset space ~
16137 \begin_inset space ~
16141 \begin_inset space ~
16149 checkbox typesets a mark to unambiguously define the presence of a space.
16153 \begin_layout Standard
16154 Generally, the master file is converted into a full \SpecialChar LaTeX
16155 file before typesetting,
16156 while the included files are converted to \SpecialChar LaTeX
16157 files that do not have all the
16158 preamble information.
16161 \begin_layout Subsection
16162 Cross-References Between Files
16165 \begin_layout Standard
16166 \begin_inset Box Shadowbox
16176 height_special "totalheight"
16181 backgroundcolor "none"
16184 \begin_layout Plain Layout
16185 This section is somewhat out of date.
16186 Need to describe default master documents and how children are opened when
16196 \begin_layout Standard
16197 It is possible to set up cross-references between the different files.
16198 First, open all the files in question: let's call them A and B in a two
16199 file example, where B is included in A.
16200 Let's say you insert a label in A, then want to reference it in B.
16201 Open the cross-reference dialog whilst in document B, and you can select
16203 \begin_inset Quotes eld
16207 \begin_inset Quotes erd
16213 \begin_layout Subsection
16214 Bibliography Lists in all Subdocuments
16217 \begin_layout Standard
16218 If you work with child documents, you might want to have only one main bibliogra
16219 phy at the end, but still be able to have a selected bibliography for the
16220 child if you output it on its own.
16221 Here is how to achieve this.
16224 \begin_layout Standard
16225 For the main document, you just insert a bibliography inset at the place
16226 where the main bibliography has to appear (within the master file or within
16228 If the bibliography inset is in the master file, the references will be
16229 inherited by all children, so they are available in the citation dialog
16233 \begin_layout Standard
16234 For child-specific bibliographies, insert bibliography insets within the
16235 child documents, at the place where the bibliography should appear when
16236 the child is compiled separately.
16237 However, the trick is to insert them into a branch (
16239 Insert\SpecialChar menuseparator
16240 Branch\SpecialChar menuseparator
16241 Insert New Branch...
16244 \begin_inset space \thinspace{}
16249 \begin_inset Quotes eld
16253 \begin_inset Quotes erd
16257 Within the children, activate the branch (
16259 Document\SpecialChar menuseparator
16260 Settings...\SpecialChar menuseparator
16264 Within the master, deactivate the branch (
16266 Document\SpecialChar menuseparator
16267 Settings...\SpecialChar menuseparator
16271 Now the child's bibliography will be ignored by the master, but considered
16275 \begin_layout Standard
16276 If you need multiple bibliographies (e.
16277 \begin_inset space \thinspace{}
16280 g., one per child in the
16284 ), please refer to sec.
16285 \begin_inset space ~
16289 \begin_inset CommandInset ref
16291 reference "subsec:Multiple-Bibliographies"
16298 \begin_layout Section
16303 \begin_layout Standard
16304 Users sometimes need to be able to
16305 \begin_inset Quotes eld
16309 \begin_inset Quotes erd
16313 file together with all the images (and other files) on which it depends,
16314 either for sending to a publisher or for sharing with a co-author.
16316 includes a Python script (
16317 \begin_inset Flex Code
16320 \begin_layout Plain Layout
16326 ) that automates this process.
16327 To use it, you must have either the
16328 \begin_inset Flex Code
16331 \begin_layout Plain Layout
16338 \begin_inset Flex Code
16341 \begin_layout Plain Layout
16347 python modules installed on your system.
16348 By default, the script prefers the
16349 \begin_inset Flex Code
16352 \begin_layout Plain Layout
16359 \begin_inset Flex Code
16362 \begin_layout Plain Layout
16368 format on Unix-like systems and the
16369 \begin_inset Flex Code
16372 \begin_layout Plain Layout
16381 \begin_layout Standard
16383 's configuration process will set the script up to export a `\SpecialChar LyX
16385 and this format will then be available under
16386 \begin_inset Flex Code
16389 \begin_layout Plain Layout
16390 File\SpecialChar menuseparator
16399 \begin_layout Standard
16400 Independently of the platform, the generation of a particular archive format
16401 can be forced by adding either the
16402 \begin_inset Flex Code
16405 \begin_layout Plain Layout
16412 \begin_inset Flex Code
16415 \begin_layout Plain Layout
16422 \begin_inset Flex Code
16425 \begin_layout Plain Layout
16432 \begin_inset Flex Code
16435 \begin_layout Plain Layout
16441 format) switch to the
16442 \begin_inset Flex Code
16445 \begin_layout Plain Layout
16447 \SpecialChar menuseparator
16455 \begin_inset Flex Code
16458 \begin_layout Plain Layout
16459 Tools\SpecialChar menuseparator
16460 Preferences\SpecialChar menuseparator
16461 File Handling\SpecialChar menuseparator
16468 (Make sure you add the switch after the script name, not before it.)
16471 \begin_layout Section
16472 Fancy Headers and Footers
16475 \begin_layout Standard
16476 The default page layout is rather plain; for an
16477 \begin_inset Flex Code
16480 \begin_layout Plain Layout
16486 document class, all you get is a centered page number at the bottom of
16488 This document uses KOMA-script's book class, so it appears to be a bit
16490 But to really put on a show, you need to set the document page style to
16492 \begin_inset Quotes eld
16496 \begin_inset Quotes erd
16499 , as mentioned in the
16504 This section describes the \SpecialChar LaTeX
16505 code you need to insert in your \SpecialChar LaTeX
16507 order to get the desired effects.
16510 \begin_layout Standard
16511 For more information on fancy headers, see the
16512 \begin_inset Flex Code
16515 \begin_layout Plain Layout
16521 package documentation.
16523 \begin_inset Flex URL
16526 \begin_layout Plain Layout
16528 https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
16536 \begin_layout Standard
16537 The page header is divided into three fields, not surprisingly labeled
16538 \begin_inset Quotes eld
16542 \begin_inset Quotes erd
16546 \begin_inset Quotes eld
16550 \begin_inset Quotes erd
16554 \begin_inset Quotes eld
16558 \begin_inset Quotes erd
16562 The footer is also divided into these three fields.
16563 The \SpecialChar LaTeX
16564 commands to set these fields in the simplest manner are
16565 \begin_inset Flex Code
16568 \begin_layout Plain Layout
16577 \begin_inset Flex Code
16580 \begin_layout Plain Layout
16589 \begin_inset Flex Code
16592 \begin_layout Plain Layout
16601 \begin_inset Flex Code
16604 \begin_layout Plain Layout
16613 Suppose you wish to put your name in the upper left hand corner of each
16615 Simply insert the following command in the preamble:
16618 \begin_layout Standard
16627 \begin_layout Standard
16628 You will now see your name in the upper left.
16629 If a field has a default entry that you would like to get rid of (often
16630 the page number appears in the central footer) simply include a command
16631 with a blank argument, e.
16632 \begin_inset space \thinspace{}
16638 \begin_layout Standard
16646 \begin_layout Standard
16647 Let's get really fancy: lets put the section number with the word
16648 \begin_inset Quotes eld
16652 \begin_inset Quotes erd
16656 \begin_inset space \thinspace{}
16660 \begin_inset space \space{}
16663 Section 3) in the upper left, the page number (e.
16664 \begin_inset space \thinspace{}
16668 \begin_inset space \space{}
16671 Page 4) in the upper right, your name in the lower left, and the date in
16673 The following commands should now appear in the preamble:
16676 \begin_layout Standard
16686 \begin_layout Standard
16694 \begin_layout Standard
16704 \begin_layout Standard
16713 \begin_layout Standard
16721 \begin_layout Standard
16731 \begin_layout Standard
16733 \begin_inset Flex Code
16736 \begin_layout Plain Layout
16745 \begin_inset Flex Code
16748 \begin_layout Plain Layout
16756 access \SpecialChar LaTeX
16757 's section and page counters, and so print out the current section
16760 \begin_inset Flex Code
16763 \begin_layout Plain Layout
16771 simply prints out today's date.
16774 \begin_layout Standard
16775 The thicknesses of the horizontal rules drawn beneath the header and above
16776 the footer can also be modified.
16777 If you don't want one of the rules, set its thickness to 0.
16778 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
16784 \begin_inset Flex Code
16787 \begin_layout Plain Layout
16792 headrulewidth}{0.4pt}
16798 \begin_inset Flex Code
16801 \begin_layout Plain Layout
16806 footrulewidth}{0.4pt}
16811 to set the thicknesses.
16814 \begin_layout Standard
16815 You can switch the header/footer settings on and off for individual pages
16816 using commands like
16817 \begin_inset Flex Code
16820 \begin_layout Plain Layout
16823 thispagestyle{empty}
16829 \begin_inset Flex Code
16832 \begin_layout Plain Layout
16835 thispagestyle{plain}
16841 \begin_inset Flex Code
16844 \begin_layout Plain Layout
16847 thispagestyle{fancy}
16853 Simply insert them in the text on the page you want changed and mark them
16854 as \SpecialChar TeX
16856 In fact, title pages are marked as plain by default, while following pages
16857 are marked fancy when using the global fancy setting.
16860 \begin_layout Standard
16861 As a final example, it is possible to include an image in the header or
16863 Suppose you want to put a company logo in the upper lefthand corner.
16864 You might try something like
16867 \begin_layout Standard
16876 includegraphics{logo.eps}}}
16879 \begin_layout Standard
16881 (you may need to preface this with
16882 \begin_inset Flex Code
16885 \begin_layout Plain Layout
16888 usepackage{graphics}
16893 if you don't include graphics elsewhere in your document).
16896 \begin_layout Section
16897 Itemize Bullet Selection
16898 \begin_inset CommandInset label
16907 \begin_layout Standard
16913 \begin_layout Subsection
16917 \begin_layout Standard
16919 provides 216 bullet shapes that can be accessed from a simple dialog.
16920 Using this dialog you can easily specify what bullet shape to use at each
16921 level of an itemized list.
16922 These settings are document-wide so you won't be able to specify different
16923 sets of bullets for different paragraphs.
16927 \begin_layout Plain Layout
16928 Well, actually you can but you'll have to do it by hand.
16936 \begin_layout Subsection
16940 \begin_layout Standard
16941 Open the dialog by selecting the
16942 \begin_inset Flex Noun
16945 \begin_layout Plain Layout
16946 Document\SpecialChar menuseparator
16952 menu item and then select the
16953 \begin_inset Flex Noun
16956 \begin_layout Plain Layout
16965 \begin_layout Standard
16966 The dialog provides you with a table of bullet shapes.
16967 A column of buttons on the left of the table provides access to the six
16968 different panels of bullet shapes.
16969 The row of buttons across the top is used to select which bullet depth
16972 \change_deleted 244031559 1603875981
16973 A text entry under the table shows the currently selected bullet shape's
16975 equivalent and this can be edited if desired.
16976 If you do modify the text you will also need to specify any needed packages
16977 in the \SpecialChar LaTeX
16983 \begin_layout Standard
16984 The six panels are divided up by the packages they require.
16985 The following table shows the mappings from button name to \SpecialChar LaTeX
16989 \begin_layout Standard
16991 \begin_inset Tabular
16992 <lyxtabular version="3" rows="7" columns="2">
16993 <features tabularvalignment="middle">
16994 <column alignment="center" valignment="top" width="0pt">
16995 <column alignment="center" valignment="top" width="0pt">
16997 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
17000 \begin_layout Plain Layout
17015 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
17018 \begin_layout Plain Layout
17035 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
17038 \begin_layout Plain Layout
17053 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
17056 \begin_layout Plain Layout
17065 base \SpecialChar LaTeX
17073 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
17076 \begin_layout Plain Layout
17091 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
17094 \begin_layout Plain Layout
17111 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
17114 \begin_layout Plain Layout
17129 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
17132 \begin_layout Plain Layout
17149 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
17152 \begin_layout Plain Layout
17167 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
17170 \begin_layout Plain Layout
17187 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
17190 \begin_layout Plain Layout
17205 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
17208 \begin_layout Plain Layout
17225 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
17228 \begin_layout Plain Layout
17243 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
17246 \begin_layout Plain Layout
17269 \begin_layout Standard
17271 doesn't stop you using bullets from packages you don't have.
17272 If you get errors from \SpecialChar LaTeX
17273 when you try to view or print the file, then it
17274 is likely you are missing a package.
17278 \begin_layout Plain Layout
17280 doesn't restrict your use since you may be editing locally and exporting
17289 \begin_layout Subsection
17293 \begin_layout Standard
17294 Select which bullet depth you want to change then select the bullet shape
17296 Any changes will not be visible in \SpecialChar LyX
17297 , but are visible when viewing the document.
17300 \begin_layout Standard
17301 You can reset a bullet shape to the default simply by clicking your right
17302 mouse button on the appropriate bullet depth button.
17306 \begin_layout Plain Layout
17311 want to have multiple sets of paragraphs with different sets of bullets
17312 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
17314 The bullet selection dialog can help though because it provides you with
17315 the \SpecialChar LaTeX
17316 code for a wide range of bullet shapes.
17317 To make your own custom paragraphs you have the following options:
17320 \begin_layout Plain Layout
17324 \begin_layout Plain Layout
17340 \begin_layout Plain Layout
17344 \begin_layout Plain Layout
17366 \begin_layout Itemize
17367 Use the \SpecialChar LaTeX
17369 \begin_inset Flex Code
17372 \begin_layout Plain Layout
17380 to specify a new bullet shape for a given depth.
17381 You'll also need to save the current bullet shape so you can restore it
17383 In this itemized list the following \SpecialChar LaTeX
17384 code was used to change the bullet
17385 used for the first depth.
17389 \begin_layout LyX-Code
17399 \begin_layout LyX-Code
17416 \begin_layout Itemize
17417 Note that the itemize depth is specified in Roman numerals as part of the
17427 \begin_layout Itemize
17428 \begin_inset Argument item:1
17431 \begin_layout Plain Layout
17435 \begin_layout Plain Layout
17453 Specify each individual entry by starting each item with the bullet shape
17455 \begin_inset Quotes eld
17459 \begin_inset Quotes erd
17462 inset (available at
17464 Insert\SpecialChar menuseparator
17468 \begin_inset Flex Noun
17471 \begin_layout Plain Layout
17479 For example, this item was started with
17480 \begin_inset Flex Code
17483 \begin_layout Plain Layout
17498 \begin_layout Plain Layout
17502 \begin_layout Plain Layout
17518 \begin_layout Plain Layout
17519 You'll also need to revert the labelitem back to its previous setting for
17520 the global bullet shape settings to remain in effect.
17521 The way used here was:
17524 \begin_layout LyX-Code
17539 \begin_layout Chapter
17541 and the World Wide Web
17544 \begin_layout Standard
17546 has long supported the export of documents to various web-friendly formats,
17548 Before version 2.0, however, HTML export was always accomplished by the
17549 use of external converters.
17553 \begin_layout Plain Layout
17554 For details on the use of external converters with \SpecialChar LyX
17559 section of the Customization manual.
17564 These fall into two large groups: there are converters that use \SpecialChar LaTeX
17566 intermediate format, such as
17567 \begin_inset Flex Code
17570 \begin_layout Plain Layout
17577 \begin_inset Flex Code
17580 \begin_layout Plain Layout
17587 \begin_inset Flex Code
17590 \begin_layout Plain Layout
17596 , relying upon \SpecialChar LyX
17597 to produce the \SpecialChar LaTeX
17598 ; and there is a converter that works directly
17599 on \SpecialChar LyX
17601 \begin_inset Flex Code
17604 \begin_layout Plain Layout
17612 All of these have different advantages and disadvantages.
17616 \begin_layout Standard
17617 The \SpecialChar LaTeX
17618 -based converters have the advantage that, in principle, they know everythin
17619 g about the exported document that \SpecialChar LaTeX
17621 Such converters do not care, for example, if a certain block of code was
17622 produced by \SpecialChar LyX
17623 or was Evil Red Text.
17624 These converters know about
17625 \begin_inset Flex Code
17628 \begin_layout Plain Layout
17634 files, counters, and references, and can often make use of the
17635 \begin_inset Flex Code
17638 \begin_layout Plain Layout
17644 files generated by Bib\SpecialChar TeX
17646 On the other hand, \SpecialChar LaTeX
17647 is a very hard language to parse—it is sometimes said
17648 that only \SpecialChar TeX
17649 itself understands \SpecialChar TeX
17650 —and \SpecialChar LaTeX
17651 -based converters will often choke on
17652 what seem to be quite simple constructs; complex ones can throw them completely
17653 , and as of this writing, for example, the
17657 manual will not export with
17658 \begin_inset Flex Code
17661 \begin_layout Plain Layout
17667 , though the others will.
17668 The other issue concerns how math is handled.
17669 These converters typically convert the formulae into little pictures that
17670 are then linked from the HTML document.
17671 Since these are actually generated by \SpecialChar LaTeX
17672 , they are accurate.
17673 But they do not scale well, and just getting them to look as if they are
17674 actually meant to be in your document—so that the font sizes seem to be
17675 roughly the same—can be a challenge.
17678 \begin_layout Standard
17680 \begin_inset Flex Code
17683 \begin_layout Plain Layout
17691 \begin_inset CommandInset href
17693 name "http://pinchito.es/elyxer/"
17694 target "http://pinchito.es/elyxer/"
17699 ) solves some of these problems.
17700 In particular, the formulae it produces scale perfectly, since it renders
17701 math using a combination of HTML and CSS rather than converting the formulae
17703 But even moderately complex formula are rendered less well than with
17704 \begin_inset Flex Code
17707 \begin_layout Plain Layout
17713 ; this reflects the limitations of HTML.
17717 \begin_layout Plain Layout
17719 \begin_inset Flex Code
17722 \begin_layout Plain Layout
17729 can also use jsMath and MathJax for equations, but this setting is only
17730 available globally and requires one to have access to a server that runs
17736 More importantly (as of version 1.1.1, at least),
17737 \begin_inset Flex Code
17740 \begin_layout Plain Layout
17747 has limited support for math macros and no support for user-defined paragraph
17748 or character styles.
17749 These limitations make
17750 \begin_inset Flex Code
17753 \begin_layout Plain Layout
17760 unsuitable for many of the documents \SpecialChar LyX
17762 In principle, of course, these problems could be solved, but the \SpecialChar LyX
17764 have decided to follow a different path and have made \SpecialChar LyX
17766 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
17767 , DocBook, and plaintext.
17770 \begin_layout Standard
17771 As of this writing, XHTML output remains under development and should probably
17773 \begin_inset Quotes eld
17777 \begin_inset Quotes erd
17784 \begin_layout Plain Layout
17786 \begin_inset Flex Code
17789 \begin_layout Plain Layout
17790 development/HTML/HTML.notes
17795 , which can be found in the \SpecialChar LyX
17797 \begin_inset CommandInset href
17799 name "accessed online"
17800 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
17805 , usually contains up-to-date information about the state of XHTML output.
17806 See also the list of XHTML bugs on
17807 \begin_inset CommandInset href
17809 name "the bug tracker"
17810 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"
17820 Still, the developers have chosen this approach because it has several
17821 potential advantages over the other two.
17824 \begin_layout Standard
17825 These advantages are primarily due to the fact that the XHTML output routines,
17826 since they are part of \SpecialChar LyX
17827 , know everything \SpecialChar LyX
17828 knows about the document being
17833 \begin_layout Plain Layout
17834 Another advantage is that, since these routines are internal to \SpecialChar LyX
17836 immune to changes in \SpecialChar LyX
17837 's file format, or to changes in the semantics of
17843 So they know about the table of contents (as displayed in the outline),
17844 about the counters associated with different paragraph styles, and about
17845 user-defined styles.
17846 The XHTML output routines know what \SpecialChar LyX
17847 knows about internationalization,
17848 too, so they will output
17849 \begin_inset Quotes eld
17853 \begin_inset Quotes erd
17857 \begin_inset Quotes eld
17865 \begin_inset Quotes erd
17868 , depending upon the language in effect at the time.
17872 \begin_layout Standard
17873 Quite generally, the output routines know what \SpecialChar LyX
17874 knows about document layout,
17875 that is, about how the document is to be rendered on screen.
17876 We use this information when we output the document as XHTML.
17877 In particular, \SpecialChar LyX
17882 generates CSS style information corresponding to the layout information
17883 it uses to render the document on screen: if section headings are supposed
17884 to be sans-serif and bold as seen in \SpecialChar LyX
17885 , then (by default) they will be sans-seri
17886 f and bold when viewed in a web browser, too.
17887 And this is true not just for pre-defined styles, like Section, but for
17888 any style, including user-defined styles.
17889 Indeed, the XHTML output routines make no distinction between user-defined
17891 \change_deleted 244031559 1603876931
17893 \change_inserted 244031559 1603876940
17896 styles and \SpecialChar LyX
17897 's own pre-defined styles: in each case, everything \SpecialChar LyX
17899 the styles is contained in the layout files.
17900 And much the same is true as regards pre-defined textual insets, such as
17901 footnotes, and various custom insets.
17905 \begin_layout Standard
17906 The result is that XHTML output can be customized and extended in exactly
17907 the same way \SpecialChar LaTeX
17908 output can be customized and extended: through layout files
17910 See chapter five of the
17914 manual for the details.
17917 \begin_layout Standard
17918 The remainder of this chapter contains more detailed information on XHTML
17919 output, its limitations, and ways to work around those limitations.
17922 \begin_layout Section
17923 Math Output in XHTML
17926 \begin_layout Standard
17928 offers four choices for how math is rendered.
17929 These have various advantages and disadvantages:
17932 \begin_layout Itemize
17934 \begin_inset Newline newline
17937 MathML is a dialect of XML designed specifically for mathematics on the
17938 web, and it typically renders very well in browsers that support it.
17939 The disadvantage is that not all browsers support MathML, and support is
17940 not complete even in the Gecko-based browsers, such as Firefox.
17941 \begin_inset Newline newline
17944 If \SpecialChar LyX
17945 is unable to render a formula as MathML—for example, if the formula
17947 \begin_inset Flex Code
17950 \begin_layout Plain Layout
17956 package or ERT—then it will instead output the formula as an image.
17960 \begin_layout Itemize
17962 \begin_inset Newline newline
17965 As mentioned above,
17966 \begin_inset Flex Code
17969 \begin_layout Plain Layout
17975 outputs math as HTML, styled by CSS.
17979 \begin_layout Plain Layout
17981 has borrowed some of the CSS for its HTML output from
17982 \begin_inset Flex Code
17985 \begin_layout Plain Layout
17996 For simple formulae, this can work quite well, though with more complicated
17997 formulae it tends to break down.
17998 Still, this method has the advantage that it is very widely supported and
17999 so it may be appropriate for documents that contain only a little, fairly
18001 \begin_inset Newline newline
18004 If Lyx is unable to render a formula as HTML—for example, if the formula
18006 \begin_inset Flex Code
18009 \begin_layout Plain Layout
18015 package or ERT—then it will instead output the formula as an image.
18019 \begin_layout Itemize
18021 \begin_inset Newline newline
18025 \begin_inset Flex Code
18028 \begin_layout Plain Layout
18035 will output formulae as images, the very same images, in fact, that are
18036 used for instant preview.
18040 \begin_layout Plain Layout
18041 Instant preview does
18045 have to be on for images to be output, however.
18050 The advantage to this method is that the images are simply generated by
18052 , so they are very accurate.
18053 The disadvantage, as mentioned earlier, is that these are bitmapped images,
18054 so they do not scale terribly well, and one cannot copy them, etc.
18055 \begin_inset Newline newline
18058 The size of the images can be controlled by setting the
18059 \begin_inset Quotes eld
18062 Math Images Scaling
18063 \begin_inset Quotes erd
18067 \begin_inset Flex Noun
18070 \begin_layout Plain Layout
18071 Document\SpecialChar menuseparator
18072 Settings\SpecialChar menuseparator
18082 \begin_layout Plain Layout
18083 For those who want to know, this controls the resolution of the image in
18084 dots per inch and is based upon a default of 75 dpi.
18090 \begin_inset Newline newline
18093 If \SpecialChar LyX
18094 for some reason fails to create an image for a formula (e.g., if a required
18096 package is not installed), then it will fall back to outputing the raw
18101 \begin_layout Itemize
18104 \begin_inset Newline newline
18107 Finally, \SpecialChar LyX
18108 will happily output math as \SpecialChar LaTeX
18110 As well as being the output of last resort, this method can be used with
18112 \begin_inset CommandInset href
18115 target "http://www.math.union.edu/~dpvc/jsMath/"
18120 , which uses JavaScript to render \SpecialChar LaTeX
18121 embedded in HTML documents.
18123 wraps the \SpecialChar LaTeX
18125 \begin_inset Flex Code
18128 \begin_layout Plain Layout
18134 (for inline formulas) or
18135 \begin_inset Flex Code
18138 \begin_layout Plain Layout
18144 (for displayed formulas) with
18145 \begin_inset Flex Code
18148 \begin_layout Plain Layout
18154 , as is required for jsMath.
18157 \begin_layout Standard
18158 One of these output methods must be selected under
18159 \begin_inset Flex Noun
18162 \begin_layout Plain Layout
18163 Document\SpecialChar menuseparator
18164 Settings\SpecialChar menuseparator
18171 By default, \SpecialChar LyX
18173 This is a document-wide setting, therefore.
18176 \begin_layout Standard
18177 Eventually, \SpecialChar LyX
18178 will offer the user the option to select an alternate output
18179 method for a particular inset, say, one that isn't being rendered very
18184 \begin_layout Plain Layout
18185 That said, since \SpecialChar LyX
18186 falls back to images if the inset contains ERT, then one
18187 can force output as an image by putting some harmless ERT into the math,
18189 \begin_inset Formula $a=b\relax$
18200 \begin_layout Section
18201 Bibliography and Citations
18204 \begin_layout Standard
18205 XHTML output fully supports bibliographies and citations.
18209 \begin_layout Standard
18210 Citation labels are generated by the same machinery that generates \SpecialChar LyX
18212 labels, so the labels will look in the output much as they do in \SpecialChar LyX
18215 If you are using numerical citations, then \SpecialChar LyX
18216 will output numerical labels,
18217 such as [1] or [17], rather than simply showing the citation key in square
18218 brackets, as it does on-screen.
18219 If you are using author-year citations, then \SpecialChar LyX
18220 will add lowercase letters
18221 to the years, just as Bib\SpecialChar TeX
18222 does, if it finds more than one citation for
18223 a given author-year combination.
18224 The labels will be printed with the bibliography entries.
18225 Note that there is, at present, no way to customize the appearance of the
18226 labels, for example, to choose between square brackets and parentheses.
18229 \begin_layout Standard
18230 Bibliography output is handled by the same machinery that handles the presentati
18231 on of reference information in the citation dialog, so you will see in the
18232 XHTML output pretty much what you would see if you were to look at a given
18233 entry in the citation dialog.
18234 The formatting can be customized in your layout file or, preferably, in
18240 manual for the details.
18243 \begin_layout Standard
18244 The main defect at present is that cross-referenced information is printed
18245 with every entry with which it is associated.
18246 So you can see things like this:
18249 \begin_layout Quote
18251 \begin_inset Quotes eld
18254 Context and Logical Form
18255 \begin_inset Quotes erd
18260 Language in Context: Selected Essays
18262 (Oxford: Oxford University Press, 2007), pp.
18266 \begin_layout Quote
18268 \begin_inset Quotes eld
18271 Semantics in Context
18272 \begin_inset Quotes erd
18277 Language in Context: Selected Essays
18279 (Oxford: Oxford University Press, 2007), pp.
18283 \begin_layout Standard
18284 This should be fixed before long.
18287 \begin_layout Standard
18288 There is no support at present for sectioned bibliographies.
18289 If you have multiple bibliographies, then \SpecialChar LyX
18290 will print the same bibliography
18294 \begin_layout Section
18298 \begin_layout Standard
18300 will happily export indexes as XHTML, but with certain limitations at the
18304 \begin_layout Standard
18305 Index export will be most reliable when you do not attempt to use the fancy
18306 constructs that are described in the section on indexes in the
18314 \begin_layout Plain Layout
18315 The main issue here is that \SpecialChar LyX
18316 itself does not really handle these.
18317 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
18323 We'll describe how they are handled using the subsection headings from
18327 \begin_layout Itemize
18328 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
18329 makes an effort to support these,
18330 but the entries must be separated by
18331 \begin_inset Quotes eld
18335 \begin_inset Quotes erd
18338 , that is, there must be spaces around the exclamation point.
18339 This is because it is otherwise too difficult to check for escaped exclamation
18340 points, ones in math, and so forth.
18343 \begin_layout Itemize
18344 Page Ranges: There is no support at all for page ranges, since these make
18345 no sense with XHMTL.
18346 Instead, you will just get two index entries, one at either end.
18349 \begin_layout Itemize
18350 Cross-referencing: There is no support for cross-referencing.
18351 If \SpecialChar LyX
18352 finds an entry containing the
18353 \begin_inset Quotes eld
18356 |see\SpecialChar ldots
18358 \begin_inset Quotes erd
18361 construct, it is just dropped, and the rest is treated as an ordinary index
18365 \begin_layout Itemize
18366 Index Entry Order: \SpecialChar LyX
18367 does support attempts to fix the sorting order.
18368 It will take what is before the first `@' it finds and use that for sorting,
18369 taking what follows the first `@' to be the actual entry.
18370 At present, \SpecialChar LyX
18371 does not check for escaped `@', so do not try to index email
18375 \begin_layout Itemize
18376 Index Entry Layout: You can format entries by using the text style dialog,
18377 or by using any other method available within \SpecialChar LyX
18379 There is no support for constructs like:
18380 \begin_inset Quotes eld
18384 \begin_inset Quotes erd
18388 Indeed, if \SpecialChar LyX
18389 finds a pipe symbol, `|', in an entry, it will delete it and
18390 everything that follows it.
18393 \begin_layout Itemize
18394 Multiple Indexes: There is no support for multiple indexes.
18395 Rather, all index entries will be printed as one large index.
18396 To avoid our printing several versions of the index, we print only the
18397 main index, so make sure you have one.
18400 \begin_layout Section
18401 Nomenclature and Glossary
18404 \begin_layout Standard
18405 There is at present no support for glossaries.
18406 Adding it would be fairly trivial, and welcome.
18409 \begin_layout Chapter
18411 \change_inserted 1075283030 1616534180
18415 \begin_layout Standard
18417 \change_inserted 1075283030 1616534386
18418 Apart from HTML, \SpecialChar LyX
18419 can generate documents in the DocBook XML vocabulary.
18420 With versions 2.3 and before, only select templates could be used to generate
18421 DocBook documents (only version 4).
18422 Starting with \SpecialChar LyX
18423 2.4, most \SpecialChar LyX
18424 layouts can generate valid DocBook documents (only
18426 This feature is built into \SpecialChar LyX
18427 and does not require the use of external tools.
18430 \begin_layout Standard
18432 \change_inserted 1075283030 1616534437
18433 The result is that the DocBook output can be customized and extended in
18434 exactly the same way \SpecialChar LaTeX
18435 output can be customized and extended: through layout
18437 See chapter five of the
18441 manual for the details.
18444 \begin_layout Standard
18446 \change_inserted 1075283030 1616534475
18447 Most \SpecialChar LyX
18448 features are supported with DocBook, like math output.
18451 \begin_layout Itemize
18453 \change_inserted 1075283030 1616534741
18454 Math output is performed mostly in MathML (the major exception being constructio
18455 ns not supported by \SpecialChar LyX
18458 All formulae are also available in raw \SpecialChar TeX
18459 in the DocBook output for further
18463 \begin_layout Itemize
18465 \change_inserted 1075283030 1616534852
18466 Bibliographies and citations are implemented, including with an external
18468 Bibliography entries are not prerendered when the detailed information
18469 are available, but rather output with the standard DocBook constructs.
18470 The external DocBook processor is expected to handle the rendering of entries.
18473 \begin_layout Itemize
18475 \change_inserted 1075283030 1616534863
18476 Indexes are supported, including multiple indices.
18481 ), page ranges, and cross-references (
18485 ) are supported, with the exception of the same symbols escaped.
18494 ) are not supported.
18495 There is no support for escaping of index entries.
18498 \begin_layout Itemize
18500 \change_inserted 1075283030 1616534884
18501 Glossaries are implemented.
18504 \begin_layout Standard
18506 \change_inserted 1075283030 1616534894
18507 Two major parameters can be set at the document level.
18510 \begin_layout Itemize
18512 \change_inserted 1075283030 1616534948
18513 Format for tables: \SpecialChar LyX
18514 can generate tables either as HTML (default value) or
18515 CALS, depending on the user's requirements.
18516 Most DocBook processors accept both formats.
18519 \begin_layout Itemize
18521 \change_inserted 1075283030 1616535006
18522 MathML prefix: in DocBook, MathML is included within its own name space,
18524 The implication is that there must be an indication of the tags belonging
18525 to the MathML standard.
18526 Three choices are offered:
18530 \begin_layout Itemize
18532 \change_inserted 1075283030 1616535044
18533 Inline: the MathML name space is defined for each formula (using the
18537 attribute on each formula)
18540 \begin_layout Itemize
18542 \change_inserted 1075283030 1616535090
18547 prefix (default): the MathML name space is defined at the document level
18552 attribute on the root element).
18553 Each MathML is prefixed with
18562 \begin_layout Itemize
18564 \change_inserted 1075283030 1616620405
18569 prefix: similar to the
18578 \begin_layout Standard
18580 \change_inserted 1075283030 1616620470
18581 This option is especially useful if you want \SpecialChar LyX
18582 to match your personal style
18583 or to work with buggy software that only accepts one prefix for MathML.
18589 \begin_layout Chapter
18590 The \SpecialChar LyX
18594 \begin_layout Section
18598 \begin_layout Standard
18599 The `\SpecialChar LyX
18600 server' allows other programs to talk to \SpecialChar LyX
18601 , invoke \SpecialChar LyX
18602 commands, and retrieve
18603 information about the \SpecialChar LyX
18605 This is only intended for advanced users, but they should find it useful.
18606 It is by writing to the \SpecialChar LyX
18607 server, for example, that bibliography managers,
18608 such as JabRef, are able to
18609 \begin_inset Quotes eld
18613 \begin_inset Quotes erd
18616 citations to \SpecialChar LyX
18620 \begin_layout Section
18621 Starting the \SpecialChar LyX
18623 \begin_inset CommandInset label
18625 name "sec:Starting-the-Server"
18632 \begin_layout Standard
18633 The \SpecialChar LyX
18634 server works through the use of a pair of named pipes.
18635 These are usually located in
18636 \begin_inset Flex Code
18639 \begin_layout Plain Layout
18645 , (except on Windows, where
18649 named pipes are special objects located in
18650 \begin_inset Flex Code
18653 \begin_layout Plain Layout
18665 ) and have the names
18666 \begin_inset Quotes eld
18670 \begin_inset Flex Code
18673 \begin_layout Plain Layout
18680 \begin_inset Quotes erd
18684 \begin_inset Quotes eld
18688 \begin_inset Flex Code
18691 \begin_layout Plain Layout
18698 \begin_inset Quotes erd
18702 External programs write into
18703 \begin_inset Flex Code
18706 \begin_layout Plain Layout
18712 and read back data from
18713 \begin_inset Flex Code
18716 \begin_layout Plain Layout
18723 The stem of the pipe names can be defined in the
18724 \begin_inset Flex Noun
18727 \begin_layout Plain Layout
18728 Tools\SpecialChar menuseparator
18734 dialog, for example
18735 \begin_inset Flex Code
18738 \begin_layout Plain Layout
18739 "/home/myhome/lyxpipe"
18745 \begin_inset Flex Code
18748 \begin_layout Plain Layout
18762 on Windows (where any working path instead of lyxpipe can be used, for
18764 \begin_inset Flex Code
18767 \begin_layout Plain Layout
18790 configure this manually in order for the server to start.
18793 \begin_layout Standard
18796 \begin_inset Flex Code
18799 \begin_layout Plain Layout
18806 \begin_inset Flex Code
18809 \begin_layout Plain Layout
18815 ' to create the pipes.
18816 If one of the pipes already exists, \SpecialChar LyX
18817 will assume that another \SpecialChar LyX
18819 is already running and will not start the server.
18820 On POSIX (Unix like) systems, if for some other reason, an unused
18821 \begin_inset Quotes eld
18825 \begin_inset Quotes erd
18828 pipe is left in existence when \SpecialChar LyX
18829 closes, then \SpecialChar LyX
18830 will try to delete it.
18831 If this fails for some reason, you will need to delete the pipes manually
18832 and then restart \SpecialChar LyX
18834 On Windows, pipes are deleted by the OS on program termination or crash,
18836 \begin_inset Quotes eld
18840 \begin_inset Quotes erd
18843 pipes should not be possible.
18846 \begin_layout Standard
18847 To have several \SpecialChar LyX
18848 processes with servers at the same time, you have to use
18849 different configurations, perhaps by using separate user directories, each
18851 \begin_inset Flex Code
18854 \begin_layout Plain Layout
18860 file, for each process.
18863 \begin_layout Standard
18864 If you are developing a client program, you might find it useful to enable
18865 debugging information from the \SpecialChar LyX
18867 Do this by starting \SpecialChar LyX
18869 \begin_inset Flex Code
18872 \begin_layout Plain Layout
18881 \begin_layout Standard
18882 You can find a complete example client written in C++ in the source distribution
18884 \begin_inset Flex Code
18887 \begin_layout Plain Layout
18888 development/lyxserver/server_monitor.cpp
18896 \begin_layout Standard
18897 Another useful tool is the command-line based client found in
18898 \begin_inset Flex Code
18901 \begin_layout Plain Layout
18902 src/client/lyxclient
18910 \begin_layout Section
18911 Normal communication
18914 \begin_layout Standard
18915 To issue a \SpecialChar LyX
18916 call, the client writes a line of ASCII text into the input
18918 This line has the following format:
18921 \begin_layout Quote
18935 \begin_layout Description
18936 clientname is a name that the client can choose arbitrarily.
18937 Its only use is that \SpecialChar LyX
18938 will echo it if it sends an answer—so a client can
18939 dispatch results from different requesters.
18942 \begin_layout Description
18943 function is the function you want \SpecialChar LyX
18945 It is the same as the commands you'd use in the minibuffer.
18948 \begin_layout Description
18949 argument is an optional argument which is meaningful only to some functions
18951 \begin_inset Quotes eld
18955 \begin_inset Quotes erd
18958 LFUN will insert the argument as text at the cursor position).
18961 \begin_layout Standard
18962 The answer from \SpecialChar LyX
18963 will arrive in the output pipe and be of the form
18966 \begin_layout Quote
18980 \begin_layout Standard
18989 are just echoed from the command request, while
18993 is more or less useful information filled according to how the command
18994 execution worked out.
18995 Some commands, such as
18996 \begin_inset Quotes eld
19000 \begin_inset Quotes erd
19003 , will return information about the internal state of \SpecialChar LyX
19005 return an empty data-response.
19006 This means that the command execution went fine.
19009 \begin_layout Standard
19010 In case of errors, the response from \SpecialChar LyX
19011 will have this form
19014 \begin_layout Quote
19028 \begin_layout Standard
19033 should contain an explanation of why the command failed.
19036 \begin_layout Standard
19040 \begin_layout LyX-Code
19041 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
19042 \begin_inset Newline newline
19045 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
19046 \begin_inset Newline newline
19049 read a <~/.lyxpipe.out
19050 \begin_inset Newline newline
19056 \begin_layout Subsection
19057 AppleScript (Mac OS X)
19060 \begin_layout Standard
19061 Since \SpecialChar LyX
19062 2.1, \SpecialChar LyX
19063 supports basic interactions with AppleScript for normal communicatio
19064 n through the command run.
19065 This command takes a direct argument (the
19069 to perform) and an optional argument.
19070 It either returns the output of the function or triggers an error with
19071 the error message and code.
19074 \begin_layout Standard
19078 \begin_layout LyX-Code
19079 tell application "\SpecialChar LyX
19083 \begin_layout LyX-Code
19087 \begin_layout LyX-Code
19088 -- Stores the current file name into f
19091 \begin_layout LyX-Code
19092 set f to (run "server-get-filename" with argument "")
19095 \begin_layout LyX-Code
19096 on error the error_message number the error_number
19099 \begin_layout LyX-Code
19100 display dialog "Error: " & the error_number & ".
19104 \begin_layout LyX-Code
19105 & the error_message buttons {"OK"} default button 1
19108 \begin_layout LyX-Code
19112 \begin_layout LyX-Code
19116 \begin_layout Section
19120 \begin_layout Standard
19122 can notify clients of events going on asynchronously.
19123 Currently it will only do this if the user binds a key sequence with the
19125 \begin_inset Quotes eld
19129 \begin_inset Quotes erd
19133 The format of the string \SpecialChar LyX
19134 sends is as follows:
19137 \begin_layout Quote
19138 \begin_inset Flex Code
19141 \begin_layout Plain Layout
19152 \begin_layout Standard
19157 is the printed representation of the key sequence that was actually typed
19161 \begin_layout Standard
19162 This mechanism can be used to extend \SpecialChar LyX
19163 's command set and implement macros.
19164 Bind some key sequence to
19165 \begin_inset Quotes eld
19169 \begin_inset Quotes erd
19173 Then start a client that listens on the output pipe, dispatches the command
19174 according to the sequence, and starts a function that may use \SpecialChar LyX
19177 requests to issue a command or a series of commands to \SpecialChar LyX
19181 \begin_layout Section
19182 The simple \SpecialChar LyX
19186 \begin_layout Standard
19188 implements a simple protocol that can be used for session management.
19189 All messages are of the form
19192 \begin_layout Quote
19202 \begin_layout Standard
19208 \begin_inset Quotes eld
19212 \begin_inset Quotes erd
19216 \begin_inset Quotes eld
19220 \begin_inset Quotes erd
19225 \begin_inset Quotes eld
19229 \begin_inset Quotes erd
19232 is received from a client, \SpecialChar LyX
19233 will report back to inform the client that
19234 it's listening to it's messages, while
19235 \begin_inset Quotes eld
19239 \begin_inset Quotes erd
19242 sent from \SpecialChar LyX
19243 will inform clients that \SpecialChar LyX
19247 \begin_layout Section
19248 Reverse DVI/PDF search
19251 \begin_layout Standard
19252 Some DVI/PDF viewers
19256 \begin_layout Plain Layout
19257 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
19258 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
19267 facility (also called
19272 This means that you can tell \SpecialChar LyX
19273 to put the cursor to a specific line in the
19274 document by clicking at the respective position in the DVI/PDF output.
19275 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
19277 This is done via the \SpecialChar LyX
19278 server either by using the named pipe (
19282 ), or the UNIX domain socket (
19286 ) that \SpecialChar LyX
19287 creates in its temporary directory (this is the way the
19288 \begin_inset Flex Code
19291 \begin_layout Plain Layout
19297 program communicates with \SpecialChar LyX
19299 In some cases, you need a helper script that mediates between the viewer
19300 and \SpecialChar LyX
19301 , in others, the viewer can communicate with \SpecialChar LyX
19303 This depends on the selected viewer and on your operating system.
19304 The same applies to the way viewers need to be configured and the way the
19305 reverse search is actually performed.
19306 In what follows, we will thus describe how to setup reverse search for
19308 Before we turn to this, though, we will explain what needs to be done generally
19309 to enable reverse search in the DVI/PDF output.
19312 \begin_layout Subsection
19314 \begin_inset CommandInset label
19316 name "subsec:rev-search"
19323 \begin_layout Standard
19324 In most cases \SpecialChar LyX
19325 will do the work for you by pressing the following button
19329 arg "buffer-toggle-output-sync"
19333 Alternatively, you can also enable the feature by checking
19335 Synchronize with Output
19338 \begin_inset Flex Noun
19341 \begin_layout Plain Layout
19342 Document\SpecialChar menuseparator
19343 Settings\SpecialChar menuseparator
19350 In such a case \SpecialChar LyX
19351 will automatically insert the necessary Sync\SpecialChar TeX
19353 PDF) or load the srcltx package (for DVI) respectively.
19354 This option can be easily reached also on
19355 \begin_inset Flex Code
19358 \begin_layout Plain Layout
19367 \begin_layout Standard
19368 If you need a different setting, you can select or input a custom macro
19369 from the drop down box just below
19370 \begin_inset Flex Noun
19373 \begin_layout Plain Layout
19374 Document\SpecialChar menuseparator
19375 Settings\SpecialChar menuseparator
19376 Output\SpecialChar menuseparator
19377 Synchronize with Output
19385 \begin_layout Standard
19386 Note that the method
19387 \begin_inset Flex Code
19390 \begin_layout Plain Layout
19398 enables gzip compression.
19399 If your viewer does not support it, you should instead use
19400 \begin_inset Flex Code
19403 \begin_layout Plain Layout
19414 \begin_layout Standard
19415 Please also note that including the
19416 \begin_inset Flex Code
19419 \begin_layout Plain Layout
19426 \begin_inset Flex Code
19429 \begin_layout Plain Layout
19435 sometimes has an undesired impact on the typesetting.
19436 Thus, you should switch output synchronization off for the final typesetting
19438 \begin_inset Flex Code
19441 \begin_layout Plain Layout
19448 \begin_inset Flex Code
19451 \begin_layout Plain Layout
19461 \begin_layout Standard
19462 In case you need some more special settings that are not covered by the
19463 automatic settings, read the next section about how to set up output synchroniz
19465 If the automatic setup suits your needs, you can readily jump to section
19466 \begin_inset space ~
19470 \begin_inset CommandInset ref
19472 reference "subsec:configuring-viewers"
19476 , where the necessary configuration steps in your viewer – needed both with
19477 the automatic and the manual setup – are described.
19480 \begin_layout Subsection
19484 \begin_layout Standard
19486 provides several different methods for reverse search.
19487 Some are built-in in the
19488 \begin_inset Flex Code
19491 \begin_layout Plain Layout
19497 program, some are provided by external packages.
19498 Your choice depends on whether your \SpecialChar LaTeX
19499 distribution already provides a given
19500 method (the built-in methods are rather new) and whether your viewer can
19502 The available methods are described in the following.
19505 \begin_layout Subsubsection*
19506 Built-in DVI-search via src-specials (DVI only)
19509 \begin_layout Standard
19510 This method provides the DVI file with the necessary information for reverse
19512 It is available in \SpecialChar LaTeX
19513 since quite some time (any somewhat recent \SpecialChar LaTeX
19515 should include it), and it works reliably.
19516 To enable it, change the
19517 \begin_inset Flex Noun
19520 \begin_layout Plain Layout
19531 \begin_inset Flex Noun
19534 \begin_layout Plain Layout
19545 \begin_inset Flex Noun
19548 \begin_layout Plain Layout
19549 Preferences\SpecialChar menuseparator
19550 File Handling\SpecialChar menuseparator
19557 \begin_inset Flex Code
19560 \begin_layout Plain Layout
19561 latex -src-specials $$i
19567 If this doesn't work, check if your \SpecialChar TeX
19568 engine needs different options (the
19569 syntax might differ in some distributions).
19572 \begin_layout Subsubsection*
19573 External Packages (PDFSync and scrltx)
19576 \begin_layout Standard
19585 provide reverse search facility for PDF output (via pdflatex) and DVI output,
19587 In order to enable it, load the packages in the \SpecialChar LyX
19591 \begin_layout Itemize
19592 \begin_inset Flex Code
19595 \begin_layout Plain Layout
19598 usepackage{pdfsync}
19603 for reverse PDF search,
19606 \begin_layout Itemize
19607 \begin_inset Flex Code
19610 \begin_layout Plain Layout
19613 usepackage[active]{srcltx}
19618 for reverse DVI search.
19621 \begin_layout Standard
19622 If you want to be able to perform both DVI and PDF reverse searches, you
19623 can also insert in the preamble the following lines
19626 \begin_layout LyX-Code
19630 \begin_inset Newline newline
19636 \begin_inset Newline newline
19641 usepackage{pdfsync}
19642 \begin_inset Newline newline
19648 \begin_inset Newline newline
19653 usepackage[active]{srcltx}
19654 \begin_inset Newline newline
19662 \begin_layout Standard
19663 This way, you can preview the file as either DVI or PDF (pdflatex) and the
19664 right package will be used.
19667 \begin_layout Standard
19668 Note that PDFSync might affect the output layout of your document.
19669 It is therefore advised to disable PDFsync for final documents.
19672 \begin_layout Subsubsection*
19673 Built-in reverse search via Sync\SpecialChar TeX
19677 \begin_layout Standard
19679 \begin_inset Flex Code
19682 \begin_layout Plain Layout
19688 have built-in support for both PDF and DVI reverse search.
19691 Sync\SpecialChar TeX
19694 facility is basically the result of the integration of the PDFSync package
19695 to the pdftex program and its merge with the
19700 You need at least \SpecialChar TeX
19701 Live 2008 or a recent Mik\SpecialChar TeX
19702 distribution in order to use
19707 \begin_layout Plain Layout
19708 For some reason, Mik\SpecialChar TeX
19709 does not understand/obey the command \SpecialChar LyX
19711 the preamble when you check the "Enable Forward/Reverse Search" button
19712 in the toolbar and does not generate the necessary info.
19715 \begin_layout Plain Layout
19716 The generation of the required info can be forced by changing the converter
19717 "\SpecialChar LaTeX
19718 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
19719 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
19720 the -synctex=1 switch).
19725 Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
19726 Skim on the Mac, SumatraPDF on Windows; see the next section for details)
19727 already provide Sync\SpecialChar TeX
19731 \begin_layout Standard
19732 To enable Sync\SpecialChar TeX
19733 for DVI output, change the
19734 \begin_inset Flex Noun
19737 \begin_layout Plain Layout
19748 \begin_inset Flex Noun
19751 \begin_layout Plain Layout
19756 (plain) -> DraftDVI
19762 \begin_inset Flex Noun
19765 \begin_layout Plain Layout
19766 Preferences\SpecialChar menuseparator
19767 File Handling\SpecialChar menuseparator
19774 \begin_inset Flex Code
19777 \begin_layout Plain Layout
19778 latex -synctex=1 $$i
19783 , and for PDF output, change the
19784 \begin_inset Flex Noun
19787 \begin_layout Plain Layout
19792 (pdflatex) -> PDF (pdflatex)
19798 \begin_inset Flex Code
19801 \begin_layout Plain Layout
19802 pdflatex -synctex=1 $$i
19808 Should your viewer not be considered in the following description, or in
19809 case of missing success, please check the documentation of your viewer
19810 whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
19815 \begin_layout Plain Layout
19816 Note that the option
19817 \begin_inset Flex Code
19820 \begin_layout Plain Layout
19826 option enables gzip compression.
19827 If your viewer does not support it, you should instead use
19828 \begin_inset Flex Code
19831 \begin_layout Plain Layout
19845 \begin_layout Subsection
19846 Configuring and using specific viewers
19847 \begin_inset CommandInset label
19849 name "subsec:configuring-viewers"
19856 \begin_layout Subsubsection*
19857 Xdvi (all platforms)
19860 \begin_layout Standard
19862 \begin_inset Flex Code
19865 \begin_layout Plain Layout
19871 , you don't need to do anything else for performing a reverse DVI search,
19872 as \SpecialChar LyX
19873 already provides the necessary hooks for automatically using the
19874 \begin_inset Flex Code
19877 \begin_layout Plain Layout
19884 Just setup your document as described above (reverse search is triggered
19885 by Ctrl-click or Alt-click on Mac OSX, respectively).
19888 \begin_layout Standard
19889 However, if for whatever reason you want to use the named pipe instead of
19890 the socket for communicating with \SpecialChar LyX
19891 , simply change the DVI viewer in
19892 \begin_inset Flex Noun
19895 \begin_layout Plain Layout
19896 Preferences\SpecialChar menuseparator
19897 File Handling\SpecialChar menuseparator
19907 \begin_layout Plain Layout
19908 On Mac OSX you have to use
19909 \begin_inset Flex Code
19912 \begin_layout Plain Layout
19913 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
19924 \begin_inset Flex Code
19927 \begin_layout Plain Layout
19928 xdvi -editor "lyxeditor.sh %f %l"
19934 \begin_inset Flex Code
19937 \begin_layout Plain Layout
19943 is a suitable script.
19944 For example, a minimal shell script is the following one:
19947 \begin_layout LyX-Code
19949 \begin_inset Newline newline
19952 LYXPIPE="/path/to/lyxpipe"
19953 \begin_inset Newline newline
19956 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
19957 \begin_inset Newline newline
19960 echo "$COMMAND" > "${LYXPIPE}".in || exit
19961 \begin_inset Newline newline
19964 read TMP < "${LYXPIPE}".out || exit
19967 \begin_layout Standard
19969 \begin_inset Flex Code
19972 \begin_layout Plain Layout
19978 is the LyXServer pipe path specified in
19979 \begin_inset Flex Noun
19982 \begin_layout Plain Layout
19983 Preferences\SpecialChar menuseparator
19993 \begin_layout Plain Layout
19995 \begin_inset Flex Code
19998 \begin_layout Plain Layout
20004 folder of a source distribution you can find a
20005 \begin_inset Flex Code
20008 \begin_layout Plain Layout
20014 script which is able to locate the
20018 based on your preferences.
20026 \begin_layout Subsubsection*
20030 \begin_layout Standard
20032 \begin_inset Flex Code
20035 \begin_layout Plain Layout
20036 /Applications/MacDviX_Folder/calleditor.script
20041 , add the following lines:
20044 \begin_layout LyX-Code
20045 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
20046 \begin_inset Newline newline
20052 \begin_layout Standard
20053 Modify the lines accordingly if you install \SpecialChar LyX
20054 somewhere else than in the
20055 Applications folder.
20058 \begin_layout Standard
20059 Reverse search is triggered by Alt-click (OPTION-click).
20062 \begin_layout Subsubsection*
20066 \begin_layout Standard
20068 \begin_inset Flex Code
20071 \begin_layout Plain Layout
20072 open -a Skim.app $$i
20077 to the viewer setting in
20078 \begin_inset Flex Noun
20081 \begin_layout Plain Layout
20082 Preferences\SpecialChar menuseparator
20083 File Handling\SpecialChar menuseparator
20084 File formats\SpecialChar menuseparator
20091 \begin_inset Flex Noun
20094 \begin_layout Plain Layout
20095 Skim\SpecialChar menuseparator
20096 Preferences\SpecialChar menuseparator
20103 \begin_inset Flex Noun
20106 \begin_layout Plain Layout
20112 preset and enter command
20113 \begin_inset Flex Noun
20116 \begin_layout Plain Layout
20117 /Applications/\SpecialChar LyX
20118 .app/Contents/MacOS/lyxeditor
20126 \begin_layout Standard
20127 Reverse search is triggered by COMMAND-SHIFT-click
20130 \begin_layout Subsubsection*
20134 \begin_layout Standard
20135 Reverse search with evince does not work out of the box, but it can be achieved
20136 by means of some third party helper scripts.
20138 \begin_inset CommandInset href
20140 target "https://wiki.lyx.org/LyX/SyncTeX"
20148 \begin_layout Subsubsection*
20152 \begin_layout Standard
20154 \begin_inset Flex Noun
20157 \begin_layout Plain Layout
20158 Settings\SpecialChar menuseparator
20159 Configure Okular\SpecialChar menuseparator
20166 \begin_inset Quotes erd
20170 This inserts the appropriate command (
20171 \begin_inset Flex Code
20174 \begin_layout Plain Layout
20183 \begin_layout Standard
20184 Reverse search is triggered by SHIFT-click.
20186 \change_inserted -712698321 1578211026
20187 Note that this only works if Okular is in
20188 \begin_inset Quotes eld
20192 \begin_inset Quotes erd
20196 \begin_inset space \thinspace{}
20199 e., the hand symbol is clicked).
20204 \begin_layout Subsubsection*
20208 \begin_layout Standard
20209 Qpdfview supports Sync\SpecialChar TeX
20210 since version 0.3.5.
20212 \begin_inset Flex Noun
20215 \begin_layout Plain Layout
20216 Edit\SpecialChar menuseparator
20217 Settings\SpecialChar menuseparator
20223 , click on the input field of the
20224 \begin_inset Quotes eld
20228 \begin_inset Quotes erd
20231 item and add the command
20232 \begin_inset Flex Code
20235 \begin_layout Plain Layout
20244 \begin_layout Standard
20245 Reverse search is triggered by double-click or, in more recent versions,
20249 \begin_layout Subsubsection*
20253 \begin_layout Standard
20254 Launch yap, choose its
20255 \begin_inset Flex Noun
20258 \begin_layout Plain Layout
20259 View\SpecialChar menuseparator
20265 menu and select the
20266 \begin_inset Quotes eld
20270 \begin_inset Quotes erd
20275 \begin_inset Quotes eld
20278 New\SpecialChar ldots
20280 \begin_inset Quotes erd
20283 button and, in the window that opens, enter
20284 \begin_inset Quotes eld
20289 \begin_inset Quotes erd
20292 (or any other name you like) in the
20293 \begin_inset Quotes eld
20297 \begin_inset Quotes erd
20301 Now click on the button labeled
20302 \begin_inset Quotes eld
20307 \begin_inset Quotes erd
20310 to open a file dialog and navigate to the directory containing the batch
20312 \begin_inset Flex Code
20315 \begin_layout Plain Layout
20323 \begin_inset Flex Code
20326 \begin_layout Plain Layout
20332 and then specify the program arguments as
20333 \begin_inset Flex Code
20336 \begin_layout Plain Layout
20344 \begin_inset Flex Code
20347 \begin_layout Plain Layout
20353 wrapper is used for communicating with \SpecialChar LyX
20361 \begin_layout LyX-Code
20363 \begin_inset Newline newline
20366 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
20375 \begin_inset Newline newline
20389 \begin_layout Standard
20390 Make sure that the \SpecialChar LyX
20391 Server pipe path you specified in \SpecialChar LyX
20393 \begin_inset Flex Code
20396 \begin_layout Plain Layout
20410 , otherwise change the
20411 \begin_inset Flex Code
20414 \begin_layout Plain Layout
20420 wrapper accordingly.
20423 \begin_layout Standard
20424 In yap, reverse search is triggered by double-click.
20427 \begin_layout Subsubsection*
20428 SumatraPDF (Windows)
20431 \begin_layout Standard
20432 In order to use SumatraPDF for inverse search, enter
20433 \begin_inset Flex Code
20436 \begin_layout Plain Layout
20437 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
20442 in the viewer setting in
20443 \begin_inset Flex Noun
20446 \begin_layout Plain Layout
20447 Preferences\SpecialChar menuseparator
20448 File Handling\SpecialChar menuseparator
20449 File formats\SpecialChar menuseparator
20456 \begin_inset Flex Code
20459 \begin_layout Plain Layout
20465 is the previous wrapper.
20466 If SumatraPDF.exe is not in your command PATH, use its full file name.
20469 \begin_layout Standard
20470 Reverse search is triggered by double-click.
20473 \begin_layout Subsubsection*
20477 \begin_layout Standard
20478 First of all, make sure that yap is your default DVI viewer in the Windows
20479 environment, then launch it, choose its
20480 \begin_inset Flex Noun
20483 \begin_layout Plain Layout
20484 View\SpecialChar menuseparator
20490 menu and select the
20491 \begin_inset Quotes eld
20495 \begin_inset Quotes erd
20500 \begin_inset Quotes eld
20503 New\SpecialChar ldots
20505 \begin_inset Quotes erd
20508 button and, in the window that opens, enter
20509 \begin_inset Quotes eld
20514 \begin_inset Quotes erd
20517 (or any other name you like) in the
20518 \begin_inset Quotes eld
20522 \begin_inset Quotes erd
20526 Now click on the button labeled
20527 \begin_inset Quotes eld
20532 \begin_inset Quotes erd
20535 to open a file dialog and navigate to the directory containing the
20536 \begin_inset Flex Code
20539 \begin_layout Plain Layout
20545 program (which is installed by default on Cygwin along with the \SpecialChar LyX
20548 \begin_inset Flex Code
20551 \begin_layout Plain Layout
20557 and then specify the program arguments as
20558 \begin_inset Flex Code
20561 \begin_layout Plain Layout
20568 In this way, you will be using the
20572 for communicating with \SpecialChar LyX
20574 If, for whatever reason, you want to use the
20579 \begin_inset Flex Code
20582 \begin_layout Plain Layout
20588 option and be sure to specify the \SpecialChar LyX
20589 Server pipe path in the \SpecialChar LyX
20593 \begin_layout Standard
20594 In yap, reverse search is triggered by double-click.
20597 \begin_layout Subsubsection*
20598 SumatraPDF (Cygwin)
20601 \begin_layout Standard
20602 In order to use SumatraPDF for inverse search, enter
20603 \begin_inset Flex Code
20606 \begin_layout Plain Layout
20607 SumatraPDF -inverse-search "lyxeditor -g %f %l"
20612 in the viewer setting in
20613 \begin_inset Flex Noun
20616 \begin_layout Plain Layout
20617 Preferences\SpecialChar menuseparator
20618 File Handling\SpecialChar menuseparator
20619 File formats\SpecialChar menuseparator
20626 If SumatraPDF.exe is not in your command PATH, use its full posix path.
20628 \begin_inset Flex Code
20631 \begin_layout Plain Layout
20637 enables communication via the
20643 \begin_inset Flex Code
20646 \begin_layout Plain Layout
20652 option if you want to use the
20656 , and be sure to specify the \SpecialChar LyX
20657 Server pipe path in the \SpecialChar LyX
20661 \begin_layout Standard
20662 Reverse search is triggered by double-click.
20665 \begin_layout Section
20669 \begin_layout Standard
20670 Forward search is, as the name implies, in a sense the
20671 \begin_inset Quotes eld
20675 \begin_inset Quotes erd
20679 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
20681 If forward search is set up (as described in what follows), you can put
20682 the cursor anywhere in your \SpecialChar LyX
20684 \begin_inset Flex Noun
20687 \begin_layout Plain Layout
20688 Navigate\SpecialChar menuseparator
20695 \begin_inset Flex Noun
20698 \begin_layout Plain Layout
20704 in the context menu via right mouse click), and then the viewer will jump
20705 to that position as well.
20706 This implies, of course, that your viewer supports this function.
20709 \begin_layout Standard
20710 To make forward search possible, you first need to provide the generated
20711 output PDF/DVI file with additional information about the \SpecialChar TeX
20713 This can be done via the methods described in the section
20714 \begin_inset CommandInset ref
20716 reference "subsec:rev-search"
20723 \begin_layout Standard
20724 Additionally, you need to configure \SpecialChar LyX
20725 for using your viewers in
20726 \begin_inset Flex Noun
20729 \begin_layout Plain Layout
20730 Tools\SpecialChar menuseparator
20731 Preferences\SpecialChar menuseparator
20732 Output\SpecialChar menuseparator
20739 We provide a range of tested configurations for some viewers, which you
20740 can select from the drop down list.
20741 If none of these configurations suits you, you have to find out and enter
20742 a suitable configuration yourself.
20743 The definition syntax uses the following placeholders:
20746 \begin_layout Itemize
20748 \begin_inset Flex Code
20751 \begin_layout Plain Layout
20760 \begin_layout Itemize
20762 \begin_inset Flex Code
20765 \begin_layout Plain Layout
20771 : name of the (temporary) exported .tex file (without path)
20774 \begin_layout Itemize
20776 \begin_inset Flex Code
20779 \begin_layout Plain Layout
20785 : name of the (temporary) exported .tex file (including path)
20788 \begin_layout Itemize
20790 \begin_inset Flex Code
20793 \begin_layout Plain Layout
20799 : name of the exported output file (either dvi or pdf, depending on which
20800 one exists in the temporary directory)
20803 \begin_layout Standard
20804 Note that only some of the viewers provide full and usable forward search
20805 functionality out of the box, among them yap, xdvi, okular
20809 \begin_layout Plain Layout
20810 You might want to set
20811 \begin_inset Flex Code
20814 \begin_layout Plain Layout
20821 \begin_inset Flex Noun
20824 \begin_layout Plain Layout
20825 Tools\SpecialChar menuseparator
20826 Preferences\SpecialChar menuseparator
20827 File Handling\SpecialChar menuseparator
20829 \begin_inset space ~
20842 , qpdfview, and SumatraPDF
20846 \begin_layout Plain Layout
20847 SumatraPDF can also use DDE commands through the external program CMCDDE
20848 — downloadable from
20849 \begin_inset CommandInset href
20851 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
20862 Others, such as evince
20866 \begin_layout Plain Layout
20867 Forward search with evince can be achieved by means of third party helper
20870 \begin_inset CommandInset href
20872 target "https://wiki.lyx.org/LyX/SyncTeX"
20882 , require some extra tools in order to use forward search.
20883 While many of the widespread PDF viewers (most notably Adobe Reader) do
20884 not support forward search at all, some other viewers – e.
20885 \begin_inset space \thinspace{}
20889 xpdf – allow at least to reload the document and jump to a specific page
20890 of the file, so you can at least navigate
20891 \begin_inset Quotes eld
20895 \begin_inset Quotes erd
20899 This latter functionality is provided by an external call of synctex (see
20900 the predefined example configurations).
20904 \begin_layout Standard
20905 Forward search works both with DVI and PDF output.
20907 simply checks which preview format you have used before (i.
20908 \begin_inset space \thinspace{}
20911 e., which format is already there in the temporary directory) and chooses
20912 the appropriate configuration for the respective format.
20915 \begin_layout Chapter
20917 \change_deleted 564990737 1671097409
20918 Special Document Classes
20923 \begin_layout Section
20925 \change_deleted 564990737 1669742044
20929 \begin_layout Standard
20931 \change_deleted 564990737 1669742044
20937 \begin_layout Subsection
20939 \change_deleted 564990737 1669742044
20943 \begin_layout Standard
20945 \change_deleted 564990737 1669742044
20946 This section describes how \SpecialChar LyX
20947 can be used to write articles for submission
20948 to the scientific journal
20950 Astronomy and Astrophysics
20953 \begin_inset Flex URL
20956 \begin_layout Plain Layout
20958 https://www.aanda.org/
20963 ) using Version 5.01 of the document class
20968 This package can be downloaded from the ftp site
20971 \begin_layout Standard
20973 \change_deleted 564990737 1669742044
20974 \begin_inset VSpace medskip
20980 \begin_layout Standard
20983 \change_deleted 564990737 1669742044
20984 \begin_inset Flex URL
20987 \begin_layout Plain Layout
20989 ftp://ftp.edpsciences.org/pub/aa/readme.html
20997 \begin_layout Standard
20999 \change_deleted 564990737 1669742044
21000 \begin_inset VSpace medskip
21006 \begin_layout Standard
21008 \change_deleted 564990737 1669742044
21009 A manual comes together with that package, and this text is not meant to
21010 replace the original manual but is merely a short guide in how to realize
21011 the correct form of your paper.
21015 \begin_layout Standard
21017 \change_deleted 564990737 1669742044
21018 Please note that the publisher of the journal was changed from Springer
21019 to EDP Sciences starting January 1, 2001.
21020 That change involved also some slight changes to the style files, namely
21021 the removal of the thesaurus command.
21022 The \SpecialChar LyX
21023 class aa supports the newest version of these style files, V 5.01.
21024 If you have an older version installed, please upgrade.
21025 For compatibility, the old (version 4) layout has been kept as
21030 Please refer to the comments in
21033 Dir/layouts/aapaper.layout
21038 \begin_layout Subsection
21040 \change_deleted 564990737 1669742044
21044 \begin_layout Standard
21046 \change_deleted 564990737 1669742044
21047 It is recommended you start from the example template distributed with \SpecialChar LyX
21049 If you are not using a template, note the following settings:
21052 \begin_layout Itemize
21054 \change_deleted 564990737 1669742044
21061 Document\SpecialChar menuseparator
21064 dialog (OK, that one was obvious).
21067 \begin_layout Itemize
21069 \change_deleted 564990737 1669742044
21070 Don't change the option
21073 \begin_inset space ~
21083 The whole layout is done by the macros, you shouldn't change anything.
21086 \begin_layout Subsection
21088 \change_deleted 564990737 1669742044
21092 \begin_layout Standard
21094 \change_deleted 564990737 1669742044
21095 First thing to enter is the header information.
21096 It consists of seven entries, of which some are optional.
21100 \begin_layout Itemize
21102 \change_deleted 564990737 1669742044
21110 \begin_layout Itemize
21112 \change_deleted 564990737 1669742044
21120 \begin_layout Itemize
21122 \change_deleted 564990737 1669742044
21130 \begin_layout Itemize
21132 \change_deleted 564990737 1669742044
21140 \begin_layout Itemize
21142 \change_deleted 564990737 1669742044
21147 : [optional] if more than one author: whom to contact for offprint requests.
21150 \begin_layout Itemize
21152 \change_deleted 564990737 1669742044
21157 : [optional] mail address for contacts.
21160 \begin_layout Itemize
21162 \change_deleted 564990737 1669742044
21168 Suggested format is
21170 Received: <date>; Accepted <date>
21173 \begin_layout Standard
21175 \change_deleted 564990737 1669742044
21176 There is no need to issue the
21182 command, this is done automatically by \SpecialChar LyX
21183 when the header is finished.
21184 Although the order of the single header entries doesn't matter it is advised
21185 to keep the above sequence, just to get the best optics and meets the layout
21186 of the real document.
21189 \begin_layout Standard
21191 \change_deleted 564990737 1669742044
21192 If you want to place footnotes in the header block, e.
21193 \begin_inset space \thinspace{}
21197 \begin_inset space \space{}
21200 to state your present address, just use the standard footnote via the menu
21203 Insert\SpecialChar menuseparator
21208 will automagically use the term
21217 \begin_layout Standard
21219 \change_deleted 564990737 1669742044
21222 Edit\SpecialChar menuseparator
21225 , you'll find two insets which are relevant for the titling:
21228 \begin_layout Itemize
21230 \change_deleted 564990737 1669742044
21237 to mark corresponding author\SpecialChar breakableslash
21239 The institutes are numbered sequentially as they appear in the
21243 field, so you have to put a marker to each author.
21246 \begin_layout Itemize
21248 \change_deleted 564990737 1669742044
21253 to supply an email address for fast contact.
21256 \begin_layout Standard
21258 \change_deleted 564990737 1669742044
21259 In addition to these topics, the macros use one additional \SpecialChar LaTeX
21261 has no counterpart in \SpecialChar LyX
21265 \begin_layout Itemize
21267 \change_deleted 564990737 1669742044
21274 to separate different names for more than one author and institute, respectivel
21278 \begin_layout Standard
21280 \change_deleted 564990737 1669742044
21281 The appropriate command has to be entered in \SpecialChar LyX
21282 and marked as \SpecialChar LaTeX
21288 \begin_layout Subsection
21290 \change_deleted 564990737 1669742044
21294 \begin_layout Standard
21296 \change_deleted 564990737 1669742044
21297 The abstract should immediately follow the header block.
21298 With version 5 the abstract environment was changed to a command, and there
21299 is now a restriction to only one paragraph.
21300 In addition, it should contain an entry with the keywords.
21301 This is done via the paragraph style
21306 Refer to the example paper.
21309 \begin_layout Subsection
21311 \change_deleted 564990737 1669742044
21312 Supported environments
21315 \begin_layout Standard
21317 \change_deleted 564990737 1669742044
21318 The A&A paper layout supports the following environments for structuring
21322 \begin_layout Itemize
21324 \change_deleted 564990737 1669742044
21330 \begin_layout Itemize
21332 \change_deleted 564990737 1669742044
21338 \begin_layout Itemize
21340 \change_deleted 564990737 1669742044
21346 \begin_layout Itemize
21348 \change_deleted 564990737 1669742044
21354 \begin_layout Itemize
21356 \change_deleted 564990737 1669742044
21362 \begin_layout Itemize
21364 \change_deleted 564990737 1669742044
21370 \begin_layout Itemize
21372 \change_deleted 564990737 1669742044
21378 \begin_layout Itemize
21380 \change_deleted 564990737 1669742044
21386 \begin_layout Itemize
21388 \change_deleted 564990737 1669742044
21394 \begin_layout Itemize
21396 \change_deleted 564990737 1669742044
21402 \begin_layout Itemize
21404 \change_deleted 564990737 1669742044
21410 \begin_layout Itemize
21412 \change_deleted 564990737 1669742044
21419 \begin_layout Subsection
21421 \change_deleted 564990737 1669742044
21422 Commands not supported by \SpecialChar LyX
21426 \begin_layout Standard
21428 \change_deleted 564990737 1669742044
21429 Some commands are not yet supported by the
21433 layout for \SpecialChar LyX
21435 Some have already been mentioned.
21436 For the sake of completeness, they are listed all together here:
21439 \begin_layout Itemize
21441 \change_deleted 564990737 1669742044
21449 \begin_layout Itemize
21451 \change_deleted 564990737 1669742044
21459 \begin_layout Itemize
21461 \change_deleted 564990737 1669742044
21469 \begin_layout Itemize
21471 \change_deleted 564990737 1669742044
21479 \begin_layout Standard
21481 \change_deleted 564990737 1669742044
21482 If you want to use any of these commands, you have to enter them yourself.
21485 Do not forget to mark them as \SpecialChar LaTeX
21489 \begin_layout Subsection
21491 \change_deleted 564990737 1669742044
21492 Figure and Table Floats
21495 \begin_layout Standard
21497 \change_deleted 564990737 1669742044
21499 provides support for the necessary float environments
21501 figure, figure*, table
21507 , therefore we won't tell much about it here.
21511 \begin_inset space ~
21517 Just remember that tables should be left-aligned.
21518 For that, select the table and change the alignment in
21520 Edit\SpecialChar menuseparator
21522 \begin_inset space ~
21528 \begin_layout Standard
21530 \change_deleted 564990737 1669742044
21531 There is only one special thing: the figures with caption besides the figure.
21532 To create such a figure, you have to do the following:
21535 \begin_layout Enumerate
21537 \change_deleted 564990737 1669742044
21538 Create a wide figure float:
21540 Insert\SpecialChar menuseparator
21541 Float\SpecialChar menuseparator
21544 , then right click in the figure and select
21547 \begin_inset space ~
21555 \begin_layout Enumerate
21557 \change_deleted 564990737 1669742044
21558 Enter your caption text.
21561 \begin_layout Enumerate
21563 \change_deleted 564990737 1669742044
21568 to move the cursor above the caption.
21571 \begin_layout Enumerate
21573 \change_deleted 564990737 1669742044
21577 \begin_layout Enumerate
21579 \change_deleted 564990737 1669742044
21580 Position the cursor behind the figure and insert a horizontal fill:
21582 Insert\SpecialChar menuseparator
21584 \begin_inset space ~
21587 Character\SpecialChar menuseparator
21589 \begin_inset space ~
21597 \begin_layout Enumerate
21599 \change_deleted 564990737 1669742044
21600 Switch to \SpecialChar LaTeX
21604 \begin_inset space ~
21612 \begin_layout Enumerate
21614 \change_deleted 564990737 1669742044
21624 Do not close the brace!
21627 \begin_layout Enumerate
21629 \change_deleted 564990737 1669742044
21630 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
21635 \begin_inset space ~
21647 \begin_layout Standard
21649 \change_deleted 564990737 1669742044
21650 Also, refer to the figures in the example paper.
21653 \begin_layout Subsection
21655 \change_deleted 564990737 1669742044
21659 \begin_layout Standard
21661 \change_deleted 564990737 1669742044
21662 For submission, the paper has to be formated in a special double-spacing
21664 For this purpose, you have to give the option
21668 to the document class.
21669 This must be done using the custom class options field in the
21671 Document\SpecialChar menuseparator
21675 Just enter the string
21682 \begin_layout Subsection
21684 \change_deleted 564990737 1669742044
21688 \begin_layout Standard
21690 \change_deleted 564990737 1669742044
21695 directory contains an example paper written with \SpecialChar LyX
21697 It is the example paper from the original macro package, translated to
21700 Use it for inspiration, and compare the original \SpecialChar LaTeX
21701 code with \SpecialChar LyX
21705 \begin_layout Section
21707 \change_deleted 564990737 1671097429
21711 \begin_layout Standard
21713 \change_deleted 564990737 1671097429
21718 can be used to type letters according to German conventions.
21719 A template file is included in
21721 .../lyx/share/templates
21723 for you to use as a starting point.
21726 \begin_layout Section
21728 \change_deleted 564990737 1671097429
21732 \begin_layout Standard
21734 \change_deleted 564990737 1671097429
21735 See the \SpecialChar LyX
21741 It contains all infos you need.
21744 \begin_layout Section
21746 \change_deleted 564990737 1669755802
21750 \begin_layout Standard
21752 \change_deleted 564990737 1669755802
21755 Panayotis Papasotiriou
21758 \begin_layout Subsection
21760 \change_deleted 564990737 1669755802
21764 \begin_layout Standard
21766 \change_deleted 564990737 1669755802
21767 The ijmpc package is a set of macros that facilitates electronic manuscript
21770 International Journal of Modern Physics C
21773 Similarly, the ijmpd package is for creating manuscripts to be submitted
21776 International Journal of Modern Physics D
21779 Both journals are published by World Scientific.
21780 The corresponding document classes are named
21789 These files, together with instructions for the authors, can be downloaded
21791 \begin_inset Flex URL
21794 \begin_layout Plain Layout
21796 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
21802 \begin_inset Flex URL
21805 \begin_layout Plain Layout
21807 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
21813 Both packages are modified versions of the standard
21814 \begin_inset Quotes eld
21818 \begin_inset Quotes erd
21821 package, and they are almost (but not exactly) identical.
21822 Most of their features are supported by \SpecialChar LyX
21824 I have used \SpecialChar LyX
21825 successfully to write articles submitted to both journals
21826 without any problem.
21829 \begin_layout Subsection
21831 \change_deleted 564990737 1669755802
21835 \begin_layout Standard
21837 \change_deleted 564990737 1669755802
21838 As usual, the easiest way to write a paper is to start with a template.
21841 File\SpecialChar menuseparator
21857 This will give an (almost) empty document that includes the most common
21858 fields found in a manuscript.
21859 Simply overwrite the existing text (including the brackets,
21864 You should keep in mind the following remarks.
21867 \begin_layout Enumerate
21869 \change_deleted 564990737 1669755802
21871 won't let you change the font size and the page style of the document,
21872 because such modifications are not allowed by both packages.
21875 \begin_layout Enumerate
21877 \change_deleted 564990737 1669755802
21878 The language of the document should not be changed.
21879 Before previewing your paper, be sure that the babel package is not used.
21880 To do this, click on
21883 arg "dialog-show document"
21888 \SpecialChar menuseparator
21892 \begin_inset Quotes eld
21896 \begin_inset Quotes erd
21906 \begin_layout Enumerate
21908 \change_deleted 564990737 1669755802
21910 \begin_inset Quotes eld
21914 \begin_inset Quotes erd
21917 style must be used to define keywords.
21920 \begin_layout Enumerate
21922 \change_deleted 564990737 1669755802
21923 The ijmpc package provides a style named
21924 \begin_inset Quotes eld
21927 Classification Codes
21928 \begin_inset Quotes erd
21931 , which can be used to define classification codes, such as PACS numbers.
21932 Note that this facility is not supported by the ijmpd package.
21935 \begin_layout Enumerate
21937 \change_deleted 564990737 1669755802
21938 Several new environments are available:
21939 \begin_inset Quotes eld
21943 \begin_inset Quotes erd
21947 \begin_inset Quotes eld
21951 \begin_inset Quotes erd
21955 \begin_inset Quotes eld
21959 \begin_inset Quotes erd
21963 \begin_inset Quotes eld
21967 \begin_inset Quotes erd
21971 \begin_inset Quotes eld
21975 \begin_inset Quotes erd
21979 \begin_inset Quotes eld
21983 \begin_inset Quotes erd
21987 \begin_inset Quotes eld
21991 \begin_inset Quotes erd
21995 \begin_inset Quotes eld
21999 \begin_inset Quotes erd
22003 \begin_inset Quotes eld
22007 \begin_inset Quotes erd
22011 \begin_inset Quotes eld
22015 \begin_inset Quotes erd
22019 \begin_inset Quotes eld
22023 \begin_inset Quotes erd
22027 \begin_inset Quotes eld
22031 \begin_inset Quotes erd
22035 \begin_inset Quotes eld
22039 \begin_inset Quotes erd
22043 \begin_inset Quotes eld
22047 \begin_inset Quotes erd
22051 Their use is more or less obvious.
22053 supports all these environments; it will use the proper label, text style,
22054 and numbering scheme for each of them.
22057 \begin_layout Enumerate
22059 \change_deleted 564990737 1669755802
22060 Both packages use basic citations; the natbib package should not be used.
22061 In \SpecialChar LyX
22062 , citation references are shown as usual; in the output, citations are
22063 shown as superscripts.
22064 If you want to use a citation as normal text, you should use the
22069 \begin_inset space \thinspace{}
22073 \begin_inset space \space{}
22077 \begin_inset Quotes eld
22081 \begin_inset space \space{}
22091 \begin_inset Quotes erd
22097 \begin_layout Enumerate
22099 \change_deleted 564990737 1669755802
22101 \begin_inset Quotes eld
22105 \begin_inset Quotes erd
22108 section in both packages.
22109 To put acknowledgments, just use the
22110 \begin_inset Quotes eld
22114 \begin_inset Quotes erd
22120 \begin_layout Enumerate
22122 \change_deleted 564990737 1669755802
22123 Appendices may be added to the paper,
22127 the Acknowledgments and
22133 provides a special environment, called
22134 \begin_inset Quotes eld
22138 \begin_inset Quotes erd
22141 which marks the beginning of the appendices.
22142 This environment should be left blank; it just sends a \SpecialChar LaTeX
22143 command, but nothing
22145 In \SpecialChar LyX
22147 \begin_inset Quotes eld
22151 \begin_inset Quotes erd
22154 is printed with blue letters, as a signal that all sections after that
22155 point are appendices.
22156 To write an appendix, use the
22157 \begin_inset Quotes eld
22161 \begin_inset Quotes erd
22166 will number each appendix with capital letters, as required by both journals.
22168 \begin_inset Quotes eld
22172 \begin_inset Quotes erd
22179 be present before the first appendix; if not, all appendices will be numbered
22180 as normal sections in the output.
22183 \begin_layout Enumerate
22185 \change_deleted 564990737 1669755802
22186 The ijmpc and the ijmpd packages use the
22190 command to implement table captions.
22191 As a result, a table created by \SpecialChar LyX
22192 is printed correctly, but its caption
22194 However, you can use some \SpecialChar TeX
22195 code to overcome this problem, so that captions
22196 are printed as expected.
22197 To do so, create a float table as usual, remove the caption, and replace
22198 it with the \SpecialChar TeX
22209 (sic); you must also the \SpecialChar TeX
22214 immediately after the tabular material.
22215 Study the example table included in the template files to see how this
22216 trick is implemented.
22217 Alternatively, If you need table captions, you should implement the whole
22222 file, then include this file to the \SpecialChar LyX
22225 Insert\SpecialChar menuseparator
22226 File\SpecialChar menuseparator
22228 \begin_inset space ~
22234 Details on how to create a table float can be found in the files
22242 , included in the corresponding packages.
22245 \begin_layout Subsection
22247 \change_deleted 564990737 1669755802
22248 Preparing a paper for submission
22251 \begin_layout Standard
22253 \change_deleted 564990737 1669755802
22254 Before you submit your paper you must export the \SpecialChar LyX
22255 document as a \SpecialChar LaTeX
22258 File\SpecialChar menuseparator
22259 Export\SpecialChar menuseparator
22267 \begin_layout Plain Layout
22268 Actually you have the choice between \SpecialChar LaTeX
22269 (plain) and pdflatex.
22270 If you intend to use pdflatex to prepare the paper, you should use the
22271 pdflatex option so that included graphics are converted to PDF format,
22272 ready for use by pdflatex.
22277 , then make the following changes to the resulting
22284 \begin_layout Enumerate
22286 \change_deleted 564990737 1669755802
22287 Remove the comment lines before the
22296 \begin_layout Enumerate
22298 \change_deleted 564990737 1669755802
22299 Remove everything between (and including) the
22311 commands, except for any commands you specifically put into the \SpecialChar LaTeX
22315 \begin_layout Standard
22317 \change_deleted 564990737 1669755802
22322 file should be saved and processed through \SpecialChar LaTeX
22323 as many times as necessary.
22324 You may also want to check the resulting
22333 \begin_layout Section
22335 \change_deleted 564990737 1669801478
22339 \begin_layout Standard
22341 \change_deleted 564990737 1669801478
22347 \begin_layout Subsection
22349 \change_deleted 564990737 1669801478
22353 \begin_layout Standard
22355 \change_deleted 564990737 1669801478
22356 The iopart package provides a document class to create electronic manuscript
22357 submission to the journals published by the Institute of Physics.
22358 Instructions for the authors how to create a paper using the iopart class
22359 can be downloaded together with the iopart package from the site
22360 \begin_inset Flex URL
22363 \begin_layout Plain Layout
22365 ftp://ftp.iop.org/pub/journals/latex2e
22373 \begin_layout Subsection
22375 \change_deleted 564990737 1669801478
22379 \begin_layout Standard
22381 \change_deleted 564990737 1669801478
22382 The easiest way to write a paper is to start with the template
22386 that is available via
22388 File\SpecialChar menuseparator
22391 The template explains how to use the special text environments.
22392 Here are the most important advices:
22395 \begin_layout Itemize
22397 \change_deleted 564990737 1669801478
22398 To be able to compile your document to a PDF, PS, or DVI, ensure that the
22399 no AMS packages are loaded in
22401 Document\SpecialChar menuseparator
22402 Settings\SpecialChar menuseparator
22408 \begin_layout Itemize
22410 \change_deleted 564990737 1669801478
22413 The title environment defines the kind of your paper.
22414 So use one of the following environments for the title:
22418 \begin_layout Itemize
22420 \change_deleted 564990737 1669801478
22429 \begin_layout Itemize
22431 \change_deleted 564990737 1669801478
22440 \begin_layout Itemize
22442 \change_deleted 564990737 1669801478
22448 for a Topical review
22451 \begin_layout Itemize
22453 \change_deleted 564990737 1669801478
22462 \begin_layout Itemize
22464 \change_deleted 564990737 1669801478
22473 \begin_layout Itemize
22475 \change_deleted 564990737 1669801478
22481 for a Paper (same as Title)
22484 \begin_layout Itemize
22486 \change_deleted 564990737 1669801478
22492 for a Preliminary communication
22495 \begin_layout Itemize
22497 \change_deleted 564990737 1669801478
22503 for a Rapid communication
22506 \begin_layout Itemize
22508 \change_deleted 564990737 1669801478
22514 for a Letter to the editor
22518 \begin_layout Itemize
22520 \change_deleted 564990737 1669801478
22523 All title environments except of
22527 can have an optional short title.
22530 \begin_layout Itemize
22532 \change_deleted 564990737 1669801478
22533 There is a general title environment
22537 which is not directly supported by \SpecialChar LyX
22539 This can be used as \SpecialChar TeX
22540 code when your document doesn't fit into one of the
22544 \begin_layout Standard
22546 \change_deleted 564990737 1669801478
22547 For more informations like hints for special table and formula formatting,
22548 look at the IOP author guidelines.
22553 \begin_layout Section
22555 \change_deleted 564990737 1670317155
22559 \begin_layout Standard
22561 \change_deleted 564990737 1670317155
22564 Panayotis Papasotiriou
22567 \begin_layout Subsection
22569 \change_deleted 564990737 1670317155
22573 \begin_layout Standard
22575 \change_deleted 564990737 1670317155
22576 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
22577 that facilitates electronic manuscript submission to the journals they
22579 Most known of them (at least in my domain of interest) are
22581 Astrophysics and Space Science
22587 , but there are many others (see a complete list at
22588 \begin_inset Flex URL
22591 \begin_layout Plain Layout
22593 http://www.wkap.nl/jrnllist.htm/JRNLHOME
22599 The Kluwer package may be downloaded from the site
22600 \begin_inset Flex URL
22603 \begin_layout Plain Layout
22605 http://www.wkap.nl/kaphtml.htm/STYLEFILES
22611 A complete user guide is contained in that package (but it can also be
22612 downloaded separately).
22615 \begin_layout Standard
22617 \change_deleted 564990737 1670317155
22619 supports many features of the package but not everything.
22620 However, the \SpecialChar TeX
22621 code needed is reduced to some
22622 \begin_inset Quotes eld
22626 \begin_inset Quotes erd
22629 commands of the package (see
22630 \begin_inset space ~
22634 \begin_inset CommandInset ref
22636 reference "subsec:kluwer_peculiarities"
22641 I have recently used \SpecialChar LyX
22642 to write an article submitted to the
22644 Astrophysics and Space Science
22646 without any problem.
22649 \begin_layout Subsection
22651 \change_deleted 564990737 1670317155
22655 \begin_layout Standard
22657 \change_deleted 564990737 1670317155
22658 The easiest way to write a paper is to start with the Kluwer template file.
22661 File\SpecialChar menuseparator
22673 This will give an (almost) empty document that includes the most common
22674 fields found in a manuscript and a short description of their use.
22675 As in most templates, simply overwrite the existing text (including the
22680 ) with the correct information.
22683 \begin_layout Subsection
22685 \change_deleted 564990737 1670317155
22686 Preparing a paper for submission
22689 \begin_layout Standard
22691 \change_deleted 564990737 1670317155
22692 As in the AAS\SpecialChar TeX
22693 package, before you submit your paper to a journal you must
22695 \begin_inset Quotes eld
22699 \begin_inset Quotes erd
22705 \begin_layout Enumerate
22707 \change_deleted 564990737 1670317155
22708 Export your paper as a \SpecialChar LaTeX
22710 To do this, click on
22712 File\SpecialChar menuseparator
22713 Export\SpecialChar menuseparator
22721 \begin_layout Enumerate
22723 \change_deleted 564990737 1670317155
22728 file with a text editor and make the following changes
22732 \begin_layout Enumerate
22734 \change_deleted 564990737 1670317155
22735 remove the comment lines before the
22744 \begin_layout Enumerate
22746 \change_deleted 564990737 1670317155
22747 remove everything between (and including) the
22759 commands, except for any commands you specifically put into the \SpecialChar LaTeX
22763 \begin_layout Standard
22765 \change_deleted 564990737 1670317155
22774 \begin_layout Enumerate
22776 \change_deleted 564990737 1670317155
22781 file through \SpecialChar LaTeX
22782 as many times as necessary (usually up to three).
22785 \begin_layout Enumerate
22787 \change_deleted 564990737 1670317155
22793 \begin_inset space \thinspace{}
22797 \begin_inset space \space{}
22804 , and check if everything is OK (it should, if you didn't make any mistake).
22807 \begin_layout Subsection
22809 \change_deleted 564990737 1670317155
22810 \begin_inset Quotes eld
22814 \begin_inset Quotes erd
22817 of the Kluwer package
22818 \begin_inset CommandInset label
22820 name "subsec:kluwer_peculiarities"
22827 \begin_layout Standard
22829 \change_deleted 564990737 1670317155
22830 The Kluwer package has the following
22831 \begin_inset Quotes eld
22835 \begin_inset Quotes erd
22841 \begin_layout Enumerate
22843 \change_deleted 564990737 1670317155
22844 It is possible to write multiple articles in the same \SpecialChar LaTeX
22849 \begin_layout Plain Layout
22850 I can't imagine any good reason to do this.
22856 Each article must be included in the environment
22857 \begin_inset Quotes eld
22861 \begin_inset Quotes erd
22865 Unfortunately, this environment cannot be omitted, even if you write just
22867 Therefore, each article starts with the command
22873 and, obviously, ends with the command
22880 Although this can be implemented in \SpecialChar LyX
22881 , I didn't included it, since it looks
22882 ugly and can confuse the novice user.
22883 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
22886 \begin_inset Quotes eld
22891 \begin_inset Quotes erd
22897 \begin_layout Enumerate
22899 \change_deleted 564990737 1670317155
22900 Information given at the beginning of the article (i.
22901 \begin_inset space \thinspace{}
22905 \begin_inset space \space{}
22908 title, subtitle, author, institution, running title, running author, abstract
22909 and keywords) must be included in an environment called
22910 \begin_inset Quotes eld
22914 \begin_inset Quotes erd
22918 This is not implemented in \SpecialChar LyX
22919 , so you must enter title, subtitle etc.
22920 \begin_inset space ~
22923 between two \SpecialChar TeX
22939 \begin_layout Enumerate
22941 \change_deleted 564990737 1670317155
22942 According to the user manual, the label of each bibliography item must be
22966 \begin_layout Standard
22968 \change_deleted 564990737 1670317155
22973 template takes care of all these
22974 \begin_inset Quotes eld
22978 \begin_inset Quotes erd
22982 If you start a new paper using this template you don't need to do anything
22987 \begin_layout Enumerate
22989 \change_deleted 564990737 1670317155
22990 don't delete the \SpecialChar TeX
22991 code included in the template, and
22994 \begin_layout Enumerate
22996 \change_deleted 564990737 1670317155
22997 copy the example bibliography item included in the template and modify it
22998 as necessary to enter new bibliography items.
23001 \begin_layout Section
23003 \change_deleted 564990737 1671097446
23007 \begin_layout Standard
23009 \change_deleted 564990737 1671097446
23014 provides an alternative to the standard
23019 It provides similar functionality, but you might prefer this layout with
23020 sans serif sections, headings, and more.
23023 \begin_layout Section
23025 \change_deleted 564990737 1671097446
23026 Springer Journals (
23033 \begin_layout Standard
23035 \change_deleted 564990737 1671097446
23041 \begin_layout Subsection
23043 \change_deleted 564990737 1671097446
23047 \begin_layout Standard
23049 \change_deleted 564990737 1671097446
23050 These are the layout files for some of the journal formats used by Springer
23051 Verlag and listed on
23052 \begin_inset Flex URL
23055 \begin_layout Plain Layout
23057 http://www.springer.de/author/tex/help-journals.html
23062 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
23064 It is a modular system: the things common to all journals are implemented
23069 , which journal-specific layout files (such as, e.
23070 \begin_inset space \thinspace{}
23074 \begin_inset space \space{}
23081 for Journal of Geodesy) can include.
23084 \begin_layout Standard
23086 \change_deleted 564990737 1671097446
23087 This means that implementing support for any other Springer journal on this
23088 list is as simple as writing your own
23096 file following the outline given in
23104 \begin_layout Standard
23106 \change_deleted 564990737 1671097446
23107 It is reasonably well tested only for the Journal of Geodesy.
23116 come with the standard \SpecialChar LyX
23118 Install the relevant class file (downloaded from Springer) in a proper
23119 directory, reconfigure \SpecialChar LaTeX
23120 (in the te\SpecialChar TeX
23125 , as root if necessary — doesn't \SpecialChar LyX
23126 take care of this?), reconfigure \SpecialChar LyX
23131 \begin_layout Subsection
23133 \change_deleted 564990737 1671097446
23137 \begin_layout Standard
23139 \change_deleted 564990737 1671097446
23140 A large number of theorem-like styles —
23152 \begin_layout Standard
23154 \change_deleted 564990737 1671097446
23157 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
23158 _Title, Author_Running, Institute,
23159 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
23162 See the Springer class file documentation for details.
23165 \begin_layout Subsection
23167 \change_deleted 564990737 1671097446
23171 \begin_layout Itemize
23173 \change_deleted 564990737 1671097446
23185 \begin_layout Itemize
23187 \change_deleted 564990737 1671097446
23190 Probability Theory and Related Fields
23196 — Jean-Marc Lasgouttes
23199 \begin_layout Standard
23201 \change_deleted 564990737 1671097446
23202 Add your own, it isn't so hard!
23205 \begin_layout Subsection
23207 \change_deleted 564990737 1671097446
23211 \begin_layout Standard
23213 \change_deleted 564990737 1671097446
23214 These files are partly based on the older
23218 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
23220 file from Springer.
23225 layout, are now defunct.
23226 Jean-Marc Lasgouttes helped out big in making me find my way around the
23228 layout file mechanism.
23231 \begin_layout Subsection
23233 \change_deleted 564990737 1671097446
23237 \begin_layout Standard
23239 \change_deleted 564990737 1671097446
23241 But probably less than in the old hacked-\SpecialChar LaTeX
23249 \begin_layout Chapter
23251 Features needing Extra Software
23254 \begin_layout Section
23255 Checking \SpecialChar TeX
23259 \begin_layout Standard
23265 \begin_layout Subsection
23269 \begin_layout Standard
23278 \begin_layout Plain Layout
23283 is not yet available when you are using the \SpecialChar LaTeX
23284 distribution MiK\SpecialChar TeX
23290 , you'll find in the
23297 \begin_inset space ~
23308 \begin_inset Newline newline
23312 \begin_inset CommandInset href
23314 target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
23322 \begin_layout Standard
23325 Chk\SpecialChar TeX
23328 package is a program that was written by
23329 \begin_inset Flex Noun
23332 \begin_layout Plain Layout
23334 \begin_inset space ~
23342 in frustration because some constructs in \SpecialChar LaTeX
23343 are sometimes non-intuitive,
23344 and easy to forget.
23345 The program runs over your \SpecialChar LaTeX
23346 file, checks the integrity of the file, and
23347 flags some common errors.
23348 In other technical words, it is
23352 for \SpecialChar LaTeX
23356 \begin_layout Standard
23357 Well, what is a syntax checker doing in \SpecialChar LyX
23358 which is supposed to produce correct
23360 anyways? The answer is simple: Just as
23364 not only checks the
23368 of C programs, but also does
23372 checks for type-errors,
23374 Chk\SpecialChar TeX
23377 catches some common
23381 errors, in addition to the syntactical ones.
23384 Chk\SpecialChar TeX
23387 is capable of detecting several common errors, such as
23390 \begin_layout Itemize
23391 Ellipsis detection:
23392 \begin_inset Newline newline
23395 Use \SpecialChar ldots
23399 \begin_layout Itemize
23400 No space in front of/after parenthesis:
23401 \begin_inset Newline newline
23407 \begin_layout Itemize
23408 Enforcement of normal space after common abbreviations:
23409 \begin_inset Newline newline
23413 \begin_inset space \thinspace{}
23417 \begin_inset space \space{}
23420 is too wide spacing.
23423 \begin_layout Itemize
23424 Enforcement of end-of-sentence space when the last sentence ends with a
23426 \begin_inset Newline newline
23430 And this is wrong spacing.
23433 \begin_layout Itemize
23434 Space in front of labels and similar commands:
23435 \begin_inset Newline newline
23438 The label should stick right up to the text to avoid falling to a wrong
23441 \begin_inset CommandInset label
23451 \begin_layout Plain Layout
23452 This footnote is in danger of falling off to a wrong page
23457 The label is separated too much.
23460 \begin_layout Itemize
23461 Space in front of references, instead of hard spaces:
23462 \begin_inset Newline newline
23465 If you have bad luck, the text will break right between the referenced text
23466 and reference number, and that's a pity.
23468 \begin_inset CommandInset ref
23470 reference "sec:chktex"
23477 \begin_layout Itemize
23479 \begin_inset Quotes eld
23483 \begin_inset Quotes erd
23487 \begin_inset Formula $\times$
23491 \begin_inset Newline newline
23494 2x2 looks cheap compared to
23495 \begin_inset Formula $2\times2$
23501 \begin_layout Standard
23502 and more \SpecialChar ldots
23503 It is an invaluable tool when you are
23504 \begin_inset Quotes eld
23508 \begin_inset Quotes erd
23511 your document before printing, and you should run it right after the obligatory
23512 spelling check, and before you go fine tuning the typesetting.
23515 \begin_layout Subsection
23519 \begin_layout Standard
23520 If you have the program installed, usage is as simple as choosing
23522 Tools\SpecialChar menuseparator
23524 \begin_inset space ~
23530 This will make \SpecialChar LyX
23531 generate a \SpecialChar LaTeX
23532 file of your document, start
23534 Chk\SpecialChar TeX
23537 to check it, and then make \SpecialChar LyX
23539 \begin_inset Quotes eld
23543 \begin_inset Quotes erd
23546 with the warnings from
23548 Chk\SpecialChar TeX
23551 , if there were any.
23552 The warnings will be placed close to the point of the mistake, and you
23553 can quickly find them by using the
23555 Navigate\SpecialChar menuseparator
23558 menu item, or the shortcut key
23567 Open the error boxes by clicking on them with the mouse, or use the shortcut
23576 bindings, or the corresponding
23585 Read the warning and correct the mistake, if it is a mistake.
23586 If you have trouble understanding what the warning is about, you can safely
23588 Remember that there is a hidden layer between the document on screen and
23589 the technical details in invoking
23591 Chk\SpecialChar TeX
23594 , and this gap can make some warnings seem arcane or just plain silly.
23597 \begin_layout Standard
23598 This document is an excellent testing bed for the feature, and it should
23599 provide quite a few warnings for you to fiddle with.
23600 Since computers are only so smart, expect most of the warnings to be false
23604 \begin_layout Subsection
23605 How to fine tune it
23608 \begin_layout Standard
23609 Sometimes, you'll find that
23611 Chk\SpecialChar TeX
23614 makes more noise than suits your mood.
23615 Then you can choose not to use it, wait until your mood changes, or try
23618 Chk\SpecialChar TeX
23621 to get better along with you.
23624 \begin_layout Standard
23627 Chk\SpecialChar TeX
23634 very configurable and extensible, you should not expect to solve all problems
23637 Chk\SpecialChar TeX
23640 in \SpecialChar LyX
23642 Since \SpecialChar LyX
23643 has to generate a somewhat special \SpecialChar LaTeX
23644 file to be able to match the
23645 line numbers from the
23647 Chk\SpecialChar TeX
23654 \begin_layout Plain Layout
23655 You can inspect the specific output from
23661 Document\SpecialChar menuseparator
23664 \begin_inset space ~
23678 to the internal document structure, some of the warnings will not appear
23680 There are two things you can do about this:
23683 \begin_layout Itemize
23686 Chk\SpecialChar TeX
23689 invocation command line in
23690 \begin_inset Flex Noun
23693 \begin_layout Plain Layout
23694 Tools\SpecialChar menuseparator
23695 Preferences\SpecialChar menuseparator
23696 Output\SpecialChar menuseparator
23697 LaTeX\SpecialChar menuseparator
23705 Chk\SpecialChar TeX
23708 installation configuration file (usually with the file
23713 See below to learn what warnings can be enabled and disabled on the command
23717 \begin_layout Itemize
23718 Export your document as a raw \SpecialChar LaTeX
23721 File\SpecialChar menuseparator
23722 Export\SpecialChar menuseparator
23731 Invoked in this way, it can be a hassle to find the corresponding place
23732 in the document inside \SpecialChar LyX
23733 , but with a little patience, you should be able
23737 \begin_layout Standard
23738 Here follows the warning messages that can be enabled and disabled in
23747 to disable a warning, and
23751 to enable a warning.
23752 The emphasized entries are disabled by default, because the default is
23755 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
23760 \begin_layout Standard
23761 Notice that you should only use the options that enable and disable warnings,
23762 because \SpecialChar LyX
23763 relies on some of the other command line parameters to be set
23764 in a specific way to have a chance to communicate with
23771 \begin_layout Enumerate
23775 Command terminated with space.
23778 \begin_layout Enumerate
23781 Non-breaking space (
23782 \begin_inset Quotes eld
23790 \begin_inset Quotes erd
23793 ) should have been used.
23796 \begin_layout Enumerate
23800 You should enclose the previous parenthesis with
23801 \begin_inset Quotes eld
23809 \begin_inset Quotes erd
23815 \begin_layout Enumerate
23818 Italic correction (
23819 \begin_inset Quotes eld
23829 \begin_inset Quotes erd
23832 ) found in non-italic buffer.
23835 \begin_layout Enumerate
23838 Italic correction (
23839 \begin_inset Quotes eld
23849 \begin_inset Quotes erd
23852 ) found more than once.
23855 \begin_layout Enumerate
23859 No italic correction (
23860 \begin_inset Quotes eld
23870 \begin_inset Quotes erd
23876 \begin_layout Enumerate
23880 \begin_inset Quotes eld
23888 \begin_inset Quotes erd
23892 \begin_inset Quotes eld
23900 \begin_inset Quotes erd
23906 \begin_layout Enumerate
23909 Wrong length of dash may have been used.
23912 \begin_layout Enumerate
23916 \begin_inset Quotes eld
23924 \begin_inset Quotes erd
23928 \begin_inset Quotes eld
23936 \begin_inset Quotes erd
23942 \begin_layout Enumerate
23946 \begin_inset Quotes eld
23954 \begin_inset Quotes erd
23960 \begin_layout Enumerate
23964 \begin_inset Quotes eld
23972 \begin_inset Quotes erd
23975 to achieve an ellipsis.
23978 \begin_layout Enumerate
23981 Inter-word spacing (
23982 \begin_inset Quotes eld
23992 \begin_inset Quotes eld
23995 ) should perhaps be used.
23998 \begin_layout Enumerate
24001 Inter-sentence spacing (
24002 \begin_inset Quotes eld
24012 \begin_inset Quotes erd
24015 ) should perhaps be used.
24018 \begin_layout Enumerate
24021 Could not find argument for command.
24024 \begin_layout Enumerate
24028 \begin_inset Quotes eld
24036 \begin_inset Quotes erd
24042 \begin_layout Enumerate
24045 Math mode still on at end of \SpecialChar LaTeX
24049 \begin_layout Enumerate
24053 \begin_inset Quotes eld
24061 \begin_inset Quotes erd
24064 doesn't match the number of
24065 \begin_inset Quotes eld
24073 \begin_inset Quotes erd
24079 \begin_layout Enumerate
24082 You should use either
24085 \begin_inset Quotes eld
24093 \begin_inset Quotes erd
24098 as an alternative to
24099 \begin_inset Quotes eld
24107 \begin_inset Quotes erd
24113 \begin_layout Enumerate
24120 " (ASCII 39) instead of "
24127 \begin_layout Enumerate
24130 User-specified pattern found.
24133 \begin_layout Enumerate
24136 This command might not be intended.
24139 \begin_layout Enumerate
24146 \begin_layout Enumerate
24164 \begin_layout Enumerate
24167 Delete this space to maintain correct page references.
24170 \begin_layout Enumerate
24174 You might wish to put this between a pair of
24175 \begin_inset Quotes eld
24183 \begin_inset Quotes erd
24189 \begin_layout Enumerate
24192 You ought to remove spaces in front of punctuation.
24195 \begin_layout Enumerate
24198 Could not execute \SpecialChar LaTeX
24202 \begin_layout Enumerate
24211 in front of small punctuation.
24214 \begin_layout Enumerate
24222 may look prettier here.
24225 \begin_layout Enumerate
24229 Multiple spaces detected in output.
24232 \begin_layout Enumerate
24235 This text may be ignored.
24238 \begin_layout Enumerate
24244 \begin_inset Quotes eld
24249 to begin quotation, not
24256 \begin_layout Enumerate
24263 to end quotation, not
24266 \begin_inset Quotes eld
24274 \begin_layout Enumerate
24280 \begin_layout Enumerate
24283 You should perhaps use
24284 \begin_inset Quotes eld
24292 \begin_inset Quotes erd
24298 \begin_layout Enumerate
24301 You should put a space in front of/after parenthesis.
24304 \begin_layout Enumerate
24307 You should avoid spaces in front of/after parenthesis.
24310 \begin_layout Enumerate
24314 You should not use punctuation in front of/after quotes.
24317 \begin_layout Enumerate
24320 Double space found.
24323 \begin_layout Enumerate
24326 You should put punctuation outside inner/inside display math mode.
24329 \begin_layout Enumerate
24332 You ought to not use primitive \SpecialChar TeX
24333 in \SpecialChar LaTeX
24337 \begin_layout Enumerate
24340 You should remove spaces in front of
24341 \begin_inset Quotes eld
24349 \begin_inset Quotes erd
24355 \begin_layout Enumerate
24358 \begin_inset Quotes eld
24366 \begin_inset Quotes erd
24369 is normally not followed by
24370 \begin_inset Quotes eld
24378 \begin_inset Quotes erd
24384 \begin_layout Standard
24385 In later versions of \SpecialChar LyX
24386 , we hope to provide a more complete interface to this
24387 tool (and it's smaller cousin
24391 ) to exploit the full power of it.
24392 But it's not exactly useless as it is now: go try it on one of your existing
24393 documents of a certain length and be surprised.
24396 \begin_layout Section
24397 Version Control in \SpecialChar LyX
24401 \begin_layout Standard
24404 Lars Gullik Bjønnes
24411 \begin_layout Subsection
24415 \begin_layout Standard
24417 supports some of the most basic RCS/CVS/SVN/GIT commands.
24418 If you need something a bit more sophisticated you will have to do that
24419 manually in a terminal.
24422 \begin_layout Standard
24423 Also note that CVS support is not as good as subversion support, so we advise
24425 A good place to start learning Subversion is the SVN Book
24429 \begin_layout Plain Layout
24430 \begin_inset CommandInset href
24432 target "http://svnbook.red-bean.com/"
24443 In the case of RCS you should read
24444 \begin_inset Quotes eld
24448 \begin_inset Quotes erd
24451 (a man file, read it with
24456 This file describes all the basic features of RCS.
24457 You should especially notice the comment about a RCS directory, and the
24458 notion of a master RCS file (the file ending in
24465 \begin_layout Standard
24466 Before you begin to use the version control features in \SpecialChar LyX
24468 familiar with RCS/CVS/SVN/GIT usage.
24469 The implementation in \SpecialChar LyX
24470 assumes a recent version of the GNU RCS or CVS/SVN
24471 package — no guarantees are made for older versions.
24472 Most of the log messages are not currently displayed after operations —
24473 you can check them in the Messages pane if you are unsure.
24474 Regular users of version control will appreciate the VC toolbar, which
24477 View\SpecialChar menuseparator
24478 Toolbars\SpecialChar menuseparator
24480 \begin_inset space ~
24488 \begin_layout Standard
24489 For introducing your own external commands consult
24490 \begin_inset Flex Code
24493 \begin_layout Plain Layout
24507 \begin_layout Standard
24508 It is strongly recommended to store documents in uncompressed format if
24509 using version control (uncheck
24511 Document\SpecialChar menuseparator
24514 if it is checked): Uncompressed LyX documents are text files and therefore
24515 for merging two different versions by version control systems.
24516 Compressed LyX documents are binary files, which cannot be merged by version
24520 \begin_layout Subsection
24521 RCS commands in \SpecialChar LyX
24525 \begin_layout Standard
24526 The following sections describe the RCS commands supported by \SpecialChar LyX
24528 You can find them in the
24530 File\SpecialChar menuseparator
24532 \begin_inset space ~
24539 was tested against RCS 5.7/5.8.
24542 \begin_layout Subsubsection
24548 \begin_layout Standard
24549 If your document is not under revision control, this is the only item shown
24551 And if it is under revision control, the
24555 item is not visible.
24559 \begin_layout Standard
24560 This command registers your document with RCS (unless you are under the
24561 directory managed by CVS)\SpecialChar endofsentence
24562 You are asked interactively to supply an initial
24563 description of the document.
24564 The document is now set in Read-Only mode and you have to
24567 \begin_inset space ~
24571 \begin_inset space ~
24575 \begin_inset space ~
24580 , before making any changes to it.
24581 A document under revision control has a
24582 \begin_inset Quotes eld
24585 [RCS:<version> <locker>]
24586 \begin_inset Quotes erd
24589 item tagged to the filename in the minibuffer.
24592 \begin_layout Standard
24593 RCS command that is run:
24596 \begin_layout LyX-Code
24599 ci -q -u -i -t-"<initial description>" <file-name>
24602 \begin_layout Standard
24607 to understand the switches.
24611 \begin_layout Subsubsection
24617 \begin_layout Standard
24618 When you are finished editing a file, you check in your changes.
24619 When you do this, you are asked for a description of the changes.
24620 This is stored in the history log.
24621 The version number is bumped, your changes are applied to the master RCS
24622 file, the document is unlocked and set to Read-Only mode.
24625 \begin_layout Itemize
24628 ci -q -u -m"<description>" <file-name>
24631 \begin_layout Subsubsection
24637 \begin_layout Standard
24638 By doing this you lock the document so that only you can edit it.
24639 This will also make the document Read-Write only for you.
24640 You will usually continue editing for a while and when you are finished
24641 you check in your changes.
24642 The status line is changed to reflect that you have locked the file.
24645 \begin_layout Itemize
24648 co -q -l <file-name>
24651 \begin_layout Subsubsection
24654 Revert To Repository Version
24657 \begin_layout Standard
24658 This will discard all changes made to the document since the last check
24660 You get a warning before changes are discarded.
24663 \begin_layout Itemize
24666 co -f -u<version> <file-name>
24669 \begin_layout Subsubsection
24675 \begin_layout Standard
24676 This will create a copy of the current document.
24677 Since RCS does not support copy operations natively, the version history
24678 is not preserved, and the copy is added as a new file.
24679 It requires a clean document without any changes since the last checkin.
24680 You are asked for a file name and a description of the copy operation.
24681 After that the copy is created, both locally and in the repository.
24682 If the parent directories of the copied and original document differ, all
24683 relative paths of included files of the copy are adjusted (like in
24685 File\SpecialChar menuseparator
24690 Finally, the copy is loaded instead of the original document.
24693 \begin_layout Labeling
24694 \labelwidthstring 00.00.0000
24696 \begin_inset space ~
24700 \begin_inset space ~
24704 \begin_inset Newline newline
24708 \begin_inset Flex Code
24711 \begin_layout Plain Layout
24714 \begin_inset Quotes qld
24718 \begin_inset Quotes qld
24727 \begin_inset Flex Code
24730 \begin_layout Plain Layout
24733 \begin_inset Quotes qld
24737 \begin_inset Quotes qld
24746 \begin_inset Newline newline
24750 \begin_inset Flex Code
24753 \begin_layout Plain Layout
24757 \begin_inset Quotes qld
24761 \begin_inset Quotes qld
24772 \begin_layout Subsubsection
24778 \begin_layout Standard
24779 This makes as if the last check in never happened.
24780 No changes are made to the document loaded into \SpecialChar LyX
24781 , but the last version
24782 is removed from the master RCS file.
24785 \begin_layout Itemize
24788 rcs -o<version> <file-name>
24791 \begin_layout Subsubsection
24797 \begin_layout Standard
24798 This shows the complete history of the RCS document.
24803 is shown in a browser.
24811 \begin_layout Subsubsection
24815 \begin_layout Standard
24817 supports RCS version number, author name, date and time of last commit.
24818 All those are extracted from
24820 rlog -r <file-name>
24824 \begin_inset CommandInset ref
24826 reference "subsec:VCS-Revision-Information"
24833 \begin_layout Subsection
24834 CVS commands in \SpecialChar LyX
24838 \begin_layout Standard
24839 A subset of CVS operations is supported by \SpecialChar LyX
24841 You can find the commands in the
24843 File\SpecialChar menuseparator
24845 \begin_inset space ~
24851 The version control system SVN is more powerful, so please use it instead
24852 of CVS if possible.
24855 \begin_layout Subsubsection
24861 \begin_layout Standard
24862 If you start from scratch with CVS you have to create your repository and
24863 checkout the working copy with external tools.
24864 If you're using a client-server setup you may need to login before doing
24865 the first repository checkout.
24868 \begin_layout Standard
24869 If your documents are under revision control and others are using the same
24870 repository problems arise when different changes to the same document at
24871 the same location happen.
24872 Standard CVS repositories don't operate with a file locking mechanism.
24873 This may be surprising, but conflicts only occur if people disagree on
24874 the proper content of the same part of a document.
24875 So, if co-workers are used to communicate regularly, these conflicts occur
24877 If they don't communicate they have a fundamental problem anyway.
24878 Nevertheless some people like to work with so called
24879 \begin_inset Quotes eld
24883 \begin_inset Quotes erd
24887 If they do so the working copy of all files is readonly when checked out
24888 first and the user starts editing after using a special command to make
24889 the working copy writable.
24890 When the changes are checked in the working copy returns to readonly state.
24891 With \SpecialChar LyX
24892 one has to edit the
24893 \begin_inset Flex Code
24896 \begin_layout Plain Layout
24902 file and add the line
24903 \begin_inset Flex Code
24906 \begin_layout Plain Layout
24912 to work with reserved checkouts.
24913 The benefit is the possibility to see who is using a writable copy of some
24915 It's not guaranteed only one user makes a copy writable.
24918 \begin_layout Standard
24920 tries to guess if you're using reserved or non-reserved checkouts.
24921 If your working copy is readonly or it is writable and an additional copy
24922 of your document exists in the CVS/Base sub-directory a reserved otherwise
24923 a non-reserved checkout is assumed.
24924 When a reserved checkout is detected you have to use
24925 \begin_inset Flex Noun
24928 \begin_layout Plain Layout
24934 to make your working copy writable if it's readonly.
24936 \begin_inset Flex Noun
24939 \begin_layout Plain Layout
24945 operation is possible and that makes your working copy readonly again after
24946 transferring your changes to the repository.
24949 \begin_layout Standard
24950 More information about CVS can be found here
24951 \begin_inset Flex URL
24954 \begin_layout Plain Layout
24956 http://www.nongnu.org/cvs
24962 \begin_inset Flex URL
24965 \begin_layout Plain Layout
24967 http://ximbiot.com/cvs
24975 \begin_layout Standard
24980 to understand the sub-commands and the switches mentioned below.
24983 \begin_layout Subsubsection
24989 \begin_layout Standard
24990 If your document is not under revision control, this is the only item shown
24992 And if it is under revision control, the
24996 item is not visible.
25000 \begin_layout Standard
25001 This command registers in CVS your document
25002 \begin_inset Flex Strong
25005 \begin_layout Plain Layout
25013 in the case you have already the documents directory under CVS control
25019 This means you have to create or checkout the archive by yourself using
25021 (In case you forget that step \SpecialChar LyX
25022 registers the document with RCS.)
25025 \begin_layout Standard
25026 Then you are asked interactively to supply an initial description of the
25028 Don't forget that registered file is not yet checked in.
25031 \begin_layout Standard
25032 CVS command that is run:
25034 cvs -q add -m"<entered message>" "<file-name>"
25037 \begin_layout Standard
25042 above and for all other CVS commands is an abbreviation for
25043 \begin_inset Quotes eld
25046 change the current working directory to file location and use the file name
25047 without path component as argument
25048 \begin_inset Quotes erd
25054 \begin_layout Subsubsection
25060 \begin_layout Standard
25061 When you are finished editing a file, you commit your changes.
25062 When you do this and you had changed the document, you are asked for a
25063 description of the changes.
25064 After that changes are written to the repository.
25065 In case you didn't change the document and a reserved checkout is detected
25066 the reservation made on
25067 \begin_inset Flex Noun
25070 \begin_layout Plain Layout
25079 \begin_layout Labeling
25080 \labelwidthstring 00.00.0000
25082 \begin_inset space ~
25086 \begin_inset space ~
25090 \begin_inset Newline newline
25094 \begin_inset Flex Code
25097 \begin_layout Plain Layout
25100 -q commit -m"<description>" "<file-name>"
25106 \begin_inset Newline newline
25110 \begin_inset Flex Code
25113 \begin_layout Plain Layout
25124 \begin_layout Subsubsection
25130 \begin_layout Standard
25131 When you are sharing a repository with others, you may have to incorporate
25132 their changes into your working copy.
25135 \begin_layout Standard
25138 cvs -q update "<file-name>"
25141 \begin_layout Standard
25142 If a readonly checkout is detected the working copy is made writable and
25146 \begin_layout Standard
25149 cvs -q edit "<file-name>"
25152 \begin_layout Subsubsection
25155 Revert To Repository Version
25158 \begin_layout Standard
25159 This will discard all changes made to the document since the last check
25161 You get a warning before changes are discarded.
25162 Firstly the file is deleted, secondly CVS update command is run.
25165 \begin_layout Standard
25168 cvs -q update "<file-name>"
25171 \begin_layout Standard
25172 If a reserved checkout is detected and the working copy has no changes only
25173 the reservation is undone.
25176 \begin_layout Standard
25179 cvs -q unedit "<file-name>"
25182 \begin_layout Subsubsection
25188 \begin_layout Standard
25189 This will create a copy of the current document.
25190 Since CVS does not support copy operations natively, the version history
25191 is not preserved, and the copy is added as a new file.
25192 It requires a clean document without any changes since the last checkin.
25193 You are asked for a file name and a description of the copy operation.
25194 After that the copy is created, both locally and in the repository.
25195 If the parent directories of the copied and original document differ, all
25196 relative paths of included files of the copy are adjusted (like in
25198 File\SpecialChar menuseparator
25203 Finally, the copy is loaded instead of the original document.
25206 \begin_layout Labeling
25207 \labelwidthstring 00.00.0000
25209 \begin_inset space ~
25213 \begin_inset space ~
25217 \begin_inset Newline newline
25221 \begin_inset Flex Code
25224 \begin_layout Plain Layout
25231 \begin_inset Flex Code
25234 \begin_layout Plain Layout
25241 \begin_inset Newline newline
25245 \begin_inset Flex Code
25248 \begin_layout Plain Layout
25249 cvs -q add "<new-file-name>"
25257 \begin_layout Subsubsection
25263 \begin_layout Standard
25264 This will rename the current document.
25265 Since CVS does not support rename operations natively, the version history
25266 is not preserved, the renamed document is added as a new file, and the
25267 original document is deleted.
25268 It requires a clean document without any changes since the last checkin.
25269 You are asked for a file name and a description of the rename operation.
25270 After that the document is renamed, both locally and in the repository.
25271 If the parent directories of the new and old file names differ, all relative
25272 paths of included files are adjusted (like in
25274 File\SpecialChar menuseparator
25279 Finally, the document is reloaded using the new name.
25282 \begin_layout Labeling
25283 \labelwidthstring 00.00.0000
25285 \begin_inset space ~
25289 \begin_inset space ~
25293 \begin_inset Newline newline
25297 \begin_inset Flex Code
25300 \begin_layout Plain Layout
25307 \begin_inset Flex Code
25310 \begin_layout Plain Layout
25317 \begin_inset Newline newline
25321 \begin_inset Flex Code
25324 \begin_layout Plain Layout
25325 cvs -q add "<new-file-name>"
25331 \begin_inset Newline newline
25335 \begin_inset Flex Code
25338 \begin_layout Plain Layout
25339 cvs -q remove "<file-name>"
25347 \begin_layout Subsubsection
25348 Update of the local directory checkout from repository
25351 \begin_layout Standard
25352 Once your documents gets more complex, containing sub-documents and pictures,
25354 \begin_inset Flex Code
25357 \begin_layout Plain Layout
25363 files and so on using version control becomes more complicated.
25365 supports updating the whole tree in which resides the document.
25366 This become especially useful once you cooperate with people which neither
25367 have detailed knowledge about CVS usage nor they have ambition to commit
25368 additional material to the repository.
25369 You have to organize the files structure so that all external files are
25370 in the same directory or subdirectories of the document.
25371 It's good practice anyway to store multipart documents in an extra directory.
25374 \begin_layout Standard
25376 \begin_inset Flex Code
25379 \begin_layout Plain Layout
25380 Update local directory from repository
25385 command updates the whole directory.
25386 If local changes are detected user is warned before update starts.
25387 In case of merge conflicts both versions of the conflicting document parts
25388 are placed in the final document.
25389 You have to review and correct the result of the merge.
25390 You'll find the conflicts enclosed in pairs of
25391 \begin_inset Flex Code
25394 \begin_layout Plain Layout
25401 \begin_inset Flex Code
25404 \begin_layout Plain Layout
25411 \begin_inset Flex Code
25414 \begin_layout Plain Layout
25421 The first part is your version as before the update operation with the
25422 document name prepended.
25423 The second one is the repository version with the version number after
25425 \begin_inset Flex Code
25428 \begin_layout Plain Layout
25437 \begin_layout Labeling
25438 \labelwidthstring 00.00.0000
25440 \begin_inset space ~
25444 \begin_inset space ~
25448 \begin_inset Newline newline
25452 \begin_inset Flex Code
25455 \begin_layout Plain Layout
25463 (Ask if changes are detected.)
25464 \begin_inset Newline newline
25468 \begin_inset Flex Code
25471 \begin_layout Plain Layout
25472 cd $path; cvs -q update
25482 \begin_layout Standard
25484 \begin_inset Flex Code
25487 \begin_layout Plain Layout
25493 stands for the path to the document.
25496 \begin_layout Subsubsection
25502 \begin_layout Standard
25503 This shows the complete history of the CVS document.
25506 cvs log "<file-name>"
25508 is shown in a browser.
25511 \begin_layout Subsubsection
25515 \begin_layout Standard
25517 supports CVS version number, author name, date and time of last commit.
25518 All those are extracted from
25520 cvs log -r <file-name>
25524 \begin_inset CommandInset ref
25526 reference "subsec:VCS-Revision-Information"
25533 \begin_layout Subsection
25534 SVN commands in \SpecialChar LyX
25538 \begin_layout Standard
25539 SVN is now partially supported by \SpecialChar LyX
25541 You can find the commands in the
25543 File\SpecialChar menuseparator
25545 \begin_inset space ~
25551 Please note that if you use password protected access to repository via
25552 ssh, you will be asked in terminal window.
25554 was tested against SVN 1.5, 1.6, 1.7 and 1.8
25558 \begin_layout Plain Layout
25559 Most of the commands will work with 1.4 too, see
25560 \begin_inset CommandInset ref
25562 reference "subsec:SVN-Repo-Update"
25567 There seems to be currently unresolved permissions problem under SVN 1.8
25568 with reverting changes when file is locked.
25576 \begin_layout Subsubsection
25582 \begin_layout Standard
25583 If your document is not under revision control, this is the only item shown
25585 And if it is under revision control, the
25589 item is not visible.
25592 \begin_layout Standard
25593 This command registers in SVN your document ONLY in case you have already
25594 the documents directory under SVN control (in particular
25599 This means you have to checkout the archive by yourself.
25602 \begin_layout Standard
25603 Then you are asked interactively to supply an initial description of the
25605 Don't forget that registered file is not yet commited.
25608 \begin_layout Standard
25609 SVN command that is run:
25612 \begin_inset Quotes qld
25616 \begin_inset Quotes qld
25622 \begin_layout Standard
25627 to understand the switches.
25630 \begin_layout Subsubsection
25636 \begin_layout Standard
25637 When you are finished editing a file, you commit your changes.
25638 When you do this, you are asked for a description of the changes.
25639 After that changes are commited.
25642 \begin_layout Standard
25647 \begin_layout Plain Layout
25648 In case locking is not enabled.
25650 \begin_inset CommandInset ref
25652 reference "subsec:SVN-File-Locking"
25663 svn commit -q -m"<description>" <file-name>
25666 \begin_layout Subsubsection
25672 \begin_layout Standard
25673 Updates the changes of this file from the repository.
25674 Be sure you understand SVN merging and conflicts resolving before using
25675 this function, because all conflicts has to be resolved manually by you!
25678 \begin_layout Standard
25683 \begin_layout Plain Layout
25691 svn update --non-interactive
25692 \begin_inset Quotes qld
25696 \begin_inset Quotes qld
25702 \begin_layout Subsubsection
25705 Revert To Repository Version
25708 \begin_layout Standard
25709 This will discard all changes made to the document since the last check
25711 You get a warning before changes are discarded.
25714 \begin_layout Standard
25718 \begin_inset Quotes qld
25722 \begin_inset Quotes qld
25728 \begin_layout Subsubsection
25734 \begin_layout Standard
25735 This will create a copy of the current document including the version history.
25736 It requires a clean document without any changes since the last checkin.
25737 You are asked for a file name and a description of the copy operation.
25738 After that the copy is created, both locally and in the repository.
25739 If the parent directories of the copied and original document differ, all
25740 relative paths of included files of the copy are adjusted (like in
25742 File\SpecialChar menuseparator
25747 Finally, the copy is loaded instead of the original document.
25750 \begin_layout Labeling
25751 \labelwidthstring 00.00.0000
25753 \begin_inset space ~
25757 \begin_inset space ~
25761 \begin_inset Newline newline
25765 \begin_inset Flex Code
25768 \begin_layout Plain Layout
25772 \begin_inset Quotes qld
25776 \begin_inset Quotes qld
25780 \begin_inset Quotes qld
25784 \begin_inset Quotes qld
25793 \begin_inset Newline newline
25797 \begin_inset Flex Code
25800 \begin_layout Plain Layout
25809 \begin_layout Subsubsection
25815 \begin_layout Standard
25816 This will rename the current document including the version history.
25817 It requires a clean document without any changes since the last checkin.
25818 You are asked for a file name and a description of the rename operation.
25819 After that the document is renamed, both locally and in the repository.
25820 If the parent directories of the new and old file names differ, all relative
25821 paths of included files are adjusted (like in
25823 File\SpecialChar menuseparator
25828 Finally, the document is reloaded using the new name.
25831 \begin_layout Labeling
25832 \labelwidthstring 00.00.0000
25834 \begin_inset space ~
25838 \begin_inset space ~
25842 \begin_inset Newline newline
25846 \begin_inset Flex Code
25849 \begin_layout Plain Layout
25853 \begin_inset Quotes qld
25857 \begin_inset Quotes qld
25861 \begin_inset Quotes qld
25865 \begin_inset Quotes qld
25874 \begin_inset Newline newline
25878 \begin_inset Flex Code
25881 \begin_layout Plain Layout
25890 \begin_layout Subsubsection
25891 \begin_inset CommandInset label
25893 name "subsec:SVN-Repo-Update"
25897 Update of the local directory checkout from repository
25901 \begin_layout Plain Layout
25902 Note that this command will work only with subversion
25903 \begin_inset Formula $\geqq1.5$
25914 \begin_layout Standard
25915 All the commands above have one shortcoming – they deal with the current
25917 Once your document contains pictures, includes external
25918 \begin_inset Flex Code
25921 \begin_layout Plain Layout
25927 files and so on administration becomes more complicated.
25929 now supports updating the whole tree in which resides the document
25933 \begin_layout Plain Layout
25934 One need to organize the files structure so that all external files are
25935 in the same directory or subdirectories of the document.
25942 This become especially useful once you cooperate with people which neither
25943 know about subversion management nor they have ambition to commit additional
25944 material to the repository.
25948 \begin_layout Standard
25949 \begin_inset Flex Code
25952 \begin_layout Plain Layout
25953 Update local directory from repository
25958 command updates the whole directory and in case of merge conflicts local
25959 version of the files are left, so no unintended data loss occurs.
25960 If local changes are detected user is warned before update starts.
25963 \begin_layout Labeling
25964 \labelwidthstring 00.00.0000
25966 \begin_inset space ~
25970 \begin_inset space ~
25974 \begin_inset Newline newline
25978 \begin_inset Flex Code
25981 \begin_layout Plain Layout
25987 (Ask if changes are detected.)
25988 \begin_inset Newline newline
25992 \begin_inset Flex Code
25995 \begin_layout Plain Layout
25996 svn update --accept mine-full $path
26004 \begin_layout Standard
26006 \begin_inset Flex Code
26009 \begin_layout Plain Layout
26015 stands for the path to the document.
26018 \begin_layout Subsubsection
26024 \begin_layout Standard
26025 This shows the complete history of the SVN document.
26029 \begin_inset Quotes qld
26033 \begin_inset Quotes qld
26038 is shown in a browser.
26041 \begin_layout Subsubsection
26043 \begin_inset CommandInset label
26045 name "subsec:SVN-File-Locking"
26052 \begin_layout Standard
26053 The file exchange through various revision control systems brings the problem
26054 of merge conflicts in case two different users try to edit the same (parts
26056 When such a conflict happens it needs manual resolving and one reasonable
26057 alternative is to provide some kind of locking mechanism, which guarantees
26058 that only one user is allowed to edit file at the given time.
26061 \begin_layout Standard
26062 SVN has two such mechanisms to provide mutual exclusivity for file access
26063 – locks and automatic setting of write permissions (see sec.
26065 \begin_inset CommandInset ref
26067 reference "subsec:Automatical-Locking-Property"
26072 \begin_inset Flex Code
26075 \begin_layout Plain Layout
26085 \begin_layout Plain Layout
26086 \begin_inset Flex URL
26089 \begin_layout Plain Layout
26091 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
26102 If this property is detected for a given document \SpecialChar LyX
26103 starts to use SVN locks
26104 for document editing automatically and the whole check-in/out mechanism
26105 switches to the same regimen as for RCS.
26106 This in particular means there are two different modes of file use in \SpecialChar LyX
26110 \begin_layout Itemize
26112 The loaded file is in the read-only mode.
26113 For editing on needs to check-out.
26118 consists of updating from the repository and gaining write lock.
26119 If the lock is not possible to obtain, we remain in unlocked state.
26122 \begin_layout Itemize
26124 The loaded file is in the
26125 \begin_inset Quotes els
26129 \begin_inset Quotes ers
26133 No other user is allowed to edit the file.
26138 consists of commiting changes and releasing write-lock.
26139 If no changes have been made to the document, no commit will be produced
26143 \begin_layout Plain Layout
26144 Don't be puzzled by the fact that you will be asked for commit message anyway.
26149 and only the write-lock will be released.
26152 \begin_layout Standard
26156 \begin_layout Labeling
26157 \labelwidthstring 00.00.0000
26160 svn commit -q -m"<description>" "<file-name>"
26161 \begin_inset Newline newline
26164 svn unlock "<file-name>"
26167 \begin_layout Labeling
26168 \labelwidthstring 00.00.0000
26171 svn update "<file-name>"
26172 \begin_inset Newline newline
26175 svn lock "<file-name>"
26178 \begin_layout Subsubsection
26181 \begin_inset CommandInset label
26183 name "subsec:Automatical-Locking-Property"
26189 Automatic Locking Property
26192 \begin_layout Standard
26193 The above mentioned automatic setting of write permissions of the .lyx file
26196 File\SpecialChar menuseparator
26198 \begin_inset space ~
26201 Control\SpecialChar menuseparator
26202 Use Locking Property
26205 This command is active only when the file is not locked on the svn server
26207 you need to check-out before proceeding).
26210 \begin_layout Labeling
26211 \labelwidthstring 00.00.0000
26213 \begin_inset space ~
26219 \begin_layout Labeling
26220 \labelwidthstring 00.00.0000
26223 svn propset svn:needs-lock ON "<file-name>"
26226 \begin_layout Labeling
26227 \labelwidthstring 00.00.0000
26230 svn propdel svn:needs-lock "<file-name>"
26233 \begin_layout Subsubsection
26234 \begin_inset CommandInset label
26236 name "subsec:VCS-Revision-Information"
26240 Revision Information in Documents
26243 \begin_layout Standard
26244 There are more possibilities how to activate revision information in our
26248 \begin_layout Itemize
26254 \begin_layout Itemize
26255 tree revision information (
26256 \begin_inset Flex Code
26259 \begin_layout Plain Layout
26266 The result is the output of the
26267 \begin_inset Flex Code
26270 \begin_layout Plain Layout
26276 command, the following table gives you an idea, how to read the results.
26279 \begin_layout Standard
26281 \begin_inset Tabular
26282 <lyxtabular version="3" rows="6" columns="2">
26283 <features tabularvalignment="middle">
26284 <column alignment="left" valignment="top">
26285 <column alignment="left" valignment="top">
26287 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26290 \begin_layout Plain Layout
26298 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26301 \begin_layout Plain Layout
26311 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
26314 \begin_layout Plain Layout
26320 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26323 \begin_layout Plain Layout
26324 mixed revision working copy
26331 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
26334 \begin_layout Plain Layout
26340 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26343 \begin_layout Plain Layout
26344 modified working copy
26351 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
26354 \begin_layout Plain Layout
26360 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26363 \begin_layout Plain Layout
26364 switched working copy
26371 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
26374 \begin_layout Plain Layout
26380 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26383 \begin_layout Plain Layout
26384 partial working copy, from a sparse checkout
26391 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26394 \begin_layout Plain Layout
26400 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26403 \begin_layout Plain Layout
26404 mixed revision, modified, switched working copy
26417 \begin_layout Itemize
26418 file revision information.
26419 The result comes from parsing the output of
26420 \begin_inset Flex Code
26423 \begin_layout Plain Layout
26425 \begin_inset space ~
26429 \begin_inset space ~
26433 \begin_inset space ~
26442 Supported flags are:
26446 \begin_layout Itemize
26447 version number of the last commit (
26448 \begin_inset Flex Code
26451 \begin_layout Plain Layout
26460 \begin_layout Itemize
26461 author of the last commit (
26462 \begin_inset Flex Code
26465 \begin_layout Plain Layout
26474 \begin_layout Itemize
26475 date of the last commit (
26476 \begin_inset Flex Code
26479 \begin_layout Plain Layout
26488 \begin_layout Itemize
26489 time of the last commit (
26490 \begin_inset Flex Code
26493 \begin_layout Plain Layout
26503 \begin_layout Standard
26504 You can obtain this info via InsetInfo (
26505 \change_inserted 5863208 1564400022
26508 Insert\SpecialChar menuseparator
26509 Field\SpecialChar menuseparator
26510 Version Control Revision
26511 \change_deleted 5863208 1564399852
26516 \begin_inset Flex Code
26519 \begin_layout Plain Layout
26520 info-insert buffer vcs-date
26528 The information will be available only when you have the file stored under
26529 svn managment (i.e.
26531 \begin_inset Flex Code
26534 \begin_layout Plain Layout
26540 directory is available with your document).
26544 \begin_layout Itemize
26545 Another—a hacking one—possibility is to use svn keywords
26549 \begin_layout Plain Layout
26550 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
26556 In short – you set file keywords property (e.g.
26559 svn propset svn:keywords 'Rev' file.lyx
26561 ) and then paste keyword \SpecialChar TeX
26566 \begin_layout Plain Layout
26567 This is an easy way how to ensure that \SpecialChar LyX
26568 won't break the line in the middle
26574 tag in your document (e.g.
26576 \begin_inset Flex Code
26579 \begin_layout Plain Layout
26586 This way svn client will automatically substitute revision number (e.g.
26588 \begin_inset Flex Code
26591 \begin_layout Plain Layout
26597 ) after each update and commit.
26598 There are more problems with this approach.
26599 Firstly, the '$' character is used in \SpecialChar TeX
26600 world for math equations, so any
26601 occurence of math formula
26602 \begin_inset Formula $Rev$
26606 \begin_inset Formula $Rev:59$
26609 in your \SpecialChar LyX
26611 Similarly for other keywords like Id, Date, Author, etc.
26612 Secondly svn output is dependent on your locales, so its very easy that
26613 svn would produce some problematic strings once Date is used.
26614 Thirdly you get the whole 'Rev: 59' string in your document instead of
26616 Until subversion implements user's custom keywords it will be hard to use
26617 this approach reliably or let \SpecialChar LyX
26618 to support it directly.
26621 \begin_layout Subsection
26622 SVN and Windows Environment
26625 \begin_layout Quote
26626 My inclination is to say that if the user cannot figure out the command
26627 line operations on their own fairly quickly, they would be well advised
26628 to use TortoiseSVN.
26634 \begin_layout Subsubsection
26638 \begin_layout Standard
26639 In addition to installing \SpecialChar LyX
26640 , and having access to a Subversion repository,
26641 the user will need to install the Subversion client program.
26642 A Windows installer for the client program is available from
26643 \begin_inset CommandInset href
26646 target "http://www.collab.net/nonav/downloads/subversion/"
26652 The user may also want to install
26653 \begin_inset CommandInset href
26656 target "http://tortoisesvn.tigris.org/"
26661 , which integrates Subversion operations into the context (rightclick) menu
26662 of Windows Explorer.
26663 Operations done outside \SpecialChar LyX
26664 will typically be more convenient using the Explorer
26666 Note that TortoiseSVN is not a replacement for the client program, which
26667 is what \SpecialChar LyX
26671 \begin_layout Subsubsection
26672 Bringing a document under Subversion control
26675 \begin_layout Standard
26676 Before a \SpecialChar LyX
26677 document can be brought under version control in Subversion, its
26678 parent directory needs to be under version control.
26679 If the document is being added to a project already in the repository,
26680 this is accomplished by checking the project out to the directory where
26681 the new document will be placed.
26682 If the project itself is not yet under version control (for instance, if
26683 this document starts a new project), the directory must be imported into
26685 This is done outside \SpecialChar LyX
26687 Both import and checkout are easily accomplished from the Explorer context
26688 menu using TortoiseSVN, or alternatively can be done using the command
26689 line client at a DOS prompt.
26690 The procedure for importing the project using TortoiseSVN is described
26691 below, assuming an existing repository and a new project being started
26699 For information on using the Subversion client program, run
26706 \begin_layout Enumerate
26713 in Windows Explorer, right click it, and select
26715 TortoiseSVN\SpecialChar menuseparator
26719 If necessary, adjust the URL for the repository, then click OK.
26722 \begin_layout Enumerate
26723 Right click the level of the repository under which you want to place the
26724 new project folder (typically the top level) and click
26728 Supply a name for the project folder and click OK.
26729 Add a message for the log file if desired, then click OK again.
26730 The new project folder should appear in the repository.
26731 Finally, click OK again to exit the repository browser.
26734 \begin_layout Enumerate
26735 Once again right click
26741 , this time selecting SVN Checkout\SpecialChar ldots
26742 Select the URL of the project folder
26743 you just created in the repository, and set the checkout directory to
26751 You will be warned about a non-empty folder; click OK to proceed.
26752 You should now have a
26763 \begin_layout Enumerate
26764 Create or open your document in \SpecialChar LyX
26767 File\SpecialChar menuseparator
26769 \begin_inset space ~
26772 Control\SpecialChar menuseparator
26776 Add a log message and click OK to commit the document to version control.
26779 \begin_layout Standard
26780 From this point onward, you should have full functionality in the
26782 File\SpecialChar menuseparator
26784 \begin_inset space ~
26790 You also have the option of checking the document in and out, viewing its
26792 using the TortoiseSVN context menu in Windows Explorer or the Subversion
26793 client program from a command prompt.
26796 \begin_layout Subsubsection
26797 SSH tunnel used with SVN under Windows
26800 \begin_layout Standard
26801 Compared with Linux setting up an svn client to communicate over ssh under
26802 Windows is a rather troublesome task.
26803 We will at least offer some hints how to setup the client side but prior
26804 knowledge about ssh and the Windows command line is needed, also be prepared
26805 for a great deal of frustration\SpecialChar ldots
26809 \begin_layout Enumerate
26810 Get an svn client for windows, as described in the previous sections.
26811 When it is a fresh install run some svn command (e.g.
26813 \begin_inset Flex Code
26816 \begin_layout Plain Layout
26822 ) to create config files, which you will need to change later on.
26825 \begin_layout Enumerate
26826 Choose an ssh client for Windows.
26827 There are several possibilities, we will use the one from Putty tools
26831 \begin_layout Plain Layout
26832 \begin_inset Flex URL
26835 \begin_layout Plain Layout
26837 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
26848 You will need to set the connection up so that the client doesn't ask for
26849 any password from you.
26850 To keep things easy we will use only keys without any additional password
26855 \begin_layout Enumerate
26857 \begin_inset Flex Code
26860 \begin_layout Plain Layout
26867 Save your private .ppk key file and put the public one on the server side.
26868 If the SVN server runs on Linux, note that the format of the public key
26869 is not compatible with Linux openssh and you will need to direcly copy-paste
26871 \begin_inset Quotes eld
26876 Public key for pasting into OpenSSH authorized_keys file
26879 \begin_inset Quotes erd
26882 edit field into the server's
26883 \begin_inset Flex Code
26886 \begin_layout Plain Layout
26887 ~/.ssh/authorized_keys
26893 \begin_inset Flex Code
26896 \begin_layout Plain Layout
26905 \begin_layout Enumerate
26907 \begin_inset Flex Code
26910 \begin_layout Plain Layout
26917 In the SVN config file
26921 \begin_layout Plain Layout
26922 Exact path depends on Windows version, usually somewhere around
26923 \begin_inset Flex Code
26926 \begin_layout Plain Layout
26929 Documents and Settings
26943 \begin_inset Flex Code
26946 \begin_layout Plain Layout
26961 , section [tunnels], setup ssh command, e.g.
26963 \begin_inset Flex Code
26966 \begin_layout Plain Layout
26967 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
26976 \begin_layout Plain Layout
26977 It will usually take a lot of time to get exact command right and it depends
26979 For example do not have some remote server saved as a default session in
26981 If things fail, try to connect via plink without SVN first.
26990 \begin_layout Enumerate
26991 Checkout the SVN archive, e.
26992 \begin_inset space \thinspace{}
26996 \begin_inset Newline newline
27000 \begin_inset Flex Code
27003 \begin_layout Plain Layout
27004 svn co svn+ssh://user@server/repository_path
27012 \begin_layout Subsubsection
27013 End-of-Line Conversions
27016 \begin_layout Standard
27017 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
27019 use different line endings inside the .lyx files.
27020 This is not a problem as far as \SpecialChar LyX
27021 functionality is concerned, but the commit
27022 diffs will be huge and merge-conflicts prone.
27023 Fortunately SVN itself knows
27027 \begin_layout Plain Layout
27028 \begin_inset Flex URL
27031 \begin_layout Plain Layout
27033 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
27043 how to deal with CR/LF problems when switching .lyx files to the
27044 \begin_inset Flex Code
27047 \begin_layout Plain Layout
27057 \begin_layout Plain Layout
27059 \begin_inset Flex Code
27062 \begin_layout Plain Layout
27063 svn propset svn:eol-style native FILE_NAME
27076 \begin_layout Subsection
27077 GIT commands in \SpecialChar LyX
27081 \begin_layout Standard
27082 A minimal subset of GIT commands is now supported by \SpecialChar LyX
27084 You can find the commands in the
27086 File\SpecialChar menuseparator
27088 \begin_inset space ~
27094 Please note that if you use password protected access to repository via
27095 ssh, you will be asked in terminal window.
27097 was tested against GIT 1.7.
27101 \begin_layout Plain Layout
27102 Windows users please note that you need to ensure that git is on the path.
27103 This can be set from within \SpecialChar LyX
27106 Tools\SpecialChar menuseparator
27107 Preferences\SpecialChar menuseparator
27108 Paths\SpecialChar menuseparator
27119 \begin_layout Standard
27120 One big difference of GIT and the other supported version control systems
27121 is the distributed nature of GIT: With traditional version control systems
27122 there is one central server which hosts the repository.
27123 Users commit their changes to the server, and get updates made by other
27125 With GIT, users commit to a local repository.
27126 The local repository can be synchronized with one or more remote repositories
27128 \begin_inset Flex Code
27131 \begin_layout Plain Layout
27138 \begin_inset Flex Code
27141 \begin_layout Plain Layout
27149 does not interact in any way with remote GIT repositories.
27150 It works exclusively with the local repository in a very similar way as
27151 with a central CVS or SVN repository.
27152 If you use remote GIT repositories you need to do the
27153 \begin_inset Flex Code
27156 \begin_layout Plain Layout
27163 \begin_inset Flex Code
27166 \begin_layout Plain Layout
27172 operations with your favourite GIT client.
27175 \begin_layout Subsubsection
27181 \begin_layout Standard
27182 If your document is not under revision control, this is the only item shown
27184 And if it is under revision control, the
27188 item is not visible.
27191 \begin_layout Standard
27192 This command registers in GIT your document ONLY in case you have already
27193 the documents directory under GIT control (in particular
27198 This means you have to checkout the archive by yourself.
27201 \begin_layout Standard
27202 Then you are asked interactively to supply an initial description of the
27204 Don't forget that registered file is not yet committed.
27207 \begin_layout Standard
27208 GIT command that is run:
27211 \begin_inset Quotes qld
27215 \begin_inset Quotes qld
27221 \begin_layout Standard
27226 to understand the switches.
27229 \begin_layout Subsubsection
27235 \begin_layout Standard
27236 When you are finished editing a file, you commit your changes.
27237 When you do this, you are asked for a description of the changes.
27238 After that changes are committed.
27241 \begin_layout Standard
27244 git commit -q -m"<description>" <file-name>
27247 \begin_layout Subsubsection
27250 Revert To Repository Version
27253 \begin_layout Standard
27254 This will discard all changes made to the document since the last check
27256 You get a warning before changes are discarded.
27259 \begin_layout Standard
27263 \begin_inset Quotes qld
27267 \begin_inset Quotes qld
27273 \begin_layout Subsubsection
27279 \begin_layout Standard
27280 This will rename the current document including the version history.
27281 It requires a clean document without any changes since the last checkin.
27282 You are asked for a file name and a description of the rename operation.
27283 After that the document is renamed, both locally and in the repository.
27284 If the parent directories of the new and old file names differ, all relative
27285 paths of included files are adjusted (like in
27287 File\SpecialChar menuseparator
27292 Finally, the document is reloaded using the new name.
27295 \begin_layout Labeling
27296 \labelwidthstring 00.00.0000
27298 \begin_inset space ~
27302 \begin_inset space ~
27306 \begin_inset Newline newline
27310 \begin_inset Flex Code
27313 \begin_layout Plain Layout
27317 \begin_inset Quotes qld
27321 \begin_inset Quotes qld
27325 \begin_inset Quotes qld
27329 \begin_inset Quotes qld
27338 \begin_inset Newline newline
27342 \begin_inset Flex Code
27345 \begin_layout Plain Layout
27354 \begin_layout Subsubsection
27360 \begin_layout Standard
27361 This shows the complete history of the GIT document.
27365 \begin_inset Quotes qld
27369 \begin_inset Quotes qld
27374 is shown in a browser.
27377 \begin_layout Subsubsection
27381 \begin_layout Standard
27383 supports GIT hash number of the last commit to the file,
27384 \change_inserted 1119979965 1564297456
27385 its abbreviated form,
27387 author name, date and time of last commit.
27388 All those are extracted from
27390 git log -n 1 --pretty=format:%H%n
27391 \change_inserted 1119979965 1564297427
27397 Tree version information is obtained via
27399 git describe --abbrev --dirty --long
27403 \begin_inset CommandInset ref
27405 reference "subsec:VCS-Revision-Information"
27412 \begin_layout Subsection
27416 \begin_layout Standard
27417 With the recent addition of the
27418 \begin_inset Flex Code
27421 \begin_layout Plain Layout
27427 function \SpecialChar LyX
27428 power users are allowed to create their own commands for revision
27432 \begin_layout Standard
27433 As an example you can see how two TortoiseSVN commands could be integrated
27437 \begin_layout Description
27439 \begin_inset Flex Code
27442 \begin_layout Plain Layout
27443 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
27451 \begin_layout Description
27453 \begin_inset Flex Code
27456 \begin_layout Plain Layout
27457 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
27465 \begin_layout Subsection
27466 Version control and Document comparison
27469 \begin_layout Standard
27470 One of the typical uses of version control is to inspect the changes between
27471 revisions, usually by creating
27472 \begin_inset Flex Code
27475 \begin_layout Plain Layout
27482 While this is useful for plain text files, it is much less useful in the
27483 case of \SpecialChar LyX
27484 files, which have more a complicated structure.
27485 Hence we provide binding to the Document comparison feature.
27486 There are two ways of calling this feature – either by direct call of
27487 \begin_inset Flex Code
27490 \begin_layout Plain Layout
27497 function (for details see \SpecialChar LyX
27498 functions manual) or by the toolbar icon
27511 One can either compare two chosen revisions of the document or he can simply
27512 compare the current version of edited text with older revisions (where
27514 \begin_inset Flex Noun
27517 \begin_layout Plain Layout
27523 ' revisions back means comparison of the edited file with last commited
27528 \begin_layout Standard
27529 This feature is supported for SVN and RCS though due to the more complicated
27530 versioning scheme of RCS there is a constraint – when addressing the revisions
27531 in dialog, numbers always point to the last number in RCS revision number,
27534 We don't currently support GIT addressing of revisions, one can just compare
27535 edited document with its revision X steps backs, where X is addressed as
27537 \begin_inset Flex Code
27540 \begin_layout Plain Layout
27549 \begin_layout Section
27550 Literate Programming
27553 \begin_layout Standard
27558 (kayvan@sylvan.com)
27562 original documentation written by
27564 Edmar Wienskoski Jr.
27567 (edmar-w-jr@technologist.com)
27570 \begin_layout Subsection
27574 \begin_layout Standard
27575 The main purpose of this documentation is to show you how to use \SpecialChar LyX
27577 programming, where it is assumed that you are familiar with this programming
27578 technique, and know what
27579 \begin_inset Quotes eld
27583 \begin_inset Quotes erd
27587 \begin_inset Quotes eld
27591 \begin_inset Quotes erd
27595 If that is not the case, please follow the web links provided in the following
27597 There is a lot of good documentation out there covering old development
27598 history to the latest tools tips.
27601 \begin_layout Standard
27602 It is also assumed that you are familiar with \SpecialChar LyX
27603 itself to a point that you
27604 are comfortable changing your \SpecialChar LyX
27605 preferences, and X resources file.
27606 If that is not the case please refer to other \SpecialChar LyX
27607 documentation to cover your
27611 \begin_layout Subsection
27612 Literate Programming
27615 \begin_layout Standard
27616 From the Literate Programming FAQ:
27619 \begin_layout Quotation
27620 Literate programming is the combination of documentation and source together
27621 in a fashion suited for reading by human beings.
27622 In fact, literate programs should be enjoyable reading, even inviting!
27623 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
27624 and documentation in a single file.
27625 Literate programming tools then parse the file to produce either readable
27626 documentation or compilable source.
27627 The WEB style of literate programming was created by D.
27628 \begin_inset space \thinspace{}
27632 Knuth during the development of his \SpecialChar TeX
27633 typesetting software.
27637 \begin_layout Standard
27638 Another excerpt says:
27641 \begin_layout Quotation
27644 How is literate programming different from verbose commenting?
27647 \begin_layout Quotation
27648 There are three distinguishing characteristics.
27649 In order of importance, they are:
27653 \begin_layout Itemize
27654 flexible order of elaboration
27657 \begin_layout Itemize
27658 automatic support for browsing
27661 \begin_layout Itemize
27662 typeset documentation, especially diagrams and mathematics
27666 \begin_layout Standard
27667 Now that I sparked your curiosity, take a look in the references.
27670 \begin_layout Subsubsection
27674 \begin_layout Standard
27675 The complete Literate Programming FAQ can be found at:
27678 \begin_layout Quote
27679 Literate Programming FAQ
27680 \begin_inset Flex URL
27683 \begin_layout Plain Layout
27685 http://www.literateprogramming.com/lpfaq.pdf
27693 \begin_layout Standard
27694 The FAQ lists 23 (twenty three!) different literate programming tools.
27695 Where some are specialized or
27696 \begin_inset Quotes eld
27700 \begin_inset Quotes erd
27703 for particular programming languages, while other have general scope.
27708 for my own use for several reasons:
27711 \begin_layout Itemize
27712 It can generate the documentation either in \SpecialChar LaTeX
27716 \begin_layout Itemize
27717 It has a open architecture, i.
27718 \begin_inset space \thinspace{}
27722 \begin_inset space \space{}
27725 it is easy to plug in new filters
27729 \begin_layout Plain Layout
27734 are programs that read a given data stream and output a manipulated data
27736 That way, a WEB file (consisting of literate code) can be turned into a
27737 file consisting only of C program code or \SpecialChar LaTeX
27743 and to perform special processing that you may need.
27747 \begin_layout Itemize
27748 There is a good selection of filters available already (the HTML is one
27752 \begin_layout Itemize
27756 \begin_layout Standard
27757 The Noweb web page can be found at:
27760 \begin_layout Quote
27762 \begin_inset Flex URL
27765 \begin_layout Plain Layout
27767 https://www.cs.tufts.edu/~nr/noweb/
27775 \begin_layout Standard
27776 Starting from there you can reach many other interesting links and even
27777 some literate program examples.
27780 \begin_layout Subsection
27782 and Literate Programming with Noweb
27785 \begin_layout Standard
27786 The \SpecialChar LyX
27787 support for Literate Programming is provided by using the generic \SpecialChar LyX
27789 converters mechanism.
27790 This support is provided in a
27791 \begin_inset Quotes eld
27795 \begin_inset Quotes erd
27799 \begin_inset space \thinspace{}
27803 \begin_inset space \space{}
27806 you will be able to use this new \SpecialChar LyX
27807 feature with some other literate programming
27808 tool of your choice by just changing your \SpecialChar LyX
27812 \begin_layout Subsubsection
27813 Generating documents and code (weaving and tangling)
27816 \begin_layout Paragraph
27817 Using the noweb module
27820 \begin_layout Standard
27821 If you have installed Noweb and \SpecialChar LyX
27822 successfully, whenever you open a new document,
27823 after you have chosen its document class, use the
27825 Document\SpecialChar menuseparator
27829 \begin_inset Quotes eld
27833 \begin_inset Quotes erd
27837 If Noweb is correctly installed, when you click on the
27838 \begin_inset Quotes eld
27842 \begin_inset Quotes erd
27845 link, you will see the
27846 \begin_inset Quotes eld
27850 \begin_inset Quotes erd
27853 module in the available list and you can add it to your document.
27856 \begin_layout Paragraph
27860 \begin_layout Standard
27862 enables you to write code with a custom inset named
27863 \begin_inset Flex Noun
27866 \begin_layout Plain Layout
27873 Noweb delimits chunks like this:
27876 \begin_layout LyX-Code
27880 \begin_layout LyX-Code
27884 \begin_layout LyX-Code
27888 \begin_layout LyX-Code
27892 \begin_layout LyX-Code
27896 \begin_layout Standard
27897 The problem is that whatever is written in between the << and the
27901 must be taken literally, i.
27902 \begin_inset space \thinspace{}
27906 \begin_inset space \space{}
27910 should be prevented from making any special interpretation of what has
27912 This is also handled by
27913 \begin_inset Flex Noun
27916 \begin_layout Plain Layout
27922 , that works like a normal text inset but has a free spacing capability.
27925 \begin_layout Standard
27926 As a special note, you can also use the
27927 \begin_inset Quotes eld
27931 \begin_inset Quotes erd
27934 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
27938 \begin_layout LyX-Code
27942 \begin_layout LyX-Code
27943 def some_function(args):
27946 \begin_layout LyX-Code
27947 "This is the doc string for this function."
27950 \begin_layout LyX-Code
27951 print "My args: ", args
27954 \begin_layout LyX-Code
27955 @ %def some_function
27958 \begin_layout Standard
27959 For an example of this usage and the resulting cross-reference output, look
27960 at the Literate python program in
27962 LIBDIR/examples/listerrors.lyx
27964 which should make this all clear.
27967 \begin_layout Paragraph
27968 Generating the documentation
27971 \begin_layout Standard
27972 At this point you already have a new document file with a proper document
27973 class, and with some code and text on it.
27974 How do I print it? The answer is simple, you select
27976 View\SpecialChar menuseparator
27980 Just like you would do for a plain document.
27981 No special procedure is required.
27984 \begin_layout Standard
27985 To help orientate you, I will now explain what happens inside \SpecialChar LyX
27989 \begin_layout Enumerate
27992 Update\SpecialChar menuseparator
27995 menu option is chosen, a \SpecialChar LaTeX
28001 \begin_layout Standard
28002 If the document is of any literate class the generated file will be named
28003 with an extension name defined by the
28004 \begin_inset Quotes eld
28008 \begin_inset Quotes erd
28011 format (defined in the Preferences panel), otherwise the file will have
28020 \begin_layout Enumerate
28021 Note that the only difference so far is in the name of the file, no special
28022 processing is required by \SpecialChar LyX
28024 Given that you formatted the code using the
28025 \begin_inset Flex Noun
28028 \begin_layout Plain Layout
28034 inset that, by itself, takes care of the business.
28037 \begin_layout Enumerate
28038 If the document is of any literate class \SpecialChar LyX
28039 will then use the internal \SpecialChar LyX
28041 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
28046 \begin_layout Plain Layout
28047 The converters are defined in the
28049 Tools\SpecialChar menuseparator
28053 \begin_inset Quotes eld
28057 \begin_inset Quotes erd
28069 manual for general information about converters.
28074 to generate the \SpecialChar LaTeX
28079 \begin_layout Standard
28080 Otherwise it will just skip this step.
28084 \begin_layout Enumerate
28085 Finally, \SpecialChar LaTeX
28086 is invoked and the regular post processing continues as in a plain
28090 \begin_layout Standard
28091 Independence from a particular
28092 \begin_inset Quotes eld
28096 \begin_inset Quotes erd
28099 is easily achieved by changing the commands that are run by the various
28103 \begin_layout Paragraph
28104 Generating the code
28107 \begin_layout Standard
28108 When the build menu option is chosen or the corresponding button in the
28109 toolbar is pressed, a \SpecialChar LaTeX
28110 file is generated just like step 1 above.
28111 Next, \SpecialChar LyX
28117 This converter needs to be defined by the user and is not installed by
28118 default, though the Program format is.
28119 This converter (like any other converter) will have two parts:
28122 \begin_layout Enumerate
28123 The converter program itself.
28124 This program performs the conversion from the one format to the other (in
28125 this case, from the Noweb format to the Program pseudo-format).
28128 \begin_layout Enumerate
28129 The error log parser.
28130 This is a program whose sole purpose is to rewrite error messages in a
28131 format that \SpecialChar LyX
28133 This makes it possible for \SpecialChar LyX
28134 to place error boxes in the right places in
28138 \begin_layout Standard
28139 The first part, the
28140 \begin_inset Quotes eld
28144 \begin_inset Quotes erd
28147 setting, should be set to
28150 \begin_layout LyX-Code
28158 \begin_layout Standard
28159 This basically means that \SpecialChar LyX
28161 \begin_inset Quotes eld
28165 \begin_inset Quotes erd
28168 (a program or script) with the name of the Noweb file (normally a file
28169 in the \SpecialChar LyX
28170 temp directory) and the directory path of the original \SpecialChar LyX
28175 \begin_layout Standard
28176 This is an implementation of
28177 \begin_inset Quotes eld
28181 \begin_inset Quotes erd
28184 that you can place in a directory on your path:
28187 \begin_layout LyX-Code
28193 \begin_layout LyX-Code
28199 \begin_layout LyX-Code
28202 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
28205 \begin_layout Standard
28206 The next part of the converter setting is the
28207 \begin_inset Quotes eld
28211 \begin_inset Quotes erd
28214 which is to be set to
28217 \begin_layout LyX-Code
28220 parselog=$$s/scripts/listerrors
28223 \begin_layout Standard
28224 This will run any errors that are generated by the
28225 \begin_inset Quotes eld
28229 \begin_inset Quotes erd
28232 process through the
28233 \begin_inset Quotes eld
28237 \begin_inset Quotes erd
28243 \begin_layout Standard
28244 The build will normally take place in \SpecialChar LyX
28245 's temporary directory, so the files
28246 produced by the conversion will be in that directory.
28248 will copy out what it regards as the `main' file, but the
28252 conversion may produce several files, and so most of these would then be
28253 deleted when \SpecialChar LyX
28255 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
28256 the build-script chunk can place the generated files in that location.
28259 \begin_layout Paragraph
28260 Build instructions in the document
28263 \begin_layout Standard
28264 The last piece of the integration between \SpecialChar LyX
28266 \begin_inset Quotes eld
28270 \begin_inset Quotes erd
28274 Generally, the instructions for building your program should be embedded
28275 in a chunk of its own.
28277 \begin_inset Quotes eld
28281 \begin_inset Quotes erd
28284 above uses the notangle command to look for this chunk (called
28285 \begin_inset Quotes eld
28289 \begin_inset Quotes erd
28292 ) and runs its contents through
28293 \begin_inset Quotes eld
28297 \begin_inset Quotes erd
28303 \begin_layout Standard
28304 Typically, such a chunk would look something like this:
28307 \begin_layout LyX-Code
28311 \begin_layout LyX-Code
28313 \begin_inset Newline newline
28316 if [ -z "${NOWEB_SOURCE}" ]
28317 \begin_inset Newline newline
28323 \begin_layout LyX-Code
28324 NOWEB_SOURCE=myfile.nw
28325 \begin_inset Newline newline
28329 \begin_inset Newline newline
28333 code to extract files ...
28334 use NOWEB_OUTPUT_DIR here ...]
28335 \begin_inset Newline newline
28339 code to compile files ...]
28340 \begin_inset Newline newline
28346 \begin_layout Standard
28349 LIBDIR/examples/listerrors.lyx
28353 LIBDIR/examples/Literate.lyx
28355 which implement two versions of the
28356 \begin_inset Quotes eld
28360 \begin_inset Quotes erd
28363 program for some illustrations of how all of these pieces go together or
28366 LIBDIR/examples/noweb2lyx.lyx.
28369 Interestingly, these three files show off the language-indepence of the
28371 literate programming support since they are written in Python, C and Perl
28375 \begin_layout Subsubsection
28376 Configuring \SpecialChar LyX
28380 \begin_layout Standard
28381 All the Literate Programming support is configured by the
28383 Tools\SpecialChar menuseparator
28387 \begin_inset Quotes eld
28391 \begin_inset Quotes erd
28395 The important parts are:
28398 \begin_layout Description
28400 \begin_inset space ~
28404 \begin_inset Quotes eld
28408 \begin_inset Quotes erd
28412 \begin_inset space ~
28415 format Set up via the File Formats tab, this is where the Noweb-specific
28425 , the file extension is set to
28430 This tells \SpecialChar LyX
28431 to create a file with a
28435 extension in the first step of the conversion process.
28438 \begin_layout Description
28440 \begin_inset space ~
28448 \begin_inset space ~
28451 format This is an empty format whose sole purpose is to be the endpoint
28452 of a conversion (which then allows us to set up a converter for it).
28455 \begin_layout Description
28465 This converter performs the
28466 \begin_inset Quotes eld
28470 \begin_inset Quotes erd
28473 of the literate document.
28474 For Noweb, it is set to
28475 \begin_inset Quotes eld
28480 noweave -delay -index $$i > $$o
28483 \begin_inset Quotes erd
28489 \begin_layout Description
28499 \begin_inset Quotes eld
28503 \begin_inset Quotes erd
28507 As stated above, the Converter is set to
28508 \begin_inset Quotes eld
28516 \begin_inset Quotes erd
28519 , with Flags set to
28520 \begin_inset Newline newline
28524 \begin_inset Quotes eld
28529 parselog=$$s/scripts/listerrors
28532 \begin_inset Quotes erd
28538 \begin_layout Subsubsection
28542 \begin_layout Standard
28543 There is also a new function implemented in the \SpecialChar LyX
28545 \begin_inset Quotes eld
28548 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
28552 \begin_layout Standard
28553 When debugging code with ddd/gdb, it is possible to invoke a text editor
28554 at the current execution position with a single key stroke.
28555 The default ddd configuration for that is shift-ctrl-V.
28556 It happens that you can define the editor command line invocation in ddd
28559 Edit\SpecialChar menuseparator
28560 Preferences\SpecialChar menuseparator
28563 dialog and changing the "Edit Sources" entry.
28566 \begin_layout Standard
28567 I take advantage of the newly created \SpecialChar LyX
28568 server function and this ddd feature,
28570 \begin_inset Quotes eld
28574 \begin_inset Quotes erd
28580 \begin_layout LyX-Code
28581 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
28584 \begin_layout Standard
28585 With this, whenever you are using ddd and find a point in the program that
28586 you want to edit, you just press shift-ctrl-V (in the ddd window), and
28587 ddd will forward this information to \SpecialChar LyX
28588 through the \SpecialChar LyX
28589 server and then the
28591 window will show the same file with the cursor at the same position ddd
28593 No more guessing or long scrolling to locate a point in the program back
28597 \begin_layout Standard
28598 Note however that you must enable the \SpecialChar LyX
28599 server to get this feature working
28600 (it is disabled by default).
28602 \begin_inset space ~
28606 \begin_inset CommandInset ref
28608 reference "sec:Starting-the-Server"
28612 explains how to do that.
28615 \begin_layout Subsubsection
28619 \begin_layout Standard
28620 There are six new buttons that can be added to your \SpecialChar LyX
28622 Four of these buttons are short cuts to layout styles:
28640 , one for the custom inset
28645 The last one is a short cut to the
28646 \begin_inset Quotes eld
28650 \begin_inset Quotes erd
28657 \begin_layout Standard
28659 has a range of buttons that are available for tool bar customization.
28660 In my toolbar I like to combine the six short cuts above with two more:
28665 \SpecialChar menuseparator
28670 \SpecialChar menuseparator
28677 Document\SpecialChar menuseparator
28678 View\SpecialChar menuseparator
28682 Here is how it looks like:
28685 \begin_layout LyX-Code
28689 \begin_layout LyX-Code
28693 \begin_layout LyX-Code
28694 Icon "layout Standard"
28697 \begin_layout LyX-Code
28698 Icon "layout Section"
28701 \begin_layout LyX-Code
28702 Icon "layout \SpecialChar LaTeX
28706 \begin_layout LyX-Code
28707 Icon "layout \SpecialChar LyX
28711 \begin_layout LyX-Code
28712 Icon "flex.insert Chunk"
28715 \begin_layout LyX-Code
28719 \begin_layout LyX-Code
28723 \begin_layout LyX-Code
28724 Icon "buffer-typeset"
28727 \begin_layout LyX-Code
28728 Icon "build-program"
28731 \begin_layout LyX-Code
28735 \begin_layout LyX-Code
28739 \begin_layout LyX-Code
28743 \begin_layout LyX-Code
28747 \begin_layout LyX-Code
28751 \begin_layout Subsubsection
28752 Colors customization
28755 \begin_layout Standard
28756 There are a number of colors in \SpecialChar LyX
28757 that can be customized in
28762 One of the things that bothers people is the \SpecialChar LaTeX
28764 The default color is red, since the chunks uses \SpecialChar LaTeX
28765 font, and there is a lot
28766 of chunks in literate documents, you may get tired of seeing everything
28768 You can change it by going to the tabs
28777 \begin_layout Standard
28778 The next thing is the visible presence of the newline character in the screen.
28779 You can choose the color of this particular character and make it blend
28781 I recommend you choosing a color that is close to the background but not
28782 equal, that way you still can see it is there, but it is not bothering
28786 \begin_layout Subsection
28791 \begin_layout Standard
28800 is documented in the
28804 example file and in the Sweave manual (menu
28806 Help\SpecialChar menuseparator
28812 \begin_layout Chapter
28816 \begin_layout Standard
28817 You can do everything with \SpecialChar LyX
28818 that you can do with \SpecialChar LaTeX
28820 However, \SpecialChar LyX
28821 cannot support every \SpecialChar LaTeX
28823 But you can always use \SpecialChar TeX
28825 This chapter shows you some more special things you might want to use.
28826 For other special things you can do with figures, tables, floats, boxes
28827 and notes, have a look at the
28830 \begin_inset space ~