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 630872221 "Jean-Pierre Chrétien" jeanpierre.chretien@free.fr
136 \author 1075283030 "Thibaut"
137 \author 1119979965 "Joel A. Kulesza"
143 Additional \SpecialChar LyX
147 \begin_layout Subtitle
149 \change_deleted 630872221 1622909155
151 \change_inserted 630872221 1622909155
158 by the \SpecialChar LyX
163 \begin_layout Plain Layout
165 Principal maintainer of this file is
167 Richard Kimberly Heck
170 If you have comments or error corrections, please send them to the \SpecialChar LyX
173 \begin_inset Flex Code
176 \begin_layout Plain Layout
177 <lyx-docs@lists.lyx.org>
190 \begin_layout Standard
191 \begin_inset CommandInset toc
192 LatexCommand tableofcontents
199 \begin_layout Chapter
203 \begin_layout Standard
204 This manual is essentially Part II of the
206 User's Guide\SpecialChar endofsentence
209 The reason for separating the two documents is simple: the
213 is already quite lengthy, and it contains information on all of the basic
214 features one needs to know in order to prepare most documents.
215 However, the \SpecialChar LyX
216 Team has worked to make \SpecialChar LyX
217 extensible through various configuration
218 files and external packages.
219 That means that if you want to support the Fizzwizzle \SpecialChar LaTeX
221 create a layout file (or module) for it without having to alter \SpecialChar LyX
223 We've already had contributions of several new features this way, and some
224 of them are documented here.
225 There are also some more `advanced' features, such as how to control the
226 presentation of bibliographies and how to work with multi-part documents,
227 that are not covered in the
231 and are discussed here.
234 \begin_layout Standard
235 This manual also documents some special features, like fax support
236 \change_deleted 244031559 1603802929
238 \change_inserted 244031559 1603802931
242 \change_deleted 244031559 1603802954
245 , which require additional software to work properly.
246 There is also a chapter on \SpecialChar LyX
248 And lastly, there's a chapter of \SpecialChar LaTeX
249 tools and tips, things you can use to
250 spruce up your documents by directly using the powerful features of \SpecialChar LaTeX
252 After all, \SpecialChar LyX
257 only WYSIWYM and will only ever interface to some, not all, \SpecialChar LaTeX
261 \begin_layout Standard
262 If you haven't read the
266 yet, you are definitely in the wrong manual.
271 is the first place to go, since it describes the notation and format of
273 You should also be thoroughly familiar with the
277 and all of the basic features of \SpecialChar LyX
278 before attempting to read this one.
281 \begin_layout Standard
282 Since many of the topics in this manual depend heavily on \SpecialChar LyX
284 with \SpecialChar LaTeX
285 , this first chapter covers the inner workings of \SpecialChar LyX
288 to generate exactly the \SpecialChar LaTeX
290 It is obviously for more seasoned \SpecialChar LyX
294 \begin_layout Chapter
296 and \SpecialChar LaTeX
300 \begin_layout Section
302 Uses \SpecialChar LaTeX
306 \begin_layout Standard
307 This chapter is for both \SpecialChar TeX
308 -nicians and the \SpecialChar LaTeX
310 In it, we'll explain how \SpecialChar LyX
311 and \SpecialChar LaTeX
312 work together to produce printable output.
313 This is the only place in any of the manuals where we assume you know something
314 about \SpecialChar LaTeX
318 \begin_layout Standard
319 At one time, \SpecialChar LyX
321 \begin_inset Quotes eld
324 WYSIWYM frontend to \SpecialChar LaTeX
326 \begin_inset Quotes erd
329 but that's no longer true.
330 There are frontends to \SpecialChar LaTeX
335 \begin_layout Plain Layout
336 Some familar ones are \SpecialChar TeX
337 maker and kile, on Linux, and \SpecialChar TeX
339 There are also the \SpecialChar LaTeX
340 modes for vi and emacs, of course.
345 These are basically text editors with the ability to run \SpecialChar LaTeX
347 errors in the file you're editing.
348 Although \SpecialChar LyX
357 run \SpecialChar LaTeX
358 , and it also indicates errors in the file, it also does much, much
360 For one thing, you don't need to know \SpecialChar LaTeX
361 to use \SpecialChar LyX
364 has added its own extensions to \SpecialChar LaTeX
366 Try the following sometime: select
367 \begin_inset Flex Noun
370 \begin_layout Plain Layout
371 Export\SpecialChar menuseparator
378 \begin_inset Flex Noun
381 \begin_layout Plain Layout
388 \begin_inset Flex Noun
391 \begin_layout Plain Layout
392 View\SpecialChar menuseparator
402 ), then look at the preamble of the resulting
403 \begin_inset Flex Code
406 \begin_layout Plain Layout
413 You'll notice a variety of new macros defined specifically by \SpecialChar LyX
415 These macros are defined automatically, according to the features you use
419 \begin_layout Standard
420 There are several commands that automatically invoke \SpecialChar LaTeX
425 \begin_layout Itemize
426 \begin_inset Flex Noun
429 \begin_layout Plain Layout
430 Document\SpecialChar menuseparator
439 \begin_layout Itemize
440 \begin_inset Flex Noun
443 \begin_layout Plain Layout
444 Document\SpecialChar menuseparator
453 \begin_layout Standard
454 They will only invoke \SpecialChar LaTeX
455 if the file has changed since the last time \SpecialChar LaTeX
461 \begin_layout Standard
462 When \SpecialChar LyX
463 runs \SpecialChar LaTeX
464 on the file you're editing, it performs these steps:
467 \begin_layout Enumerate
468 Convert the document to \SpecialChar LaTeX
469 and save to a file with the extension
470 \begin_inset Flex Code
473 \begin_layout Plain Layout
480 \begin_inset Flex Code
483 \begin_layout Plain Layout
492 \begin_layout Enumerate
493 Run \SpecialChar LaTeX
495 \begin_inset Flex Code
498 \begin_layout Plain Layout
504 file (maybe several times), and run any other commands (such as
505 \begin_inset Flex Code
508 \begin_layout Plain Layout
515 \begin_inset Flex Code
518 \begin_layout Plain Layout
524 ) needed to compile the \SpecialChar LaTeX
528 \begin_layout Enumerate
529 If there are any errors, show the error log.
532 \begin_layout Standard
533 If you have run \SpecialChar LaTeX
535 \begin_inset Flex Noun
538 \begin_layout Plain Layout
539 View\SpecialChar menuseparator
546 then runs a DVI viewer to display the DVI-file.
548 \begin_inset Flex Noun
551 \begin_layout Plain Layout
552 View\SpecialChar menuseparator
559 performs further steps:
562 \begin_layout Enumerate
564 \begin_inset Flex Code
567 \begin_layout Plain Layout
573 to convert the DVI file to PostScript.
576 \begin_layout Enumerate
577 Run a PostScript viewer, such as
578 \begin_inset Flex Code
581 \begin_layout Plain Layout
587 , to display the PostScript file.
590 \begin_layout Standard
592 does similar things when viewing, or exporting, other formats.
595 \begin_layout Section
596 Translating \SpecialChar LaTeX
597 files into \SpecialChar LyX
601 \begin_layout Standard
602 You can import a \SpecialChar LaTeX
603 file into \SpecialChar LyX
605 \begin_inset Flex Noun
608 \begin_layout Plain Layout
609 File\SpecialChar menuseparator
610 Import\SpecialChar menuseparator
616 command in \SpecialChar LyX
618 This will call a program named
619 \begin_inset Flex Code
622 \begin_layout Plain Layout
628 which will create a file
629 \begin_inset Flex Code
632 \begin_layout Plain Layout
639 \begin_inset Flex Code
642 \begin_layout Plain Layout
650 will then open that file.
654 \begin_layout Plain Layout
655 \begin_inset Flex Code
658 \begin_layout Plain Layout
664 can also be run from the command line, of course.
672 \begin_layout Standard
673 \begin_inset Flex Code
676 \begin_layout Plain Layout
682 will translate most legal \SpecialChar LaTeX
683 , but not everything.
684 It will put things it doesn't understand into \SpecialChar TeX
685 code, so after translating
687 \begin_inset Flex Code
690 \begin_layout Plain Layout
696 , you can look for \SpecialChar TeX
697 code and hand-edit it until it looks right.
700 \begin_layout Standard
701 If you don't know what \SpecialChar TeX
702 code is, read the next section.
705 \begin_layout Section
706 \begin_inset CommandInset label
708 name "sec:Inserting-TeX-Code"
712 Inserting \SpecialChar TeX
713 Code into \SpecialChar LyX
717 \begin_layout Standard
718 Anything you can do in \SpecialChar LaTeX
719 you can do in \SpecialChar LyX
720 , for a very simple reason: You can
721 always insert \SpecialChar TeX
722 code into any \SpecialChar LyX
725 cannot, and will never be able to, display every possible \SpecialChar LaTeX
727 If ever you need to insert \SpecialChar LaTeX
728 commands into your \SpecialChar LyX
729 document, you can use the
731 \begin_inset Flex Code
734 \begin_layout Plain Layout
741 box, which you can insert into your document with
742 \begin_inset Flex Noun
745 \begin_layout Plain Layout
746 Insert\SpecialChar menuseparator
756 or the keyboard shortcut
765 \begin_layout Standard
766 Here's an example of inserting \SpecialChar LaTeX
767 commands in a \SpecialChar LyX
769 The code looks like this:
772 \begin_layout LyX-Code
776 \begin_inset Newline newline
782 \begin_inset Newline newline
785 This is an example of a minipage environment.
787 \begin_inset Newline newline
790 can put nearly everything in it, even (non-floating)
791 \begin_inset Newline newline
796 \begin_inset Newline newline
802 \begin_inset Newline newline
806 \begin_inset Newline newline
812 \begin_inset Newline newline
818 \begin_inset Newline newline
824 \begin_inset Newline newline
829 \begin_inset Newline newline
835 \begin_inset Newline newline
841 \begin_inset Newline newline
847 \begin_inset Newline newline
855 \begin_layout LyX-Code
859 \begin_layout Standard
861 \begin_inset Flex Code
864 \begin_layout Plain Layout
871 box containing this text is directly after this paragraph.
872 Those of you reading the manual in \SpecialChar LyX
873 will only see the \SpecialChar TeX
875 Those reading a printed version of the manuals will see the actual results:
876 \begin_inset VSpace bigskip
882 \begin_layout Standard
886 \begin_layout Plain Layout
893 \begin_layout Plain Layout
900 \begin_layout Plain Layout
902 This is an example of a minipage environment.
903 You can put nearly everything in it, even (non-floating) figures and tables.
907 \begin_layout Plain Layout
914 \begin_layout Plain Layout
919 \begin_layout Plain Layout
926 \begin_layout Plain Layout
933 \begin_layout Plain Layout
940 \begin_layout Plain Layout
946 \begin_layout Plain Layout
953 \begin_layout Plain Layout
960 \begin_layout Plain Layout
967 \begin_layout Plain Layout
977 \begin_inset VSpace bigskip
983 \begin_layout Standard
984 In addition to using \SpecialChar TeX
985 code, you can also create a separate file containing
986 some complex \SpecialChar LaTeX
987 structure and then use
988 \begin_inset Flex Noun
991 \begin_layout Plain Layout
992 Insert\SpecialChar menuseparator
1002 to include your file (you should select the type
1003 \begin_inset Flex Code
1006 \begin_layout Plain Layout
1013 We recommend that you only do this if you have a
1014 \begin_inset Flex Code
1017 \begin_layout Plain Layout
1028 Otherwise, you'll have a big job tracking down \SpecialChar LaTeX
1032 \begin_layout Standard
1033 There are a few last points to emphasize:
1036 \begin_layout Itemize
1042 check if your \SpecialChar LaTeX
1046 \begin_layout Itemize
1047 Beware of reinventing the wheel.
1050 \begin_layout Standard
1051 On that last point, \SpecialChar LyX
1052 does have quite a few features tucked into it, and
1054 Be sure to check the manuals to make sure that \SpecialChar LyX
1055 doesn't have such-and-such
1056 feature before you decide you have to do it by hand.
1057 Moreover, there are numerous \SpecialChar LaTeX
1058 packages out there to do all sorts of things,
1059 from labels to envelopes to fancy multipage tables.
1061 \change_inserted 244031559 1603815732
1063 \begin_inset CommandInset href
1066 target "https://www.ctan.org/"
1072 \change_deleted 244031559 1603815732
1074 \begin_inset CommandInset href
1077 target "http://www.ctan.org/"
1087 \begin_layout Standard
1088 If you do need to do some wild and fancy things within your document, be
1089 sure to check out a good \SpecialChar LaTeX
1090 book for assistance.
1091 There are a number of them listed in the bibliography of the
1098 \begin_layout Section
1100 and the \SpecialChar LaTeX
1104 \begin_layout Subsection
1105 About the \SpecialChar LaTeX
1109 \begin_layout Standard
1110 If you already know \SpecialChar LaTeX
1111 , there is no need to explain here what the preamble
1113 If you don't, the following will give you some ideas—we recommend again
1114 that you consult a \SpecialChar LaTeX
1115 book for further information.
1116 In any case, you should read the points below, because they explain what
1117 you can do and what you don't need to do in the \SpecialChar LaTeX
1118 preamble of a \SpecialChar LyX
1122 \begin_layout Standard
1123 The \SpecialChar LaTeX
1124 preamble comes at the very beginning of a document,
1132 \begin_layout Itemize
1133 Declare the document class.
1135 \begin_inset Newline newline
1139 already does this for you.
1140 If you're a seasoned \SpecialChar LaTeX
1141 -nician, and you have a custom document class you
1142 want to use, check out the
1144 Customization Manual
1146 for information on how to make \SpecialChar LyX
1150 \begin_layout Itemize
1151 Declare the usage of packages.
1153 \begin_inset Newline newline
1157 packages provide special commands, which are only available within a document
1158 when the package has been declared in the preamble.
1159 In addition to providing special commands, the inclusion of a package can
1160 change the document.
1161 For example, the package
1162 \begin_inset Flex Code
1165 \begin_layout Plain Layout
1171 forces all paragraphs to be indented.
1172 There are other packages for labels, envelopes, margins, etc.
1176 \begin_layout Itemize
1177 Set counters, variables, lengths and widths.
1179 \begin_inset Newline newline
1182 There are several \SpecialChar LaTeX
1183 counters and variables that
1187 be set globally from within the preamble in order to have the desired effect.
1188 (There are variables that you can set and reset inside the document, too.)
1189 Margins are a good example of something that must be set in the preamble.
1190 Another example is the label format for lists.
1191 You can actually set these just about anywhere, but it's best to do it
1192 just once, inside the preamble.
1195 \begin_layout Itemize
1196 Declare user defined commands (with
1197 \begin_inset Flex Code
1200 \begin_layout Plain Layout
1209 \begin_inset Flex Code
1212 \begin_layout Plain Layout
1221 \begin_inset Newline newline
1224 These are abbreviations for \SpecialChar LaTeX
1225 commands which appear very often inside a document.
1226 Although the preamble is a good place to declare such commands, they
1230 be declared anywhere (before they are used for the first time, of course).
1231 This can be useful if there is a lot of raw \SpecialChar LaTeX
1232 code in your document, which
1233 normally should not be the case.
1236 \begin_layout Standard
1238 adds its own set of definitions to the preamble of the
1239 \begin_inset Flex Code
1242 \begin_layout Plain Layout
1249 This makes \SpecialChar LaTeX
1250 files generated by \SpecialChar LyX
1254 \begin_layout Subsection
1255 Changing the Preamble
1258 \begin_layout Standard
1259 The commands which \SpecialChar LyX
1260 adds to the preamble of a \SpecialChar LaTeX
1261 file are fixed; you can't
1262 change them without patching \SpecialChar LyX
1264 You can, however, add your own stuff to the preamble by selecting
1265 \begin_inset Flex Noun
1268 \begin_layout Plain Layout
1271 \begin_inset space ~
1280 \begin_inset Flex Noun
1283 \begin_layout Plain Layout
1284 Document\SpecialChar menuseparator
1292 adds anything in the
1293 \begin_inset Flex Noun
1296 \begin_layout Plain Layout
1302 dialog to its own built-in preamble.
1303 Before adding your own declarations in the preamble, you should make sure
1304 that \SpecialChar LyX
1305 doesn't already support what you want to do.
1306 (Remember what we said about reinventing the wheel?) Also,
1308 make sure your preamble code is correct
1312 doesn't check it for you.
1313 If there is an error, you're likely to get an error like
1314 \begin_inset Quotes eld
1318 \begin_inset Flex Code
1321 \begin_layout Plain Layout
1330 \begin_inset Quotes erd
1334 If you see this error, check your preamble.
1337 \begin_layout Subsection
1341 \begin_layout Standard
1342 Here are some examples of what you can add to a preamble, and what they
1346 \begin_layout Subsubsection
1350 \begin_layout Standard
1351 There are two variables under \SpecialChar LaTeX
1352 that control page position:
1353 \begin_inset Flex Code
1356 \begin_layout Plain Layout
1365 \begin_inset Flex Code
1368 \begin_layout Plain Layout
1377 Their names should be self-explanatory.
1378 These variables are useful if you think for a moment about computer labels.
1379 Sometimes, the size of a print medium and the area of the medium that you
1380 can actually print on aren't the same.
1382 \begin_inset Flex Code
1385 \begin_layout Plain Layout
1394 \begin_inset Flex Code
1397 \begin_layout Plain Layout
1408 \begin_layout Standard
1409 The default values for
1410 \begin_inset Flex Code
1413 \begin_layout Plain Layout
1422 \begin_inset Flex Code
1425 \begin_layout Plain Layout
1434 \begin_inset space \thinspace{}
1438 \begin_inset space \thinspace{}
1442 \begin_inset space \space{}
1445 the page isn't shifted.
1446 Unfortunately, some DVI drivers always seem to shift the page.
1447 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1448 If you're using \SpecialChar LyX
1449 on a system that you don't personally maintain, and your
1450 sysadmin is a doofus,
1451 \begin_inset Flex Code
1454 \begin_layout Plain Layout
1463 \begin_inset Flex Code
1466 \begin_layout Plain Layout
1475 Suppose your left and top margins are always 0.5
1476 \begin_inset space \thinspace{}
1480 You can add this to the preamble:
1483 \begin_layout LyX-Code
1491 \begin_layout LyX-Code
1499 \begin_layout Standard
1500 and your margins should now be correct.
1503 \begin_layout Subsubsection
1507 \begin_layout Standard
1508 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1509 There's a rather nice package, available at your nearest CTAN archive,
1510 for printing sheets of labels:
1511 \begin_inset Flex Code
1514 \begin_layout Plain Layout
1521 Now, your system may not have this package installed by default.
1522 We leave that up to you to check.
1523 You'll also want to read the documentation for it; we're not going to do
1525 Since this is an example, however, we'll give you an example of how you
1529 \begin_layout Standard
1530 First, make sure you're using the
1531 \begin_inset Flex Code
1534 \begin_layout Plain Layout
1541 Next, you need to put the following in your preamble:
1544 \begin_layout LyX-Code
1550 \begin_layout LyX-Code
1556 \begin_layout LyX-Code
1562 \begin_layout LyX-Code
1568 \begin_layout LyX-Code
1574 \begin_layout LyX-Code
1580 \begin_layout LyX-Code
1586 \begin_layout Standard
1587 This sets things up for Avery label sheets, stock #5360.
1588 You're now ready to print labels, but you'll need to insert \SpecialChar LaTeX
1591 \begin_inset Flex Code
1594 \begin_layout Plain Layout
1603 \begin_inset Flex Code
1606 \begin_layout Plain Layout
1614 around each label text.
1615 This and other special features of
1616 \begin_inset Flex Code
1619 \begin_layout Plain Layout
1625 are explained in its documentation.
1628 \begin_layout Standard
1629 Someday, someone may write a \SpecialChar LyX
1630 layout file to support this package directly.
1631 Maybe that someone is you.
1634 \begin_layout Subsubsection
1635 Example #3: Paragraph Indentation
1638 \begin_layout Standard
1639 Americans are trained to indent the first line of
1644 As with all of their other weird quirks, most Americans will whine and
1645 moan until they can have their way and indent the first line of all paragraphs.
1654 \begin_layout Standard
1655 Of course, this behavior isn't standard typography.
1656 In books, you typically only indent the first line of a paragraph
1660 it follows another one.
1661 The idea behind indenting the first line of a paragraph is to distinguish
1662 neighboring paragraphs from one another.
1663 If there is no previous paragraph—for example, if it follows a figure or
1664 is the first paragraph in a section—then there is no need for indentation.
1668 \begin_layout Standard
1669 If you're a typical American (we're still joking!), though, you don't care
1670 about such esoteric things; you want your indentation! Add this to the
1674 \begin_layout LyX-Code
1677 usepackage{indentfirst}
1680 \begin_layout Standard
1681 If your \SpecialChar TeX
1682 distribution isn't braindead, you'll have this package, and all
1683 of your paragraphs will get the indentation the Founding Fathers intended
1687 \begin_layout Subsubsection
1688 Example #4: This Document
1691 \begin_layout Standard
1692 You can also check out the preamble of this document to get an idea of some
1693 of the advanced things you can do.
1696 \begin_layout Section
1698 and \SpecialChar LaTeX
1702 \begin_layout Standard
1703 When \SpecialChar LyX
1704 calls \SpecialChar LaTeX
1705 , it tells \SpecialChar LaTeX
1706 to blithely ignore any errors and keep going.
1707 It then uses the logfile from the \SpecialChar LaTeX
1708 run to do a post-mortem.
1709 After analyzing the logfile, \SpecialChar LyX
1710 displays a dialog listing the errors.
1711 Clicking on any one of them will take you to the position in your \SpecialChar LyX
1713 where the error occurred.
1717 \begin_layout Plain Layout
1719 Analyzing the logfile is a tough job, and \SpecialChar LyX
1720 doesn't always go to the right
1722 There are also cases where \SpecialChar LaTeX
1723 reports the error on one line, but the actual
1725 This is not unlike forgetting a closing brace in a program: You'll get
1726 an error, but only later.
1734 \begin_layout Standard
1735 Some folks also like to look at the log file directly: It is available from
1737 \begin_inset Flex Noun
1740 \begin_layout Plain Layout
1741 Document\SpecialChar menuseparator
1743 \begin_inset space ~
1752 There are some fairly common error messages and warnings.
1753 We'll cover those here.
1754 You should look at a good \SpecialChar LaTeX
1755 book for a complete listing.
1758 \begin_layout Itemize
1759 \begin_inset Flex Code
1762 \begin_layout Plain Layout
1769 \begin_inset Newline newline
1772 Anything beginning with these words is a warning message for the purpose
1774 \begin_inset Quotes eld
1778 \begin_inset Quotes erd
1781 the \SpecialChar LaTeX
1783 You'll get messages like this if you added or changed cross-references
1784 or bibliography entries, in which case, \SpecialChar LaTeX
1785 is trying to tell you that you
1786 need to make another run.
1787 You can by-and-large ignore these.
1790 \begin_layout Itemize
1791 \begin_inset Flex Code
1794 \begin_layout Plain Layout
1801 \begin_inset Newline newline
1804 Another warning message, this time about fonts which \SpecialChar LaTeX
1806 The rest of the message will often say something about a replacement font
1807 that \SpecialChar LaTeX
1809 You can safely ignore these, too.
1812 \begin_layout Itemize
1813 \begin_inset Flex Code
1816 \begin_layout Plain Layout
1825 \begin_inset Newline newline
1834 It seems to generate at least one of these messages for just about any
1836 They are warnings about lines that were too long and run past the right
1838 This happens if \SpecialChar LaTeX
1839 does not find a reasonable way to break the lines (notoriously
1840 often with typewriter font, since this does not allow for automatic break
1842 In many cases, this is unnoticeable in the final output.
1843 (It can be just a point or two.) Sometimes, however, the lines run rather
1844 visibly into the margin; something you will not want to have in your final
1847 \begin_inset Newline newline
1850 There are several global ways to try to minimize the overfull lines.
1853 Enable micro-typographic extensions
1857 Document\SpecialChar menuseparator
1858 Settings\SpecialChar menuseparator
1861 might already improve things a lot.
1862 Furthermore, \SpecialChar LaTeX
1863 code such as the following in
1865 Document\SpecialChar menuseparator
1866 Settings\SpecialChar menuseparator
1869 usually reduces the overfull lines drastically (we use this in the preamble
1874 \begin_layout LyX-Code
1878 \begin_inset Newline newline
1884 \begin_inset Newline newline
1889 emergencystretch 1.5em
1890 \begin_inset Newline newline
1898 \begin_layout Standard
1899 In some cases, however, you eventually have to rewrite the text to get the
1900 line breaking right.
1904 \begin_layout Plain Layout
1905 For more information, see
1906 \begin_inset Flex URL
1909 \begin_layout Plain Layout
1911 http://www.tex.ac.uk/FAQ-overfull.html
1924 \begin_layout Standard
1925 In any case, you should check the respective lines, at least for the final
1926 version of your document.
1927 Your eyes will tell you if there's a problem with something that's too
1932 \begin_layout Plain Layout
1933 You can also enable the `draft' option in
1934 \begin_inset Flex Noun
1937 \begin_layout Plain Layout
1938 Document\SpecialChar menuseparator
1944 , and then \SpecialChar LaTeX
1945 will draw a black box in the margin of lines that are overfull.
1954 \begin_layout Itemize
1955 \begin_inset Flex Code
1958 \begin_layout Plain Layout
1967 \begin_inset Newline newline
1970 Not quite as common as its cousin.
1971 This happens again if \SpecialChar LaTeX
1972 does not find a reasonable break point and consequently
1973 generates too loose lines.
1974 As with the overfull lines, you should check if this is a visible problem.
1977 \begin_layout Itemize
1978 \begin_inset Flex Code
1981 \begin_layout Plain Layout
1990 \begin_inset Flex Code
1993 \begin_layout Plain Layout
2002 \begin_inset Newline newline
2005 Warnings about troubles breaking the page.
2006 Once again, just look at the output.
2007 Your eyes will tell you where something has gone wrong.
2010 \begin_layout Itemize
2011 \begin_inset Flex Code
2014 \begin_layout Plain Layout
2016 \begin_inset Quotes els
2020 \begin_inset Quotes ers
2029 \begin_inset Newline newline
2033 \begin_inset Quotes eld
2037 \begin_inset Quotes erd
2040 isn't installed on this system.
2041 This usually appears because some package your document needs isn't installed.
2042 If you didn't touch the preamble or didn't use the
2043 \begin_inset Flex Code
2046 \begin_layout Plain Layout
2054 command, then one of the packages \SpecialChar LyX
2055 tried to load is missing.
2057 \begin_inset Flex Noun
2060 \begin_layout Plain Layout
2061 Help\SpecialChar menuseparator
2068 to get a list of packages that \SpecialChar LyX
2070 This file is updated whenever you reconfigure \SpecialChar LyX
2072 \begin_inset Flex Noun
2075 \begin_layout Plain Layout
2076 Tools\SpecialChar menuseparator
2082 ) and tells you which packages have been detected and what they do.
2083 \begin_inset Newline newline
2087 \begin_inset Flex Code
2090 \begin_layout Plain Layout
2098 command and the package in question isn't installed, then you'll need to
2099 install it yourself.
2102 \begin_layout Itemize
2103 \begin_inset Flex Code
2106 \begin_layout Plain Layout
2107 LaTeX Error: Unknown option
2113 \begin_inset Newline newline
2116 Error messages beginning with this are trying to tell you that you specified
2117 a bad or undefined option to a package.
2118 Check the package's documentation.
2121 \begin_layout Itemize
2122 \begin_inset Flex Code
2125 \begin_layout Plain Layout
2126 Undefined control sequence
2132 \begin_inset Newline newline
2135 If you've inserted \SpecialChar LaTeX
2136 code into your document, but made a typo, you'll get
2138 You may have forgotten to load a package.
2139 In any case, this error message usually means that you used an undefined
2144 \begin_layout Standard
2145 There are other error and warning messages.
2146 Some are self-explanatory.
2147 These are usually \SpecialChar LaTeX
2149 Others are downright cryptic.
2150 These are usually \SpecialChar TeX
2151 error messages, and we really have
2155 what they mean or how to decipher them.
2159 \begin_layout Standard
2160 There's a general sequence you should follow if you get error messages:
2163 \begin_layout Enumerate
2164 Look at the \SpecialChar LaTeX
2165 code you inserted for typos.
2168 \begin_layout Enumerate
2169 If there are no typos, check that you used the command(s) correctly.
2172 \begin_layout Enumerate
2173 If you get a bunch of error boxes piled up at the very top of the document—and
2174 especially if you see a
2175 \begin_inset Quotes eld
2179 \begin_inset Flex Code
2182 \begin_layout Plain Layout
2191 \begin_inset Quotes erd
2194 error—it means that there are errors in the preamble.
2195 Start debugging your preamble.
2198 \begin_layout Enumerate
2199 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2201 document, the first suspect is your \SpecialChar LaTeX
2202 distribution itself.
2203 Check for missing packages and install them.
2206 \begin_layout Enumerate
2207 Okay, so there are no missing packages.
2208 Did you use any of the fine-tuning options in \SpecialChar LyX
2209 ? Specifically, did you
2213 any of them, like trying to manually insert lots of
2214 \begin_inset Flex Code
2217 \begin_layout Plain Layout
2219 \change_deleted 177693 1654669036
2221 \change_inserted 177693 1654669038
2225 \begin_inset space ~
2229 \change_deleted 177693 1654669040
2231 \change_inserted 177693 1654669041
2240 \begin_inset Flex Code
2243 \begin_layout Plain Layout
2250 \begin_inset Flex Code
2253 \begin_layout Plain Layout
2259 ? Did you try to kludge something together with these instead of using the
2260 appropriate paragraph environment?
2263 \begin_layout Enumerate
2264 All right, you didn't use any of the fine-tuning options, you played by
2266 Did you try to pull a fancy maneuver? Did you do something funky inside
2267 a table or an equation, like inserting a graphic into a table cell?
2270 \begin_layout Enumerate
2271 Do you have long sections of text where \SpecialChar LaTeX
2272 cannot find a place to break a
2273 line? By default, \SpecialChar LaTeX
2274 is rather strict about how much extra inter-word spacing
2275 it will add in order to break a line.
2276 Preferably, you should rework the paragraph to avoid the problem.
2279 \begin_layout Enumerate
2280 Did you go overboard with the nesting? \SpecialChar LyX
2281 (currently) doesn't check to make
2282 sure you're in the limits for nesting environments.
2283 If you nested a bunch of environments to the
2284 \begin_inset Formula $17^{\mathrm{th}}$
2287 level, that's the problem.
2288 (The limit in \SpecialChar LaTeX
2292 \begin_layout Enumerate
2293 Okay, you didn't get any error messages, but your output looks awful.
2294 If you have a table or figure that's too wide or long for the page, you
2299 \begin_layout Enumerate
2300 rescale the figure so it fits.
2303 \begin_layout Enumerate
2304 trim down the table so it fits.
2308 \begin_layout Enumerate
2309 If something else is wrong with the output, and you didn't try to pull anything
2310 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2313 \begin_layout Standard
2314 If all this doesn't help—well, then
2318 you might have found a bug in \SpecialChar LyX
2323 \begin_layout Chapter
2327 \begin_layout Section
2328 Customizing Bibliographies with Bib\SpecialChar TeX
2332 \begin_layout Standard
2333 The most basic information about how to use Bib\SpecialChar TeX
2338 with \SpecialChar LyX
2339 is contained in the section
2341 Bibliography databases
2348 The following subsections explain special bibliography features supported
2353 \begin_layout Subsection
2354 Alternative Citation Styles
2357 \begin_layout Standard
2358 Standard Bib\SpecialChar TeX
2360 \begin_inset space \thinspace{}
2364 \begin_inset space \space{}
2368 \begin_inset Quotes eld
2372 \begin_inset Quotes erd
2375 ) to refer to a cited work.
2376 However, in many scientific disciplines, other citation styles are in use.
2377 The most common one is the author-year style (e.
2378 \begin_inset space \thinspace{}
2382 \begin_inset space \space{}
2386 \begin_inset Quotes eld
2390 \begin_inset Quotes erd
2395 supports three packages that provide this style,
2396 \begin_inset Flex Code
2399 \begin_layout Plain Layout
2406 \begin_inset Flex Code
2409 \begin_layout Plain Layout
2416 \begin_inset Flex Code
2419 \begin_layout Plain Layout
2426 Each of these packages has their pros and cons, which cannot be listed
2428 If you only want to have simple author-year (or author-numerical) style,
2429 or if you want to use one of the countless style files for
2430 \begin_inset Flex Code
2433 \begin_layout Plain Layout
2439 , then the established
2440 \begin_inset Flex Code
2443 \begin_layout Plain Layout
2449 package is probably your choice.
2450 If you look for specific citation styles common in law studies, you might
2452 \begin_inset Flex Code
2455 \begin_layout Plain Layout
2462 If you want to have full control over the formatting or look for advanced
2463 features such as ibidem, footnote citations, full title citations, advanced
2464 date formats (such as 400 BC) or full localization to other languages than
2465 English, you should definitely consider
2466 \begin_inset Flex Code
2469 \begin_layout Plain Layout
2475 , which exceeds all other packages in terms of features, but is also quite
2476 heavy and more resource-hungry.
2479 \begin_layout Standard
2480 The handling of these packages in \SpecialChar LyX
2481 is basically the same.
2483 \begin_inset Flex Noun
2486 \begin_layout Plain Layout
2487 Document\SpecialChar menuseparator
2494 \begin_inset Flex Noun
2497 \begin_layout Plain Layout
2504 \begin_inset Flex Noun
2507 \begin_layout Plain Layout
2514 \begin_inset Flex Noun
2517 \begin_layout Plain Layout
2524 \begin_inset Flex Noun
2527 \begin_layout Plain Layout
2534 \begin_inset Flex Noun
2537 \begin_layout Plain Layout
2538 Biblatex (Natbib mode)
2544 \begin_inset Flex Noun
2547 \begin_layout Plain Layout
2554 \begin_inset Flex Noun
2557 \begin_layout Plain Layout
2564 \begin_inset space ~
2567 6.5.3 in the User's Guide for more information on these choices).
2568 With all these packages, you will get some extra features in the citation
2569 dialog and you can select the style of the reference (
2570 \begin_inset Quotes eld
2574 \begin_inset Quotes erd
2578 \begin_inset Quotes eld
2582 \begin_inset Quotes erd
2586 \begin_inset Quotes eld
2590 \begin_inset Quotes erd
2594 \begin_inset Quotes eld
2598 \begin_inset Quotes erd
2602 Note that either package needs specifically designed style files.
2603 They all ship their own, but there are lots of additional style files,
2604 and there is even an interactive style file builder
2608 \begin_layout Plain Layout
2610 \begin_inset Flex URL
2613 \begin_layout Plain Layout
2615 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2626 \begin_inset Flex Code
2629 \begin_layout Plain Layout
2638 \begin_layout Subsection
2639 Subdivided Bibliographies
2642 \begin_layout Standard
2643 Sometimes you might need to divide your bibliography into several sections.
2644 If you are for instance a historian, the possibility to separate sources
2645 and scientific works is most likely a
2646 \begin_inset Quotes eld
2650 \begin_inset Quotes erd
2654 Unfortunately, Bib\SpecialChar TeX
2655 itself does not allow you to do this.
2656 But with the help of some \SpecialChar LaTeX
2657 packages, Bib\SpecialChar TeX
2658 can be extended to fit your needs.
2661 \begin_layout Standard
2663 provides native support for one of these packages,
2671 \begin_layout Plain Layout
2673 \begin_inset Flex URL
2676 \begin_layout Plain Layout
2678 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2688 The advantage of this package (compared to other packages such as
2692 ) is that you don't need to define new citation commands.
2693 Instead, you need to prepare different bibliographic databases which include
2694 the entries for the different sections of the bibliography.
2695 For example: If you want to divide your bibliography into the sections
2697 \begin_inset Quotes eld
2701 \begin_inset Quotes erd
2705 \begin_inset Quotes eld
2709 \begin_inset Quotes erd
2712 , you first need to create two bibliographic databases, e.
2713 \begin_inset space \thinspace{}
2717 \begin_inset space \space{}
2721 \begin_inset Flex Code
2724 \begin_layout Plain Layout
2731 \begin_inset Flex Code
2734 \begin_layout Plain Layout
2744 \begin_layout Standard
2746 \begin_inset Flex Noun
2749 \begin_layout Plain Layout
2750 Document\SpecialChar menuseparator
2757 \begin_inset Flex Noun
2760 \begin_layout Plain Layout
2767 \begin_inset Flex Noun
2770 \begin_layout Plain Layout
2771 Subdivided bibliography
2777 Now you can insert multiple Bib\SpecialChar TeX
2778 bibliographies, one for each section of
2780 Returning to our example: Insert the Bib\SpecialChar TeX
2782 \begin_inset Flex Code
2785 \begin_layout Plain Layout
2791 and a second one for the database
2792 \begin_inset Flex Code
2795 \begin_layout Plain Layout
2802 You are free to use the same or different styles for each section.
2803 Additionally, you can choose if the bibliography section should contain
2805 \begin_inset Quotes eld
2808 all cited references
2809 \begin_inset Quotes erd
2812 of the specified database(s) (which is the default),
2813 \begin_inset Quotes eld
2816 all uncited references
2817 \begin_inset Quotes erd
2821 \begin_inset Quotes eld
2825 \begin_inset Quotes erd
2829 This might be useful if you would like to separate your bibliography into
2831 \begin_inset Quotes eld
2835 \begin_inset Quotes erd
2839 \begin_inset Quotes eld
2843 \begin_inset Quotes erd
2847 \begin_inset Quotes eld
2851 \begin_inset Quotes erd
2855 The titles for the sections can be added as ordinary sections or subsections.
2857 \begin_inset Flex Code
2860 \begin_layout Plain Layout
2866 removes the bibliography title, you have to manually re-add that, too (as
2867 a chapter* or section*, for instance).
2870 \begin_layout Standard
2875 , the procedure is a bit different.
2884 , the aforementioned
2885 \begin_inset Flex Noun
2888 \begin_layout Plain Layout
2889 Subdivided bibliography
2894 option is disabled if you use
2903 provides its own means to generate subdivided bibliographies.
2904 You can either add keywords to bibliography entries via the
2905 \begin_inset Flex Code
2908 \begin_layout Plain Layout
2914 entry option and then filter bibliography sections by keyword (by adding
2916 \begin_inset Flex Code
2919 \begin_layout Plain Layout
2926 \begin_inset Flex Noun
2929 \begin_layout Plain Layout
2935 field of the dialog that opens if you left-click on the
2936 \begin_inset Flex Noun
2939 \begin_layout Plain Layout
2940 Biblatex Generated Bibliography
2945 button), or you can filter by entry types (such as
2954 \begin_inset space \thinspace{}
2959 \begin_inset Flex Code
2962 \begin_layout Plain Layout
2969 \begin_inset Flex Code
2972 \begin_layout Plain Layout
2979 \begin_inset Flex Noun
2982 \begin_layout Plain Layout
2988 field, or you can create so-called
2989 \begin_inset Quotes eld
2992 Bibliography Categories
2993 \begin_inset Quotes erd
2996 to which you can assign individual entries.
2997 Please refer to the Biblatex manual, section
2999 Subdivided Bibliographies
3004 \begin_layout Subsection
3005 Multiple Bibliographies
3006 \begin_inset CommandInset label
3008 name "subsec:Multiple-Bibliographies"
3015 \begin_layout Standard
3016 Multiple bibliographies, e.
3017 \begin_inset space \thinspace{}
3021 \begin_inset space \space{}
3024 a bibliography for each part, chapter, section, subsection or child (sub-documen
3025 t) of the document, are also supported by \SpecialChar LyX
3027 In order to enable it, go to
3028 \begin_inset Flex Noun
3031 \begin_layout Plain Layout
3032 Document\SpecialChar menuseparator
3033 Settings\SpecialChar menuseparator
3039 and select the relevant unit (e.
3040 \begin_inset space \thinspace{}
3044 \begin_inset Quotes eld
3048 \begin_inset Quotes erd
3052 \begin_inset Flex Noun
3055 \begin_layout Plain Layout
3056 Multiple Bibliographies
3062 Then add a Bib(la)\SpecialChar TeX
3063 bibliography to each unit (e.
3064 \begin_inset space \thinspace{}
3067 g., section) of your document.
3068 In the output, a separate bibliography, containing only the references
3069 done in the current unit is generated.
3072 \begin_layout Standard
3073 If you use Bib\SpecialChar TeX
3075 \begin_inset Flex Code
3078 \begin_layout Plain Layout
3085 \begin_inset Flex Code
3088 \begin_layout Plain Layout
3094 package is used to create multiple bibliographies.
3095 The former package is used if you select
3096 \begin_inset Quotes eld
3100 \begin_inset Quotes erd
3108 \begin_inset Flex Noun
3111 \begin_layout Plain Layout
3112 Sectioned Bibliography
3119 \begin_inset Flex Code
3122 \begin_layout Plain Layout
3132 \begin_layout Plain Layout
3133 An alternative approach, if you are willing to use some
3134 \begin_inset Flex Noun
3137 \begin_layout Plain Layout
3145 \begin_inset space ~
3149 \begin_inset CommandInset ref
3151 reference "sec:Inserting-TeX-Code"
3156 \begin_inset Flex Code
3159 \begin_layout Plain Layout
3171 \begin_inset Flex Code
3174 \begin_layout Plain Layout
3180 is used, \SpecialChar LyX
3181 encloses the specified units in
3182 \begin_inset Flex Code
3185 \begin_layout Plain Layout
3192 \begin_inset Flex Code
3195 \begin_layout Plain Layout
3204 \begin_inset Flex Code
3207 \begin_layout Plain Layout
3215 in order to create the units.
3216 Note that this approach has some limitations.
3217 First, every citation reference has to be inside some
3218 \begin_inset Flex Code
3221 \begin_layout Plain Layout
3228 So citations outside a defined unit (e.
3229 \begin_inset space \thinspace{}
3232 g., before the first section if you use
3233 \begin_inset Quotes eld
3237 \begin_inset Quotes erd
3241 \begin_inset Quotes eld
3245 \begin_inset Quotes erd
3249 You can also create your own units by entering
3250 \begin_inset Flex Code
3253 \begin_layout Plain Layout
3262 \begin_inset Flex Code
3265 \begin_layout Plain Layout
3274 code (for instance to work around the mentioned limitation).
3276 \begin_inset Flex Code
3279 \begin_layout Plain Layout
3286 A second limitation is that
3287 \begin_inset Flex Code
3290 \begin_layout Plain Layout
3296 always processes all references of a bibliography database, even if they
3298 This can result in odd labels (e.
3299 \begin_inset space \thinspace{}
3304 \begin_inset Quotes eld
3308 \begin_inset Quotes erd
3311 if two works of this author from 2014 are in the database, even if only
3315 \begin_layout Standard
3321 \begin_inset Flex Code
3324 \begin_layout Plain Layout
3330 option is used instead.
3331 If you need specific units, you can start them with the \SpecialChar TeX
3333 \begin_inset Flex Code
3336 \begin_layout Plain Layout
3345 \begin_inset Flex Code
3348 \begin_layout Plain Layout
3357 If you also want to control the end of the unit, use the environment
3358 \begin_inset Flex Code
3361 \begin_layout Plain Layout
3371 \begin_inset Flex Code
3374 \begin_layout Plain Layout
3384 \begin_inset Flex Code
3387 \begin_layout Plain Layout
3394 In addition to the individual bibliography of the current unit,
3398 also provides an easy way to output all bibliographies, subsequently, at
3400 \begin_inset space \thinspace{}
3403 g., at the end of the document).
3405 \begin_inset Quotes eld
3409 \begin_inset Quotes erd
3412 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve
3418 manual for more information on this topic.
3421 \begin_layout Section
3425 \begin_layout Subsection
3429 \begin_layout Standard
3430 When you are working on a large file with many sections, it is often convenient
3431 to break up the document into several files, or perhaps you have something
3432 where a table may change from time to time, but the preceding text does
3434 In these cases, you should seriously consider using multipart documents.
3435 For example, scientific papers often have five major sections: the introduction
3436 , observations, results, discussion, and conclusion.
3437 Each of these could be its own separate \SpecialChar LyX
3439 \begin_inset Quotes eld
3443 \begin_inset Quotes erd
3446 file which contains the title, authors, abstract, references, etc., plus
3447 the five included files.
3448 It is important to note that each of these files is a full \SpecialChar LyX
3450 can be formatted and printed on its own, as well as included in a master
3452 Each of these files must have the same document class, however—don't attempt
3453 to mix book classes with article classes.
3454 You may also include \SpecialChar LaTeX
3455 files; however, these files must not have their own
3457 \begin_inset space \thinspace{}
3461 \begin_inset space \space{}
3464 everything up to and including the
3465 \begin_inset Flex Code
3468 \begin_layout Plain Layout
3477 \begin_inset Flex Code
3480 \begin_layout Plain Layout
3488 line must be deleted) or else errors will be generated when you try to
3492 \begin_layout Standard
3494 allows you to include files quite easily with
3495 \begin_inset Flex Noun
3498 \begin_layout Plain Layout
3499 Insert\SpecialChar menuseparator
3501 \begin_inset space ~
3510 When you click on this selection a small box is inserted into the file
3511 at the current cursor location.
3512 Clicking on the box raises a dialog which allows you to select the file
3513 to be included, and the method of its inclusion.
3517 \begin_layout Standard
3518 The file selection box should by now be obvious.
3519 The three inclusion methods are
3520 \begin_inset Quotes eld
3524 \begin_inset Quotes erd
3528 \begin_inset Quotes eld
3532 \begin_inset Quotes erd
3536 \begin_inset Quotes eld
3540 \begin_inset Quotes erd
3545 \begin_inset Quotes eld
3549 \begin_inset Quotes erd
3553 \begin_inset Quotes eld
3557 \begin_inset Quotes erd
3560 are similar in many ways, but there are also some notable differences:
3563 \begin_layout Enumerate
3565 \begin_inset Quotes eld
3569 \begin_inset Quotes erd
3572 are typeset beginning on a new page, while files that are
3573 \begin_inset Quotes eld
3577 \begin_inset Quotes erd
3580 are typeset starting on the current page.
3583 \begin_layout Enumerate
3584 \begin_inset Quotes eld
3588 \begin_inset Quotes erd
3591 files cannot themselves
3592 \begin_inset Quotes eld
3596 \begin_inset Quotes erd
3600 \begin_inset Quotes eld
3604 \begin_inset Quotes erd
3609 \begin_inset Quotes eld
3613 \begin_inset Quotes erd
3616 , on the other hand, infinite sub-inputting is possible.
3619 \begin_layout Enumerate
3620 \begin_inset Quotes eld
3624 \begin_inset Quotes erd
3627 allow for the output of only selected
3628 \begin_inset Quotes eld
3632 \begin_inset Quotes erd
3635 files, while maintaining the actual counters (pagination etc.) and references
3636 (please refer to the section
3639 \begin_inset space ~
3647 \begin_inset space ~
3652 manual for details).
3655 \begin_layout Standard
3657 \begin_inset Quotes eld
3661 \begin_inset Quotes erd
3664 is the preferred method for chapters that are outsourced to child documents,
3666 \begin_inset Quotes eld
3670 \begin_inset Quotes erd
3673 is more suitable for arbitrary file inheritance.
3676 \begin_layout Standard
3678 \begin_inset Quotes eld
3682 \begin_inset Quotes erd
3685 included file allows you to include a file typeset exactly as it appears
3687 \begin_inset space \thinspace{}
3691 \begin_inset space \space{}
3695 \begin_inset Flex Code
3698 \begin_layout Plain Layout
3704 mode, with the characters set in a fixed-width typewriter font.
3705 Normally, spaces in this file are invisible, though two consecutive spaces
3706 are conserved, unlike \SpecialChar LyX
3707 's normal treatment of spaces.
3708 However, setting the
3709 \begin_inset Flex Noun
3712 \begin_layout Plain Layout
3714 \begin_inset space ~
3718 \begin_inset space ~
3722 \begin_inset space ~
3730 checkbox typesets a mark to unambiguously define the presence of a space.
3734 \begin_layout Standard
3735 Generally, the master file is converted into a full \SpecialChar LaTeX
3736 file before typesetting,
3737 while the included files are converted to \SpecialChar LaTeX
3738 files that do not have all the
3739 preamble information.
3742 \begin_layout Subsection
3743 Cross-References Between Files
3746 \begin_layout Standard
3747 \begin_inset Box Shadowbox
3757 height_special "totalheight"
3762 backgroundcolor "none"
3765 \begin_layout Plain Layout
3766 This section is somewhat out of date.
3767 Need to describe default master documents and how children are opened when
3777 \begin_layout Standard
3778 It is possible to set up cross-references between the different files.
3779 First, open all the files in question: let's call them A and B in a two
3780 file example, where B is included in A.
3781 Let's say you insert a label in A, then want to reference it in B.
3782 Open the cross-reference dialog whilst in document B, and you can select
3784 \begin_inset Quotes eld
3788 \begin_inset Quotes erd
3794 \begin_layout Subsection
3795 Bibliography Lists in all Subdocuments
3798 \begin_layout Standard
3799 If you work with child documents, you might want to have only one main bibliogra
3800 phy at the end, but still be able to have a selected bibliography for the
3801 child if you output it on its own.
3802 Here is how to achieve this.
3805 \begin_layout Standard
3806 For the main document, you just insert a bibliography inset at the place
3807 where the main bibliography has to appear (within the master file or within
3809 If the bibliography inset is in the master file, the references will be
3810 inherited by all children, so they are available in the citation dialog
3814 \begin_layout Standard
3815 For child-specific bibliographies, insert bibliography insets within the
3816 child documents, at the place where the bibliography should appear when
3817 the child is compiled separately.
3818 However, the trick is to insert them into a branch (
3820 Insert\SpecialChar menuseparator
3821 Branch\SpecialChar menuseparator
3822 Insert New Branch...
3825 \begin_inset space \thinspace{}
3830 \begin_inset Quotes eld
3834 \begin_inset Quotes erd
3838 Within the children, activate the branch (
3840 Document\SpecialChar menuseparator
3841 Settings...\SpecialChar menuseparator
3845 Within the master, deactivate the branch (
3847 Document\SpecialChar menuseparator
3848 Settings...\SpecialChar menuseparator
3852 Now the child's bibliography will be ignored by the master, but considered
3856 \begin_layout Standard
3857 If you need multiple bibliographies (e.
3858 \begin_inset space \thinspace{}
3861 g., one per child in the
3865 ), please refer to sec.
3866 \begin_inset space ~
3870 \begin_inset CommandInset ref
3872 reference "subsec:Multiple-Bibliographies"
3879 \begin_layout Section
3884 \begin_layout Standard
3885 Users sometimes need to be able to
3886 \begin_inset Quotes eld
3890 \begin_inset Quotes erd
3894 file together with all the images (and other files) on which it depends,
3895 either for sending to a publisher or for sharing with a co-author.
3897 includes a Python script (
3898 \begin_inset Flex Code
3901 \begin_layout Plain Layout
3907 ) that automates this process.
3908 To use it, you must have either the
3909 \begin_inset Flex Code
3912 \begin_layout Plain Layout
3919 \begin_inset Flex Code
3922 \begin_layout Plain Layout
3928 python modules installed on your system.
3929 By default, the script prefers the
3930 \begin_inset Flex Code
3933 \begin_layout Plain Layout
3940 \begin_inset Flex Code
3943 \begin_layout Plain Layout
3949 format on Unix-like systems and the
3950 \begin_inset Flex Code
3953 \begin_layout Plain Layout
3962 \begin_layout Standard
3964 's configuration process will set the script up to export a `\SpecialChar LyX
3966 and this format will then be available under
3967 \begin_inset Flex Code
3970 \begin_layout Plain Layout
3971 File\SpecialChar menuseparator
3980 \begin_layout Standard
3981 Independently of the platform, the generation of a particular archive format
3982 can be forced by adding either the
3983 \begin_inset Flex Code
3986 \begin_layout Plain Layout
3993 \begin_inset Flex Code
3996 \begin_layout Plain Layout
4003 \begin_inset Flex Code
4006 \begin_layout Plain Layout
4013 \begin_inset Flex Code
4016 \begin_layout Plain Layout
4022 format) switch to the
4023 \begin_inset Flex Code
4026 \begin_layout Plain Layout
4028 \SpecialChar menuseparator
4036 \begin_inset Flex Code
4039 \begin_layout Plain Layout
4040 Tools\SpecialChar menuseparator
4041 Preferences\SpecialChar menuseparator
4042 File Handling\SpecialChar menuseparator
4049 (Make sure you add the switch after the script name, not before it.)
4052 \begin_layout Section
4053 Fancy Headers and Footers
4056 \begin_layout Standard
4057 The default page layout is rather plain; for an
4058 \begin_inset Flex Code
4061 \begin_layout Plain Layout
4067 document class, all you get is a centered page number at the bottom of
4069 This document uses KOMA-script's book class, so it appears to be a bit
4071 But to really put on a show, you need to set the document page style to
4073 \begin_inset Quotes eld
4077 \begin_inset Quotes erd
4080 , as mentioned in the
4085 This section describes the \SpecialChar LaTeX
4086 code you need to insert in your \SpecialChar LaTeX
4088 order to get the desired effects.
4091 \begin_layout Standard
4092 For more information on fancy headers, see the
4093 \begin_inset Flex Code
4096 \begin_layout Plain Layout
4102 package documentation.
4104 \begin_inset Flex URL
4107 \begin_layout Plain Layout
4109 https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
4117 \begin_layout Standard
4118 The page header is divided into three fields, not surprisingly labeled
4119 \begin_inset Quotes eld
4123 \begin_inset Quotes erd
4127 \begin_inset Quotes eld
4131 \begin_inset Quotes erd
4135 \begin_inset Quotes eld
4139 \begin_inset Quotes erd
4143 The footer is also divided into these three fields.
4144 The \SpecialChar LaTeX
4145 commands to set these fields in the simplest manner are
4146 \begin_inset Flex Code
4149 \begin_layout Plain Layout
4158 \begin_inset Flex Code
4161 \begin_layout Plain Layout
4170 \begin_inset Flex Code
4173 \begin_layout Plain Layout
4182 \begin_inset Flex Code
4185 \begin_layout Plain Layout
4194 Suppose you wish to put your name in the upper left hand corner of each
4196 Simply insert the following command in the preamble:
4199 \begin_layout Standard
4208 \begin_layout Standard
4209 You will now see your name in the upper left.
4210 If a field has a default entry that you would like to get rid of (often
4211 the page number appears in the central footer) simply include a command
4212 with a blank argument, e.
4213 \begin_inset space \thinspace{}
4219 \begin_layout Standard
4227 \begin_layout Standard
4228 Let's get really fancy: lets put the section number with the word
4229 \begin_inset Quotes eld
4233 \begin_inset Quotes erd
4237 \begin_inset space \thinspace{}
4241 \begin_inset space \space{}
4244 Section 3) in the upper left, the page number (e.
4245 \begin_inset space \thinspace{}
4249 \begin_inset space \space{}
4252 Page 4) in the upper right, your name in the lower left, and the date in
4254 The following commands should now appear in the preamble:
4257 \begin_layout Standard
4267 \begin_layout Standard
4275 \begin_layout Standard
4285 \begin_layout Standard
4294 \begin_layout Standard
4302 \begin_layout Standard
4312 \begin_layout Standard
4314 \begin_inset Flex Code
4317 \begin_layout Plain Layout
4326 \begin_inset Flex Code
4329 \begin_layout Plain Layout
4337 access \SpecialChar LaTeX
4338 's section and page counters, and so print out the current section
4341 \begin_inset Flex Code
4344 \begin_layout Plain Layout
4352 simply prints out today's date.
4355 \begin_layout Standard
4356 The thicknesses of the horizontal rules drawn beneath the header and above
4357 the footer can also be modified.
4358 If you don't want one of the rules, set its thickness to 0.
4359 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
4365 \begin_inset Flex Code
4368 \begin_layout Plain Layout
4373 headrulewidth}{0.4pt}
4379 \begin_inset Flex Code
4382 \begin_layout Plain Layout
4387 footrulewidth}{0.4pt}
4392 to set the thicknesses.
4395 \begin_layout Standard
4396 You can switch the header/footer settings on and off for individual pages
4398 \begin_inset Flex Code
4401 \begin_layout Plain Layout
4404 thispagestyle{empty}
4410 \begin_inset Flex Code
4413 \begin_layout Plain Layout
4416 thispagestyle{plain}
4422 \begin_inset Flex Code
4425 \begin_layout Plain Layout
4428 thispagestyle{fancy}
4434 Simply insert them in the text on the page you want changed and mark them
4437 In fact, title pages are marked as plain by default, while following pages
4438 are marked fancy when using the global fancy setting.
4441 \begin_layout Standard
4442 As a final example, it is possible to include an image in the header or
4444 Suppose you want to put a company logo in the upper lefthand corner.
4445 You might try something like
4448 \begin_layout Standard
4457 includegraphics{logo.eps}}}
4460 \begin_layout Standard
4462 (you may need to preface this with
4463 \begin_inset Flex Code
4466 \begin_layout Plain Layout
4469 usepackage{graphics}
4474 if you don't include graphics elsewhere in your document).
4477 \begin_layout Section
4478 Itemize Bullet Selection
4479 \begin_inset CommandInset label
4488 \begin_layout Standard
4494 \begin_layout Subsection
4498 \begin_layout Standard
4500 provides 216 bullet shapes that can be accessed from a simple dialog.
4501 Using this dialog you can easily specify what bullet shape to use at each
4502 level of an itemized list.
4503 These settings are document-wide so you won't be able to specify different
4504 sets of bullets for different paragraphs.
4508 \begin_layout Plain Layout
4509 Well, actually you can but you'll have to do it by hand.
4517 \begin_layout Subsection
4521 \begin_layout Standard
4522 Open the dialog by selecting the
4523 \begin_inset Flex Noun
4526 \begin_layout Plain Layout
4527 Document\SpecialChar menuseparator
4533 menu item and then select the
4534 \begin_inset Flex Noun
4537 \begin_layout Plain Layout
4546 \begin_layout Standard
4547 The dialog provides you with a table of bullet shapes.
4548 A column of buttons on the left of the table provides access to the six
4549 different panels of bullet shapes.
4550 The row of buttons across the top is used to select which bullet depth
4553 \change_deleted 244031559 1603875981
4554 A text entry under the table shows the currently selected bullet shape's
4556 equivalent and this can be edited if desired.
4557 If you do modify the text you will also need to specify any needed packages
4558 in the \SpecialChar LaTeX
4564 \begin_layout Standard
4565 The six panels are divided up by the packages they require.
4566 The following table shows the mappings from button name to \SpecialChar LaTeX
4570 \begin_layout Standard
4572 \begin_inset Tabular
4573 <lyxtabular version="3" rows="7" columns="2">
4574 <features tabularvalignment="middle">
4575 <column alignment="center" valignment="top" width="0pt">
4576 <column alignment="center" valignment="top" width="0pt">
4578 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4581 \begin_layout Plain Layout
4596 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4599 \begin_layout Plain Layout
4616 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4619 \begin_layout Plain Layout
4634 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4637 \begin_layout Plain Layout
4646 base \SpecialChar LaTeX
4654 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4657 \begin_layout Plain Layout
4672 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4675 \begin_layout Plain Layout
4692 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4695 \begin_layout Plain Layout
4710 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4713 \begin_layout Plain Layout
4730 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4733 \begin_layout Plain Layout
4748 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4751 \begin_layout Plain Layout
4768 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4771 \begin_layout Plain Layout
4786 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4789 \begin_layout Plain Layout
4806 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4809 \begin_layout Plain Layout
4824 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4827 \begin_layout Plain Layout
4850 \begin_layout Standard
4852 doesn't stop you using bullets from packages you don't have.
4853 If you get errors from \SpecialChar LaTeX
4854 when you try to view or print the file, then it
4855 is likely you are missing a package.
4859 \begin_layout Plain Layout
4861 doesn't restrict your use since you may be editing locally and exporting
4870 \begin_layout Subsection
4874 \begin_layout Standard
4875 Select which bullet depth you want to change then select the bullet shape
4877 Any changes will not be visible in \SpecialChar LyX
4878 , but are visible when viewing the document.
4881 \begin_layout Standard
4882 You can reset a bullet shape to the default simply by clicking your right
4883 mouse button on the appropriate bullet depth button.
4887 \begin_layout Plain Layout
4892 want to have multiple sets of paragraphs with different sets of bullets
4893 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
4895 The bullet selection dialog can help though because it provides you with
4896 the \SpecialChar LaTeX
4897 code for a wide range of bullet shapes.
4898 To make your own custom paragraphs you have the following options:
4901 \begin_layout Plain Layout
4905 \begin_layout Plain Layout
4921 \begin_layout Plain Layout
4925 \begin_layout Plain Layout
4947 \begin_layout Itemize
4948 Use the \SpecialChar LaTeX
4950 \begin_inset Flex Code
4953 \begin_layout Plain Layout
4961 to specify a new bullet shape for a given depth.
4962 You'll also need to save the current bullet shape so you can restore it
4964 In this itemized list the following \SpecialChar LaTeX
4965 code was used to change the bullet
4966 used for the first depth.
4970 \begin_layout LyX-Code
4980 \begin_layout LyX-Code
4997 \begin_layout Itemize
4998 Note that the itemize depth is specified in Roman numerals as part of the
5008 \begin_layout Itemize
5009 \begin_inset Argument item:1
5012 \begin_layout Plain Layout
5016 \begin_layout Plain Layout
5034 Specify each individual entry by starting each item with the bullet shape
5036 \begin_inset Quotes eld
5040 \begin_inset Quotes erd
5045 Insert\SpecialChar menuseparator
5049 \begin_inset Flex Noun
5052 \begin_layout Plain Layout
5060 For example, this item was started with
5061 \begin_inset Flex Code
5064 \begin_layout Plain Layout
5079 \begin_layout Plain Layout
5083 \begin_layout Plain Layout
5099 \begin_layout Plain Layout
5100 You'll also need to revert the labelitem back to its previous setting for
5101 the global bullet shape settings to remain in effect.
5102 The way used here was:
5105 \begin_layout LyX-Code
5120 \begin_layout Chapter
5122 and the World Wide Web
5125 \begin_layout Standard
5127 has long supported the export of documents to various web-friendly formats,
5129 Before version 2.0, however, HTML export was always accomplished by the
5130 use of external converters.
5134 \begin_layout Plain Layout
5135 For details on the use of external converters with \SpecialChar LyX
5140 section of the Customization manual.
5145 These fall into two large groups: there are converters that use \SpecialChar LaTeX
5147 intermediate format, such as
5148 \begin_inset Flex Code
5151 \begin_layout Plain Layout
5158 \begin_inset Flex Code
5161 \begin_layout Plain Layout
5168 \begin_inset Flex Code
5171 \begin_layout Plain Layout
5177 , relying upon \SpecialChar LyX
5178 to produce the \SpecialChar LaTeX
5179 ; and there is a converter that works directly
5182 \begin_inset Flex Code
5185 \begin_layout Plain Layout
5193 All of these have different advantages and disadvantages.
5197 \begin_layout Standard
5198 The \SpecialChar LaTeX
5199 -based converters have the advantage that, in principle, they know everythin
5200 g about the exported document that \SpecialChar LaTeX
5202 Such converters do not care, for example, if a certain block of code was
5203 produced by \SpecialChar LyX
5204 or was Evil Red Text.
5205 These converters know about
5206 \begin_inset Flex Code
5209 \begin_layout Plain Layout
5215 files, counters, and references, and can often make use of the
5216 \begin_inset Flex Code
5219 \begin_layout Plain Layout
5225 files generated by Bib\SpecialChar TeX
5227 On the other hand, \SpecialChar LaTeX
5228 is a very hard language to parse—it is sometimes said
5229 that only \SpecialChar TeX
5230 itself understands \SpecialChar TeX
5231 —and \SpecialChar LaTeX
5232 -based converters will often choke on
5233 what seem to be quite simple constructs; complex ones can throw them completely
5234 , and as of this writing, for example, the
5238 manual will not export with
5239 \begin_inset Flex Code
5242 \begin_layout Plain Layout
5248 , though the others will.
5249 The other issue concerns how math is handled.
5250 These converters typically convert the formulae into little pictures that
5251 are then linked from the HTML document.
5252 Since these are actually generated by \SpecialChar LaTeX
5253 , they are accurate.
5254 But they do not scale well, and just getting them to look as if they are
5255 actually meant to be in your document—so that the font sizes seem to be
5256 roughly the same—can be a challenge.
5259 \begin_layout Standard
5261 \begin_inset Flex Code
5264 \begin_layout Plain Layout
5272 \begin_inset CommandInset href
5274 name "http://pinchito.es/elyxer/"
5275 target "http://pinchito.es/elyxer/"
5280 ) solves some of these problems.
5281 In particular, the formulae it produces scale perfectly, since it renders
5282 math using a combination of HTML and CSS rather than converting the formulae
5284 But even moderately complex formula are rendered less well than with
5285 \begin_inset Flex Code
5288 \begin_layout Plain Layout
5294 ; this reflects the limitations of HTML.
5298 \begin_layout Plain Layout
5300 \begin_inset Flex Code
5303 \begin_layout Plain Layout
5310 can also use jsMath and MathJax for equations, but this setting is only
5311 available globally and requires one to have access to a server that runs
5317 More importantly (as of version 1.1.1, at least),
5318 \begin_inset Flex Code
5321 \begin_layout Plain Layout
5328 has limited support for math macros and no support for user-defined paragraph
5329 or character styles.
5330 These limitations make
5331 \begin_inset Flex Code
5334 \begin_layout Plain Layout
5341 unsuitable for many of the documents \SpecialChar LyX
5343 In principle, of course, these problems could be solved, but the \SpecialChar LyX
5345 have decided to follow a different path and have made \SpecialChar LyX
5347 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
5348 , DocBook, and plaintext.
5351 \begin_layout Standard
5352 As of this writing, XHTML output remains under development and should probably
5354 \begin_inset Quotes eld
5358 \begin_inset Quotes erd
5365 \begin_layout Plain Layout
5367 \begin_inset Flex Code
5370 \begin_layout Plain Layout
5371 development/HTML/HTML.notes
5376 , which can be found in the \SpecialChar LyX
5378 \begin_inset CommandInset href
5380 name "accessed online"
5381 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
5386 , usually contains up-to-date information about the state of XHTML output.
5387 See also the list of XHTML bugs on
5388 \begin_inset CommandInset href
5390 name "the bug tracker"
5391 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"
5401 Still, the developers have chosen this approach because it has several
5402 potential advantages over the other two.
5405 \begin_layout Standard
5406 These advantages are primarily due to the fact that the XHTML output routines,
5407 since they are part of \SpecialChar LyX
5408 , know everything \SpecialChar LyX
5409 knows about the document being
5414 \begin_layout Plain Layout
5415 Another advantage is that, since these routines are internal to \SpecialChar LyX
5417 immune to changes in \SpecialChar LyX
5418 's file format, or to changes in the semantics of
5424 So they know about the table of contents (as displayed in the outline),
5425 about the counters associated with different paragraph styles, and about
5426 user-defined styles.
5427 The XHTML output routines know what \SpecialChar LyX
5428 knows about internationalization,
5429 too, so they will output
5430 \begin_inset Quotes eld
5434 \begin_inset Quotes erd
5438 \begin_inset Quotes eld
5446 \begin_inset Quotes erd
5449 , depending upon the language in effect at the time.
5453 \begin_layout Standard
5454 Quite generally, the output routines know what \SpecialChar LyX
5455 knows about document layout,
5456 that is, about how the document is to be rendered on screen.
5457 We use this information when we output the document as XHTML.
5458 In particular, \SpecialChar LyX
5463 generates CSS style information corresponding to the layout information
5464 it uses to render the document on screen: if section headings are supposed
5465 to be sans-serif and bold as seen in \SpecialChar LyX
5466 , then (by default) they will be sans-seri
5467 f and bold when viewed in a web browser, too.
5468 And this is true not just for pre-defined styles, like Section, but for
5469 any style, including user-defined styles.
5470 Indeed, the XHTML output routines make no distinction between user-defined
5472 \change_deleted 244031559 1603876931
5474 \change_inserted 244031559 1603876940
5477 styles and \SpecialChar LyX
5478 's own pre-defined styles: in each case, everything \SpecialChar LyX
5480 the styles is contained in the layout files.
5481 And much the same is true as regards pre-defined textual insets, such as
5482 footnotes, and various custom insets.
5486 \begin_layout Standard
5487 The result is that XHTML output can be customized and extended in exactly
5488 the same way \SpecialChar LaTeX
5489 output can be customized and extended: through layout files
5491 See chapter five of the
5495 manual for the details.
5498 \begin_layout Standard
5499 The remainder of this chapter contains more detailed information on XHTML
5500 output, its limitations, and ways to work around those limitations.
5503 \begin_layout Section
5504 Math Output in XHTML
5507 \begin_layout Standard
5509 offers four choices for how math is rendered.
5510 These have various advantages and disadvantages:
5513 \begin_layout Itemize
5515 \begin_inset Newline newline
5518 MathML is a dialect of XML designed specifically for mathematics on the
5519 web, and it typically renders very well in browsers that support it.
5520 The disadvantage is that not all browsers support MathML, and support is
5521 not complete even in the Gecko-based browsers, such as Firefox.
5522 \begin_inset Newline newline
5526 is unable to render a formula as MathML—for example, if the formula
5528 \begin_inset Flex Code
5531 \begin_layout Plain Layout
5537 package or ERT—then it will instead output the formula as an image.
5541 \begin_layout Itemize
5543 \begin_inset Newline newline
5547 \begin_inset Flex Code
5550 \begin_layout Plain Layout
5556 outputs math as HTML, styled by CSS.
5560 \begin_layout Plain Layout
5562 has borrowed some of the CSS for its HTML output from
5563 \begin_inset Flex Code
5566 \begin_layout Plain Layout
5577 For simple formulae, this can work quite well, though with more complicated
5578 formulae it tends to break down.
5579 Still, this method has the advantage that it is very widely supported and
5580 so it may be appropriate for documents that contain only a little, fairly
5582 \begin_inset Newline newline
5585 If Lyx is unable to render a formula as HTML—for example, if the formula
5587 \begin_inset Flex Code
5590 \begin_layout Plain Layout
5596 package or ERT—then it will instead output the formula as an image.
5600 \begin_layout Itemize
5602 \begin_inset Newline newline
5606 \begin_inset Flex Code
5609 \begin_layout Plain Layout
5616 will output formulae as images, the very same images, in fact, that are
5617 used for instant preview.
5621 \begin_layout Plain Layout
5622 Instant preview does
5626 have to be on for images to be output, however.
5631 The advantage to this method is that the images are simply generated by
5633 , so they are very accurate.
5634 The disadvantage, as mentioned earlier, is that these are bitmapped images,
5635 so they do not scale terribly well, and one cannot copy them, etc.
5636 \begin_inset Newline newline
5639 The size of the images can be controlled by setting the
5640 \begin_inset Quotes eld
5644 \begin_inset Quotes erd
5648 \begin_inset Flex Noun
5651 \begin_layout Plain Layout
5652 Document\SpecialChar menuseparator
5653 Settings\SpecialChar menuseparator
5663 \begin_layout Plain Layout
5664 For those who want to know, this controls the resolution of the image in
5665 dots per inch and is based upon a default of 75 dpi.
5671 \begin_inset Newline newline
5675 for some reason fails to create an image for a formula (e.g., if a required
5677 package is not installed), then it will fall back to outputing the raw
5682 \begin_layout Itemize
5685 \begin_inset Newline newline
5688 Finally, \SpecialChar LyX
5689 will happily output math as \SpecialChar LaTeX
5691 As well as being the output of last resort, this method can be used with
5693 \begin_inset CommandInset href
5696 target "http://www.math.union.edu/~dpvc/jsMath/"
5701 , which uses JavaScript to render \SpecialChar LaTeX
5702 embedded in HTML documents.
5704 wraps the \SpecialChar LaTeX
5706 \begin_inset Flex Code
5709 \begin_layout Plain Layout
5715 (for inline formulas) or
5716 \begin_inset Flex Code
5719 \begin_layout Plain Layout
5725 (for displayed formulas) with
5726 \begin_inset Flex Code
5729 \begin_layout Plain Layout
5735 , as is required for jsMath.
5738 \begin_layout Standard
5739 One of these output methods must be selected under
5740 \begin_inset Flex Noun
5743 \begin_layout Plain Layout
5744 Document\SpecialChar menuseparator
5745 Settings\SpecialChar menuseparator
5752 By default, \SpecialChar LyX
5754 This is a document-wide setting, therefore.
5757 \begin_layout Standard
5758 Eventually, \SpecialChar LyX
5759 will offer the user the option to select an alternate output
5760 method for a particular inset, say, one that isn't being rendered very
5765 \begin_layout Plain Layout
5766 That said, since \SpecialChar LyX
5767 falls back to images if the inset contains ERT, then one
5768 can force output as an image by putting some harmless ERT into the math,
5770 \begin_inset Formula $a=b\relax$
5781 \begin_layout Section
5782 Bibliography and Citations
5785 \begin_layout Standard
5786 XHTML output fully supports bibliographies and citations.
5790 \begin_layout Standard
5791 Citation labels are generated by the same machinery that generates \SpecialChar LyX
5793 labels, so the labels will look in the output much as they do in \SpecialChar LyX
5796 If you are using numerical citations, then \SpecialChar LyX
5797 will output numerical labels,
5798 such as [1] or [17], rather than simply showing the citation key in square
5799 brackets, as it does on-screen.
5800 If you are using author-year citations, then \SpecialChar LyX
5801 will add lowercase letters
5802 to the years, just as Bib\SpecialChar TeX
5803 does, if it finds more than one citation for
5804 a given author-year combination.
5805 The labels will be printed with the bibliography entries.
5806 Note that there is, at present, no way to customize the appearance of the
5807 labels, for example, to choose between square brackets and parentheses.
5810 \begin_layout Standard
5811 Bibliography output is handled by the same machinery that handles the presentati
5812 on of reference information in the citation dialog, so you will see in the
5813 XHTML output pretty much what you would see if you were to look at a given
5814 entry in the citation dialog.
5815 The formatting can be customized in your layout file or, preferably, in
5821 manual for the details.
5824 \begin_layout Standard
5825 The main defect at present is that cross-referenced information is printed
5826 with every entry with which it is associated.
5827 So you can see things like this:
5832 \begin_inset Quotes eld
5835 Context and Logical Form
5836 \begin_inset Quotes erd
5841 Language in Context: Selected Essays
5843 (Oxford: Oxford University Press, 2007), pp.
5849 \begin_inset Quotes eld
5852 Semantics in Context
5853 \begin_inset Quotes erd
5858 Language in Context: Selected Essays
5860 (Oxford: Oxford University Press, 2007), pp.
5864 \begin_layout Standard
5865 This should be fixed before long.
5868 \begin_layout Standard
5869 There is no support at present for sectioned bibliographies.
5870 If you have multiple bibliographies, then \SpecialChar LyX
5871 will print the same bibliography
5875 \begin_layout Section
5879 \begin_layout Standard
5881 will happily export indexes as XHTML, but with certain limitations at the
5885 \begin_layout Standard
5886 Index export will be most reliable when you do not attempt to use the fancy
5887 constructs that are described in the section on indexes in the
5895 \begin_layout Plain Layout
5896 The main issue here is that \SpecialChar LyX
5897 itself does not really handle these.
5898 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
5904 We'll describe how they are handled using the subsection headings from
5908 \begin_layout Itemize
5909 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
5910 makes an effort to support these,
5911 but the entries must be separated by
5912 \begin_inset Quotes eld
5916 \begin_inset Quotes erd
5919 , that is, there must be spaces around the exclamation point.
5920 This is because it is otherwise too difficult to check for escaped exclamation
5921 points, ones in math, and so forth.
5924 \begin_layout Itemize
5925 Page Ranges: There is no support at all for page ranges, since these make
5926 no sense with XHMTL.
5927 Instead, you will just get two index entries, one at either end.
5930 \begin_layout Itemize
5931 Cross-referencing: There is no support for cross-referencing.
5933 finds an entry containing the
5934 \begin_inset Quotes eld
5937 |see\SpecialChar ldots
5939 \begin_inset Quotes erd
5942 construct, it is just dropped, and the rest is treated as an ordinary index
5946 \begin_layout Itemize
5947 Index Entry Order: \SpecialChar LyX
5948 does support attempts to fix the sorting order.
5949 It will take what is before the first `@' it finds and use that for sorting,
5950 taking what follows the first `@' to be the actual entry.
5951 At present, \SpecialChar LyX
5952 does not check for escaped `@', so do not try to index email
5956 \begin_layout Itemize
5957 Index Entry Layout: You can format entries by using the text style dialog,
5958 or by using any other method available within \SpecialChar LyX
5960 There is no support for constructs like:
5961 \begin_inset Quotes eld
5965 \begin_inset Quotes erd
5969 Indeed, if \SpecialChar LyX
5970 finds a pipe symbol, `|', in an entry, it will delete it and
5971 everything that follows it.
5974 \begin_layout Itemize
5975 Multiple Indexes: There is no support for multiple indexes.
5976 Rather, all index entries will be printed as one large index.
5977 To avoid our printing several versions of the index, we print only the
5978 main index, so make sure you have one.
5981 \begin_layout Section
5982 Nomenclature and Glossary
5985 \begin_layout Standard
5986 There is at present no support for glossaries.
5987 Adding it would be fairly trivial, and welcome.
5990 \begin_layout Chapter
5992 \change_inserted 1075283030 1616534180
5996 \begin_layout Standard
5998 \change_inserted 1075283030 1616534386
5999 Apart from HTML, \SpecialChar LyX
6000 can generate documents in the DocBook XML vocabulary.
6001 With versions 2.3 and before, only select templates could be used to generate
6002 DocBook documents (only version 4).
6003 Starting with \SpecialChar LyX
6004 2.4, most \SpecialChar LyX
6005 layouts can generate valid DocBook documents (only
6007 This feature is built into \SpecialChar LyX
6008 and does not require the use of external tools.
6011 \begin_layout Standard
6013 \change_inserted 1075283030 1616534437
6014 The result is that the DocBook output can be customized and extended in
6015 exactly the same way \SpecialChar LaTeX
6016 output can be customized and extended: through layout
6018 See chapter five of the
6022 manual for the details.
6025 \begin_layout Standard
6027 \change_inserted 1075283030 1616534475
6028 Most \SpecialChar LyX
6029 features are supported with DocBook, like math output.
6032 \begin_layout Itemize
6034 \change_inserted 1075283030 1616534741
6035 Math output is performed mostly in MathML (the major exception being constructio
6036 ns not supported by \SpecialChar LyX
6039 All formulae are also available in raw \SpecialChar TeX
6040 in the DocBook output for further
6044 \begin_layout Itemize
6046 \change_inserted 1075283030 1616534852
6047 Bibliographies and citations are implemented, including with an external
6049 Bibliography entries are not prerendered when the detailed information
6050 are available, but rather output with the standard DocBook constructs.
6051 The external DocBook processor is expected to handle the rendering of entries.
6054 \begin_layout Itemize
6056 \change_inserted 1075283030 1616534863
6057 Indexes are supported, including multiple indices.
6062 ), page ranges, and cross-references (
6066 ) are supported, with the exception of the same symbols escaped.
6075 ) are not supported.
6076 There is no support for escaping of index entries.
6079 \begin_layout Itemize
6081 \change_inserted 1075283030 1616534884
6082 Glossaries are implemented.
6085 \begin_layout Standard
6087 \change_inserted 1075283030 1616534894
6088 Two major parameters can be set at the document level.
6091 \begin_layout Itemize
6093 \change_inserted 1075283030 1616534948
6094 Format for tables: \SpecialChar LyX
6095 can generate tables either as HTML (default value) or
6096 CALS, depending on the user's requirements.
6097 Most DocBook processors accept both formats.
6100 \begin_layout Itemize
6102 \change_inserted 1075283030 1616535006
6103 MathML prefix: in DocBook, MathML is included within its own name space,
6105 The implication is that there must be an indication of the tags belonging
6106 to the MathML standard.
6107 Three choices are offered:
6111 \begin_layout Itemize
6113 \change_inserted 1075283030 1616535044
6114 Inline: the MathML name space is defined for each formula (using the
6118 attribute on each formula)
6121 \begin_layout Itemize
6123 \change_inserted 1075283030 1616535090
6128 prefix (default): the MathML name space is defined at the document level
6133 attribute on the root element).
6134 Each MathML is prefixed with
6143 \begin_layout Itemize
6145 \change_inserted 1075283030 1616620405
6150 prefix: similar to the
6159 \begin_layout Standard
6161 \change_inserted 1075283030 1616620470
6162 This option is especially useful if you want \SpecialChar LyX
6163 to match your personal style
6164 or to work with buggy software that only accepts one prefix for MathML.
6170 \begin_layout Chapter
6171 The \SpecialChar LyX
6175 \begin_layout Section
6179 \begin_layout Standard
6180 The `\SpecialChar LyX
6181 server' allows other programs to talk to \SpecialChar LyX
6182 , invoke \SpecialChar LyX
6183 commands, and retrieve
6184 information about the \SpecialChar LyX
6186 This is only intended for advanced users, but they should find it useful.
6187 It is by writing to the \SpecialChar LyX
6188 server, for example, that bibliography managers,
6189 such as JabRef, are able to
6190 \begin_inset Quotes eld
6194 \begin_inset Quotes erd
6197 citations to \SpecialChar LyX
6201 \begin_layout Section
6202 Starting the \SpecialChar LyX
6204 \begin_inset CommandInset label
6206 name "sec:Starting-the-Server"
6213 \begin_layout Standard
6214 The \SpecialChar LyX
6215 server works through the use of a pair of named pipes.
6216 These are usually located in
6217 \begin_inset Flex Code
6220 \begin_layout Plain Layout
6226 , (except on Windows, where
6230 named pipes are special objects located in
6231 \begin_inset Flex Code
6234 \begin_layout Plain Layout
6246 ) and have the names
6247 \begin_inset Quotes eld
6251 \begin_inset Flex Code
6254 \begin_layout Plain Layout
6261 \begin_inset Quotes erd
6265 \begin_inset Quotes eld
6269 \begin_inset Flex Code
6272 \begin_layout Plain Layout
6279 \begin_inset Quotes erd
6283 External programs write into
6284 \begin_inset Flex Code
6287 \begin_layout Plain Layout
6293 and read back data from
6294 \begin_inset Flex Code
6297 \begin_layout Plain Layout
6304 The stem of the pipe names can be defined in the
6305 \begin_inset Flex Noun
6308 \begin_layout Plain Layout
6309 Tools\SpecialChar menuseparator
6316 \begin_inset Flex Code
6319 \begin_layout Plain Layout
6320 "/home/myhome/lyxpipe"
6326 \begin_inset Flex Code
6329 \begin_layout Plain Layout
6343 on Windows (where any working path instead of lyxpipe can be used, for
6345 \begin_inset Flex Code
6348 \begin_layout Plain Layout
6371 configure this manually in order for the server to start.
6374 \begin_layout Standard
6377 \begin_inset Flex Code
6380 \begin_layout Plain Layout
6387 \begin_inset Flex Code
6390 \begin_layout Plain Layout
6396 ' to create the pipes.
6397 If one of the pipes already exists, \SpecialChar LyX
6398 will assume that another \SpecialChar LyX
6400 is already running and will not start the server.
6401 On POSIX (Unix like) systems, if for some other reason, an unused
6402 \begin_inset Quotes eld
6406 \begin_inset Quotes erd
6409 pipe is left in existence when \SpecialChar LyX
6410 closes, then \SpecialChar LyX
6411 will try to delete it.
6412 If this fails for some reason, you will need to delete the pipes manually
6413 and then restart \SpecialChar LyX
6415 On Windows, pipes are deleted by the OS on program termination or crash,
6417 \begin_inset Quotes eld
6421 \begin_inset Quotes erd
6424 pipes should not be possible.
6427 \begin_layout Standard
6428 To have several \SpecialChar LyX
6429 processes with servers at the same time, you have to use
6430 different configurations, perhaps by using separate user directories, each
6432 \begin_inset Flex Code
6435 \begin_layout Plain Layout
6441 file, for each process.
6444 \begin_layout Standard
6445 If you are developing a client program, you might find it useful to enable
6446 debugging information from the \SpecialChar LyX
6448 Do this by starting \SpecialChar LyX
6450 \begin_inset Flex Code
6453 \begin_layout Plain Layout
6462 \begin_layout Standard
6463 You can find a complete example client written in C++ in the source distribution
6465 \begin_inset Flex Code
6468 \begin_layout Plain Layout
6469 development/lyxserver/server_monitor.cpp
6477 \begin_layout Standard
6478 Another useful tool is the command-line based client found in
6479 \begin_inset Flex Code
6482 \begin_layout Plain Layout
6483 src/client/lyxclient
6491 \begin_layout Section
6492 Normal communication
6495 \begin_layout Standard
6496 To issue a \SpecialChar LyX
6497 call, the client writes a line of ASCII text into the input
6499 This line has the following format:
6516 \begin_layout Description
6517 clientname is a name that the client can choose arbitrarily.
6518 Its only use is that \SpecialChar LyX
6519 will echo it if it sends an answer—so a client can
6520 dispatch results from different requesters.
6523 \begin_layout Description
6524 function is the function you want \SpecialChar LyX
6526 It is the same as the commands you'd use in the minibuffer.
6529 \begin_layout Description
6530 argument is an optional argument which is meaningful only to some functions
6532 \begin_inset Quotes eld
6536 \begin_inset Quotes erd
6539 LFUN will insert the argument as text at the cursor position).
6542 \begin_layout Standard
6543 The answer from \SpecialChar LyX
6544 will arrive in the output pipe and be of the form
6561 \begin_layout Standard
6570 are just echoed from the command request, while
6574 is more or less useful information filled according to how the command
6575 execution worked out.
6576 Some commands, such as
6577 \begin_inset Quotes eld
6581 \begin_inset Quotes erd
6584 , will return information about the internal state of \SpecialChar LyX
6586 return an empty data-response.
6587 This means that the command execution went fine.
6590 \begin_layout Standard
6591 In case of errors, the response from \SpecialChar LyX
6609 \begin_layout Standard
6614 should contain an explanation of why the command failed.
6617 \begin_layout Standard
6621 \begin_layout LyX-Code
6622 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
6623 \begin_inset Newline newline
6626 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
6627 \begin_inset Newline newline
6630 read a <~/.lyxpipe.out
6631 \begin_inset Newline newline
6637 \begin_layout Subsection
6638 AppleScript (Mac OS X)
6641 \begin_layout Standard
6642 Since \SpecialChar LyX
6643 2.1, \SpecialChar LyX
6644 supports basic interactions with AppleScript for normal communicatio
6645 n through the command run.
6646 This command takes a direct argument (the
6650 to perform) and an optional argument.
6651 It either returns the output of the function or triggers an error with
6652 the error message and code.
6655 \begin_layout Standard
6659 \begin_layout LyX-Code
6660 tell application "\SpecialChar LyX
6664 \begin_layout LyX-Code
6668 \begin_layout LyX-Code
6669 -- Stores the current file name into f
6672 \begin_layout LyX-Code
6673 set f to (run "server-get-filename" with argument "")
6676 \begin_layout LyX-Code
6677 on error the error_message number the error_number
6680 \begin_layout LyX-Code
6681 display dialog "Error: " & the error_number & ".
6685 \begin_layout LyX-Code
6686 & the error_message buttons {"OK"} default button 1
6689 \begin_layout LyX-Code
6693 \begin_layout LyX-Code
6697 \begin_layout Section
6701 \begin_layout Standard
6703 can notify clients of events going on asynchronously.
6704 Currently it will only do this if the user binds a key sequence with the
6706 \begin_inset Quotes eld
6710 \begin_inset Quotes erd
6714 The format of the string \SpecialChar LyX
6715 sends is as follows:
6719 \begin_inset Flex Code
6722 \begin_layout Plain Layout
6733 \begin_layout Standard
6738 is the printed representation of the key sequence that was actually typed
6742 \begin_layout Standard
6743 This mechanism can be used to extend \SpecialChar LyX
6744 's command set and implement macros.
6745 Bind some key sequence to
6746 \begin_inset Quotes eld
6750 \begin_inset Quotes erd
6754 Then start a client that listens on the output pipe, dispatches the command
6755 according to the sequence, and starts a function that may use \SpecialChar LyX
6758 requests to issue a command or a series of commands to \SpecialChar LyX
6762 \begin_layout Section
6763 The simple \SpecialChar LyX
6767 \begin_layout Standard
6769 implements a simple protocol that can be used for session management.
6770 All messages are of the form
6783 \begin_layout Standard
6789 \begin_inset Quotes eld
6793 \begin_inset Quotes erd
6797 \begin_inset Quotes eld
6801 \begin_inset Quotes erd
6806 \begin_inset Quotes eld
6810 \begin_inset Quotes erd
6813 is received from a client, \SpecialChar LyX
6814 will report back to inform the client that
6815 it's listening to it's messages, while
6816 \begin_inset Quotes eld
6820 \begin_inset Quotes erd
6823 sent from \SpecialChar LyX
6824 will inform clients that \SpecialChar LyX
6828 \begin_layout Section
6829 Reverse DVI/PDF search
6832 \begin_layout Standard
6833 Some DVI/PDF viewers
6837 \begin_layout Plain Layout
6838 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
6839 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
6848 facility (also called
6853 This means that you can tell \SpecialChar LyX
6854 to put the cursor to a specific line in the
6855 document by clicking at the respective position in the DVI/PDF output.
6856 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
6858 This is done via the \SpecialChar LyX
6859 server either by using the named pipe (
6863 ), or the UNIX domain socket (
6867 ) that \SpecialChar LyX
6868 creates in its temporary directory (this is the way the
6869 \begin_inset Flex Code
6872 \begin_layout Plain Layout
6878 program communicates with \SpecialChar LyX
6880 In some cases, you need a helper script that mediates between the viewer
6881 and \SpecialChar LyX
6882 , in others, the viewer can communicate with \SpecialChar LyX
6884 This depends on the selected viewer and on your operating system.
6885 The same applies to the way viewers need to be configured and the way the
6886 reverse search is actually performed.
6887 In what follows, we will thus describe how to setup reverse search for
6889 Before we turn to this, though, we will explain what needs to be done generally
6890 to enable reverse search in the DVI/PDF output.
6893 \begin_layout Subsection
6895 \begin_inset CommandInset label
6897 name "subsec:rev-search"
6904 \begin_layout Standard
6905 In most cases \SpecialChar LyX
6906 will do the work for you by pressing the following button
6910 arg "buffer-toggle-output-sync"
6914 Alternatively, you can also enable the feature by checking
6916 Synchronize with Output
6919 \begin_inset Flex Noun
6922 \begin_layout Plain Layout
6923 Document\SpecialChar menuseparator
6924 Settings\SpecialChar menuseparator
6931 In such a case \SpecialChar LyX
6932 will automatically insert the necessary Sync\SpecialChar TeX
6934 PDF) or load the srcltx package (for DVI) respectively.
6935 This option can be easily reached also on
6936 \begin_inset Flex Code
6939 \begin_layout Plain Layout
6948 \begin_layout Standard
6949 If you need a different setting, you can select or input a custom macro
6950 from the drop down box just below
6951 \begin_inset Flex Noun
6954 \begin_layout Plain Layout
6955 Document\SpecialChar menuseparator
6956 Settings\SpecialChar menuseparator
6957 Output\SpecialChar menuseparator
6958 Synchronize with Output
6966 \begin_layout Standard
6967 Note that the method
6968 \begin_inset Flex Code
6971 \begin_layout Plain Layout
6979 enables gzip compression.
6980 If your viewer does not support it, you should instead use
6981 \begin_inset Flex Code
6984 \begin_layout Plain Layout
6995 \begin_layout Standard
6996 Please also note that including the
6997 \begin_inset Flex Code
7000 \begin_layout Plain Layout
7007 \begin_inset Flex Code
7010 \begin_layout Plain Layout
7016 sometimes has an undesired impact on the typesetting.
7017 Thus, you should switch output synchronization off for the final typesetting
7019 \begin_inset Flex Code
7022 \begin_layout Plain Layout
7029 \begin_inset Flex Code
7032 \begin_layout Plain Layout
7042 \begin_layout Standard
7043 In case you need some more special settings that are not covered by the
7044 automatic settings, read the next section about how to set up output synchroniz
7046 If the automatic setup suits your needs, you can readily jump to section
7047 \begin_inset space ~
7051 \begin_inset CommandInset ref
7053 reference "subsec:configuring-viewers"
7057 , where the necessary configuration steps in your viewer – needed both with
7058 the automatic and the manual setup – are described.
7061 \begin_layout Subsection
7065 \begin_layout Standard
7067 provides several different methods for reverse search.
7068 Some are built-in in the
7069 \begin_inset Flex Code
7072 \begin_layout Plain Layout
7078 program, some are provided by external packages.
7079 Your choice depends on whether your \SpecialChar LaTeX
7080 distribution already provides a given
7081 method (the built-in methods are rather new) and whether your viewer can
7083 The available methods are described in the following.
7086 \begin_layout Subsubsection*
7087 Built-in DVI-search via src-specials (DVI only)
7090 \begin_layout Standard
7091 This method provides the DVI file with the necessary information for reverse
7093 It is available in \SpecialChar LaTeX
7094 since quite some time (any somewhat recent \SpecialChar LaTeX
7096 should include it), and it works reliably.
7097 To enable it, change the
7098 \begin_inset Flex Noun
7101 \begin_layout Plain Layout
7112 \begin_inset Flex Noun
7115 \begin_layout Plain Layout
7126 \begin_inset Flex Noun
7129 \begin_layout Plain Layout
7130 Preferences\SpecialChar menuseparator
7131 File Handling\SpecialChar menuseparator
7138 \begin_inset Flex Code
7141 \begin_layout Plain Layout
7142 latex -src-specials $$i
7148 If this doesn't work, check if your \SpecialChar TeX
7149 engine needs different options (the
7150 syntax might differ in some distributions).
7153 \begin_layout Subsubsection*
7154 External Packages (PDFSync and scrltx)
7157 \begin_layout Standard
7166 provide reverse search facility for PDF output (via pdflatex) and DVI output,
7168 In order to enable it, load the packages in the \SpecialChar LyX
7172 \begin_layout Itemize
7173 \begin_inset Flex Code
7176 \begin_layout Plain Layout
7184 for reverse PDF search,
7187 \begin_layout Itemize
7188 \begin_inset Flex Code
7191 \begin_layout Plain Layout
7194 usepackage[active]{srcltx}
7199 for reverse DVI search.
7202 \begin_layout Standard
7203 If you want to be able to perform both DVI and PDF reverse searches, you
7204 can also insert in the preamble the following lines
7207 \begin_layout LyX-Code
7211 \begin_inset Newline newline
7217 \begin_inset Newline newline
7223 \begin_inset Newline newline
7229 \begin_inset Newline newline
7234 usepackage[active]{srcltx}
7235 \begin_inset Newline newline
7243 \begin_layout Standard
7244 This way, you can preview the file as either DVI or PDF (pdflatex) and the
7245 right package will be used.
7248 \begin_layout Standard
7249 Note that PDFSync might affect the output layout of your document.
7250 It is therefore advised to disable PDFsync for final documents.
7253 \begin_layout Subsubsection*
7254 Built-in reverse search via Sync\SpecialChar TeX
7258 \begin_layout Standard
7260 \begin_inset Flex Code
7263 \begin_layout Plain Layout
7269 have built-in support for both PDF and DVI reverse search.
7272 Sync\SpecialChar TeX
7275 facility is basically the result of the integration of the PDFSync package
7276 to the pdftex program and its merge with the
7281 You need at least \SpecialChar TeX
7282 Live 2008 or a recent Mik\SpecialChar TeX
7283 distribution in order to use
7288 \begin_layout Plain Layout
7289 For some reason, Mik\SpecialChar TeX
7290 does not understand/obey the command \SpecialChar LyX
7292 the preamble when you check the "Enable Forward/Reverse Search" button
7293 in the toolbar and does not generate the necessary info.
7296 \begin_layout Plain Layout
7297 The generation of the required info can be forced by changing the converter
7299 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
7300 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
7301 the -synctex=1 switch).
7306 Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
7307 Skim on the Mac, SumatraPDF on Windows; see the next section for details)
7308 already provide Sync\SpecialChar TeX
7312 \begin_layout Standard
7313 To enable Sync\SpecialChar TeX
7314 for DVI output, change the
7315 \begin_inset Flex Noun
7318 \begin_layout Plain Layout
7329 \begin_inset Flex Noun
7332 \begin_layout Plain Layout
7343 \begin_inset Flex Noun
7346 \begin_layout Plain Layout
7347 Preferences\SpecialChar menuseparator
7348 File Handling\SpecialChar menuseparator
7355 \begin_inset Flex Code
7358 \begin_layout Plain Layout
7359 latex -synctex=1 $$i
7364 , and for PDF output, change the
7365 \begin_inset Flex Noun
7368 \begin_layout Plain Layout
7373 (pdflatex) -> PDF (pdflatex)
7379 \begin_inset Flex Code
7382 \begin_layout Plain Layout
7383 pdflatex -synctex=1 $$i
7389 Should your viewer not be considered in the following description, or in
7390 case of missing success, please check the documentation of your viewer
7391 whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
7396 \begin_layout Plain Layout
7397 Note that the option
7398 \begin_inset Flex Code
7401 \begin_layout Plain Layout
7407 option enables gzip compression.
7408 If your viewer does not support it, you should instead use
7409 \begin_inset Flex Code
7412 \begin_layout Plain Layout
7426 \begin_layout Subsection
7427 Configuring and using specific viewers
7428 \begin_inset CommandInset label
7430 name "subsec:configuring-viewers"
7437 \begin_layout Subsubsection*
7438 Xdvi (all platforms)
7441 \begin_layout Standard
7443 \begin_inset Flex Code
7446 \begin_layout Plain Layout
7452 , you don't need to do anything else for performing a reverse DVI search,
7454 already provides the necessary hooks for automatically using the
7455 \begin_inset Flex Code
7458 \begin_layout Plain Layout
7465 Just setup your document as described above (reverse search is triggered
7466 by Ctrl-click or Alt-click on Mac OSX, respectively).
7469 \begin_layout Standard
7470 However, if for whatever reason you want to use the named pipe instead of
7471 the socket for communicating with \SpecialChar LyX
7472 , simply change the DVI viewer in
7473 \begin_inset Flex Noun
7476 \begin_layout Plain Layout
7477 Preferences\SpecialChar menuseparator
7478 File Handling\SpecialChar menuseparator
7488 \begin_layout Plain Layout
7489 On Mac OSX you have to use
7490 \begin_inset Flex Code
7493 \begin_layout Plain Layout
7494 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
7505 \begin_inset Flex Code
7508 \begin_layout Plain Layout
7509 xdvi -editor "lyxeditor.sh %f %l"
7515 \begin_inset Flex Code
7518 \begin_layout Plain Layout
7524 is a suitable script.
7525 For example, a minimal shell script is the following one:
7528 \begin_layout LyX-Code
7530 \begin_inset Newline newline
7533 LYXPIPE="/path/to/lyxpipe"
7534 \begin_inset Newline newline
7537 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
7538 \begin_inset Newline newline
7541 echo "$COMMAND" > "${LYXPIPE}".in || exit
7542 \begin_inset Newline newline
7545 read TMP < "${LYXPIPE}".out || exit
7548 \begin_layout Standard
7550 \begin_inset Flex Code
7553 \begin_layout Plain Layout
7559 is the LyXServer pipe path specified in
7560 \begin_inset Flex Noun
7563 \begin_layout Plain Layout
7564 Preferences\SpecialChar menuseparator
7574 \begin_layout Plain Layout
7576 \begin_inset Flex Code
7579 \begin_layout Plain Layout
7585 folder of a source distribution you can find a
7586 \begin_inset Flex Code
7589 \begin_layout Plain Layout
7595 script which is able to locate the
7599 based on your preferences.
7607 \begin_layout Subsubsection*
7611 \begin_layout Standard
7613 \begin_inset Flex Code
7616 \begin_layout Plain Layout
7617 /Applications/MacDviX_Folder/calleditor.script
7622 , add the following lines:
7625 \begin_layout LyX-Code
7626 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
7627 \begin_inset Newline newline
7633 \begin_layout Standard
7634 Modify the lines accordingly if you install \SpecialChar LyX
7635 somewhere else than in the
7636 Applications folder.
7639 \begin_layout Standard
7640 Reverse search is triggered by Alt-click (OPTION-click).
7643 \begin_layout Subsubsection*
7647 \begin_layout Standard
7649 \begin_inset Flex Code
7652 \begin_layout Plain Layout
7653 open -a Skim.app $$i
7658 to the viewer setting in
7659 \begin_inset Flex Noun
7662 \begin_layout Plain Layout
7663 Preferences\SpecialChar menuseparator
7664 File Handling\SpecialChar menuseparator
7665 File formats\SpecialChar menuseparator
7672 \begin_inset Flex Noun
7675 \begin_layout Plain Layout
7676 Skim\SpecialChar menuseparator
7677 Preferences\SpecialChar menuseparator
7684 \begin_inset Flex Noun
7687 \begin_layout Plain Layout
7693 preset and enter command
7694 \begin_inset Flex Noun
7697 \begin_layout Plain Layout
7698 /Applications/\SpecialChar LyX
7699 .app/Contents/MacOS/lyxeditor
7707 \begin_layout Standard
7708 Reverse search is triggered by COMMAND-SHIFT-click
7711 \begin_layout Subsubsection*
7715 \begin_layout Standard
7716 Reverse search with evince does not work out of the box, but it can be achieved
7717 by means of some third party helper scripts.
7719 \begin_inset CommandInset href
7721 target "https://wiki.lyx.org/LyX/SyncTeX"
7729 \begin_layout Subsubsection*
7733 \begin_layout Standard
7735 \begin_inset Flex Noun
7738 \begin_layout Plain Layout
7739 Settings\SpecialChar menuseparator
7740 Configure Okular\SpecialChar menuseparator
7747 \begin_inset Quotes erd
7751 This inserts the appropriate command (
7752 \begin_inset Flex Code
7755 \begin_layout Plain Layout
7764 \begin_layout Standard
7765 Reverse search is triggered by SHIFT-click.
7767 \change_inserted -712698321 1578211026
7768 Note that this only works if Okular is in
7769 \begin_inset Quotes eld
7773 \begin_inset Quotes erd
7777 \begin_inset space \thinspace{}
7780 e., the hand symbol is clicked).
7785 \begin_layout Subsubsection*
7789 \begin_layout Standard
7790 Qpdfview supports Sync\SpecialChar TeX
7791 since version 0.3.5.
7793 \begin_inset Flex Noun
7796 \begin_layout Plain Layout
7797 Edit\SpecialChar menuseparator
7798 Settings\SpecialChar menuseparator
7804 , click on the input field of the
7805 \begin_inset Quotes eld
7809 \begin_inset Quotes erd
7812 item and add the command
7813 \begin_inset Flex Code
7816 \begin_layout Plain Layout
7825 \begin_layout Standard
7826 Reverse search is triggered by double-click or, in more recent versions,
7830 \begin_layout Subsubsection*
7834 \begin_layout Standard
7835 Launch yap, choose its
7836 \begin_inset Flex Noun
7839 \begin_layout Plain Layout
7840 View\SpecialChar menuseparator
7847 \begin_inset Quotes eld
7851 \begin_inset Quotes erd
7856 \begin_inset Quotes eld
7859 New\SpecialChar ldots
7861 \begin_inset Quotes erd
7864 button and, in the window that opens, enter
7865 \begin_inset Quotes eld
7870 \begin_inset Quotes erd
7873 (or any other name you like) in the
7874 \begin_inset Quotes eld
7878 \begin_inset Quotes erd
7882 Now click on the button labeled
7883 \begin_inset Quotes eld
7888 \begin_inset Quotes erd
7891 to open a file dialog and navigate to the directory containing the batch
7893 \begin_inset Flex Code
7896 \begin_layout Plain Layout
7904 \begin_inset Flex Code
7907 \begin_layout Plain Layout
7913 and then specify the program arguments as
7914 \begin_inset Flex Code
7917 \begin_layout Plain Layout
7925 \begin_inset Flex Code
7928 \begin_layout Plain Layout
7934 wrapper is used for communicating with \SpecialChar LyX
7942 \begin_layout LyX-Code
7944 \begin_inset Newline newline
7947 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
7956 \begin_inset Newline newline
7970 \begin_layout Standard
7971 Make sure that the \SpecialChar LyX
7972 Server pipe path you specified in \SpecialChar LyX
7974 \begin_inset Flex Code
7977 \begin_layout Plain Layout
7991 , otherwise change the
7992 \begin_inset Flex Code
7995 \begin_layout Plain Layout
8001 wrapper accordingly.
8004 \begin_layout Standard
8005 In yap, reverse search is triggered by double-click.
8008 \begin_layout Subsubsection*
8009 SumatraPDF (Windows)
8012 \begin_layout Standard
8013 In order to use SumatraPDF for inverse search, enter
8014 \begin_inset Flex Code
8017 \begin_layout Plain Layout
8018 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
8023 in the viewer setting in
8024 \begin_inset Flex Noun
8027 \begin_layout Plain Layout
8028 Preferences\SpecialChar menuseparator
8029 File Handling\SpecialChar menuseparator
8030 File formats\SpecialChar menuseparator
8037 \begin_inset Flex Code
8040 \begin_layout Plain Layout
8046 is the previous wrapper.
8047 If SumatraPDF.exe is not in your command PATH, use its full file name.
8050 \begin_layout Standard
8051 Reverse search is triggered by double-click.
8054 \begin_layout Subsubsection*
8058 \begin_layout Standard
8059 First of all, make sure that yap is your default DVI viewer in the Windows
8060 environment, then launch it, choose its
8061 \begin_inset Flex Noun
8064 \begin_layout Plain Layout
8065 View\SpecialChar menuseparator
8072 \begin_inset Quotes eld
8076 \begin_inset Quotes erd
8081 \begin_inset Quotes eld
8084 New\SpecialChar ldots
8086 \begin_inset Quotes erd
8089 button and, in the window that opens, enter
8090 \begin_inset Quotes eld
8095 \begin_inset Quotes erd
8098 (or any other name you like) in the
8099 \begin_inset Quotes eld
8103 \begin_inset Quotes erd
8107 Now click on the button labeled
8108 \begin_inset Quotes eld
8113 \begin_inset Quotes erd
8116 to open a file dialog and navigate to the directory containing the
8117 \begin_inset Flex Code
8120 \begin_layout Plain Layout
8126 program (which is installed by default on Cygwin along with the \SpecialChar LyX
8129 \begin_inset Flex Code
8132 \begin_layout Plain Layout
8138 and then specify the program arguments as
8139 \begin_inset Flex Code
8142 \begin_layout Plain Layout
8149 In this way, you will be using the
8153 for communicating with \SpecialChar LyX
8155 If, for whatever reason, you want to use the
8160 \begin_inset Flex Code
8163 \begin_layout Plain Layout
8169 option and be sure to specify the \SpecialChar LyX
8170 Server pipe path in the \SpecialChar LyX
8174 \begin_layout Standard
8175 In yap, reverse search is triggered by double-click.
8178 \begin_layout Subsubsection*
8182 \begin_layout Standard
8183 In order to use SumatraPDF for inverse search, enter
8184 \begin_inset Flex Code
8187 \begin_layout Plain Layout
8188 SumatraPDF -inverse-search "lyxeditor -g %f %l"
8193 in the viewer setting in
8194 \begin_inset Flex Noun
8197 \begin_layout Plain Layout
8198 Preferences\SpecialChar menuseparator
8199 File Handling\SpecialChar menuseparator
8200 File formats\SpecialChar menuseparator
8207 If SumatraPDF.exe is not in your command PATH, use its full posix path.
8209 \begin_inset Flex Code
8212 \begin_layout Plain Layout
8218 enables communication via the
8224 \begin_inset Flex Code
8227 \begin_layout Plain Layout
8233 option if you want to use the
8237 , and be sure to specify the \SpecialChar LyX
8238 Server pipe path in the \SpecialChar LyX
8242 \begin_layout Standard
8243 Reverse search is triggered by double-click.
8246 \begin_layout Section
8250 \begin_layout Standard
8251 Forward search is, as the name implies, in a sense the
8252 \begin_inset Quotes eld
8256 \begin_inset Quotes erd
8260 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
8262 If forward search is set up (as described in what follows), you can put
8263 the cursor anywhere in your \SpecialChar LyX
8265 \begin_inset Flex Noun
8268 \begin_layout Plain Layout
8269 Navigate\SpecialChar menuseparator
8276 \begin_inset Flex Noun
8279 \begin_layout Plain Layout
8285 in the context menu via right mouse click), and then the viewer will jump
8286 to that position as well.
8287 This implies, of course, that your viewer supports this function.
8290 \begin_layout Standard
8291 To make forward search possible, you first need to provide the generated
8292 output PDF/DVI file with additional information about the \SpecialChar TeX
8294 This can be done via the methods described in the section
8295 \begin_inset CommandInset ref
8297 reference "subsec:rev-search"
8304 \begin_layout Standard
8305 Additionally, you need to configure \SpecialChar LyX
8306 for using your viewers in
8307 \begin_inset Flex Noun
8310 \begin_layout Plain Layout
8311 Tools\SpecialChar menuseparator
8312 Preferences\SpecialChar menuseparator
8313 Output\SpecialChar menuseparator
8320 We provide a range of tested configurations for some viewers, which you
8321 can select from the drop down list.
8322 If none of these configurations suits you, you have to find out and enter
8323 a suitable configuration yourself.
8324 The definition syntax uses the following placeholders:
8327 \begin_layout Itemize
8329 \begin_inset Flex Code
8332 \begin_layout Plain Layout
8341 \begin_layout Itemize
8343 \begin_inset Flex Code
8346 \begin_layout Plain Layout
8352 : name of the (temporary) exported .tex file (without path)
8355 \begin_layout Itemize
8357 \begin_inset Flex Code
8360 \begin_layout Plain Layout
8366 : name of the (temporary) exported .tex file (including path)
8369 \begin_layout Itemize
8371 \begin_inset Flex Code
8374 \begin_layout Plain Layout
8380 : name of the exported output file (either dvi or pdf, depending on which
8381 one exists in the temporary directory)
8384 \begin_layout Standard
8385 Note that only some of the viewers provide full and usable forward search
8386 functionality out of the box, among them yap, xdvi, okular
8390 \begin_layout Plain Layout
8391 You might want to set
8392 \begin_inset Flex Code
8395 \begin_layout Plain Layout
8402 \begin_inset Flex Noun
8405 \begin_layout Plain Layout
8406 Tools\SpecialChar menuseparator
8407 Preferences\SpecialChar menuseparator
8408 File Handling\SpecialChar menuseparator
8410 \begin_inset space ~
8423 , qpdfview, and SumatraPDF
8427 \begin_layout Plain Layout
8428 SumatraPDF can also use DDE commands through the external program CMCDDE
8430 \begin_inset CommandInset href
8432 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
8443 Others, such as evince
8447 \begin_layout Plain Layout
8448 Forward search with evince can be achieved by means of third party helper
8451 \begin_inset CommandInset href
8453 target "https://wiki.lyx.org/LyX/SyncTeX"
8463 , require some extra tools in order to use forward search.
8464 While many of the widespread PDF viewers (most notably Adobe Reader) do
8465 not support forward search at all, some other viewers – e.
8466 \begin_inset space \thinspace{}
8470 xpdf – allow at least to reload the document and jump to a specific page
8471 of the file, so you can at least navigate
8472 \begin_inset Quotes eld
8476 \begin_inset Quotes erd
8480 This latter functionality is provided by an external call of synctex (see
8481 the predefined example configurations).
8485 \begin_layout Standard
8486 Forward search works both with DVI and PDF output.
8488 simply checks which preview format you have used before (i.
8489 \begin_inset space \thinspace{}
8492 e., which format is already there in the temporary directory) and chooses
8493 the appropriate configuration for the respective format.
8496 \begin_layout Chapter
8497 Special Document Classes
8500 \begin_layout Section
8504 \begin_layout Standard
8510 \begin_layout Subsection
8514 \begin_layout Standard
8515 This section describes how \SpecialChar LyX
8516 can be used to write articles for submission
8517 to the scientific journal
8519 Astronomy and Astrophysics
8522 \begin_inset Flex URL
8525 \begin_layout Plain Layout
8527 https://www.aanda.org/
8532 ) using Version 5.01 of the document class
8537 This package can be downloaded from the ftp site
8540 \begin_layout Standard
8541 \begin_inset VSpace medskip
8547 \begin_layout Standard
8549 \begin_inset Flex URL
8552 \begin_layout Plain Layout
8554 ftp://ftp.edpsciences.org/pub/aa/readme.html
8562 \begin_layout Standard
8563 \begin_inset VSpace medskip
8569 \begin_layout Standard
8570 A manual comes together with that package, and this text is not meant to
8571 replace the original manual but is merely a short guide in how to realize
8572 the correct form of your paper.
8576 \begin_layout Standard
8577 Please note that the publisher of the journal was changed from Springer
8578 to EDP Sciences starting January 1, 2001.
8579 That change involved also some slight changes to the style files, namely
8580 the removal of the thesaurus command.
8581 The \SpecialChar LyX
8582 class aa supports the newest version of these style files, V 5.01.
8583 If you have an older version installed, please upgrade.
8584 For compatibility, the old (version 4) layout has been kept as
8589 Please refer to the comments in
8592 Dir/layouts/aapaper.layout
8597 \begin_layout Subsection
8601 \begin_layout Standard
8602 It is recommended you start from the example template distributed with \SpecialChar LyX
8604 If you are not using a template, note the following settings:
8607 \begin_layout Itemize
8614 Document\SpecialChar menuseparator
8617 dialog (OK, that one was obvious).
8620 \begin_layout Itemize
8621 Don't change the option
8624 \begin_inset space ~
8634 The whole layout is done by the macros, you shouldn't change anything.
8637 \begin_layout Subsection
8641 \begin_layout Standard
8642 First thing to enter is the header information.
8643 It consists of seven entries, of which some are optional.
8647 \begin_layout Itemize
8655 \begin_layout Itemize
8663 \begin_layout Itemize
8671 \begin_layout Itemize
8679 \begin_layout Itemize
8684 : [optional] if more than one author: whom to contact for offprint requests.
8687 \begin_layout Itemize
8692 : [optional] mail address for contacts.
8695 \begin_layout Itemize
8703 Received: <date>; Accepted <date>
8706 \begin_layout Standard
8707 There is no need to issue the
8713 command, this is done automatically by \SpecialChar LyX
8714 when the header is finished.
8715 Although the order of the single header entries doesn't matter it is advised
8716 to keep the above sequence, just to get the best optics and meets the layout
8717 of the real document.
8720 \begin_layout Standard
8721 If you want to place footnotes in the header block, e.
8722 \begin_inset space \thinspace{}
8726 \begin_inset space \space{}
8729 to state your present address, just use the standard footnote via the menu
8732 Insert\SpecialChar menuseparator
8737 will automagically use the term
8746 \begin_layout Standard
8749 Edit\SpecialChar menuseparator
8752 , you'll find two insets which are relevant for the titling:
8755 \begin_layout Itemize
8762 to mark corresponding author\SpecialChar breakableslash
8764 The institutes are numbered sequentially as they appear in the
8768 field, so you have to put a marker to each author.
8771 \begin_layout Itemize
8776 to supply an email address for fast contact.
8779 \begin_layout Standard
8780 In addition to these topics, the macros use one additional \SpecialChar LaTeX
8782 has no counterpart in \SpecialChar LyX
8786 \begin_layout Itemize
8793 to separate different names for more than one author and institute, respectivel
8797 \begin_layout Standard
8798 The appropriate command has to be entered in \SpecialChar LyX
8799 and marked as \SpecialChar LaTeX
8805 \begin_layout Subsection
8809 \begin_layout Standard
8810 The abstract should immediately follow the header block.
8811 With version 5 the abstract environment was changed to a command, and there
8812 is now a restriction to only one paragraph.
8813 In addition, it should contain an entry with the keywords.
8814 This is done via the paragraph style
8819 Refer to the example paper.
8822 \begin_layout Subsection
8823 Supported environments
8826 \begin_layout Standard
8827 The A&A paper layout supports the following environments for structuring
8831 \begin_layout Itemize
8837 \begin_layout Itemize
8843 \begin_layout Itemize
8849 \begin_layout Itemize
8855 \begin_layout Itemize
8861 \begin_layout Itemize
8867 \begin_layout Itemize
8873 \begin_layout Itemize
8879 \begin_layout Itemize
8885 \begin_layout Itemize
8891 \begin_layout Itemize
8897 \begin_layout Itemize
8904 \begin_layout Subsection
8905 Commands not supported by \SpecialChar LyX
8909 \begin_layout Standard
8910 Some commands are not yet supported by the
8914 layout for \SpecialChar LyX
8916 Some have already been mentioned.
8917 For the sake of completeness, they are listed all together here:
8920 \begin_layout Itemize
8928 \begin_layout Itemize
8936 \begin_layout Itemize
8944 \begin_layout Itemize
8952 \begin_layout Standard
8953 If you want to use any of these commands, you have to enter them yourself.
8956 Do not forget to mark them as \SpecialChar LaTeX
8960 \begin_layout Subsection
8961 Figure and Table Floats
8964 \begin_layout Standard
8966 provides support for the necessary float environments
8968 figure, figure*, table
8974 , therefore we won't tell much about it here.
8978 \begin_inset space ~
8984 Just remember that tables should be left-aligned.
8985 For that, select the table and change the alignment in
8987 Edit\SpecialChar menuseparator
8989 \begin_inset space ~
8995 \begin_layout Standard
8996 There is only one special thing: the figures with caption besides the figure.
8997 To create such a figure, you have to do the following:
9000 \begin_layout Enumerate
9001 Create a wide figure float:
9003 Insert\SpecialChar menuseparator
9004 Float\SpecialChar menuseparator
9007 , then right click in the figure and select
9010 \begin_inset space ~
9018 \begin_layout Enumerate
9019 Enter your caption text.
9022 \begin_layout Enumerate
9027 to move the cursor above the caption.
9030 \begin_layout Enumerate
9034 \begin_layout Enumerate
9035 Position the cursor behind the figure and insert a horizontal fill:
9037 Insert\SpecialChar menuseparator
9039 \begin_inset space ~
9042 Character\SpecialChar menuseparator
9044 \begin_inset space ~
9052 \begin_layout Enumerate
9053 Switch to \SpecialChar LaTeX
9057 \begin_inset space ~
9065 \begin_layout Enumerate
9075 Do not close the brace!
9078 \begin_layout Enumerate
9079 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
9084 \begin_inset space ~
9096 \begin_layout Standard
9097 Also, refer to the figures in the example paper.
9100 \begin_layout Subsection
9104 \begin_layout Standard
9105 For submission, the paper has to be formated in a special double-spacing
9107 For this purpose, you have to give the option
9111 to the document class.
9112 This must be done using the custom class options field in the
9114 Document\SpecialChar menuseparator
9118 Just enter the string
9125 \begin_layout Subsection
9129 \begin_layout Standard
9134 directory contains an example paper written with \SpecialChar LyX
9136 It is the example paper from the original macro package, translated to
9139 Use it for inspiration, and compare the original \SpecialChar LaTeX
9140 code with \SpecialChar LyX
9144 \begin_layout Section
9149 \begin_layout Standard
9155 \begin_layout Subsection
9159 \begin_layout Standard
9161 is a set of macros produced by the American Astronomical Society to
9162 facilitate electronic manuscript submission to the three journals they
9163 publish: the Astrophysical Journal (including the Letters and Supplement),
9164 the Astronomical Journal, and the Publications of the Astronomical Society
9167 has proven to be an excellent tool for generating these documents, especially
9168 given its equation, citation, and figure handling capabilities.
9170 requires version 5.0 (or higher) of these macros; preferably 6.0, which
9171 is the version described here, or higher.
9172 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
9173 2.09 and are fundamentally
9174 incompatible with \SpecialChar LyX
9176 The AAS\SpecialChar TeX
9177 package may be downloaded from the AAS\SpecialChar TeX
9181 \begin_layout Standard
9182 \begin_inset VSpace medskip
9188 \begin_layout Standard
9190 \begin_inset Flex URL
9193 \begin_layout Plain Layout
9195 https://aas.org/aastex/aastex-downloads
9203 \begin_layout Standard
9204 \begin_inset VSpace medskip
9210 \begin_layout Standard
9211 A complete user guide is contained in that package and you should familiarize
9212 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
9215 will not reduce the need to figure out all the AAS\SpecialChar TeX
9216 commands, it will only
9217 reduce the drudgery of typing everything in.
9218 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
9220 completely to the requirements of the journal to which you are submitting
9224 \begin_layout Subsection
9225 Starting a New Paper
9228 \begin_layout Standard
9229 I strongly suggest that you start with the AAS\SpecialChar TeX
9233 File\SpecialChar menuseparator
9240 , enter the new file name, then choose the
9245 This will show the most common fields found in a manuscript.
9246 Simply overwrite the existing text (including the brackets,
9250 ) with the correct information.
9251 Many of the AAS\SpecialChar TeX
9252 commands and environments can be implemented directly in
9255 For commands such as these, the \SpecialChar LaTeX
9256 code must be entered directly and marked
9258 Such commands are referred to as \SpecialChar TeX
9259 code, or Evil Red Text.
9260 I tried to minimize the amount of \SpecialChar TeX
9261 code needed in an AAS\SpecialChar TeX
9265 \begin_layout Subsection
9266 Finishing Your Paper
9269 \begin_layout Standard
9270 When the paper is finished to your satisfaction and previews/prints correctly,
9272 \begin_inset Quotes eld
9276 \begin_inset Quotes erd
9279 actions which need to be done before you submit it to the journals.
9283 \begin_layout Enumerate
9284 Export your paper as a \SpecialChar LaTeX
9287 File\SpecialChar menuseparator
9288 Export\SpecialChar menuseparator
9296 \begin_layout Enumerate
9301 file with your favorite text editor
9305 \begin_layout Enumerate
9306 remove the comment lines before the
9315 \begin_layout Enumerate
9320 usepackage...{fontenc}
9322 line if it appears (usually just after
9337 \begin_layout Enumerate
9338 remove everything between (and including) the
9350 commands, except for any commands you specifically put into the \SpecialChar LaTeX
9352 (which should appear immediately after the
9353 \begin_inset Quotes eld
9356 User specified \SpecialChar LaTeX
9358 \begin_inset Quotes erd
9369 \begin_layout Enumerate
9370 Run the resulting file through \SpecialChar LaTeX
9371 to make sure it still processes correctly.
9374 \begin_layout Enumerate
9375 Reread the journal requirements to make sure your filenames and formats
9379 \begin_layout Enumerate
9383 \begin_layout Subsection
9384 Comments On Specific Commands
9387 \begin_layout Standard
9388 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
9395 ) gives a good description of each.
9396 Thus it's probably easiest for me to go down the list as found in the guide
9397 and offer comments where necessary.
9398 So let's begin \SpecialChar ldots
9402 \begin_layout Subsubsection
9403 Things that work as expected
9406 \begin_layout Standard
9407 Because they work as you might expect, I simply list them and the section
9508 begin{thebibliography}
9516 (2.13.2), all the cite commands and their variations (2.13.2), the generic
9517 graphicx figure commands (2.14.1),
9541 (2.15.4, amongst other places),
9568 \begin_layout Standard
9569 The following style options also work correctly:
9590 Simply put them in the
9596 Layout\SpecialChar menuseparator
9602 \begin_layout Subsubsection
9603 Things that work, but require more comment
9606 \begin_layout Standard
9607 The following items work, but require a little more discussion:
9610 \begin_layout Itemize
9611 These items are reserved for use by the journal editors, but you can put
9612 them into the \SpecialChar LaTeX
9613 preamble if you feel compelled to do so:
9646 \begin_layout Itemize
9647 These items may be placed in the \SpecialChar LaTeX
9648 preamble, and are included as blanks in
9670 \begin_layout Itemize
9677 (2.3) – can only be used
9678 \begin_inset Quotes eld
9682 \begin_inset Quotes erd
9685 , not in the middle of a paragraph.
9686 Use \SpecialChar TeX
9687 code if you need to embed it.
9690 \begin_layout Itemize
9697 (2.3) – will have extra {} after it.
9698 This should not cause an error.
9701 \begin_layout Itemize
9708 (2.6) – can only be used
9709 \begin_inset Quotes eld
9713 \begin_inset Quotes erd
9716 , not in the middle of a paragraph.
9717 Use \SpecialChar TeX
9718 code if you need to embed it.
9721 \begin_layout Itemize
9728 (2.8) – can't insert a cross-reference tag, you must type the tag name by
9732 \begin_layout Itemize
9746 \begin_layout Itemize
9753 (2.9) – will have extra {} after it.
9754 This should not cause an error.
9757 \begin_layout Itemize
9764 (2.11) – will have extra {} after it.
9765 This should not cause an error.
9768 \begin_layout Itemize
9775 (2.14.2) – you can insert an optional filename argument by placing the cursor
9776 at the beginning of the text and selecting
9778 Insert\SpecialChar menuseparator
9783 \begin_inset Quotes eld
9787 \begin_inset Quotes erd
9790 inserts an optional argument of the type needed by
9797 Hopefully it will be renamed someday.
9800 \begin_layout Itemize
9813 for the catalog ID optional parameter
9816 \begin_layout Itemize
9829 for the catalog ID optional parameter
9832 \begin_layout Subsubsection
9833 Things not implemented, use \SpecialChar TeX
9837 \begin_layout Standard
9848 setcounter{equation}
9850 (2.12), Journal name abbreviations (2.13.4),
9886 (2.15.4, insert it as the first element in the lefthand cell after where
9888 Don't use any of \SpecialChar LyX
9889 's rules in the table),
9901 (2.15.5), much of Misc (2.17, except
9952 \begin_layout Subsubsection
9953 Things that cannot be implemented
9956 \begin_layout Standard
9958 at least in any meaningful sort of way, so I suggest ignoring them.
9959 They are the references environment (2.13.3), and the deluxetable environment
9961 If you really, really need to use deluxetable, I suggest editing it in
9962 a separate file with a text editor, then using
9964 Insert\SpecialChar menuseparator
9966 \begin_inset space ~
9971 to include it in your \SpecialChar LyX
9977 file to see an example of this.
9980 \begin_layout Subsection
9981 FAQs, Tips, Tricks, and Other Ruminations
9984 \begin_layout Subsubsection
9985 Getting \SpecialChar LyX
9986 and AAS\SpecialChar TeX
9990 \begin_layout Standard
9991 It can be a bit tricky to get \SpecialChar LyX
9992 to recognize a new layout and document class.
9993 When all else fails, do this:
9996 \begin_layout Enumerate
9997 Make certain that \SpecialChar LaTeX
9998 can find AAS\SpecialChar TeX
10000 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
10001 distribution into a
10002 directory completely unrelated to \SpecialChar LaTeX
10003 or AAS\SpecialChar TeX
10004 and run \SpecialChar LaTeX
10012 \begin_layout Enumerate
10017 appears in \SpecialChar LyX
10025 \begin_layout Enumerate
10028 Tools\SpecialChar menuseparator
10031 in \SpecialChar LyX
10032 , then restart \SpecialChar LyX
10036 \begin_layout Enumerate
10037 Open a regular new file, not from a template.
10038 Does AAS\SpecialChar TeX
10039 appear in the class list in
10041 Document\SpecialChar menuseparator
10047 \begin_layout Standard
10048 If you get a warning from an existing AAS\SpecialChar TeX
10049 document about not being able
10050 to find the AAS\SpecialChar TeX
10051 layout or a message about
10052 \begin_inset Quotes eld
10055 You should not mix title layouts with normal ones
10056 \begin_inset Quotes erd
10059 , things haven't been installed correctly.
10062 \begin_layout Subsubsection
10064 error processing a table
10067 \begin_layout Standard
10069 , by default, attempts to center the table caption/title.
10070 This seems to produce a bad interaction in AAS\SpecialChar TeX
10071 so you should click somewhere
10072 in the caption/title, then select
10074 Edit\SpecialChar menuseparator
10076 \begin_inset space ~
10090 This took care of it for me.
10093 \begin_layout Subsubsection
10097 \begin_layout Standard
10098 A couple of things: 1) I have noticed some funny spacing in the reference
10099 entries in the text.
10100 When you enter the bibliography item data, make sure their is
10104 space between the last author and the parenthesis setting off the year;
10108 \begin_inset space \thinspace{}
10112 \begin_inset space \space{}
10126 2) Entering the references at all is not obvious.
10127 The easiest thing is to start typing your first reference at the end of
10128 the document, then mark it as type
10133 That will put a small gray box in front of what you just typed.
10134 Click on the box to fill in the rest of the information.
10135 For new references, go to the end of an existing reference and press return.
10136 That will create a new line with its own box, etc.
10139 \begin_layout Subsubsection
10140 Including EPS files
10143 \begin_layout Standard
10144 Even though AAS\SpecialChar TeX
10145 provides its own figure commands (
10151 , for example), I much prefer \SpecialChar LaTeX
10152 's standard figure commands (with the default
10161 \begin_inset space ~
10164 commands as \SpecialChar TeX
10165 code into a Figure Float box if you desire, but I never have
10166 much luck getting the layout right.
10167 With the standard graphics, \SpecialChar LyX
10172 usepackage{graphicx}
10174 command into the \SpecialChar LaTeX
10175 preamble and handle the figures in the standard \SpecialChar LaTeX2e
10177 interspersing the figures in the text.
10178 I believe ApJ accepts figures exactly this way now; AJ might still use
10180 \begin_inset Quotes eld
10183 stack everything at the end
10184 \begin_inset Quotes erd
10190 \begin_layout Subsubsection
10191 Things I could have done, but didn't
10194 \begin_layout Standard
10196 \begin_inset Quotes eld
10200 \begin_inset Quotes erd
10203 things I could have implemented, but chose not to.
10204 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
10206 even though it is double-spaced in the paper manuscript.
10207 Also, I chose not to make separate layouts for the preprint and preprint2
10209 Since I assume you will spend most of your time in the plain manuscript
10210 mode anyway, I decided not to chew up more disk space with this.
10214 \begin_layout Subsection
10218 \begin_layout Standard
10219 Your mileage may vary.
10220 I've now had papers published by both ApJ and AJ that have had 98% of the
10221 effort done in \SpecialChar LyX
10222 ; the last 2% was the \SpecialChar LaTeX
10223 post-processing and a few cleanups.
10224 I have had no trouble with the submission process, and I'm sure the journals
10225 were never aware that there might be a difference.
10226 So, go forth and publish!
10229 \begin_layout Section
10230 AMS \SpecialChar LaTeX
10234 \begin_layout Standard
10241 Richard Kimberly Heck
10244 \begin_layout Standard
10245 \begin_inset VSpace bigskip
10251 \begin_layout Standard
10253 The AMS \SpecialChar LaTeX
10254 layouts are set up to conform to suggested styles for mathematical
10255 papers to be submitted to American Mathematical Society publications.
10256 The layouts are not tailored to a specific journal, but easily can be.
10257 You should refer to the AMS documentation for specific instructions for
10258 each journal (usually it will entail only changing a single line in the
10261 That documentation is available on the Web at
10262 \begin_inset Flex URL
10265 \begin_layout Plain Layout
10273 \begin_inset Flex URL
10276 \begin_layout Plain Layout
10278 ftp://ftp.ams.org/pub/tex/amslatex/
10284 These layouts are appropriate, and useful, for any mathematical writing.
10288 \begin_layout Standard
10289 There are two basic AMS \SpecialChar LaTeX
10293 \begin_layout Itemize
10294 amsart: The standard AMS article format.
10297 \begin_layout Itemize
10298 amsbook: the standard AMS book (really, monograph) format.
10302 \begin_layout Standard
10303 The layouts themselves contain only the minimum necessary to use the AMS
10305 They do not, in particular, contain any of the `theorem' environments used
10306 for setting theorems, lemmas, and the like.
10307 These are contained, instead, in the
10308 \begin_inset Flex Code
10311 \begin_layout Plain Layout
10317 module, which is loaded by default when you select one of the AMS classes.
10318 (It can also be used with other classes and can be removed, if you would
10319 rather use something else.) Less commonly used environments are in the
10320 \begin_inset Flex Code
10323 \begin_layout Plain Layout
10324 Theorems (AMS-Extended)
10329 module, which must be loaded manually.
10332 \begin_layout Standard
10333 By default, theorems and the like are numbered consecutively throughout
10334 the document, but this may be modified by loading the module
10335 \begin_inset Flex Code
10338 \begin_layout Plain Layout
10339 Theorems (Order by Section)
10344 or, if you are using
10345 \begin_inset Flex Code
10348 \begin_layout Plain Layout
10355 \begin_inset Flex Code
10358 \begin_layout Plain Layout
10359 Theorems (Order by Chapter)
10365 These will number the results as
10366 \begin_inset Formula $n.m$
10369 , where the first number refers to the section (or chapter) and the second
10370 refers to the total number of results so far in that section (or chapter).
10371 Many environments are also available unnumbered.
10372 These are indicated by an asterisk at the end.
10373 If you happen to want
10377 unnumbered results, the module
10378 \begin_inset Flex Code
10381 \begin_layout Plain Layout
10387 provides that option.
10390 \begin_layout Standard
10391 Note that these modules do not
10395 to be used with the AMS classes.
10396 It is perfectly possible to use the
10397 \begin_inset Flex Code
10400 \begin_layout Plain Layout
10406 module, and the others mentioned, with other classes, such as
10407 \begin_inset Flex Code
10410 \begin_layout Plain Layout
10417 \begin_inset Flex Code
10420 \begin_layout Plain Layout
10427 \begin_inset Flex Code
10430 \begin_layout Plain Layout
10439 \begin_layout Subsection
10440 What these layouts provide
10443 \begin_layout Standard
10444 There is a long list of included environments provided by these layouts.
10445 In AMS-\SpecialChar LaTeX
10446 , there is, in fact, an opportunity to define an unlimited variety
10447 of `theorem' environments.
10448 However, the AMS recommends the environments that are available in \SpecialChar LyX
10453 \begin_layout Standard
10454 The following environments—as well as the standard environments, such as
10456 \begin_inset Flex Noun
10459 \begin_layout Plain Layout
10466 \begin_inset Flex Noun
10469 \begin_layout Plain Layout
10476 \begin_inset Flex Noun
10479 \begin_layout Plain Layout
10486 \begin_inset Flex Noun
10489 \begin_layout Plain Layout
10496 \begin_inset Flex Noun
10499 \begin_layout Plain Layout
10506 \begin_inset Flex Code
10509 \begin_layout Plain Layout
10516 \begin_inset Flex Code
10519 \begin_layout Plain Layout
10528 \begin_layout Description
10529 Address This should be the author's permanent address.
10532 \begin_layout Description
10534 \begin_inset space ~
10537 Address This should be the author's temporary address at the time of submission,
10538 if different from the Address.
10541 \begin_layout Description
10542 Email Author's e-mail address
10545 \begin_layout Description
10546 URL Author's Web address, if desired.
10549 \begin_layout Description
10550 Keywords Key words or phrases used to identify specific topics discussed
10554 \begin_layout Description
10555 Subjectclass These refer to the AMS Subject Classifications, published and
10558 Mathematical Reviews
10561 These are also available online at the AMS cites listed above.
10564 \begin_layout Description
10568 \begin_layout Description
10572 \begin_layout Description
10576 \begin_layout Standard
10577 The following environments are provided by both the
10578 \begin_inset Flex Code
10581 \begin_layout Plain Layout
10588 \begin_inset Flex Code
10591 \begin_layout Plain Layout
10597 modules, in the latter case in both starred (unnumbered) and unstarred
10598 (numbered) versions.
10599 These same environments are provided only in the starred versions by the
10601 \begin_inset Flex Code
10604 \begin_layout Plain Layout
10613 \begin_layout Theorem
10614 This is typically used for the statements of major results.
10618 \begin_layout Corollary*
10619 This is used for statements which follow fairly directly from previous statement
10621 Again, these can be major results.
10625 \begin_layout Lemma
10626 These are smaller results needed to prove other statements.
10629 \begin_layout Proposition
10630 These are less major results which (hopefully) add to the general theory
10634 \begin_layout Conjecture
10635 These are statements provided without justification, which the author does
10636 not know how to prove, but which seem to be true (to the author, at least).
10639 \begin_layout Definition*
10640 Guess what this is for.
10641 The font is different for this environment than for the previous ones.
10645 \begin_layout Example*
10646 Used for examples illustrating proven results.
10649 \begin_layout Problem
10650 It's not really known what this is for.
10651 You should figure it out.
10654 \begin_layout Exercise*
10655 Write a description for this one.
10658 \begin_layout Remark
10659 This environment is also a type of theorem, usually a lesser sort of observation.
10662 \begin_layout Claim*
10663 Often used in the course of giving a proof of a larger result.
10667 Generally, these are used to break up long arguments, using specific instances
10673 The numbering scheme for cases is on its own, not together with other numbered
10678 \begin_layout Proof
10679 At the end of this environment, a QED symbol (usually a square, but it can
10680 vary with different styles) is placed.
10681 If you want to have other environments within this one—for example, Case
10682 environments—and have the QED symbol appear only after them, then the other
10683 environments need to be nested within the proof environment.
10686 Nesting Environments
10692 for information on nesting.
10695 \begin_layout Standard
10696 And these environments are provided by
10697 \begin_inset Flex Code
10700 \begin_layout Plain Layout
10701 Theorems (AMS-Extended)
10709 \begin_layout Criterion*
10710 A required condition.
10713 \begin_layout Algorithm*
10714 A general procedure to be used.
10717 \begin_layout Axiom*
10718 This is a property or statement taken as true within the system being discussed.
10721 \begin_layout Condition*
10722 Sometimes used to state a condition assumed within the present context of
10726 \begin_layout Note*
10727 Similar to a Remark.
10730 \begin_layout Notation*
10731 Used for the explanation of, yes, notation.
10734 \begin_layout Summary
10735 Do we really need to tell you?
10738 \begin_layout Acknowledgement*
10742 \begin_layout Conclusion*
10743 Sometimes used at the end of a long train of argument.
10747 Used in a way similar to Proposition, though perhaps lower on the scale.
10750 \begin_layout Standard
10751 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
10754 They need to be available on your system in order to use these environments.
10757 \begin_layout Section
10761 \begin_layout Standard
10767 \begin_layout Subsection
10771 \begin_layout Standard
10772 Broadway is for writing plays.
10773 The format is more decorative than Hollywood, and much less standardized.
10774 This format should be suitable for workshops.
10777 \begin_layout Subsection
10781 \begin_layout Standard
10782 The same as in Hollywood.
10785 \begin_layout Subsection
10789 \begin_layout Standard
10794 names as labels then cross-reference the label to insert the name.
10795 The cross-reference dialog will show the current cast of characters.
10798 \begin_layout Subsection
10799 Paper size and Margins
10802 \begin_layout Standard
10803 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
10806 \begin_layout Subsection
10810 \begin_layout Standard
10811 The following environments are available.
10812 You can use broadway.bind to get the bind keys shown at the right.
10815 \begin_layout Itemize
10819 \begin_inset Newline newline
10824 You should not have to use this, but it is here for anything that does not
10828 \begin_layout Itemize
10832 \begin_inset space \hfill{}
10836 \begin_inset Newline newline
10841 Used to describe stage setting and the action.
10842 First use of speaker names in all CAPs.
10845 \begin_layout Itemize
10849 \begin_inset space \hfill{}
10853 \begin_inset Newline newline
10858 Automatically numbered.
10859 On screen it will be arabic, but will print as Roman.
10862 \begin_layout Itemize
10866 \begin_inset space \hfill{}
10870 \begin_inset Newline newline
10880 It is just centered text.
10883 \begin_layout Itemize
10887 \begin_inset space \hfill{}
10891 \begin_inset Newline newline
10896 Not automatically numbered.
10897 You supply the number.
10898 This is because I couldn't figure out how.
10901 \begin_layout Itemize
10905 \begin_inset space \hfill{}
10909 \begin_inset Newline newline
10914 A special case of Narrative to describe the setting and action as the curtain
10918 \begin_layout Itemize
10922 \begin_inset space \hfill{}
10926 \begin_inset Newline newline
10931 The speaker's (actor's) title, centered in all CAPS.
10934 \begin_layout Itemize
10938 \begin_inset space \hfill{}
10942 \begin_inset Newline newline
10947 Instructions to the speaker.
10948 The parentheses are automatically inserted.
10949 The ( will appear on screen, but both will be in the printed play.
10950 This environment is only used within
10957 \begin_layout Itemize
10961 \begin_inset space \hfill{}
10965 \begin_inset Newline newline
10970 What the Speaker says.
10973 \begin_layout Itemize
10977 \begin_inset space \hfill{}
10981 \begin_inset Newline newline
10986 The curtain comes down.
10989 \begin_layout Itemize
10993 \begin_inset space \hfill{}
10999 \begin_layout Itemize
11003 \begin_inset space \hfill{}
11009 \begin_layout Itemize
11013 \begin_inset space \hfill{}
11019 \begin_layout Standard
11023 \begin_layout Section
11027 \begin_layout Standard
11032 can be used to type letters according to German conventions.
11033 A template file is included in
11035 .../lyx/share/templates
11037 for you to use as a starting point.
11040 \begin_layout Section
11044 \begin_layout Standard
11045 See the \SpecialChar LyX
11051 It contains all infos you need.
11054 \begin_layout Section
11057 Foil\SpecialChar TeX
11061 \begin_inset CommandInset label
11070 \begin_layout Standard
11076 \begin_layout Subsection
11080 \begin_layout Standard
11081 This section describes how to use \SpecialChar LyX
11082 to make slides for overhead projectors.
11083 There are two document classes that can do this: the default slides class
11086 Foil\SpecialChar TeX
11090 This section documents the latter.
11093 \begin_layout Standard
11094 I'm going to say this again, nice and clear, so that there's no misunderstanding
11098 \begin_layout Standard
11099 \begin_inset VSpace bigskip
11105 \begin_layout Standard
11109 This section documents the class
11110 \begin_inset Quotes eld
11118 \begin_inset Quotes erd
11126 \begin_layout Standard
11127 \begin_inset VSpace bigskip
11133 \begin_layout Standard
11134 If you're looking for the documentation for
11135 \begin_inset Quotes eld
11143 \begin_inset Quotes erd
11146 , check out section
11147 \begin_inset space ~
11151 \begin_inset CommandInset ref
11153 reference "sec:slitex"
11158 If your machine doesn't have the
11166 installed, you'll probably have to use the default
11170 class, which isn't quite as good as
11175 \begin_layout Standard
11180 class is designed for use with version
11181 \begin_inset space ~
11189 class file which is now an integral part of \SpecialChar LaTeX2e
11193 \begin_layout Subsection
11197 \begin_layout Standard
11198 Obviously, to use this document class, you need to select
11209 \begin_inset space ~
11215 There are some settings in the
11218 \begin_inset space ~
11223 dialog that you should know about that are specific to this class:
11226 \begin_layout Itemize
11227 Don't change the options
11238 \begin_inset space ~
11244 They're ignored by the
11251 \begin_layout Itemize
11252 The default font size is 20
11253 \begin_inset space \thinspace{}
11256 pt with the other options being 17
11257 \begin_inset space \thinspace{}
11261 \begin_inset space \thinspace{}
11265 \begin_inset space \thinspace{}
11271 \begin_layout Itemize
11272 The default font is
11280 but all math equations are still typeset in the usual roman font.
11283 \begin_layout Itemize
11286 Foil\SpecialChar TeX
11289 supports A4 and Letter paper sizes as well as a special size for working
11291 \begin_inset space \thinspace{}
11295 It doesn't support A5, B5, legal or executive paper sizes.
11298 \begin_layout Itemize
11299 Don't bother changing the
11303 settings because they are ignored anyway.
11304 All floats appear where they are defined in the text.
11307 \begin_layout Itemize
11312 setting behaves a bit differently for this class.
11315 Foil\SpecialChar TeX
11318 provides extensive footer and header capabilities including a user-defined
11321 \begin_inset space ~
11325 \begin_inset CommandInset ref
11327 reference "sec:foilfoot"
11332 The title page is treated differently to all other pages in the document
11341 has the logo centered at the bottom of the page (if one is defined).
11342 The possible page style choices and what they do are as follows:
11346 \begin_layout Labeling
11347 \labelwidthstring MMMMMMM
11354 The final output contains no page numbers, or other headers or footers
11355 (except footnotes of course).
11359 \begin_layout Labeling
11360 \labelwidthstring MMMMMMM
11367 The final output contains page numbers centered at the bottom of the page.
11368 No other headings or footers (other than footnotes).
11371 \begin_layout Labeling
11372 \labelwidthstring MMMMMMM
11377 Page numbers in lower right corner.
11378 Additional headers and footers are also shown.
11379 This is also the default.
11382 \begin_layout Labeling
11383 \labelwidthstring MMMMMMM
11388 Gives you access to the
11392 package although its use with
11394 Foil\SpecialChar TeX
11397 is discouraged by the writer of the
11399 Foil\SpecialChar TeX
11402 package because of some potential page layout clashes.
11406 \begin_layout Subsubsection
11410 \begin_layout Standard
11411 The following options may be used in the extra class options in the
11413 Document\SpecialChar menuseparator
11419 \begin_layout Labeling
11420 \labelwidthstring MMMMMMx
11425 This sets up the page layout for 7.33
11426 \begin_inset space \thinspace{}
11430 \begin_inset space \thinspace{}
11433 in paper, which is about the same aspect ratio as a 35
11434 \begin_inset space \thinspace{}
11437 mm slide, making it a bit easier to work with this medium.
11440 \begin_layout Labeling
11441 \labelwidthstring MMMMMMx
11446 Places a rule across the page below the header on every page except the
11450 \begin_layout Labeling
11451 \labelwidthstring MMMMMMx
11456 Places a rule across the page above the footer on every page except the
11460 \begin_layout Labeling
11461 \labelwidthstring MMMMMMx
11466 This is automatically set each time you create a new
11473 Foil\SpecialChar TeX
11476 to use the dvips driver to rotate those pages that are set as landscape
11480 \begin_layout Labeling
11481 \labelwidthstring MMMMMMx
11486 Simply changes the page dimensions to those of a landscape page but doesn't
11488 Thus if you use this option you need to use an external program to rotate
11489 each page or feed your paper through your printer as landscape.
11490 Note that this option effectively reverses the roles of the
11498 environments (don't worry these are described in the next section).
11501 \begin_layout Labeling
11502 \labelwidthstring MMMMMMx
11507 Equation numbers on the left.
11510 \begin_layout Labeling
11511 \labelwidthstring MMMMMMx
11516 Flush-left equations.
11519 \begin_layout Subsection
11520 Supported Environments
11523 \begin_layout Standard
11524 Most of the environments commonly supported in other classes are also supported
11530 There are several additional environments provided by
11532 Foil\SpecialChar TeX
11535 as well as a couple added by \SpecialChar LyX
11537 The following environments are shared with other classes:
11540 \begin_layout Standard
11541 \begin_inset Flex Multiple Columns
11544 \begin_layout Itemize
11550 \begin_layout Itemize
11556 \begin_layout Itemize
11562 \begin_layout Itemize
11568 \begin_layout Itemize
11574 \begin_layout Itemize
11581 \begin_layout Itemize
11587 \begin_layout Itemize
11593 \begin_layout Itemize
11599 \begin_layout Itemize
11605 \begin_layout Itemize
11611 \begin_layout Itemize
11617 \begin_layout Itemize
11623 \begin_layout Itemize
11629 \begin_layout Itemize
11640 \begin_layout Standard
11641 That is, all the major environments apart from the sectioning environments.
11642 Since foils are essentially self-contained sections, with a title and body,
11645 Foil\SpecialChar TeX
11648 provides specific commands for starting new foils and these are:
11651 \begin_layout Itemize
11657 \begin_layout Itemize
11663 \begin_layout Standard
11665 also provides slightly modified versions of these two environments called:
11668 \begin_layout Itemize
11674 \begin_layout Itemize
11677 ShortRotatefoilhead
11680 \begin_layout Standard
11681 and the differences will be explained in the next section.
11684 \begin_layout Standard
11685 Since foils are often used in presenting ideas or new theorems and such
11688 Foil\SpecialChar TeX
11691 also provides a comprehensive box of goodies for presenting them:
11694 \begin_layout Standard
11695 \begin_inset Flex Multiple Columns
11698 \begin_layout Itemize
11704 \begin_layout Itemize
11710 \begin_layout Itemize
11716 \begin_layout Itemize
11722 \begin_layout Itemize
11728 \begin_layout Itemize
11734 \begin_layout Itemize
11740 \begin_layout Itemize
11746 \begin_layout Itemize
11752 \begin_layout Itemize
11758 \begin_layout Itemize
11769 \begin_layout Standard
11770 The starred versions are unnumbered while the unstarred versions are numbered.
11771 There are also two list environments added by \SpecialChar LyX
11775 \begin_layout Itemize
11781 \begin_layout Itemize
11787 \begin_layout Standard
11790 Foil\SpecialChar TeX
11793 provides some powerful header and footer capabilities that are best set
11794 in the preamble although they may be set at any point in a document.
11795 If you want to change these settings in your document the best place to
11796 do so is at the very top of a foil, i.
11797 \begin_inset space \thinspace{}
11803 \begin_inset space \space{}
11808 straight after the foilhead.
11811 \begin_layout Standard
11812 For this purpose, the following command styles are provided [
11819 \begin_layout Standard
11820 \begin_inset Flex Multiple Columns
11823 \begin_layout Itemize
11827 \begin_inset space ~
11833 \begin_layout Itemize
11839 \begin_layout Itemize
11843 \begin_inset space ~
11849 \begin_layout Itemize
11853 \begin_inset space ~
11859 \begin_layout Itemize
11863 \begin_inset space ~
11870 \begin_layout Plain Layout
11871 \begin_inset space ~
11883 \begin_layout Standard
11884 There are also a few commands provided by
11886 Foil\SpecialChar TeX
11889 that aren't directly supported by \SpecialChar LyX
11890 but I'll tell you what they do and how
11891 to use them in section
11892 \begin_inset space ~
11896 \begin_inset CommandInset ref
11898 reference "sec:unsuppfoils"
11905 \begin_layout Subsection
11906 Building a Set of Foils
11909 \begin_layout Standard
11910 This section will give a simple introduction to using the different environments
11911 to build a set of foils.
11912 If you want to see an example set of foils, take a look at the
11916 file you find in \SpecialChar LyX
11924 \begin_layout Subsubsection
11925 Give It a Title Page
11928 \begin_layout Standard
11929 Unlike other classes that provide
11949 creates the title on a page of its own.
11950 If you leave out the
11954 environment \SpecialChar LaTeX
11955 will substitute the current date (every time you regenerate
11959 \begin_layout Subsubsection
11963 \begin_layout Standard
11964 As I mentioned earlier, there are four ways of starting a new foil.
11965 For portrait foils you should use
11974 The difference between these two environments is the amount of space between
11975 the title of the foil (the foilhead) and the body of the foil.
11978 \begin_layout Standard
11979 Landscape foils are generated using the
11985 ShortRotatefoilhead
11988 Again the only difference is the spacing between foilhead and body.
11989 Both of the short versions have 0.5
11990 \begin_inset space ~
11993 inches less separation between the foilhead and the body.
11997 \begin_layout Standard
11998 One problem with the support for landscape foils is the requirement that
11999 you have to use the
12003 driver to generate the PostScript output otherwise the foils won't be rotated.
12004 It is possible to get landscape foils even if you haven't got the
12008 driver provided you can feed your foils sideways through your printer ;-)
12011 \begin_layout Subsubsection
12012 Theorems, Lemmas, Proofs and more
12015 \begin_layout Standard
12016 You can't have two of the same type of these environments directly following
12018 If you use a normal paragraph break, , you will just be extending the previous
12019 environment as if you had merged the two environments together.
12020 Rather than that, you need to insert a so-called separator.
12021 Please refer to the section entitled
12032 \begin_layout Subsubsection
12036 \begin_layout Standard
12037 You get all the commonly supported list styles found in other classes as
12038 well as two new ones.
12039 I'll only describe the new ones here.
12040 If you want to find out more about the other list environments check out
12046 If you intend to use itemized lists you might also want to read about the
12050 \begin_inset space ~
12054 \begin_inset space ~
12059 dialog described above in section
12060 \begin_inset space ~
12064 \begin_inset CommandInset ref
12066 reference "sec:bullet"
12073 \begin_layout Standard
12074 The two new list styles,
12082 , are designed to make it easier for you to create lists of do's and don'ts
12083 or right and wrong by providing dedicated environments that use a tick
12084 or a cross as the label of the list.
12085 These lists are in fact dedicated variants of the
12090 They do however require that you have the
12094 packages installed.
12097 \begin_layout Subsubsection
12101 \begin_layout Standard
12104 Foil\SpecialChar TeX
12107 redefines the floating tables and figures so that they appear exactly where
12108 they are in the text rather than pushing them to the top of the page or
12109 to some user specified location.
12110 In fact if you change the float placement settings they are simply ignored.
12113 \begin_layout Subsubsection
12114 Page Headers and Footers
12115 \begin_inset CommandInset label
12117 name "sec:foilfoot"
12124 \begin_layout Standard
12128 \begin_inset space ~
12137 are two commands used to control the left-footer text string.
12138 The first is meant to allow you to include a graphic logo on your foils
12140 \begin_inset Quotes eld
12145 Foil\SpecialChar TeX
12149 \begin_inset Quotes erd
12153 While the second is meant to provide a classification for the audience,
12157 \begin_inset space \thinspace{}
12163 \begin_inset space \space{}
12167 It is empty by default.
12170 \begin_layout Standard
12171 The remaining page corners can be filled by
12174 \begin_inset space ~
12179 (which defaults to page numbers),
12182 \begin_inset space ~
12190 \begin_inset space ~
12198 \begin_layout Subsection
12201 Foil\SpecialChar TeX
12205 \begin_inset CommandInset label
12207 name "sec:unsuppfoils"
12214 \begin_layout Standard
12215 All the commands mentioned below need to be set in a
12225 within another environment.
12228 \begin_layout Subsubsection
12232 \begin_layout Standard
12233 All lengths are adjusted using the
12256 should be replaced by the name given to the length you want to change and
12261 is the length value.
12262 All lengths should be specified in units of length such as inches (
12274 ) or relative to some document or font-based length such as
12284 \begin_layout Standard
12285 It's possible to change the spacing between a foilhead and the body of the
12286 foil by adjusting the length specified by
12293 For example, to make
12298 \begin_inset space \space{}
12301 in closer to their bodies put the following in the preamble:
12307 foilheadskip}{-0.5in}
12310 \begin_layout Standard
12311 The spacings around floats can be adjusted by setting these lengths:
12314 \begin_layout Labeling
12315 \labelwidthstring MMMMMMMMMMM
12322 Separation between the text and the top of the float
12325 \begin_layout Labeling
12326 \labelwidthstring MMMMMMMMMMM
12333 Separation between the float and the caption
12336 \begin_layout Labeling
12337 \labelwidthstring MMMMMMMMMMM
12344 Separation between the caption and the following text
12347 \begin_layout Labeling
12348 \labelwidthstring MMMMMMMMMMM
12355 You can make the captions narrower than the surrounding text by adjusting
12357 Best done relative to
12366 \begin_layout Standard
12367 There are also several title page related lengths that you may find useful
12368 if you have a long title or several authors:
12371 \begin_layout Labeling
12372 \labelwidthstring MMMMMMMMMMM
12379 Separation from headers to
12384 \begin_layout Labeling
12385 \labelwidthstring MMMMMMMMMMM
12403 \begin_layout Labeling
12404 \labelwidthstring MMMMMMMMMMM
12418 \begin_layout Labeling
12419 \labelwidthstring MMMMMMMMMMM
12435 \begin_layout Labeling
12436 \labelwidthstring MMMMMMMMMMM
12452 \begin_layout Standard
12453 The last length related command affects all the list environments.
12464 a list environment then all the vertical spacing between the list items
12466 Note that this is a command not a length so it doesn't require
12472 like the stuff mentioned above.
12475 \begin_layout Subsubsection
12476 Headers and Footers
12479 \begin_layout Standard
12492 commands control whether the logo in the
12496 definition appear on a given page.
12503 in the preamble then none of the foils will have the logo on them.
12504 If you don't want the logo on a particular page place the
12510 directly after the foilhead of that page and the
12516 directly after the next foilhead.
12519 \begin_layout Standard
12520 If you decide to use the
12524 page style setting in the
12527 \begin_inset space ~
12532 dialog you should probably add
12542 to your preamble so headers and footers on landscape pages are correctly
12543 placed when rotated.
12544 This is due to some clashes between the page layouts provided by the
12555 \begin_layout Section
12556 Hollywood (Hollywood spec scripts)
12559 \begin_layout Standard
12565 \begin_layout Subsection
12569 \begin_layout Standard
12570 Getting the format of a Hollywood script right is a
12571 \begin_inset Quotes eld
12575 \begin_inset Quotes erd
12578 It is designed to make the readers focus on content and to be easy and
12579 familiar for the actors to read.
12580 Each page of a script should be one minute of film.
12581 Nothing goes in a script that you cannot see or hear on screen.
12582 The courier 12 pt font should be used throughout.
12586 \begin_layout Subsection
12590 \begin_layout Standard
12591 Speakers' lines should NEVER break in mid-sentence.
12592 If a speaker's lines continue over a page break, repeat the
12596 title followed by (Cont'd).
12599 \begin_layout Subsection
12603 \begin_layout Standard
12608 names as labels then cross-reference the label to insert the name.
12609 The cross-reference dialog will show the current cast of characters.
12610 You can use this to insert the speaker name in narratives also.
12613 \begin_layout Subsection
12614 Paper size and Margins
12617 \begin_layout Standard
12618 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12621 \begin_layout Subsection
12625 \begin_layout Standard
12626 The following environments are available.
12627 You can use hollywood.bind to get the bind keys shown at the right.
12630 \begin_layout Itemize
12634 \begin_inset Newline newline
12639 Used where nothing else works.
12643 \begin_layout Itemize
12649 \begin_inset space \hfill{}
12657 \begin_inset Newline newline
12660 Usually followed by something like
12661 \begin_inset Quotes eld
12664 on Sally waking up.
12665 \begin_inset Quotes erd
12671 \begin_layout Itemize
12675 \begin_inset space \hfill{}
12679 \begin_inset Newline newline
12684 Introduces a new INTERIOR camera set-up.
12685 Always followed by DAY or NIGHT, or something similar to define the lighting
12687 Everthing on this line in CAPS.
12690 \begin_layout Itemize
12694 \begin_inset space \hfill{}
12698 \begin_inset Newline newline
12703 Introduces a new EXTERIOR camera set-up.
12704 Everthing on this line in CAPS.
12707 \begin_layout Itemize
12711 \begin_inset space \hfill{}
12715 \begin_inset Newline newline
12720 The character speaking.
12723 \begin_layout Itemize
12727 \begin_inset space \hfill{}
12731 \begin_inset Newline newline
12736 Instructions to the speaker.
12737 The () are automatically inserted.
12740 \begin_layout Itemize
12744 \begin_inset space \hfill{}
12748 \begin_inset Newline newline
12760 \begin_layout Itemize
12764 \begin_inset space \hfill{}
12768 \begin_inset Newline newline
12773 Camera movement instruction.
12775 \begin_inset space \thinspace{}
12779 \begin_inset space \space{}
12785 \begin_layout Itemize
12789 \begin_inset space \hfill{}
12795 \begin_layout Itemize
12799 \begin_inset space \hfill{}
12805 \begin_layout Itemize
12809 \begin_inset space \hfill{}
12815 \begin_layout Itemize
12819 \begin_inset space \hfill{}
12825 \begin_layout Subsection
12829 \begin_layout Itemize
12833 \begin_layout Itemize
12837 \begin_layout Itemize
12839 \begin_inset space \thinspace{}
12846 \begin_layout Itemize
12851 \begin_layout Itemize
12852 PAN — camera movement
12855 \begin_layout Itemize
12856 INSERT — cut to close-up of
12859 \begin_layout Section
12863 \begin_layout Standard
12866 Panayotis Papasotiriou
12869 \begin_layout Subsection
12873 \begin_layout Standard
12874 The ijmpc package is a set of macros that facilitates electronic manuscript
12877 International Journal of Modern Physics C
12880 Similarly, the ijmpd package is for creating manuscripts to be submitted
12883 International Journal of Modern Physics D
12886 Both journals are published by World Scientific.
12887 The corresponding document classes are named
12896 These files, together with instructions for the authors, can be downloaded
12898 \begin_inset Flex URL
12901 \begin_layout Plain Layout
12903 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
12909 \begin_inset Flex URL
12912 \begin_layout Plain Layout
12914 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
12920 Both packages are modified versions of the standard
12921 \begin_inset Quotes eld
12925 \begin_inset Quotes erd
12928 package, and they are almost (but not exactly) identical.
12929 Most of their features are supported by \SpecialChar LyX
12931 I have used \SpecialChar LyX
12932 successfully to write articles submitted to both journals
12933 without any problem.
12936 \begin_layout Subsection
12940 \begin_layout Standard
12941 As usual, the easiest way to write a paper is to start with a template.
12944 File\SpecialChar menuseparator
12960 This will give an (almost) empty document that includes the most common
12961 fields found in a manuscript.
12962 Simply overwrite the existing text (including the brackets,
12967 You should keep in mind the following remarks.
12970 \begin_layout Enumerate
12972 won't let you change the font size and the page style of the document,
12973 because such modifications are not allowed by both packages.
12976 \begin_layout Enumerate
12977 The language of the document should not be changed.
12978 Before previewing your paper, be sure that the babel package is not used.
12979 To do this, click on
12982 arg "dialog-show document"
12987 \SpecialChar menuseparator
12991 \begin_inset Quotes eld
12995 \begin_inset Quotes erd
13005 \begin_layout Enumerate
13007 \begin_inset Quotes eld
13011 \begin_inset Quotes erd
13014 style must be used to define keywords.
13017 \begin_layout Enumerate
13018 The ijmpc package provides a style named
13019 \begin_inset Quotes eld
13022 Classification Codes
13023 \begin_inset Quotes erd
13026 , which can be used to define classification codes, such as PACS numbers.
13027 Note that this facility is not supported by the ijmpd package.
13030 \begin_layout Enumerate
13031 Several new environments are available:
13032 \begin_inset Quotes eld
13036 \begin_inset Quotes erd
13040 \begin_inset Quotes eld
13044 \begin_inset Quotes erd
13048 \begin_inset Quotes eld
13052 \begin_inset Quotes erd
13056 \begin_inset Quotes eld
13060 \begin_inset Quotes erd
13064 \begin_inset Quotes eld
13068 \begin_inset Quotes erd
13072 \begin_inset Quotes eld
13076 \begin_inset Quotes erd
13080 \begin_inset Quotes eld
13084 \begin_inset Quotes erd
13088 \begin_inset Quotes eld
13092 \begin_inset Quotes erd
13096 \begin_inset Quotes eld
13100 \begin_inset Quotes erd
13104 \begin_inset Quotes eld
13108 \begin_inset Quotes erd
13112 \begin_inset Quotes eld
13116 \begin_inset Quotes erd
13120 \begin_inset Quotes eld
13124 \begin_inset Quotes erd
13128 \begin_inset Quotes eld
13132 \begin_inset Quotes erd
13136 \begin_inset Quotes eld
13140 \begin_inset Quotes erd
13144 Their use is more or less obvious.
13146 supports all these environments; it will use the proper label, text style,
13147 and numbering scheme for each of them.
13150 \begin_layout Enumerate
13151 Both packages use basic citations; the natbib package should not be used.
13152 In \SpecialChar LyX
13153 , citation references are shown as usual; in the output, citations are
13154 shown as superscripts.
13155 If you want to use a citation as normal text, you should use the
13160 \begin_inset space \thinspace{}
13164 \begin_inset space \space{}
13168 \begin_inset Quotes eld
13172 \begin_inset space \space{}
13182 \begin_inset Quotes erd
13188 \begin_layout Enumerate
13190 \begin_inset Quotes eld
13194 \begin_inset Quotes erd
13197 section in both packages.
13198 To put acknowledgments, just use the
13199 \begin_inset Quotes eld
13203 \begin_inset Quotes erd
13209 \begin_layout Enumerate
13210 Appendices may be added to the paper,
13214 the Acknowledgments and
13220 provides a special environment, called
13221 \begin_inset Quotes eld
13225 \begin_inset Quotes erd
13228 which marks the beginning of the appendices.
13229 This environment should be left blank; it just sends a \SpecialChar LaTeX
13230 command, but nothing
13232 In \SpecialChar LyX
13234 \begin_inset Quotes eld
13238 \begin_inset Quotes erd
13241 is printed with blue letters, as a signal that all sections after that
13242 point are appendices.
13243 To write an appendix, use the
13244 \begin_inset Quotes eld
13248 \begin_inset Quotes erd
13253 will number each appendix with capital letters, as required by both journals.
13255 \begin_inset Quotes eld
13259 \begin_inset Quotes erd
13266 be present before the first appendix; if not, all appendices will be numbered
13267 as normal sections in the output.
13270 \begin_layout Enumerate
13271 The ijmpc and the ijmpd packages use the
13275 command to implement table captions.
13276 As a result, a table created by \SpecialChar LyX
13277 is printed correctly, but its caption
13279 However, you can use some \SpecialChar TeX
13280 code to overcome this problem, so that captions
13281 are printed as expected.
13282 To do so, create a float table as usual, remove the caption, and replace
13283 it with the \SpecialChar TeX
13294 (sic); you must also the \SpecialChar TeX
13299 immediately after the tabular material.
13300 Study the example table included in the template files to see how this
13301 trick is implemented.
13302 Alternatively, If you need table captions, you should implement the whole
13307 file, then include this file to the \SpecialChar LyX
13310 Insert\SpecialChar menuseparator
13311 File\SpecialChar menuseparator
13313 \begin_inset space ~
13319 Details on how to create a table float can be found in the files
13327 , included in the corresponding packages.
13330 \begin_layout Subsection
13331 Preparing a paper for submission
13334 \begin_layout Standard
13335 Before you submit your paper you must export the \SpecialChar LyX
13336 document as a \SpecialChar LaTeX
13339 File\SpecialChar menuseparator
13340 Export\SpecialChar menuseparator
13348 \begin_layout Plain Layout
13349 Actually you have the choice between \SpecialChar LaTeX
13350 (plain) and pdflatex.
13351 If you intend to use pdflatex to prepare the paper, you should use the
13352 pdflatex option so that included graphics are converted to PDF format,
13353 ready for use by pdflatex.
13358 , then make the following changes to the resulting
13365 \begin_layout Enumerate
13366 Remove the comment lines before the
13375 \begin_layout Enumerate
13376 Remove everything between (and including) the
13388 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13392 \begin_layout Standard
13397 file should be saved and processed through \SpecialChar LaTeX
13398 as many times as necessary.
13399 You may also want to check the resulting
13406 \begin_layout Section
13410 \begin_layout Standard
13416 \begin_layout Subsection
13420 \begin_layout Standard
13421 The iopart package provides a document class to create electronic manuscript
13422 submission to the journals published by the Institute of Physics.
13423 Instructions for the authors how to create a paper using the iopart class
13424 can be downloaded together with the iopart package from the site
13425 \begin_inset Flex URL
13428 \begin_layout Plain Layout
13430 ftp://ftp.iop.org/pub/journals/latex2e
13438 \begin_layout Subsection
13442 \begin_layout Standard
13443 The easiest way to write a paper is to start with the template
13447 that is available via
13449 File\SpecialChar menuseparator
13452 The template explains how to use the special text environments.
13453 Here are the most important advices:
13456 \begin_layout Itemize
13457 To be able to compile your document to a PDF, PS, or DVI, ensure that the
13458 no AMS packages are loaded in
13460 Document\SpecialChar menuseparator
13461 Settings\SpecialChar menuseparator
13467 \begin_layout Itemize
13470 The title environment defines the kind of your paper.
13471 So use one of the following environments for the title:
13475 \begin_layout Itemize
13484 \begin_layout Itemize
13493 \begin_layout Itemize
13499 for a Topical review
13502 \begin_layout Itemize
13511 \begin_layout Itemize
13520 \begin_layout Itemize
13526 for a Paper (same as Title)
13529 \begin_layout Itemize
13535 for a Preliminary communication
13538 \begin_layout Itemize
13544 for a Rapid communication
13547 \begin_layout Itemize
13553 for a Letter to the editor
13557 \begin_layout Itemize
13560 All title environments except of
13564 can have an optional short title.
13567 \begin_layout Itemize
13568 There is a general title environment
13572 which is not directly supported by \SpecialChar LyX
13574 This can be used as \SpecialChar TeX
13575 code when your document doesn't fit into one of the
13579 \begin_layout Standard
13580 For more informations like hints for special table and formula formatting,
13581 look at the IOP author guidelines.
13584 \begin_layout Section
13588 \begin_layout Standard
13591 Panayotis Papasotiriou
13594 \begin_layout Subsection
13598 \begin_layout Standard
13599 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
13600 that facilitates electronic manuscript submission to the journals they
13602 Most known of them (at least in my domain of interest) are
13604 Astrophysics and Space Science
13610 , but there are many others (see a complete list at
13611 \begin_inset Flex URL
13614 \begin_layout Plain Layout
13616 http://www.wkap.nl/jrnllist.htm/JRNLHOME
13622 The Kluwer package may be downloaded from the site
13623 \begin_inset Flex URL
13626 \begin_layout Plain Layout
13628 http://www.wkap.nl/kaphtml.htm/STYLEFILES
13634 A complete user guide is contained in that package (but it can also be
13635 downloaded separately).
13638 \begin_layout Standard
13640 supports many features of the package but not everything.
13641 However, the \SpecialChar TeX
13642 code needed is reduced to some
13643 \begin_inset Quotes eld
13647 \begin_inset Quotes erd
13650 commands of the package (see
13651 \begin_inset space ~
13655 \begin_inset CommandInset ref
13657 reference "subsec:kluwer_peculiarities"
13662 I have recently used \SpecialChar LyX
13663 to write an article submitted to the
13665 Astrophysics and Space Science
13667 without any problem.
13670 \begin_layout Subsection
13674 \begin_layout Standard
13675 The easiest way to write a paper is to start with the Kluwer template file.
13678 File\SpecialChar menuseparator
13690 This will give an (almost) empty document that includes the most common
13691 fields found in a manuscript and a short description of their use.
13692 As in most templates, simply overwrite the existing text (including the
13697 ) with the correct information.
13700 \begin_layout Subsection
13701 Preparing a paper for submission
13704 \begin_layout Standard
13705 As in the AAS\SpecialChar TeX
13706 package, before you submit your paper to a journal you must
13708 \begin_inset Quotes eld
13712 \begin_inset Quotes erd
13718 \begin_layout Enumerate
13719 Export your paper as a \SpecialChar LaTeX
13721 To do this, click on
13723 File\SpecialChar menuseparator
13724 Export\SpecialChar menuseparator
13732 \begin_layout Enumerate
13737 file with a text editor and make the following changes
13741 \begin_layout Enumerate
13742 remove the comment lines before the
13751 \begin_layout Enumerate
13752 remove everything between (and including) the
13764 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13768 \begin_layout Standard
13777 \begin_layout Enumerate
13782 file through \SpecialChar LaTeX
13783 as many times as necessary (usually up to three).
13786 \begin_layout Enumerate
13792 \begin_inset space \thinspace{}
13796 \begin_inset space \space{}
13803 , and check if everything is OK (it should, if you didn't make any mistake).
13806 \begin_layout Subsection
13807 \begin_inset Quotes eld
13811 \begin_inset Quotes erd
13814 of the Kluwer package
13815 \begin_inset CommandInset label
13817 name "subsec:kluwer_peculiarities"
13824 \begin_layout Standard
13825 The Kluwer package has the following
13826 \begin_inset Quotes eld
13830 \begin_inset Quotes erd
13836 \begin_layout Enumerate
13837 It is possible to write multiple articles in the same \SpecialChar LaTeX
13842 \begin_layout Plain Layout
13843 I can't imagine any good reason to do this.
13849 Each article must be included in the environment
13850 \begin_inset Quotes eld
13854 \begin_inset Quotes erd
13858 Unfortunately, this environment cannot be omitted, even if you write just
13860 Therefore, each article starts with the command
13866 and, obviously, ends with the command
13873 Although this can be implemented in \SpecialChar LyX
13874 , I didn't included it, since it looks
13875 ugly and can confuse the novice user.
13876 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
13879 \begin_inset Quotes eld
13884 \begin_inset Quotes erd
13890 \begin_layout Enumerate
13891 Information given at the beginning of the article (i.
13892 \begin_inset space \thinspace{}
13896 \begin_inset space \space{}
13899 title, subtitle, author, institution, running title, running author, abstract
13900 and keywords) must be included in an environment called
13901 \begin_inset Quotes eld
13905 \begin_inset Quotes erd
13909 This is not implemented in \SpecialChar LyX
13910 , so you must enter title, subtitle etc.
13911 \begin_inset space ~
13914 between two \SpecialChar TeX
13930 \begin_layout Enumerate
13931 According to the user manual, the label of each bibliography item must be
13955 \begin_layout Standard
13960 template takes care of all these
13961 \begin_inset Quotes eld
13965 \begin_inset Quotes erd
13969 If you start a new paper using this template you don't need to do anything
13974 \begin_layout Enumerate
13975 don't delete the \SpecialChar TeX
13976 code included in the template, and
13979 \begin_layout Enumerate
13980 copy the example bibliography item included in the template and modify it
13981 as necessary to enter new bibliography items.
13984 \begin_layout Section
13988 \begin_layout Standard
13994 \begin_layout Subsection
13998 \begin_layout Standard
13999 The \SpecialChar LyX
14002 article (koma-script)
14006 report (koma-script)
14024 correspond to the \SpecialChar LaTeX
14042 \begin_inset space ~
14045 of the Koma-Script family.
14046 They are replacements for the standard document classes
14062 , resp., and fit better to European typography conventions in a number of
14066 \begin_layout Itemize
14067 Standard character size is 11pt in
14069 article (koma-script)
14073 report (koma-script)
14081 letter (koma-script)
14086 \begin_layout Itemize
14087 Headings, labels of the description environment, and a number of elements
14090 letter (koma-script)
14092 document class are set in a bold sans serif font.
14096 \begin_layout Plain Layout
14097 There is a big difference between the bold sans serif old cm fonts and new
14098 ec fonts, especially in the appearance of headings.
14099 In comparison, the ec bold sans serif fonts look a bit thin.
14100 Here the \SpecialChar LaTeX
14109 helps to produce the
14110 \begin_inset Quotes eld
14114 \begin_inset Quotes erd
14117 appearance when using the ec fonts.
14122 The numbering of chapter headings is made in the same way as the numbering
14123 of section headings, that is without the extra line
14124 \begin_inset Quotes eld
14127 Chapter\SpecialChar ldots
14129 \begin_inset Quotes erd
14133 In addition, the appearance of the headings can be modified by using a
14134 number of options (in \SpecialChar LyX
14135 to be entered in the field
14138 \begin_inset space ~
14145 Layout\SpecialChar menuseparator
14152 \begin_layout Itemize
14153 The main means in the Koma-Script document classes to design the type area
14162 (in \SpecialChar LyX
14163 to be entered in the extra class options field in the dialog
14165 Document\SpecialChar menuseparator
14169 They make a clearer modification of page margins possible as do the options
14172 Document\SpecialChar menuseparator
14179 \begin_layout Itemize
14180 The \SpecialChar LaTeX
14181 document classes of the Koma-Script family define a number of additional
14183 Those part of it which makes sense in \SpecialChar LyX
14184 is implemented in corresponding
14188 \begin_layout Standard
14189 Detailed descriptions of the \SpecialChar LaTeX
14190 document classes of the Koma-Script family
14191 can be found in the Koma-Script documentation
14202 \begin_layout Subsection
14203 article (koma-script), report (koma-script), and book (koma-script)
14206 \begin_layout Standard
14207 The document classes
14209 article (koma-script)
14213 report (koma-script)
14223 are implemented in the layout files
14236 They contain all the paragraph types of the corresponding standard document
14249 , resp., partly modified, with the exception of the \SpecialChar LyX
14254 -type, which is replaced by the new
14258 -type having the same functionality.
14263 -Type there is a number of new paragraph types added.
14270 letter (koma-script)
14275 \begin_layout Itemize
14284 : are equivalents to
14292 , resp., additionally inserting an entry in the table of contents.
14301 are not contained in
14303 article (koma-script)
14308 \begin_layout Itemize
14317 : behave exactly as
14325 , resp., additionally clearing running heads.
14330 is not contained in
14332 article (koma-script)
14338 \begin_layout Plain Layout
14351 report (koma-script)
14353 , but since this is identical to
14357 , is has not been implemented in \SpecialChar LyX
14366 \begin_layout Itemize
14371 : generates a heading directly above the following paragraph in the standard
14372 character size without affecting the structure of the document.
14375 \begin_layout Itemize
14384 are special captions which respect the different space settings needed
14385 for captions placed above or below an element (if you follow strict typographic
14386 rules, you might want to place table captions always above the table).
14387 You can also use the class option
14391 , which will switch
14404 You need at least Koma-Script version 2.8q to use this.
14407 \begin_layout Itemize
14412 : can be used to set a bonmot, e.
14413 \begin_inset space \thinspace{}
14417 \begin_inset space \space{}
14420 at the beginning of a chapter.
14421 If you use the optional argument (
14423 Insert\SpecialChar menuseparator
14425 \begin_inset space ~
14430 ), you can insert the dictum's author there.
14431 Dictum and author are separated by a line.
14432 You need at least Koma-Script version 2.8q to use this.
14437 is not contained in
14439 article (koma-script)
14444 \begin_layout Standard
14445 The following types, together with the standard types
14457 , form the title area of the document.
14458 They must be entered ahead of the first
14459 \begin_inset Quotes eld
14463 \begin_inset Quotes erd
14470 \begin_layout Plain Layout
14471 The corresponding \SpecialChar LaTeX
14472 commands must appear before the
14483 When such a type is used more than once, the latter usage overwrites the
14484 former one, that means, for every type only the latest usage is valid.
14485 The order of the different types however has, like
14497 , no effect on the appearance of the produced document.
14500 \begin_layout Itemize
14505 : produces a centered paragraph above the ordinary title (
14517 ) for the subject of the document.
14520 \begin_layout Itemize
14525 : produces a centered paragraph below the ordinary title (
14537 ) for the publishers' name.
14540 \begin_layout Itemize
14547 report (koma-script)
14553 produces a centered paragraph on its own page behind the title page, or
14556 article (koma-script)
14558 produces a centered paragraph below the ordinary title (
14574 ) for a dedication.
14577 \begin_layout Itemize
14582 : produces a left aligned paragraph above the ordinary title (
14598 ) for a document`s head.
14601 \begin_layout Itemize
14606 : produces in a double-sided print in
14608 report (koma-script)
14614 a left-aligned paragraph at the top of the title page`s back or has no
14615 effect in a single-sided print or in
14617 article (koma-script)
14622 \begin_layout Itemize
14627 : produces in a double-sided print in
14629 report (koma-script)
14635 a left-aligned paragraph at the bottom of the title page`s back or has
14636 no effect in a single-sided print or in
14638 article (koma-script)
14643 \begin_layout Itemize
14648 : produces a special
14649 \begin_inset Quotes eld
14653 \begin_inset Quotes erd
14656 page ahead of the actual document containing a paragraph without special
14660 \begin_layout Standard
14661 The layout files for the document classes
14663 article (koma-script)
14667 report (koma-script)
14673 do include the file
14678 This is thought of as a place to define your own types.
14683 in your personal layout directory and edit the file!
14686 \begin_layout Subsection
14687 letter (koma-script)
14690 \begin_layout Description
14691 Note: This section discusses the obsolete
14693 KOMA-Script-Letter (v.
14694 \begin_inset space ~
14699 , which is not even included anymore in recent KOMA releases.
14700 Please refer to the next section for the current KOMA-Script-Letter class
14702 \begin_inset space ~
14708 \begin_layout Standard
14712 letter (koma-script)
14714 is implemented in the layout file
14719 It contains all the paragraph types of the corresponding standard document
14724 , partly modified, with the exception of the \SpecialChar LyX
14738 type, which is replaced by the new
14743 In addition, it contains, in contrast to the standard document class, the
14762 Furthermore, there are a number of new letter specific types.
14765 \begin_layout Standard
14766 The appearance of the letter produced by this document class can be controlled
14767 by a number of \SpecialChar LaTeX
14768 commands, which you can put in the \SpecialChar LaTeX
14773 \begin_layout Plain Layout
14774 For example, the standard appearance of the letter`s heading, consisting
14775 of name and address, is quite self-willed.
14777 \begin_inset Quotes eld
14781 \begin_inset Quotes erd
14784 heading is produced by the following \SpecialChar LaTeX
14785 commands in the preamble:
14788 \begin_layout LyX-Code
14798 \begin_layout LyX-Code
14814 \begin_layout LyX-Code
14824 \begin_layout LyX-Code
14844 A detailed German description of such \SpecialChar LaTeX
14845 commands can be found in the Koma-Script
14851 With it, the letter's author can produce his personal letter layout.
14854 \begin_layout Standard
14863 define the beginning of the letter and must be used in every letter.
14864 To emphasize them in the \SpecialChar LyX
14865 document class, they are marked with the letter
14875 \begin_inset space ~
14878 in the left margin.
14879 It is possible to write any number of letters in one file.
14884 type produces a new letter using the same addressee and a
14888 type produces a new addressee.
14905 are ordinary paragraph types and can also be used several times in one
14906 and the same letter.
14909 \begin_layout Itemize
14914 : produces a paragraph for the addressee and implicitly defines the beginning
14918 \begin_layout Itemize
14923 : produces a paragraph for the form of address and implicitly produces a
14927 \begin_layout Itemize
14932 : produces a paragraph for a close.
14935 \begin_layout Itemize
14940 : produces a paragraph for a postscript.
14943 \begin_layout Itemize
14948 : produces a paragraph for a distribution list.
14951 \begin_layout Itemize
14956 : produces a paragraph for enclosures.
14959 \begin_layout Standard
15000 are input types provided with a label to enter information, which will
15001 be processed by the document class.
15005 \begin_layout Plain Layout
15006 It could be seen as a matter of inconsequence, that the types
15014 described above are not such input types as well.
15015 Because of the special meaning of those types, however, I have implemented
15016 them as ordinary paragraph types with a one letter mark in the left margin.
15017 Moreover, it would affect my feeling of symmetry, if the
15025 type had such a serious different appearance.
15030 The types must be used ahead of the corresponding
15037 \begin_layout Standard
15038 An implementation of these types in a WYSIWYG fashion does not seem to make
15039 sense, because the real appearance of the produced letter does not only
15040 depend on the usage of the particular type, but also on other factors.
15041 For example, a signature entered in the
15045 type will in the standard behavior appear in the produced letter only,
15046 when in the same letter also a
15051 The entered value of the
15055 type will in the standard behavior not appear in the produced letter at
15057 The possibility to design the letter`s heading freely is already indicated
15058 in a footnote above.
15061 \begin_layout Standard
15062 The input types can also be used as empty paragraphs.
15063 This makes sense e.
15064 \begin_inset space \thinspace{}
15068 \begin_inset space \space{}
15080 type is not used at all, in the standard behavior the value of the
15084 type is used as signature, whereas if an empty
15088 type is used, no signature value is defined.
15091 \begin_layout Standard
15092 By using the input types it is possible to write a letter template, containing
15093 filled input types with your personal dates (name, address, etc.) and empty
15094 input types for other dates you want to enter.
15097 \begin_layout Itemize
15102 : sender's name, in the standard behavior appears as a centered paragraph
15103 in small caps in the letter`s heading.
15106 \begin_layout Itemize
15111 : sender's signature, in the standard behavior appears below the
15120 type is used, the value of the
15124 type appears instead.
15127 \begin_layout Itemize
15132 : sender's address, in the standard behavior appears in a centered paragraph
15133 in the letter`s heading below the sender's name.
15136 \begin_layout Itemize
15141 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
15152 \begin_layout Itemize
15157 : place of the letter`s making.
15160 \begin_layout Itemize
15165 : date of the letter`s making.
15174 , in the standard behavior, produce the place and the date in a right-aligned
15175 line below the addressee's field.
15180 type is used, neither place nor date appear, independent of the value of
15190 type is used, the date of the letter `s production is used.
15193 \begin_layout Itemize
15198 : sender`s back address, in the standard behavior appears above the addressee's
15199 field in a small sans serif font.
15202 \begin_layout Itemize
15207 : special mail information, in the standard behavior appears underlined
15208 above the addressee's field below the back address.
15211 \begin_layout Itemize
15216 : additional information, in the standard behavior appears on right side
15217 below the addressee`s field.
15220 \begin_layout Itemize
15225 : the letter's title, in the standard behavior appears in a big, bold, sans
15226 serif font above the subject.
15229 \begin_layout Itemize
15234 : the letter's subject, in the standard behavior appears in a bold font
15242 \begin_layout Standard
15263 produce a business letter like line above the
15267 line containing the fields
15268 \begin_inset Quotes eld
15272 \begin_inset Quotes erd
15276 \begin_inset Quotes eld
15280 \begin_inset Quotes erd
15284 \begin_inset Quotes eld
15288 \begin_inset Quotes erd
15292 \begin_inset Quotes eld
15296 \begin_inset Quotes erd
15300 \begin_inset Quotes eld
15304 \begin_inset Quotes erd
15308 \begin_inset Quotes eld
15312 \begin_inset Quotes erd
15316 For the date field, the value of the
15322 \begin_inset Quotes eld
15325 business letter types
15326 \begin_inset Quotes erd
15329 is used, the value of the
15333 type however does not appear, but only the \SpecialChar LaTeX
15341 The ordinary output of place and date in a right-aligned line below the
15342 addressee`s field is suppressed.
15343 The types are implemented as input types provided with a label and must
15344 be used ahead of the corresponding
15351 \begin_layout Itemize
15359 \begin_layout Itemize
15367 \begin_layout Itemize
15375 \begin_layout Itemize
15383 \begin_layout Itemize
15391 \begin_layout Subsection
15392 The new letter class: letter (koma-script v.2)
15395 \begin_layout Standard
15401 \begin_layout Standard
15402 \begin_inset VSpace medskip
15408 \begin_layout Standard
15410 Koma-Script version 2.8 has introduced a new letter class
15414 which supersedes the now unsupported
15419 It has — on the \SpecialChar LaTeX
15420 side — a completely new interface and is not compatible
15421 with the old class.
15422 Therefore, \SpecialChar LyX
15423 supports both, though it is recommended you use the new class.
15426 \begin_layout Standard
15427 This class covers the same functionality as
15429 letter (koma-script),
15432 The basic items are
15436 (receiver's address, same as
15440 in the old layout),
15453 will start a new letter (i.
15454 \begin_inset space \thinspace{}
15458 \begin_inset space \space{}
15461 you can write several letters per document).
15462 New elements are sender's
15478 and the possibility to use a
15484 Insert\SpecialChar menuseparator
15490 \begin_layout Standard
15491 The biggest improvement is, though, that the letter's layout is configurable
15492 to meet almost any needs.
15493 This can be done via the preamble or with a special style file (Letter
15494 Class Option, extension
15498 ), that will be read in as a class option.
15502 \begin_layout Plain Layout
15503 The KOMA package comes with some default
15508 There is, for instance, a
15512 file that follows german typesetting rules, or a
15516 that provides the default layout of the old
15521 The latter can be loaded with the class option
15527 Layout\SpecialChar menuseparator
15528 Document\SpecialChar menuseparator
15540 template that is included in \SpecialChar LyX
15542 A detailed description is to be found in the Koma-Script documentation
15550 \begin_layout Subsection
15554 \begin_layout Standard
15555 Visualizing the Koma-Script document classes in \SpecialChar LyX
15556 , the \SpecialChar LyX
15557 internals cause some
15561 \begin_layout Itemize
15562 The chapter number of a
15566 type appears on a line of its own above the chapter heading instead of
15567 appearing in the same line ahead of it.
15568 The cause for that is the \SpecialChar LyX
15569 internal behavior for the labeltype
15573 in the layout file.
15576 \begin_layout Itemize
15577 The headings of the types
15585 are only put in the
15586 \begin_inset Quotes eld
15590 \begin_inset Quotes erd
15594 table of contents, but not in the \SpecialChar LyX
15595 table of contents (
15597 Document\SpecialChar menuseparator
15599 \begin_inset space ~
15603 \begin_inset space ~
15611 \begin_layout Itemize
15612 The paragraphs in a
15616 document class appear in a skip separation mode, not indented.
15617 This is the standard behavior, no special \SpecialChar LaTeX
15618 commands are needed for that.
15621 Document\SpecialChar menuseparator
15624 dialog the corresponding radio button indicates
15633 value always has the effect that extra \SpecialChar LaTeX
15634 commands are inserted in the document
15635 to produce the gap, which is not what is wanted in this case.
15638 \begin_layout Section
15642 \begin_layout Standard
15648 \begin_layout Subsection
15652 \begin_layout Standard
15653 Memoir is a very powerful and constantly evolving class.
15654 It has been designed with regard to fictional and non-fictional literature.
15655 Its aim is to let the user have maximum control over the typesetting of
15657 Memoir is based on the standard book class, but it can also emulate the
15658 article class (see below).
15661 \begin_layout Standard
15662 Peter Wilson, the developer of Memoir, is known as the author of lots of
15663 useful packages in the \SpecialChar LaTeX
15665 Most of them have been merged with Memoir.
15666 Therefore, it is much easier to layout the table of contents, appendices,
15667 chapter designs and such.
15669 , though, does not support all of these goodies natively.
15670 Some of them might be added to forthcoming releases
15674 \begin_layout Plain Layout
15675 You are invited to send suggestions to
15676 \begin_inset Flex URL
15679 \begin_layout Plain Layout
15681 lyx-devel@lists.lyx.org
15691 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
15693 Of course you can still use all features with the help of some native \SpecialChar LaTeX
15695 commands (\SpecialChar TeX
15700 \begin_layout Plain Layout
15705 \begin_layout Plain Layout
15715 \begin_inset space ~
15719 \begin_inset CommandInset ref
15721 reference "sec:Inserting-TeX-Code"
15731 In this section, we can only list those features that are natively supported
15732 by \SpecialChar LyX
15734 For detailed descriptions (and for the rest of features) we recommend you
15735 have a look at the detailed manual of the Memoir class
15739 \begin_layout Plain Layout
15744 \begin_layout Plain Layout
15754 \begin_inset Flex URL
15757 \begin_layout Plain Layout
15759 CTAN:/macros/latex/memoir/memman.pdf
15769 , which is not only a user guide for the class, but also both a comprehensive
15770 description on good typesetting and a superb example for good typesetting
15774 \begin_layout Subsection
15775 Basic features and restrictions
15778 \begin_layout Standard
15779 Memoir supports basically all features of the standard book classes.
15780 There are, however, some differences, as follows:
15783 \begin_layout Description
15785 \begin_inset space ~
15788 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
15791 \begin_layout Description
15793 \begin_inset space ~
15796 style: The fancy page style is not supported, due to a command clash between
15797 Memoir and the fancyhdr package (they both define a command with the same
15798 name, which confuses \SpecialChar LaTeX
15800 Instead, Memoir comes with a number of its own page styles (see
15802 Document\SpecialChar menuseparator
15803 Settings\SpecialChar menuseparator
15805 \begin_inset space ~
15811 If you want to use these for the chapter pages, you have to use the command
15818 in the main text or in preamble (e.
15819 \begin_inset space \thinspace{}
15823 \begin_inset space \space{}
15830 chapterstyle{companion}
15835 \begin_layout Description
15836 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
15837 optional argument in the standard classes.
15838 With this, you can specify an alternative version of the title for the
15839 table of contents and the headers (for instance, if the title is too long).
15840 In \SpecialChar LyX
15841 , you can do this via
15843 Insert\SpecialChar menuseparator
15845 \begin_inset space ~
15850 at the beginning of a chapter/section.
15851 Memoir features a second optional argument and thus separates the table
15852 of contents from the header.
15853 You can define three variants of a title with this: one for the main text,
15854 one for the table of contents, and one for the headers.
15856 makes these available in form of specific
15867 \begin_layout Description
15868 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
15869 of contents, the list of figures and the list of table start a new page
15871 Memoir does not follow this route.
15872 You have to insert a page break yourself, if you want to have one.
15875 \begin_layout Description
15876 Titlepage: For some unknown reason, Memoir uses pagination on the title
15877 page (in the standard classes, title pages are
15878 \begin_inset Quotes eld
15882 \begin_inset Quotes erd
15886 If you want an empty title page, type
15890 aliaspagestyle{title}{empty}
15895 \begin_layout Description
15896 Article: With the class option
15902 Document\SpecialChar menuseparator
15903 Settings\SpecialChar menuseparator
15904 Class Settings\SpecialChar menuseparator
15906 \begin_inset space ~
15911 ), you can emulate article style.
15912 That is, counters (footnotes, figures, tables etc.) will not be reset on
15913 new chapters, chapters don't start a new page (but are—in contrary to
15914 \begin_inset Quotes eld
15918 \begin_inset Quotes erd
15921 article classes—still allowed), parts, though, use their own page, as in
15925 \begin_layout Description
15926 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
15927 font commands, which have been used in the old \SpecialChar LaTeX
15929 \begin_inset space \thinspace{}
15933 \begin_inset space \space{}
15949 It produces an error and stops \SpecialChar LaTeX
15950 whenever such a command appears.
15955 reallows the commands and spits out warnings instead (which does at least
15956 not stop \SpecialChar LaTeX
15958 Since a lot of packages and particularly Bib\SpecialChar TeX
15959 style files are still using
15960 those commands, we have decided to use this option by default.
15963 \begin_layout Subsection
15967 \begin_layout Standard
15968 We will only describe the features supported by \SpecialChar LyX
15969 (which is not much currently).
15970 Please consult the Memoir manual
15974 \begin_layout Plain Layout
15979 \begin_layout Plain Layout
15989 \begin_inset Flex URL
15992 \begin_layout Plain Layout
15994 CTAN:/macros/latex/memoir/memman.pdf
16007 \begin_layout Description
16008 Abstract: You may wonder why an abstract is an extra feature.
16009 Well, it is in book class.
16010 Usually books don't have abstracts.
16011 Memoir, however, has.
16012 You can use it wherever and how often you like.
16015 \begin_layout Description
16016 Chapterprecis: You may know this older typesetting style: The contents of
16017 a chapter are summarized below the title and also in the table of contents
16019 \begin_inset space \thinspace{}
16023 \begin_inset space \space{}
16028 Our hero arrives in Troia; he loses some friends; he finds others
16031 Chapterprecis does exactly this.
16032 It is therefore only sensible below a chapter.
16035 \begin_layout Description
16036 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
16037 The epigraph environment provides an elegant way of typesetting such a
16039 The motto itself (text) and its (optional) author (source) are divided
16041 The author (source) can be inserted via
16043 Insert\SpecialChar menuseparator
16050 \begin_layout Description
16051 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
16052 complex figurative poems).
16054 can only support a few of them.
16055 One is poemtitle, which is a centered title for poems, which will also
16056 be added to the table of contents (verse is the standard environment for
16058 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
16060 because they have to be nested inside regular verse environments, which
16061 is not possible with \SpecialChar LyX
16065 \begin_layout Description
16066 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
16069 \begin_layout Section
16070 Article (mwart), book (mwbk) and report (mwrep)
16071 \begin_inset Argument status
16074 \begin_layout Plain Layout
16087 \begin_layout Standard
16093 \begin_layout Standard
16094 The \SpecialChar LyX
16111 correspond to the \SpecialChar LaTeX
16125 They are replacements for the standard document classes
16137 , resp., and fit better to Polish typography conventions in a number of points.
16141 \begin_layout Standard
16145 \begin_layout Itemize
16146 Unnumbered titles (with star, e.
16147 \begin_inset space \thinspace{}
16151 \begin_inset space \space{}
16158 ) are added into table of contents,
16161 \begin_layout Itemize
16162 Additional page styles:
16166 \begin_layout Description
16167 uheadings header with separated lines,
16170 \begin_layout Description
16171 myheadings custom header, contents headers via commands:
16186 \begin_layout Description
16187 myuheadings custom header with separated lines,
16190 \begin_layout Description
16191 outer page number is placed on outer side of page
16195 \begin_layout Itemize
16200 \begin_layout Description
16201 rmheadings serif titles — default,
16204 \begin_layout Description
16205 sfheadings sansserif titles,
16208 \begin_layout Description
16209 authortitle on title page first placed is author next title — default,
16212 \begin_layout Description
16213 titleauthor on title page first placed is title next author,
16216 \begin_layout Description
16217 withmarginpar reserve place on page for margins.
16221 \begin_layout Section
16225 \begin_layout Standard
16230 provides an alternative to the standard
16235 It provides similar functionality, but you might prefer this layout with
16236 sans serif sections, headings, and more.
16239 \begin_layout Section
16240 Rev\SpecialChar TeX
16244 \begin_layout Standard
16250 \begin_layout Standard
16251 \begin_inset VSpace bigskip
16257 \begin_layout Standard
16262 \begin_inset space ~
16267 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
16269 \begin_inset Formula $\beta$
16272 release of May, 1999) class.
16275 \begin_layout Standard
16281 textclass, which works with Rev\SpecialChar TeX
16283 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
16285 That means that it doesn't interact very well with \SpecialChar LyX
16286 , which requires \SpecialChar LaTeX2e
16288 it has been kludged to work.
16289 Since Rev\SpecialChar TeX
16290 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
16295 Rev\SpecialChar TeX
16297 \begin_inset space ~
16302 textclass should also be pretty easy to use.
16305 \begin_layout Standard
16306 These documents are supposed to be used in
16310 to the Rev\SpecialChar TeX
16311 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
16313 and assume you'll know what to put in the preamble if necessary.
16316 \begin_layout Subsection
16320 \begin_layout Standard
16321 All you need to do is install Rev\SpecialChar TeX
16322 4, as described in the package's README
16324 The package can be found at The Rev\SpecialChar TeX
16326 \begin_inset Flex URL
16329 \begin_layout Plain Layout
16331 http://publish.aps.org/revtex4/
16337 Install it somewhere that \SpecialChar LaTeX
16339 Test it by trying to \SpecialChar LaTeX
16340 a short Rev\SpecialChar TeX
16341 4 document in some random directory (i.
16342 \begin_inset space \thinspace{}
16346 \begin_inset space \space{}
16349 not the directory where you installed the class file.) Then, if you reconfigure
16351 , it will find the class file and let you use the Rev\SpecialChar TeX
16355 \begin_layout Standard
16356 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
16365 \begin_inset space ~
16370 template, found in the templates directory.
16373 \begin_layout Subsection
16377 \begin_layout Standard
16378 Optional arguments to
16385 \begin_inset Quotes eld
16389 \begin_inset Quotes erd
16393 \begin_inset Quotes eld
16397 \begin_inset Quotes erd
16403 \begin_inset space ~
16411 \begin_inset space ~
16417 Remember that in Rev\SpecialChar TeX
16418 , at least one optional argument is required!
16421 \begin_layout Standard
16422 Other preamble matter, like
16429 \begin_inset space ~
16436 \begin_inset space ~
16441 dialog, also as usual.
16444 \begin_layout Subsection
16448 \begin_layout Standard
16449 The layouts basically correspond to the commands in Rev\SpecialChar TeX
16451 For example, the Email layout corresponds to
16458 Note that (at least as of Rev\SpecialChar TeX
16467 layouts are exactly equivalent, so you shouldn't need to use both.
16471 \begin_layout Plain Layout
16472 In case you're curious, both were included so that
16476 would be able to translate both
16496 \begin_layout Subsection
16500 \begin_layout Standard
16501 There are a couple of important unique aspects of Rev\SpecialChar TeX
16502 4 which might cause
16503 bugs that will be even more confusing in \SpecialChar LyX
16507 \begin_layout Standard
16508 In Rev\SpecialChar TeX
16526 The \SpecialChar LyX
16527 equivalent is that there is a separate Thanks layout.
16532 write footnotes in the
16536 layout, or weird things may happen.
16537 See the Rev\SpecialChar TeX
16538 4 documentation for more details.
16541 \begin_layout Standard
16545 \begin_inset space ~
16553 \begin_inset space ~
16562 layouts must be placed
16570 layout and the corresponding
16587 , the \SpecialChar LaTeX
16591 \begin_layout Section
16592 Springer Journals (
16599 \begin_layout Standard
16605 \begin_layout Subsection
16609 \begin_layout Standard
16610 These are the layout files for some of the journal formats used by Springer
16611 Verlag and listed on
16612 \begin_inset Flex URL
16615 \begin_layout Plain Layout
16617 http://www.springer.de/author/tex/help-journals.html
16622 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
16624 It is a modular system: the things common to all journals are implemented
16629 , which journal-specific layout files (such as, e.
16630 \begin_inset space \thinspace{}
16634 \begin_inset space \space{}
16641 for Journal of Geodesy) can include.
16644 \begin_layout Standard
16645 This means that implementing support for any other Springer journal on this
16646 list is as simple as writing your own
16654 file following the outline given in
16662 \begin_layout Standard
16663 It is reasonably well tested only for the Journal of Geodesy.
16672 come with the standard \SpecialChar LyX
16674 Install the relevant class file (downloaded from Springer) in a proper
16675 directory, reconfigure \SpecialChar LaTeX
16676 (in the te\SpecialChar TeX
16681 , as root if necessary — doesn't \SpecialChar LyX
16682 take care of this?), reconfigure \SpecialChar LyX
16687 \begin_layout Subsection
16691 \begin_layout Standard
16692 A large number of theorem-like styles —
16704 \begin_layout Standard
16707 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
16708 _Title, Author_Running, Institute,
16709 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
16712 See the Springer class file documentation for details.
16715 \begin_layout Subsection
16719 \begin_layout Itemize
16731 \begin_layout Itemize
16734 Probability Theory and Related Fields
16740 — Jean-Marc Lasgouttes
16743 \begin_layout Standard
16744 Add your own, it isn't so hard!
16747 \begin_layout Subsection
16751 \begin_layout Standard
16752 These files are partly based on the older
16756 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
16758 file from Springer.
16763 layout, are now defunct.
16764 Jean-Marc Lasgouttes helped out big in making me find my way around the
16766 layout file mechanism.
16769 \begin_layout Subsection
16773 \begin_layout Standard
16775 But probably less than in the old hacked-\SpecialChar LaTeX
16783 \begin_layout Section
16786 Sli\SpecialChar TeX
16790 \begin_inset CommandInset label
16799 \begin_layout Standard
16807 \begin_layout Subsection
16811 \begin_layout Standard
16812 This section describes how to use \SpecialChar LyX
16813 to make slides for overhead projectors.
16814 There are two document classes that can do this: the default slides class
16817 Foil\SpecialChar TeX
16821 This section documents the former.
16824 \begin_layout Standard
16825 I'm going to say this again, nice and clear, so that there's no misunderstanding
16829 \begin_layout Standard
16830 \begin_inset VSpace bigskip
16836 \begin_layout Standard
16840 This section documents the class
16841 \begin_inset Quotes eld
16849 \begin_inset Quotes erd
16857 \begin_layout Standard
16858 \begin_inset VSpace bigskip
16864 \begin_layout Standard
16865 If you're looking for the documentation for
16866 \begin_inset Quotes eld
16871 slides (Foil\SpecialChar TeX
16875 \begin_inset Quotes erd
16878 , check out section
16879 \begin_inset space ~
16883 \begin_inset CommandInset ref
16885 reference "sec:foiltex"
16895 \begin_inset Quotes eld
16900 slides (Foil\SpecialChar TeX
16904 \begin_inset Quotes erd
16907 ] is actually somewhat better than the default
16915 \begin_layout Plain Layout
16917 or so I've been told repeatedly by its advocates.
16918 Having never used it, I have no idea if this claim is true or not.
16923 which this section documents.
16926 \begin_layout Standard
16927 This class is the \SpecialChar LaTeX2e
16928 improvement of the old
16930 Sli\SpecialChar TeX
16934 Every \SpecialChar LaTeX2e
16935 distribution includes this class [which I'll just refer to as
16936 \begin_inset Quotes eld
16944 \begin_inset Quotes erd
16947 from now on], so you're bound to have it.
16948 As I noted earlier, there are other classes, such as
16952 , which also produce slides for overhead projectors and do a better job
16954 However, there are some things which
16958 can do which the others can't, such as generate overlays.
16959 Read on to learn more!
16962 \begin_layout Subsection
16964 \begin_inset CommandInset label
16966 name "sec:slidesetup"
16973 \begin_layout Standard
16974 Obviously, to use this document class, you need to select
16975 \begin_inset Quotes eld
16983 \begin_inset Quotes erd
16986 from the class list in the
16988 Document\SpecialChar menuseparator
16992 There are some other special things you should know about this class:
16995 \begin_layout Itemize
16996 Don't bother changing the options
17001 They're not supported by the
17008 \begin_layout Itemize
17012 \begin_inset space ~
17017 behaves a bit differently for this class.
17018 The possible choices and what they do are as follows:
17022 \begin_layout Description
17027 The final output contains page numbers in the lower right corner.
17030 \begin_layout Description
17039 , but also prints out any time markers you've put in.
17040 This is the default.
17043 \begin_layout Description
17048 The final output contains no page numbers, time markers, or alignment markers.
17052 \begin_layout Itemize
17057 class has an extra option:
17063 \begin_inset Quotes eld
17071 \begin_inset Quotes erd
17074 in the extra class options.
17078 \begin_layout Standard
17079 Using this options allows you to add time markers to
17085 \begin_inset space ~
17089 \begin_inset CommandInset ref
17091 reference "sec:slideNote"
17099 \begin_layout Standard
17100 You can also use the template file
17101 \begin_inset Quotes eld
17109 \begin_inset Quotes erd
17112 to automatically set up a document to use the
17118 File\SpecialChar menuseparator
17120 \begin_inset space ~
17124 \begin_inset space ~
17129 to open your new document].
17130 The template file also contains some examples of the special paragraph
17131 environments used by this class.
17132 I'll describe those next.
17135 \begin_layout Subsection
17136 Paragraph Environments
17139 \begin_layout Subsubsection
17140 Supported Environments
17143 \begin_layout Standard
17144 The first thing you'll notice when you start up a new
17148 document is the font size and type: it's the equivalent of the size
17149 \begin_inset Quotes eld
17157 \begin_inset Quotes erd
17163 \begin_inset space ~
17169 This is also what's used in the output.
17171 \begin_inset Quotes eld
17175 \begin_inset Quotes erd
17178 to remind you that this is a slide.
17179 Your final slides will use a larger font; ergo, you'll have less space.
17180 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
17183 \begin_layout Standard
17184 The next thing that becomes obvious is the changes to the paragraph environment
17185 pull-down box [at the far-left end of the toolbar].
17186 Most of the paragraph environments you're used to seeing are missing.
17187 There are also five new ones.
17192 class itself only supports certain paragraph environments:
17195 \begin_layout Itemize
17201 \begin_layout Itemize
17207 \begin_layout Itemize
17213 \begin_layout Itemize
17219 \begin_layout Itemize
17225 \begin_layout Itemize
17231 \begin_layout Itemize
17237 \begin_layout Itemize
17243 \begin_layout Itemize
17249 \begin_layout Itemize
17256 \begin_layout Standard
17257 All of the other standard environments, including the section-heading environmen
17258 ts, aren't used in the
17265 \begin_layout Standard
17266 On the other hand, you'll notice the following new environments:
17269 \begin_layout Itemize
17275 \begin_layout Itemize
17281 \begin_layout Itemize
17287 \begin_layout Itemize
17293 \begin_layout Itemize
17299 \begin_layout Standard
17300 These five are kind of quirky, due to a
17301 \begin_inset Quotes eld
17305 \begin_inset Quotes erd
17308 in \SpecialChar LyX
17310 You see, \SpecialChar LyX
17311 doesn't permit you to nest any other paragraph environment into
17312 an empty environment.
17313 Now, that's fine and dandy, but it means that you wouldn't be able to start
17314 a slide with anything except plain text.
17315 To deal with this, I've performed a little
17316 \begin_inset Quotes eld
17321 \begin_inset Quotes erd
17327 \begin_layout Subsubsection
17328 Quirks of the New Environments
17329 \begin_inset CommandInset label
17331 name "sec:slideQuirk"
17338 \begin_layout Standard
17339 All five of the new paragraph environments are somewhat quirky due to inherent
17340 limitiations in the current version of \SpecialChar LyX
17342 As I just mentioned, \SpecialChar LyX
17343 forbids environments that begin with another environment.
17344 To get around this, the
17348 environment isn't a paragraph environment as described in the
17356 \begin_layout Standard
17357 You should consider
17370 \begin_inset Quotes eld
17373 pseudo-environments.
17374 \begin_inset Quotes erd
17377 They look like a section heading or a
17378 \begin_inset Quotes eld
17386 \begin_inset Quotes erd
17389 but really begin a [and, if necessary, end the previous] paragraph environment.
17399 \begin_inset Quotes eld
17403 \begin_inset Quotes erd
17406 These two perform some action.
17409 \begin_layout Standard
17410 A common feature of all five environments,
17430 , is a rather long-ish label.
17431 The text following this label — ordinarily the contents of the paragraph
17432 environment — is utterly irrelevant for
17454 completely ignores it.
17455 In fact, you can leave these five environments completely empty.
17459 \begin_layout Standard
17464 to put any text after the rather long-ish label, you might want to.
17465 This could be a short description of the contents of the
17470 In that case, enter your descriptive comment and hit
17474 as you normally would.
17477 \begin_layout Standard
17478 If, on the other hand, you don't want to enter any descriptive text, you'll
17479 hit another \SpecialChar LyX
17482 , like nature, abhors a vacuum, and will not let you start a new paragraph
17483 environment until you put something in the old one.
17487 \begin_layout Itemize
17488 Start entering the text that will
17516 \begin_layout Itemize
17517 Now move to the beginning of that paragraph.
17521 \begin_layout Itemize
17530 \begin_layout Itemize
17531 Finally, change this new, empty paragraph to a
17555 \begin_layout Standard
17556 Some future version of \SpecialChar LyX
17557 will, hopefully, resolve this quirkiness\SpecialChar ldots
17561 \begin_layout Subsection
17562 Making a Presentation with
17575 \begin_layout Subsubsection
17583 \begin_layout Standard
17584 If you're expecting this section to teach you how to actually make a presentatio
17585 n, you'll be sorely disappointed.
17586 Naturally, I'll describe all of the ways the
17590 class can assist you in preparing the materials for a presentation.
17591 Filling in the contents, however, is up to you.
17596 the \SpecialChar LyX
17600 \begin_layout Standard
17605 environment [in the manner described in section
17606 \begin_inset space ~
17610 \begin_inset CommandInset ref
17612 reference "sec:slideQuirk"
17616 ] tells \SpecialChar LyX
17617 to begin a new slide [duh].
17618 The label for this environment/
17619 \begin_inset Quotes erd
17623 \begin_inset Quotes erd
17627 \begin_inset Quotes eld
17631 \begin_inset Quotes erd
17634 in cool blue, followed by the label,
17635 \begin_inset Quotes eld
17639 \begin_inset Quotes erd
17643 Any text or paragraph environments that follow this one go on the new slide.
17647 \begin_layout Standard
17648 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
17650 (this can be specified in the
17655 In fact, you'll want to, once you finish entering the contents of one slide.
17656 If you've entered more text than can physically fit on a slide, the extra
17657 overflows onto a new slide.
17658 I don't recommend doing this, however, since the overflow slide won't have
17659 any page number on it.
17660 Furthermore, it may interfere with any
17664 you've made to accompany the oversized
17671 \begin_layout Standard
17680 environments work the same way as the
17685 They both create an
17686 \begin_inset Quotes eld
17690 \begin_inset Quotes erd
17693 followed by a label [
17694 \begin_inset Quotes eld
17698 \begin_inset Quotes erd
17702 \begin_inset Quotes eld
17706 \begin_inset Quotes erd
17710 The color is a stunning magenta instead of blue, and the
17711 \begin_inset Quotes eld
17715 \begin_inset Quotes erd
17718 will look different, in style and in length.
17719 The label fonts of all three also differ from one another.
17722 \begin_layout Standard
17727 , if the contents of a
17735 exceed the physical size of a slide or sheet of paper, the extra will overflow
17737 Again, you should avoid this.
17738 It defeats the whole purpose of
17749 \begin_layout Subsubsection
17759 \begin_layout Standard
17764 is a slide that sits atop another slide.
17765 Perhaps you wish to discuss a figure on the main
17769 before displaying the text associated with it.
17770 One way to accomplish this is tape a flap of dark paper over the part of
17775 you want to display later.
17776 This method fails, however, if you wish to overlap one graph with another,
17778 You would then have to fumble while speaking to align the two separate,
17783 s to align the two graphs.
17788 environment in both cases makes life much easier.
17791 \begin_layout Standard
17796 receives the page number of its
17797 \begin_inset Quotes eld
17801 \begin_inset Quotes erd
17809 \begin_inset Quotes eld
17817 \begin_inset Quotes erd
17824 \begin_layout Plain Layout
17825 Presumably, mutliple
17830 \begin_inset Quotes eld
17838 \begin_inset Quotes erd
17842 \begin_inset Quotes eld
17850 \begin_inset Quotes erd
17854 \begin_inset Quotes eld
17862 \begin_inset Quotes erd
17866 \begin_inset space ~
17869 appended to the page number of the parent
17879 Clearly, you want the contents of both the
17887 to each fit on a single physical slide! You should probably consider an
17893 \begin_inset Quotes eld
17897 \begin_inset Quotes erd
17905 Indeed, the \SpecialChar LyX
17910 class provides a visual cue for this: the label at the start of an
17914 is shorter than that at the start of a
17919 Lastly, when you generate printable output, you'll find alignment markers
17920 in all four corners of both the
17924 page and its parent
17929 These will assist you in lining up the two physical slides.
17932 \begin_layout Standard
17933 The major problem in overlaying two slides is aligning the contents of the
17934 two transparencies.
17935 How much space should you leave for that graph on the second slide? Worse
17936 still, what if you want a graph and a sentence on second slide, but there
17937 is text on the main transparency that goes in between them? You could try
17938 and insert vertical space of the right size.
17939 The better way is to use
17950 \begin_layout Standard
17951 As their names imply,
17959 are two command-like paragraph environments that make all subsequent text
17960 invisible and visible, respectively.
17962 \begin_inset space ~
17966 \begin_inset CommandInset ref
17968 reference "sec:slideQuirk"
17972 that you don't place anything
17976 these two environments, however.
17981 , it inserts a centered, sky-blue label into the page reading
17982 \begin_inset Quotes eld
17985 <Invisible Text Follows>
17986 \begin_inset Quotes erd
17990 For paragraphs following this label, the parts of the
17998 ; it doesn't matter which] where they would be contain instead blank space.
18002 \begin_layout Standard
18007 , the corresponding centered label is
18008 \begin_inset Quotes eld
18011 <Visible Text Follows>
18012 \begin_inset Quotes erd
18016 Paragraphs following this label behave normally.
18017 Note that the beginning of a new
18029 automatically shuts off an
18034 It's therefore not necessary to use
18045 \begin_layout Standard
18046 By now, it should be obvious how to create overlay transparencies using
18047 the proper combination of
18066 \begin_layout Enumerate
18071 , including everything that will appear on it, whether on the main slide
18079 \begin_layout Enumerate
18080 Before each figure or paragraph that will appear only on the
18089 If necessary, insert a
18093 environment after the
18100 \begin_layout Enumerate
18105 immediately following the
18112 \begin_layout Enumerate
18113 Copy the contents of this
18124 \begin_layout Enumerate
18129 , change all of the
18140 \begin_layout Standard
18142 You've just made an
18149 \begin_layout Standard
18150 There's one problem with the way I've designed the \SpecialChar LyX
18155 class: you can't make text in the middle of a paragraph invisible, nor
18156 make text in the middle of an invisible paragraph visible again.
18157 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
18162 \begin_layout Plain Layout
18163 The commands of interest are:
18166 \begin_layout Itemize
18171 invisible \SpecialChar ldots
18175 \begin_layout Itemize
18180 visible \SpecialChar ldots
18184 \begin_layout Plain Layout
18186 and need to be marked as \SpecialChar TeX
18189 \begin_inset Quotes eld
18193 \begin_inset Quotes erd
18196 you wish to change goes in between the brackets [and after the
18209 If you don't know how to mark text as \SpecialChar TeX
18210 , see the appropriate section of
18223 \begin_layout Subsubsection
18233 \begin_inset CommandInset label
18235 name "sec:slideNote"
18242 \begin_layout Standard
18251 is associated with a
18252 \begin_inset Quotes eld
18256 \begin_inset Quotes erd
18264 Here, too, the \SpecialChar LyX
18269 class provides visual cues.
18274 is shorter than that of a
18278 [yet longer than that of an
18282 ] and, like the label of an
18286 is shockingly magenta.
18287 Additionally, the printed
18291 has the page number of its
18292 \begin_inset Quotes eld
18296 \begin_inset Quotes erd
18304 \begin_inset Quotes eld
18312 \begin_inset Quotes erd
18316 \begin_inset Quotes eld
18324 \begin_inset Quotes erd
18328 \begin_inset Quotes eld
18336 \begin_inset Quotes erd
18340 You can have multiple
18344 s associated with a single
18356 , you'll probably want to break up long
18360 s so that they fit on a single sheet of paper.
18363 \begin_layout Standard
18368 is obvious: it contains anything additional you might want to say about
18374 It could also be used as a sheet of reminders for a particular
18379 In the case of the latter, you might want to make use of time markers.
18380 Currently, the \SpecialChar LyX
18386 \begin_inset Quotes eld
18390 \begin_inset Quotes erd
18393 support for time markers, a
18395 Sli\SpecialChar TeX
18399 So, you'll have to resort to using the \SpecialChar LaTeX
18403 \begin_layout Standard
18404 To use time markers, you'll need to specify the extra class option
18405 \begin_inset Quotes eld
18413 \begin_inset Quotes erd
18417 \begin_inset space ~
18421 \begin_inset CommandInset ref
18423 reference "sec:slidesetup"
18428 This option turns on timing marks, which will appear in the lower-left-hand
18434 To set what appears in the time marker, you use the \SpecialChar LaTeX
18436 \begin_inset Quotes eld
18446 \begin_inset Quotes erd
18450 \begin_inset Quotes eld
18460 \begin_inset Quotes erd
18464 The arguments of both commands are time measured in seconds.
18466 \begin_inset Quotes eld
18476 \begin_inset Quotes erd
18479 sets the time marker to a given time.
18481 \begin_inset Quotes eld
18491 \begin_inset Quotes erd
18494 increments the time marker by the specified amount.
18495 Using time markers and
18499 s in this fashion, you can remind yourself how much time to spend on a particula
18507 \begin_layout Standard
18508 There's one last feature to describe.
18509 Clearly, you'd like to print out all of your
18517 s on transparencies while printing all of your
18534 with which it is associated.
18535 What's a person to do?
18538 \begin_layout Standard
18539 Luckily, there are two \SpecialChar LaTeX
18540 commands that allow you to select what to print
18542 Both must be placed into the preamble of your document.
18544 \begin_inset Quotes eld
18556 \begin_inset Quotes erd
18559 will cause the output to contain only the
18568 Correspondingly, the command
18569 \begin_inset Quotes eld
18581 \begin_inset Quotes erd
18584 prevents the output of anything but
18589 I'd advise placing both commands in the preamble and initially comment
18591 You can then preview your entire presentation as you write.
18592 When you're done writing, you can then uncomment one of the two to select
18593 what you want to print.
18594 I like to uncomment
18595 \begin_inset Quotes eld
18607 \begin_inset Quotes erd
18610 , print to a file with
18611 \begin_inset Quotes eld
18619 \begin_inset Quotes erd
18622 in its name, comment it back out, then uncomment
18623 \begin_inset Quotes eld
18635 \begin_inset Quotes erd
18639 \begin_inset Quotes eld
18647 \begin_inset Quotes erd
18651 I can then send either file to a printer, loading transparencies or plain
18652 paper as appropriate.
18655 \begin_layout Standard
18656 You can also provide other arguments to the
18657 \begin_inset Quotes eld
18667 \begin_inset Quotes erd
18671 \begin_inset Quotes eld
18681 \begin_inset Quotes erd
18685 See a good \SpecialChar LaTeX
18689 \begin_layout Subsection
18694 Class Template File
18697 \begin_layout Standard
18698 I have also provided a template file,
18699 \begin_inset Quotes eld
18707 \begin_inset Quotes erd
18715 To use it, begin your new presentation with
18717 File\SpecialChar menuseparator
18719 \begin_inset space ~
18723 \begin_inset space ~
18729 Your new \SpecialChar LyX
18730 presentation file will contain an example
18751 additionally contain an example of the use of
18760 Lastly, the preamble will contain:
18763 \begin_layout LyX-Code
18764 % Uncomment to print out only slides and overlays
18767 \begin_layout LyX-Code
18771 \begin_layout LyX-Code
18777 \begin_inset Newline newline
18783 \begin_layout LyX-Code
18784 % Uncomment to print out only notes
18787 \begin_layout LyX-Code
18791 \begin_layout LyX-Code
18799 \begin_layout Standard
18800 One final thing: I created this class to support the \SpecialChar LaTeX2e
18802 \begin_inset Quotes eld
18807 Sli\SpecialChar TeX
18811 \begin_inset Quotes erd
18814 class, one of the built-in \SpecialChar LaTeX2e
18816 Neither I nor the rest of the \SpecialChar LyX
18817 Team endorse or oppose the use of this built-in
18819 It's here if you want it or need it.
18820 There exist other \SpecialChar LaTeX2e
18821 classes for creating presentations, such as the
18826 \begin_inset space ~
18830 \begin_inset CommandInset ref
18832 reference "sec:foiltex"
18837 \begin_inset Quotes eld
18845 \begin_inset Quotes erd
18848 package [present on some \SpecialChar TeX
18850 The latter is not yet supported under \SpecialChar LyX
18855 \begin_layout Plain Layout
18856 Perhaps you can take on the task\SpecialChar ldots
18862 I know nothing about these other classes.
18863 Try them out to see what sort of alternative they provide.
18866 \begin_layout Chapter
18868 Features needing Extra Software
18871 \begin_layout Section
18872 Checking \SpecialChar TeX
18876 \begin_layout Standard
18882 \begin_layout Subsection
18886 \begin_layout Standard
18895 \begin_layout Plain Layout
18900 is not yet available when you are using the \SpecialChar LaTeX
18901 distribution MiK\SpecialChar TeX
18907 , you'll find in the
18914 \begin_inset space ~
18925 \begin_inset Newline newline
18929 \begin_inset CommandInset href
18931 target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
18939 \begin_layout Standard
18942 Chk\SpecialChar TeX
18945 package is a program that was written by
18946 \begin_inset Flex Noun
18949 \begin_layout Plain Layout
18951 \begin_inset space ~
18959 in frustration because some constructs in \SpecialChar LaTeX
18960 are sometimes non-intuitive,
18961 and easy to forget.
18962 The program runs over your \SpecialChar LaTeX
18963 file, checks the integrity of the file, and
18964 flags some common errors.
18965 In other technical words, it is
18969 for \SpecialChar LaTeX
18973 \begin_layout Standard
18974 Well, what is a syntax checker doing in \SpecialChar LyX
18975 which is supposed to produce correct
18977 anyways? The answer is simple: Just as
18981 not only checks the
18985 of C programs, but also does
18989 checks for type-errors,
18991 Chk\SpecialChar TeX
18994 catches some common
18998 errors, in addition to the syntactical ones.
19001 Chk\SpecialChar TeX
19004 is capable of detecting several common errors, such as
19007 \begin_layout Itemize
19008 Ellipsis detection:
19009 \begin_inset Newline newline
19012 Use \SpecialChar ldots
19016 \begin_layout Itemize
19017 No space in front of/after parenthesis:
19018 \begin_inset Newline newline
19024 \begin_layout Itemize
19025 Enforcement of normal space after common abbreviations:
19026 \begin_inset Newline newline
19030 \begin_inset space \thinspace{}
19034 \begin_inset space \space{}
19037 is too wide spacing.
19040 \begin_layout Itemize
19041 Enforcement of end-of-sentence space when the last sentence ends with a
19043 \begin_inset Newline newline
19047 And this is wrong spacing.
19050 \begin_layout Itemize
19051 Space in front of labels and similar commands:
19052 \begin_inset Newline newline
19055 The label should stick right up to the text to avoid falling to a wrong
19058 \begin_inset CommandInset label
19068 \begin_layout Plain Layout
19069 This footnote is in danger of falling off to a wrong page
19074 The label is separated too much.
19077 \begin_layout Itemize
19078 Space in front of references, instead of hard spaces:
19079 \begin_inset Newline newline
19082 If you have bad luck, the text will break right between the referenced text
19083 and reference number, and that's a pity.
19085 \begin_inset CommandInset ref
19087 reference "sec:chktex"
19094 \begin_layout Itemize
19096 \begin_inset Quotes eld
19100 \begin_inset Quotes erd
19104 \begin_inset Formula $\times$
19108 \begin_inset Newline newline
19111 2x2 looks cheap compared to
19112 \begin_inset Formula $2\times2$
19118 \begin_layout Standard
19119 and more \SpecialChar ldots
19120 It is an invaluable tool when you are
19121 \begin_inset Quotes eld
19125 \begin_inset Quotes erd
19128 your document before printing, and you should run it right after the obligatory
19129 spelling check, and before you go fine tuning the typesetting.
19132 \begin_layout Subsection
19136 \begin_layout Standard
19137 If you have the program installed, usage is as simple as choosing
19139 Tools\SpecialChar menuseparator
19141 \begin_inset space ~
19147 This will make \SpecialChar LyX
19148 generate a \SpecialChar LaTeX
19149 file of your document, start
19151 Chk\SpecialChar TeX
19154 to check it, and then make \SpecialChar LyX
19156 \begin_inset Quotes eld
19160 \begin_inset Quotes erd
19163 with the warnings from
19165 Chk\SpecialChar TeX
19168 , if there were any.
19169 The warnings will be placed close to the point of the mistake, and you
19170 can quickly find them by using the
19172 Navigate\SpecialChar menuseparator
19175 menu item, or the shortcut key
19184 Open the error boxes by clicking on them with the mouse, or use the shortcut
19193 bindings, or the corresponding
19202 Read the warning and correct the mistake, if it is a mistake.
19203 If you have trouble understanding what the warning is about, you can safely
19205 Remember that there is a hidden layer between the document on screen and
19206 the technical details in invoking
19208 Chk\SpecialChar TeX
19211 , and this gap can make some warnings seem arcane or just plain silly.
19214 \begin_layout Standard
19215 This document is an excellent testing bed for the feature, and it should
19216 provide quite a few warnings for you to fiddle with.
19217 Since computers are only so smart, expect most of the warnings to be false
19221 \begin_layout Subsection
19222 How to fine tune it
19225 \begin_layout Standard
19226 Sometimes, you'll find that
19228 Chk\SpecialChar TeX
19231 makes more noise than suits your mood.
19232 Then you can choose not to use it, wait until your mood changes, or try
19235 Chk\SpecialChar TeX
19238 to get better along with you.
19241 \begin_layout Standard
19244 Chk\SpecialChar TeX
19251 very configurable and extensible, you should not expect to solve all problems
19254 Chk\SpecialChar TeX
19257 in \SpecialChar LyX
19259 Since \SpecialChar LyX
19260 has to generate a somewhat special \SpecialChar LaTeX
19261 file to be able to match the
19262 line numbers from the
19264 Chk\SpecialChar TeX
19271 \begin_layout Plain Layout
19272 You can inspect the specific output from
19278 Document\SpecialChar menuseparator
19281 \begin_inset space ~
19295 to the internal document structure, some of the warnings will not appear
19297 There are two things you can do about this:
19300 \begin_layout Itemize
19303 Chk\SpecialChar TeX
19306 invocation command line in
19307 \begin_inset Flex Noun
19310 \begin_layout Plain Layout
19311 Tools\SpecialChar menuseparator
19312 Preferences\SpecialChar menuseparator
19313 Output\SpecialChar menuseparator
19314 LaTeX\SpecialChar menuseparator
19322 Chk\SpecialChar TeX
19325 installation configuration file (usually with the file
19330 See below to learn what warnings can be enabled and disabled on the command
19334 \begin_layout Itemize
19335 Export your document as a raw \SpecialChar LaTeX
19338 File\SpecialChar menuseparator
19339 Export\SpecialChar menuseparator
19348 Invoked in this way, it can be a hassle to find the corresponding place
19349 in the document inside \SpecialChar LyX
19350 , but with a little patience, you should be able
19354 \begin_layout Standard
19355 Here follows the warning messages that can be enabled and disabled in
19364 to disable a warning, and
19368 to enable a warning.
19369 The emphasized entries are disabled by default, because the default is
19372 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
19377 \begin_layout Standard
19378 Notice that you should only use the options that enable and disable warnings,
19379 because \SpecialChar LyX
19380 relies on some of the other command line parameters to be set
19381 in a specific way to have a chance to communicate with
19388 \begin_layout Enumerate
19392 Command terminated with space.
19395 \begin_layout Enumerate
19398 Non-breaking space (
19399 \begin_inset Quotes eld
19407 \begin_inset Quotes erd
19410 ) should have been used.
19413 \begin_layout Enumerate
19417 You should enclose the previous parenthesis with
19418 \begin_inset Quotes eld
19426 \begin_inset Quotes erd
19432 \begin_layout Enumerate
19435 Italic correction (
19436 \begin_inset Quotes eld
19446 \begin_inset Quotes erd
19449 ) found in non-italic buffer.
19452 \begin_layout Enumerate
19455 Italic correction (
19456 \begin_inset Quotes eld
19466 \begin_inset Quotes erd
19469 ) found more than once.
19472 \begin_layout Enumerate
19476 No italic correction (
19477 \begin_inset Quotes eld
19487 \begin_inset Quotes erd
19493 \begin_layout Enumerate
19497 \begin_inset Quotes eld
19505 \begin_inset Quotes erd
19509 \begin_inset Quotes eld
19517 \begin_inset Quotes erd
19523 \begin_layout Enumerate
19526 Wrong length of dash may have been used.
19529 \begin_layout Enumerate
19533 \begin_inset Quotes eld
19541 \begin_inset Quotes erd
19545 \begin_inset Quotes eld
19553 \begin_inset Quotes erd
19559 \begin_layout Enumerate
19563 \begin_inset Quotes eld
19571 \begin_inset Quotes erd
19577 \begin_layout Enumerate
19581 \begin_inset Quotes eld
19589 \begin_inset Quotes erd
19592 to achieve an ellipsis.
19595 \begin_layout Enumerate
19598 Inter-word spacing (
19599 \begin_inset Quotes eld
19609 \begin_inset Quotes eld
19612 ) should perhaps be used.
19615 \begin_layout Enumerate
19618 Inter-sentence spacing (
19619 \begin_inset Quotes eld
19629 \begin_inset Quotes erd
19632 ) should perhaps be used.
19635 \begin_layout Enumerate
19638 Could not find argument for command.
19641 \begin_layout Enumerate
19645 \begin_inset Quotes eld
19653 \begin_inset Quotes erd
19659 \begin_layout Enumerate
19662 Math mode still on at end of \SpecialChar LaTeX
19666 \begin_layout Enumerate
19670 \begin_inset Quotes eld
19678 \begin_inset Quotes erd
19681 doesn't match the number of
19682 \begin_inset Quotes eld
19690 \begin_inset Quotes erd
19696 \begin_layout Enumerate
19699 You should use either
19702 \begin_inset Quotes eld
19710 \begin_inset Quotes erd
19715 as an alternative to
19716 \begin_inset Quotes eld
19724 \begin_inset Quotes erd
19730 \begin_layout Enumerate
19737 " (ASCII 39) instead of "
19744 \begin_layout Enumerate
19747 User-specified pattern found.
19750 \begin_layout Enumerate
19753 This command might not be intended.
19756 \begin_layout Enumerate
19763 \begin_layout Enumerate
19781 \begin_layout Enumerate
19784 Delete this space to maintain correct page references.
19787 \begin_layout Enumerate
19791 You might wish to put this between a pair of
19792 \begin_inset Quotes eld
19800 \begin_inset Quotes erd
19806 \begin_layout Enumerate
19809 You ought to remove spaces in front of punctuation.
19812 \begin_layout Enumerate
19815 Could not execute \SpecialChar LaTeX
19819 \begin_layout Enumerate
19828 in front of small punctuation.
19831 \begin_layout Enumerate
19839 may look prettier here.
19842 \begin_layout Enumerate
19846 Multiple spaces detected in output.
19849 \begin_layout Enumerate
19852 This text may be ignored.
19855 \begin_layout Enumerate
19861 \begin_inset Quotes eld
19866 to begin quotation, not
19873 \begin_layout Enumerate
19880 to end quotation, not
19883 \begin_inset Quotes eld
19891 \begin_layout Enumerate
19897 \begin_layout Enumerate
19900 You should perhaps use
19901 \begin_inset Quotes eld
19909 \begin_inset Quotes erd
19915 \begin_layout Enumerate
19918 You should put a space in front of/after parenthesis.
19921 \begin_layout Enumerate
19924 You should avoid spaces in front of/after parenthesis.
19927 \begin_layout Enumerate
19931 You should not use punctuation in front of/after quotes.
19934 \begin_layout Enumerate
19937 Double space found.
19940 \begin_layout Enumerate
19943 You should put punctuation outside inner/inside display math mode.
19946 \begin_layout Enumerate
19949 You ought to not use primitive \SpecialChar TeX
19950 in \SpecialChar LaTeX
19954 \begin_layout Enumerate
19957 You should remove spaces in front of
19958 \begin_inset Quotes eld
19966 \begin_inset Quotes erd
19972 \begin_layout Enumerate
19975 \begin_inset Quotes eld
19983 \begin_inset Quotes erd
19986 is normally not followed by
19987 \begin_inset Quotes eld
19995 \begin_inset Quotes erd
20001 \begin_layout Standard
20002 In later versions of \SpecialChar LyX
20003 , we hope to provide a more complete interface to this
20004 tool (and it's smaller cousin
20008 ) to exploit the full power of it.
20009 But it's not exactly useless as it is now: go try it on one of your existing
20010 documents of a certain length and be surprised.
20013 \begin_layout Section
20014 Version Control in \SpecialChar LyX
20018 \begin_layout Standard
20021 Lars Gullik Bjønnes
20028 \begin_layout Subsection
20032 \begin_layout Standard
20034 supports some of the most basic RCS/CVS/SVN/GIT commands.
20035 If you need something a bit more sophisticated you will have to do that
20036 manually in a terminal.
20039 \begin_layout Standard
20040 Also note that CVS support is not as good as subversion support, so we advise
20042 A good place to start learning Subversion is the SVN Book
20046 \begin_layout Plain Layout
20047 \begin_inset CommandInset href
20049 target "http://svnbook.red-bean.com/"
20060 In the case of RCS you should read
20061 \begin_inset Quotes eld
20065 \begin_inset Quotes erd
20068 (a man file, read it with
20073 This file describes all the basic features of RCS.
20074 You should especially notice the comment about a RCS directory, and the
20075 notion of a master RCS file (the file ending in
20082 \begin_layout Standard
20083 Before you begin to use the version control features in \SpecialChar LyX
20085 familiar with RCS/CVS/SVN/GIT usage.
20086 The implementation in \SpecialChar LyX
20087 assumes a recent version of the GNU RCS or CVS/SVN
20088 package — no guarantees are made for older versions.
20089 Most of the log messages are not currently displayed after operations —
20090 you can check them in the Messages pane if you are unsure.
20091 Regular users of version control will appreciate the VC toolbar, which
20094 View\SpecialChar menuseparator
20095 Toolbars\SpecialChar menuseparator
20097 \begin_inset space ~
20105 \begin_layout Standard
20106 For introducing your own external commands consult
20107 \begin_inset Flex Code
20110 \begin_layout Plain Layout
20124 \begin_layout Standard
20125 It is strongly recommended to store documents in uncompressed format if
20126 using version control (uncheck
20128 Document\SpecialChar menuseparator
20131 if it is checked): Uncompressed LyX documents are text files and therefore
20132 for merging two different versions by version control systems.
20133 Compressed LyX documents are binary files, which cannot be merged by version
20137 \begin_layout Subsection
20138 RCS commands in \SpecialChar LyX
20142 \begin_layout Standard
20143 The following sections describe the RCS commands supported by \SpecialChar LyX
20145 You can find them in the
20147 File\SpecialChar menuseparator
20149 \begin_inset space ~
20156 was tested against RCS 5.7/5.8.
20159 \begin_layout Subsubsection
20165 \begin_layout Standard
20166 If your document is not under revision control, this is the only item shown
20168 And if it is under revision control, the
20172 item is not visible.
20176 \begin_layout Standard
20177 This command registers your document with RCS (unless you are under the
20178 directory managed by CVS)\SpecialChar endofsentence
20179 You are asked interactively to supply an initial
20180 description of the document.
20181 The document is now set in Read-Only mode and you have to
20184 \begin_inset space ~
20188 \begin_inset space ~
20192 \begin_inset space ~
20197 , before making any changes to it.
20198 A document under revision control has a
20199 \begin_inset Quotes eld
20202 [RCS:<version> <locker>]
20203 \begin_inset Quotes erd
20206 item tagged to the filename in the minibuffer.
20209 \begin_layout Standard
20210 RCS command that is run:
20213 \begin_layout LyX-Code
20216 ci -q -u -i -t-"<initial description>" <file-name>
20219 \begin_layout Standard
20224 to understand the switches.
20228 \begin_layout Subsubsection
20234 \begin_layout Standard
20235 When you are finished editing a file, you check in your changes.
20236 When you do this, you are asked for a description of the changes.
20237 This is stored in the history log.
20238 The version number is bumped, your changes are applied to the master RCS
20239 file, the document is unlocked and set to Read-Only mode.
20242 \begin_layout Itemize
20245 ci -q -u -m"<description>" <file-name>
20248 \begin_layout Subsubsection
20254 \begin_layout Standard
20255 By doing this you lock the document so that only you can edit it.
20256 This will also make the document Read-Write only for you.
20257 You will usually continue editing for a while and when you are finished
20258 you check in your changes.
20259 The status line is changed to reflect that you have locked the file.
20262 \begin_layout Itemize
20265 co -q -l <file-name>
20268 \begin_layout Subsubsection
20271 Revert To Repository Version
20274 \begin_layout Standard
20275 This will discard all changes made to the document since the last check
20277 You get a warning before changes are discarded.
20280 \begin_layout Itemize
20283 co -f -u<version> <file-name>
20286 \begin_layout Subsubsection
20292 \begin_layout Standard
20293 This will create a copy of the current document.
20294 Since RCS does not support copy operations natively, the version history
20295 is not preserved, and the copy is added as a new file.
20296 It requires a clean document without any changes since the last checkin.
20297 You are asked for a file name and a description of the copy operation.
20298 After that the copy is created, both locally and in the repository.
20299 If the parent directories of the copied and original document differ, all
20300 relative paths of included files of the copy are adjusted (like in
20302 File\SpecialChar menuseparator
20307 Finally, the copy is loaded instead of the original document.
20310 \begin_layout Labeling
20311 \labelwidthstring 00.00.0000
20313 \begin_inset space ~
20317 \begin_inset space ~
20321 \begin_inset Newline newline
20325 \begin_inset Flex Code
20328 \begin_layout Plain Layout
20331 \begin_inset Quotes qld
20335 \begin_inset Quotes qld
20344 \begin_inset Flex Code
20347 \begin_layout Plain Layout
20350 \begin_inset Quotes qld
20354 \begin_inset Quotes qld
20363 \begin_inset Newline newline
20367 \begin_inset Flex Code
20370 \begin_layout Plain Layout
20374 \begin_inset Quotes qld
20378 \begin_inset Quotes qld
20389 \begin_layout Subsubsection
20395 \begin_layout Standard
20396 This makes as if the last check in never happened.
20397 No changes are made to the document loaded into \SpecialChar LyX
20398 , but the last version
20399 is removed from the master RCS file.
20402 \begin_layout Itemize
20405 rcs -o<version> <file-name>
20408 \begin_layout Subsubsection
20414 \begin_layout Standard
20415 This shows the complete history of the RCS document.
20420 is shown in a browser.
20428 \begin_layout Subsubsection
20432 \begin_layout Standard
20434 supports RCS version number, author name, date and time of last commit.
20435 All those are extracted from
20437 rlog -r <file-name>
20441 \begin_inset CommandInset ref
20443 reference "subsec:VCS-Revision-Information"
20450 \begin_layout Subsection
20451 CVS commands in \SpecialChar LyX
20455 \begin_layout Standard
20456 A subset of CVS operations is supported by \SpecialChar LyX
20458 You can find the commands in the
20460 File\SpecialChar menuseparator
20462 \begin_inset space ~
20468 The version control system SVN is more powerful, so please use it instead
20469 of CVS if possible.
20472 \begin_layout Subsubsection
20478 \begin_layout Standard
20479 If you start from scratch with CVS you have to create your repository and
20480 checkout the working copy with external tools.
20481 If you're using a client-server setup you may need to login before doing
20482 the first repository checkout.
20485 \begin_layout Standard
20486 If your documents are under revision control and others are using the same
20487 repository problems arise when different changes to the same document at
20488 the same location happen.
20489 Standard CVS repositories don't operate with a file locking mechanism.
20490 This may be surprising, but conflicts only occur if people disagree on
20491 the proper content of the same part of a document.
20492 So, if co-workers are used to communicate regularly, these conflicts occur
20494 If they don't communicate they have a fundamental problem anyway.
20495 Nevertheless some people like to work with so called
20496 \begin_inset Quotes eld
20500 \begin_inset Quotes erd
20504 If they do so the working copy of all files is readonly when checked out
20505 first and the user starts editing after using a special command to make
20506 the working copy writable.
20507 When the changes are checked in the working copy returns to readonly state.
20508 With \SpecialChar LyX
20509 one has to edit the
20510 \begin_inset Flex Code
20513 \begin_layout Plain Layout
20519 file and add the line
20520 \begin_inset Flex Code
20523 \begin_layout Plain Layout
20529 to work with reserved checkouts.
20530 The benefit is the possibility to see who is using a writable copy of some
20532 It's not guaranteed only one user makes a copy writable.
20535 \begin_layout Standard
20537 tries to guess if you're using reserved or non-reserved checkouts.
20538 If your working copy is readonly or it is writable and an additional copy
20539 of your document exists in the CVS/Base sub-directory a reserved otherwise
20540 a non-reserved checkout is assumed.
20541 When a reserved checkout is detected you have to use
20542 \begin_inset Flex Noun
20545 \begin_layout Plain Layout
20551 to make your working copy writable if it's readonly.
20553 \begin_inset Flex Noun
20556 \begin_layout Plain Layout
20562 operation is possible and that makes your working copy readonly again after
20563 transferring your changes to the repository.
20566 \begin_layout Standard
20567 More information about CVS can be found here
20568 \begin_inset Flex URL
20571 \begin_layout Plain Layout
20573 http://www.nongnu.org/cvs
20579 \begin_inset Flex URL
20582 \begin_layout Plain Layout
20584 http://ximbiot.com/cvs
20592 \begin_layout Standard
20597 to understand the sub-commands and the switches mentioned below.
20600 \begin_layout Subsubsection
20606 \begin_layout Standard
20607 If your document is not under revision control, this is the only item shown
20609 And if it is under revision control, the
20613 item is not visible.
20617 \begin_layout Standard
20618 This command registers in CVS your document
20619 \begin_inset Flex Strong
20622 \begin_layout Plain Layout
20630 in the case you have already the documents directory under CVS control
20636 This means you have to create or checkout the archive by yourself using
20638 (In case you forget that step \SpecialChar LyX
20639 registers the document with RCS.)
20642 \begin_layout Standard
20643 Then you are asked interactively to supply an initial description of the
20645 Don't forget that registered file is not yet checked in.
20648 \begin_layout Standard
20649 CVS command that is run:
20651 cvs -q add -m"<entered message>" "<file-name>"
20654 \begin_layout Standard
20659 above and for all other CVS commands is an abbreviation for
20660 \begin_inset Quotes eld
20663 change the current working directory to file location and use the file name
20664 without path component as argument
20665 \begin_inset Quotes erd
20671 \begin_layout Subsubsection
20677 \begin_layout Standard
20678 When you are finished editing a file, you commit your changes.
20679 When you do this and you had changed the document, you are asked for a
20680 description of the changes.
20681 After that changes are written to the repository.
20682 In case you didn't change the document and a reserved checkout is detected
20683 the reservation made on
20684 \begin_inset Flex Noun
20687 \begin_layout Plain Layout
20696 \begin_layout Labeling
20697 \labelwidthstring 00.00.0000
20699 \begin_inset space ~
20703 \begin_inset space ~
20707 \begin_inset Newline newline
20711 \begin_inset Flex Code
20714 \begin_layout Plain Layout
20717 -q commit -m"<description>" "<file-name>"
20723 \begin_inset Newline newline
20727 \begin_inset Flex Code
20730 \begin_layout Plain Layout
20741 \begin_layout Subsubsection
20747 \begin_layout Standard
20748 When you are sharing a repository with others, you may have to incorporate
20749 their changes into your working copy.
20752 \begin_layout Standard
20755 cvs -q update "<file-name>"
20758 \begin_layout Standard
20759 If a readonly checkout is detected the working copy is made writable and
20763 \begin_layout Standard
20766 cvs -q edit "<file-name>"
20769 \begin_layout Subsubsection
20772 Revert To Repository Version
20775 \begin_layout Standard
20776 This will discard all changes made to the document since the last check
20778 You get a warning before changes are discarded.
20779 Firstly the file is deleted, secondly CVS update command is run.
20782 \begin_layout Standard
20785 cvs -q update "<file-name>"
20788 \begin_layout Standard
20789 If a reserved checkout is detected and the working copy has no changes only
20790 the reservation is undone.
20793 \begin_layout Standard
20796 cvs -q unedit "<file-name>"
20799 \begin_layout Subsubsection
20805 \begin_layout Standard
20806 This will create a copy of the current document.
20807 Since CVS does not support copy operations natively, the version history
20808 is not preserved, and the copy is added as a new file.
20809 It requires a clean document without any changes since the last checkin.
20810 You are asked for a file name and a description of the copy operation.
20811 After that the copy is created, both locally and in the repository.
20812 If the parent directories of the copied and original document differ, all
20813 relative paths of included files of the copy are adjusted (like in
20815 File\SpecialChar menuseparator
20820 Finally, the copy is loaded instead of the original document.
20823 \begin_layout Labeling
20824 \labelwidthstring 00.00.0000
20826 \begin_inset space ~
20830 \begin_inset space ~
20834 \begin_inset Newline newline
20838 \begin_inset Flex Code
20841 \begin_layout Plain Layout
20848 \begin_inset Flex Code
20851 \begin_layout Plain Layout
20858 \begin_inset Newline newline
20862 \begin_inset Flex Code
20865 \begin_layout Plain Layout
20866 cvs -q add "<new-file-name>"
20874 \begin_layout Subsubsection
20880 \begin_layout Standard
20881 This will rename the current document.
20882 Since CVS does not support rename operations natively, the version history
20883 is not preserved, the renamed document is added as a new file, and the
20884 original document is deleted.
20885 It requires a clean document without any changes since the last checkin.
20886 You are asked for a file name and a description of the rename operation.
20887 After that the document is renamed, both locally and in the repository.
20888 If the parent directories of the new and old file names differ, all relative
20889 paths of included files are adjusted (like in
20891 File\SpecialChar menuseparator
20896 Finally, the document is reloaded using the new name.
20899 \begin_layout Labeling
20900 \labelwidthstring 00.00.0000
20902 \begin_inset space ~
20906 \begin_inset space ~
20910 \begin_inset Newline newline
20914 \begin_inset Flex Code
20917 \begin_layout Plain Layout
20924 \begin_inset Flex Code
20927 \begin_layout Plain Layout
20934 \begin_inset Newline newline
20938 \begin_inset Flex Code
20941 \begin_layout Plain Layout
20942 cvs -q add "<new-file-name>"
20948 \begin_inset Newline newline
20952 \begin_inset Flex Code
20955 \begin_layout Plain Layout
20956 cvs -q remove "<file-name>"
20964 \begin_layout Subsubsection
20965 Update of the local directory checkout from repository
20968 \begin_layout Standard
20969 Once your documents gets more complex, containing sub-documents and pictures,
20971 \begin_inset Flex Code
20974 \begin_layout Plain Layout
20980 files and so on using version control becomes more complicated.
20982 supports updating the whole tree in which resides the document.
20983 This become especially useful once you cooperate with people which neither
20984 have detailed knowledge about CVS usage nor they have ambition to commit
20985 additional material to the repository.
20986 You have to organize the files structure so that all external files are
20987 in the same directory or subdirectories of the document.
20988 It's good practice anyway to store multipart documents in an extra directory.
20991 \begin_layout Standard
20993 \begin_inset Flex Code
20996 \begin_layout Plain Layout
20997 Update local directory from repository
21002 command updates the whole directory.
21003 If local changes are detected user is warned before update starts.
21004 In case of merge conflicts both versions of the conflicting document parts
21005 are placed in the final document.
21006 You have to review and correct the result of the merge.
21007 You'll find the conflicts enclosed in pairs of
21008 \begin_inset Flex Code
21011 \begin_layout Plain Layout
21018 \begin_inset Flex Code
21021 \begin_layout Plain Layout
21028 \begin_inset Flex Code
21031 \begin_layout Plain Layout
21038 The first part is your version as before the update operation with the
21039 document name prepended.
21040 The second one is the repository version with the version number after
21042 \begin_inset Flex Code
21045 \begin_layout Plain Layout
21054 \begin_layout Labeling
21055 \labelwidthstring 00.00.0000
21057 \begin_inset space ~
21061 \begin_inset space ~
21065 \begin_inset Newline newline
21069 \begin_inset Flex Code
21072 \begin_layout Plain Layout
21080 (Ask if changes are detected.)
21081 \begin_inset Newline newline
21085 \begin_inset Flex Code
21088 \begin_layout Plain Layout
21089 cd $path; cvs -q update
21099 \begin_layout Standard
21101 \begin_inset Flex Code
21104 \begin_layout Plain Layout
21110 stands for the path to the document.
21113 \begin_layout Subsubsection
21119 \begin_layout Standard
21120 This shows the complete history of the CVS document.
21123 cvs log "<file-name>"
21125 is shown in a browser.
21128 \begin_layout Subsubsection
21132 \begin_layout Standard
21134 supports CVS version number, author name, date and time of last commit.
21135 All those are extracted from
21137 cvs log -r <file-name>
21141 \begin_inset CommandInset ref
21143 reference "subsec:VCS-Revision-Information"
21150 \begin_layout Subsection
21151 SVN commands in \SpecialChar LyX
21155 \begin_layout Standard
21156 SVN is now partially supported by \SpecialChar LyX
21158 You can find the commands in the
21160 File\SpecialChar menuseparator
21162 \begin_inset space ~
21168 Please note that if you use password protected access to repository via
21169 ssh, you will be asked in terminal window.
21171 was tested against SVN 1.5, 1.6, 1.7 and 1.8
21175 \begin_layout Plain Layout
21176 Most of the commands will work with 1.4 too, see
21177 \begin_inset CommandInset ref
21179 reference "subsec:SVN-Repo-Update"
21184 There seems to be currently unresolved permissions problem under SVN 1.8
21185 with reverting changes when file is locked.
21193 \begin_layout Subsubsection
21199 \begin_layout Standard
21200 If your document is not under revision control, this is the only item shown
21202 And if it is under revision control, the
21206 item is not visible.
21209 \begin_layout Standard
21210 This command registers in SVN your document ONLY in case you have already
21211 the documents directory under SVN control (in particular
21216 This means you have to checkout the archive by yourself.
21219 \begin_layout Standard
21220 Then you are asked interactively to supply an initial description of the
21222 Don't forget that registered file is not yet commited.
21225 \begin_layout Standard
21226 SVN command that is run:
21229 \begin_inset Quotes qld
21233 \begin_inset Quotes qld
21239 \begin_layout Standard
21244 to understand the switches.
21247 \begin_layout Subsubsection
21253 \begin_layout Standard
21254 When you are finished editing a file, you commit your changes.
21255 When you do this, you are asked for a description of the changes.
21256 After that changes are commited.
21259 \begin_layout Standard
21264 \begin_layout Plain Layout
21265 In case locking is not enabled.
21267 \begin_inset CommandInset ref
21269 reference "subsec:SVN-File-Locking"
21280 svn commit -q -m"<description>" <file-name>
21283 \begin_layout Subsubsection
21289 \begin_layout Standard
21290 Updates the changes of this file from the repository.
21291 Be sure you understand SVN merging and conflicts resolving before using
21292 this function, because all conflicts has to be resolved manually by you!
21295 \begin_layout Standard
21300 \begin_layout Plain Layout
21308 svn update --non-interactive
21309 \begin_inset Quotes qld
21313 \begin_inset Quotes qld
21319 \begin_layout Subsubsection
21322 Revert To Repository Version
21325 \begin_layout Standard
21326 This will discard all changes made to the document since the last check
21328 You get a warning before changes are discarded.
21331 \begin_layout Standard
21335 \begin_inset Quotes qld
21339 \begin_inset Quotes qld
21345 \begin_layout Subsubsection
21351 \begin_layout Standard
21352 This will create a copy of the current document including the version history.
21353 It requires a clean document without any changes since the last checkin.
21354 You are asked for a file name and a description of the copy operation.
21355 After that the copy is created, both locally and in the repository.
21356 If the parent directories of the copied and original document differ, all
21357 relative paths of included files of the copy are adjusted (like in
21359 File\SpecialChar menuseparator
21364 Finally, the copy is loaded instead of the original document.
21367 \begin_layout Labeling
21368 \labelwidthstring 00.00.0000
21370 \begin_inset space ~
21374 \begin_inset space ~
21378 \begin_inset Newline newline
21382 \begin_inset Flex Code
21385 \begin_layout Plain Layout
21389 \begin_inset Quotes qld
21393 \begin_inset Quotes qld
21397 \begin_inset Quotes qld
21401 \begin_inset Quotes qld
21410 \begin_inset Newline newline
21414 \begin_inset Flex Code
21417 \begin_layout Plain Layout
21426 \begin_layout Subsubsection
21432 \begin_layout Standard
21433 This will rename the current document including the version history.
21434 It requires a clean document without any changes since the last checkin.
21435 You are asked for a file name and a description of the rename operation.
21436 After that the document is renamed, both locally and in the repository.
21437 If the parent directories of the new and old file names differ, all relative
21438 paths of included files are adjusted (like in
21440 File\SpecialChar menuseparator
21445 Finally, the document is reloaded using the new name.
21448 \begin_layout Labeling
21449 \labelwidthstring 00.00.0000
21451 \begin_inset space ~
21455 \begin_inset space ~
21459 \begin_inset Newline newline
21463 \begin_inset Flex Code
21466 \begin_layout Plain Layout
21470 \begin_inset Quotes qld
21474 \begin_inset Quotes qld
21478 \begin_inset Quotes qld
21482 \begin_inset Quotes qld
21491 \begin_inset Newline newline
21495 \begin_inset Flex Code
21498 \begin_layout Plain Layout
21507 \begin_layout Subsubsection
21508 \begin_inset CommandInset label
21510 name "subsec:SVN-Repo-Update"
21514 Update of the local directory checkout from repository
21518 \begin_layout Plain Layout
21519 Note that this command will work only with subversion
21520 \begin_inset Formula $\geqq1.5$
21531 \begin_layout Standard
21532 All the commands above have one shortcoming – they deal with the current
21534 Once your document contains pictures, includes external
21535 \begin_inset Flex Code
21538 \begin_layout Plain Layout
21544 files and so on administration becomes more complicated.
21546 now supports updating the whole tree in which resides the document
21550 \begin_layout Plain Layout
21551 One need to organize the files structure so that all external files are
21552 in the same directory or subdirectories of the document.
21559 This become especially useful once you cooperate with people which neither
21560 know about subversion management nor they have ambition to commit additional
21561 material to the repository.
21565 \begin_layout Standard
21566 \begin_inset Flex Code
21569 \begin_layout Plain Layout
21570 Update local directory from repository
21575 command updates the whole directory and in case of merge conflicts local
21576 version of the files are left, so no unintended data loss occurs.
21577 If local changes are detected user is warned before update starts.
21580 \begin_layout Labeling
21581 \labelwidthstring 00.00.0000
21583 \begin_inset space ~
21587 \begin_inset space ~
21591 \begin_inset Newline newline
21595 \begin_inset Flex Code
21598 \begin_layout Plain Layout
21604 (Ask if changes are detected.)
21605 \begin_inset Newline newline
21609 \begin_inset Flex Code
21612 \begin_layout Plain Layout
21613 svn update --accept mine-full $path
21621 \begin_layout Standard
21623 \begin_inset Flex Code
21626 \begin_layout Plain Layout
21632 stands for the path to the document.
21635 \begin_layout Subsubsection
21641 \begin_layout Standard
21642 This shows the complete history of the SVN document.
21646 \begin_inset Quotes qld
21650 \begin_inset Quotes qld
21655 is shown in a browser.
21658 \begin_layout Subsubsection
21660 \begin_inset CommandInset label
21662 name "subsec:SVN-File-Locking"
21669 \begin_layout Standard
21670 The file exchange through various revision control systems brings the problem
21671 of merge conflicts in case two different users try to edit the same (parts
21673 When such a conflict happens it needs manual resolving and one reasonable
21674 alternative is to provide some kind of locking mechanism, which guarantees
21675 that only one user is allowed to edit file at the given time.
21678 \begin_layout Standard
21679 SVN has two such mechanisms to provide mutual exclusivity for file access
21680 – locks and automatic setting of write permissions (see sec.
21682 \begin_inset CommandInset ref
21684 reference "subsec:Automatical-Locking-Property"
21689 \begin_inset Flex Code
21692 \begin_layout Plain Layout
21702 \begin_layout Plain Layout
21703 \begin_inset Flex URL
21706 \begin_layout Plain Layout
21708 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
21719 If this property is detected for a given document \SpecialChar LyX
21720 starts to use SVN locks
21721 for document editing automatically and the whole check-in/out mechanism
21722 switches to the same regimen as for RCS.
21723 This in particular means there are two different modes of file use in \SpecialChar LyX
21727 \begin_layout Itemize
21729 The loaded file is in the read-only mode.
21730 For editing on needs to check-out.
21735 consists of updating from the repository and gaining write lock.
21736 If the lock is not possible to obtain, we remain in unlocked state.
21739 \begin_layout Itemize
21741 The loaded file is in the
21742 \begin_inset Quotes els
21746 \begin_inset Quotes ers
21750 No other user is allowed to edit the file.
21755 consists of commiting changes and releasing write-lock.
21756 If no changes have been made to the document, no commit will be produced
21760 \begin_layout Plain Layout
21761 Don't be puzzled by the fact that you will be asked for commit message anyway.
21766 and only the write-lock will be released.
21769 \begin_layout Standard
21773 \begin_layout Labeling
21774 \labelwidthstring 00.00.0000
21777 svn commit -q -m"<description>" "<file-name>"
21778 \begin_inset Newline newline
21781 svn unlock "<file-name>"
21784 \begin_layout Labeling
21785 \labelwidthstring 00.00.0000
21788 svn update "<file-name>"
21789 \begin_inset Newline newline
21792 svn lock "<file-name>"
21795 \begin_layout Subsubsection
21798 \begin_inset CommandInset label
21800 name "subsec:Automatical-Locking-Property"
21806 Automatic Locking Property
21809 \begin_layout Standard
21810 The above mentioned automatic setting of write permissions of the .lyx file
21813 File\SpecialChar menuseparator
21815 \begin_inset space ~
21818 Control\SpecialChar menuseparator
21819 Use Locking Property
21822 This command is active only when the file is not locked on the svn server
21824 you need to check-out before proceeding).
21827 \begin_layout Labeling
21828 \labelwidthstring 00.00.0000
21830 \begin_inset space ~
21836 \begin_layout Labeling
21837 \labelwidthstring 00.00.0000
21840 svn propset svn:needs-lock ON "<file-name>"
21843 \begin_layout Labeling
21844 \labelwidthstring 00.00.0000
21847 svn propdel svn:needs-lock "<file-name>"
21850 \begin_layout Subsubsection
21851 \begin_inset CommandInset label
21853 name "subsec:VCS-Revision-Information"
21857 Revision Information in Documents
21860 \begin_layout Standard
21861 There are more possibilities how to activate revision information in our
21865 \begin_layout Itemize
21871 \begin_layout Itemize
21872 tree revision information (
21873 \begin_inset Flex Code
21876 \begin_layout Plain Layout
21883 The result is the output of the
21884 \begin_inset Flex Code
21887 \begin_layout Plain Layout
21893 command, the following table gives you an idea, how to read the results.
21896 \begin_layout Standard
21898 \begin_inset Tabular
21899 <lyxtabular version="3" rows="6" columns="2">
21900 <features tabularvalignment="middle">
21901 <column alignment="left" valignment="top">
21902 <column alignment="left" valignment="top">
21904 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21907 \begin_layout Plain Layout
21915 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21918 \begin_layout Plain Layout
21928 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
21931 \begin_layout Plain Layout
21937 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21940 \begin_layout Plain Layout
21941 mixed revision working copy
21948 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
21951 \begin_layout Plain Layout
21957 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21960 \begin_layout Plain Layout
21961 modified working copy
21968 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
21971 \begin_layout Plain Layout
21977 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21980 \begin_layout Plain Layout
21981 switched working copy
21988 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
21991 \begin_layout Plain Layout
21997 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22000 \begin_layout Plain Layout
22001 partial working copy, from a sparse checkout
22008 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
22011 \begin_layout Plain Layout
22017 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
22020 \begin_layout Plain Layout
22021 mixed revision, modified, switched working copy
22034 \begin_layout Itemize
22035 file revision information.
22036 The result comes from parsing the output of
22037 \begin_inset Flex Code
22040 \begin_layout Plain Layout
22042 \begin_inset space ~
22046 \begin_inset space ~
22050 \begin_inset space ~
22059 Supported flags are:
22063 \begin_layout Itemize
22064 version number of the last commit (
22065 \begin_inset Flex Code
22068 \begin_layout Plain Layout
22077 \begin_layout Itemize
22078 author of the last commit (
22079 \begin_inset Flex Code
22082 \begin_layout Plain Layout
22091 \begin_layout Itemize
22092 date of the last commit (
22093 \begin_inset Flex Code
22096 \begin_layout Plain Layout
22105 \begin_layout Itemize
22106 time of the last commit (
22107 \begin_inset Flex Code
22110 \begin_layout Plain Layout
22120 \begin_layout Standard
22121 You can obtain this info via InsetInfo (
22122 \change_inserted 5863208 1564400022
22125 Insert\SpecialChar menuseparator
22126 Field\SpecialChar menuseparator
22127 Version Control Revision
22128 \change_deleted 5863208 1564399852
22133 \begin_inset Flex Code
22136 \begin_layout Plain Layout
22137 info-insert buffer vcs-date
22145 The information will be available only when you have the file stored under
22146 svn managment (i.e.
22148 \begin_inset Flex Code
22151 \begin_layout Plain Layout
22157 directory is available with your document).
22161 \begin_layout Itemize
22162 Another—a hacking one—possibility is to use svn keywords
22166 \begin_layout Plain Layout
22167 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
22173 In short – you set file keywords property (e.g.
22176 svn propset svn:keywords 'Rev' file.lyx
22178 ) and then paste keyword \SpecialChar TeX
22183 \begin_layout Plain Layout
22184 This is an easy way how to ensure that \SpecialChar LyX
22185 won't break the line in the middle
22191 tag in your document (e.g.
22193 \begin_inset Flex Code
22196 \begin_layout Plain Layout
22203 This way svn client will automatically substitute revision number (e.g.
22205 \begin_inset Flex Code
22208 \begin_layout Plain Layout
22214 ) after each update and commit.
22215 There are more problems with this approach.
22216 Firstly, the '$' character is used in \SpecialChar TeX
22217 world for math equations, so any
22218 occurence of math formula
22219 \begin_inset Formula $Rev$
22223 \begin_inset Formula $Rev:59$
22226 in your \SpecialChar LyX
22228 Similarly for other keywords like Id, Date, Author, etc.
22229 Secondly svn output is dependent on your locales, so its very easy that
22230 svn would produce some problematic strings once Date is used.
22231 Thirdly you get the whole 'Rev: 59' string in your document instead of
22233 Until subversion implements user's custom keywords it will be hard to use
22234 this approach reliably or let \SpecialChar LyX
22235 to support it directly.
22238 \begin_layout Subsection
22239 SVN and Windows Environment
22242 \begin_layout Quote
22243 My inclination is to say that if the user cannot figure out the command
22244 line operations on their own fairly quickly, they would be well advised
22245 to use TortoiseSVN.
22251 \begin_layout Subsubsection
22255 \begin_layout Standard
22256 In addition to installing \SpecialChar LyX
22257 , and having access to a Subversion repository,
22258 the user will need to install the Subversion client program.
22259 A Windows installer for the client program is available from
22260 \begin_inset CommandInset href
22263 target "http://www.collab.net/nonav/downloads/subversion/"
22269 The user may also want to install
22270 \begin_inset CommandInset href
22273 target "http://tortoisesvn.tigris.org/"
22278 , which integrates Subversion operations into the context (rightclick) menu
22279 of Windows Explorer.
22280 Operations done outside \SpecialChar LyX
22281 will typically be more convenient using the Explorer
22283 Note that TortoiseSVN is not a replacement for the client program, which
22284 is what \SpecialChar LyX
22288 \begin_layout Subsubsection
22289 Bringing a document under Subversion control
22292 \begin_layout Standard
22293 Before a \SpecialChar LyX
22294 document can be brought under version control in Subversion, its
22295 parent directory needs to be under version control.
22296 If the document is being added to a project already in the repository,
22297 this is accomplished by checking the project out to the directory where
22298 the new document will be placed.
22299 If the project itself is not yet under version control (for instance, if
22300 this document starts a new project), the directory must be imported into
22302 This is done outside \SpecialChar LyX
22304 Both import and checkout are easily accomplished from the Explorer context
22305 menu using TortoiseSVN, or alternatively can be done using the command
22306 line client at a DOS prompt.
22307 The procedure for importing the project using TortoiseSVN is described
22308 below, assuming an existing repository and a new project being started
22316 For information on using the Subversion client program, run
22323 \begin_layout Enumerate
22330 in Windows Explorer, right click it, and select
22332 TortoiseSVN\SpecialChar menuseparator
22336 If necessary, adjust the URL for the repository, then click OK.
22339 \begin_layout Enumerate
22340 Right click the level of the repository under which you want to place the
22341 new project folder (typically the top level) and click
22345 Supply a name for the project folder and click OK.
22346 Add a message for the log file if desired, then click OK again.
22347 The new project folder should appear in the repository.
22348 Finally, click OK again to exit the repository browser.
22351 \begin_layout Enumerate
22352 Once again right click
22358 , this time selecting SVN Checkout\SpecialChar ldots
22359 Select the URL of the project folder
22360 you just created in the repository, and set the checkout directory to
22368 You will be warned about a non-empty folder; click OK to proceed.
22369 You should now have a
22380 \begin_layout Enumerate
22381 Create or open your document in \SpecialChar LyX
22384 File\SpecialChar menuseparator
22386 \begin_inset space ~
22389 Control\SpecialChar menuseparator
22393 Add a log message and click OK to commit the document to version control.
22396 \begin_layout Standard
22397 From this point onward, you should have full functionality in the
22399 File\SpecialChar menuseparator
22401 \begin_inset space ~
22407 You also have the option of checking the document in and out, viewing its
22409 using the TortoiseSVN context menu in Windows Explorer or the Subversion
22410 client program from a command prompt.
22413 \begin_layout Subsubsection
22414 SSH tunnel used with SVN under Windows
22417 \begin_layout Standard
22418 Compared with Linux setting up an svn client to communicate over ssh under
22419 Windows is a rather troublesome task.
22420 We will at least offer some hints how to setup the client side but prior
22421 knowledge about ssh and the Windows command line is needed, also be prepared
22422 for a great deal of frustration\SpecialChar ldots
22426 \begin_layout Enumerate
22427 Get an svn client for windows, as described in the previous sections.
22428 When it is a fresh install run some svn command (e.g.
22430 \begin_inset Flex Code
22433 \begin_layout Plain Layout
22439 ) to create config files, which you will need to change later on.
22442 \begin_layout Enumerate
22443 Choose an ssh client for Windows.
22444 There are several possibilities, we will use the one from Putty tools
22448 \begin_layout Plain Layout
22449 \begin_inset Flex URL
22452 \begin_layout Plain Layout
22454 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
22465 You will need to set the connection up so that the client doesn't ask for
22466 any password from you.
22467 To keep things easy we will use only keys without any additional password
22472 \begin_layout Enumerate
22474 \begin_inset Flex Code
22477 \begin_layout Plain Layout
22484 Save your private .ppk key file and put the public one on the server side.
22485 If the SVN server runs on Linux, note that the format of the public key
22486 is not compatible with Linux openssh and you will need to direcly copy-paste
22488 \begin_inset Quotes eld
22493 Public key for pasting into OpenSSH authorized_keys file
22496 \begin_inset Quotes erd
22499 edit field into the server's
22500 \begin_inset Flex Code
22503 \begin_layout Plain Layout
22504 ~/.ssh/authorized_keys
22510 \begin_inset Flex Code
22513 \begin_layout Plain Layout
22522 \begin_layout Enumerate
22524 \begin_inset Flex Code
22527 \begin_layout Plain Layout
22534 In the SVN config file
22538 \begin_layout Plain Layout
22539 Exact path depends on Windows version, usually somewhere around
22540 \begin_inset Flex Code
22543 \begin_layout Plain Layout
22546 Documents and Settings
22560 \begin_inset Flex Code
22563 \begin_layout Plain Layout
22578 , section [tunnels], setup ssh command, e.g.
22580 \begin_inset Flex Code
22583 \begin_layout Plain Layout
22584 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
22593 \begin_layout Plain Layout
22594 It will usually take a lot of time to get exact command right and it depends
22596 For example do not have some remote server saved as a default session in
22598 If things fail, try to connect via plink without SVN first.
22607 \begin_layout Enumerate
22608 Checkout the SVN archive, e.
22609 \begin_inset space \thinspace{}
22613 \begin_inset Newline newline
22617 \begin_inset Flex Code
22620 \begin_layout Plain Layout
22621 svn co svn+ssh://user@server/repository_path
22629 \begin_layout Subsubsection
22630 End-of-Line Conversions
22633 \begin_layout Standard
22634 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
22636 use different line endings inside the .lyx files.
22637 This is not a problem as far as \SpecialChar LyX
22638 functionality is concerned, but the commit
22639 diffs will be huge and merge-conflicts prone.
22640 Fortunately SVN itself knows
22644 \begin_layout Plain Layout
22645 \begin_inset Flex URL
22648 \begin_layout Plain Layout
22650 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
22660 how to deal with CR/LF problems when switching .lyx files to the
22661 \begin_inset Flex Code
22664 \begin_layout Plain Layout
22674 \begin_layout Plain Layout
22676 \begin_inset Flex Code
22679 \begin_layout Plain Layout
22680 svn propset svn:eol-style native FILE_NAME
22693 \begin_layout Subsection
22694 GIT commands in \SpecialChar LyX
22698 \begin_layout Standard
22699 A minimal subset of GIT commands is now supported by \SpecialChar LyX
22701 You can find the commands in the
22703 File\SpecialChar menuseparator
22705 \begin_inset space ~
22711 Please note that if you use password protected access to repository via
22712 ssh, you will be asked in terminal window.
22714 was tested against GIT 1.7.
22718 \begin_layout Plain Layout
22719 Windows users please note that you need to ensure that git is on the path.
22720 This can be set from within \SpecialChar LyX
22723 Tools\SpecialChar menuseparator
22724 Preferences\SpecialChar menuseparator
22725 Paths\SpecialChar menuseparator
22736 \begin_layout Standard
22737 One big difference of GIT and the other supported version control systems
22738 is the distributed nature of GIT: With traditional version control systems
22739 there is one central server which hosts the repository.
22740 Users commit their changes to the server, and get updates made by other
22742 With GIT, users commit to a local repository.
22743 The local repository can be synchronized with one or more remote repositories
22745 \begin_inset Flex Code
22748 \begin_layout Plain Layout
22755 \begin_inset Flex Code
22758 \begin_layout Plain Layout
22766 does not interact in any way with remote GIT repositories.
22767 It works exclusively with the local repository in a very similar way as
22768 with a central CVS or SVN repository.
22769 If you use remote GIT repositories you need to do the
22770 \begin_inset Flex Code
22773 \begin_layout Plain Layout
22780 \begin_inset Flex Code
22783 \begin_layout Plain Layout
22789 operations with your favourite GIT client.
22792 \begin_layout Subsubsection
22798 \begin_layout Standard
22799 If your document is not under revision control, this is the only item shown
22801 And if it is under revision control, the
22805 item is not visible.
22808 \begin_layout Standard
22809 This command registers in GIT your document ONLY in case you have already
22810 the documents directory under GIT control (in particular
22815 This means you have to checkout the archive by yourself.
22818 \begin_layout Standard
22819 Then you are asked interactively to supply an initial description of the
22821 Don't forget that registered file is not yet committed.
22824 \begin_layout Standard
22825 GIT command that is run:
22828 \begin_inset Quotes qld
22832 \begin_inset Quotes qld
22838 \begin_layout Standard
22843 to understand the switches.
22846 \begin_layout Subsubsection
22852 \begin_layout Standard
22853 When you are finished editing a file, you commit your changes.
22854 When you do this, you are asked for a description of the changes.
22855 After that changes are committed.
22858 \begin_layout Standard
22861 git commit -q -m"<description>" <file-name>
22864 \begin_layout Subsubsection
22867 Revert To Repository Version
22870 \begin_layout Standard
22871 This will discard all changes made to the document since the last check
22873 You get a warning before changes are discarded.
22876 \begin_layout Standard
22880 \begin_inset Quotes qld
22884 \begin_inset Quotes qld
22890 \begin_layout Subsubsection
22896 \begin_layout Standard
22897 This will rename the current document including the version history.
22898 It requires a clean document without any changes since the last checkin.
22899 You are asked for a file name and a description of the rename operation.
22900 After that the document is renamed, both locally and in the repository.
22901 If the parent directories of the new and old file names differ, all relative
22902 paths of included files are adjusted (like in
22904 File\SpecialChar menuseparator
22909 Finally, the document is reloaded using the new name.
22912 \begin_layout Labeling
22913 \labelwidthstring 00.00.0000
22915 \begin_inset space ~
22919 \begin_inset space ~
22923 \begin_inset Newline newline
22927 \begin_inset Flex Code
22930 \begin_layout Plain Layout
22934 \begin_inset Quotes qld
22938 \begin_inset Quotes qld
22942 \begin_inset Quotes qld
22946 \begin_inset Quotes qld
22955 \begin_inset Newline newline
22959 \begin_inset Flex Code
22962 \begin_layout Plain Layout
22971 \begin_layout Subsubsection
22977 \begin_layout Standard
22978 This shows the complete history of the GIT document.
22982 \begin_inset Quotes qld
22986 \begin_inset Quotes qld
22991 is shown in a browser.
22994 \begin_layout Subsubsection
22998 \begin_layout Standard
23000 supports GIT hash number of the last commit to the file,
23001 \change_inserted 1119979965 1564297456
23002 its abbreviated form,
23004 author name, date and time of last commit.
23005 All those are extracted from
23007 git log -n 1 --pretty=format:%H%n
23008 \change_inserted 1119979965 1564297427
23014 Tree version information is obtained via
23016 git describe --abbrev --dirty --long
23020 \begin_inset CommandInset ref
23022 reference "subsec:VCS-Revision-Information"
23029 \begin_layout Subsection
23033 \begin_layout Standard
23034 With the recent addition of the
23035 \begin_inset Flex Code
23038 \begin_layout Plain Layout
23044 function \SpecialChar LyX
23045 power users are allowed to create their own commands for revision
23049 \begin_layout Standard
23050 As an example you can see how two TortoiseSVN commands could be integrated
23054 \begin_layout Description
23056 \begin_inset Flex Code
23059 \begin_layout Plain Layout
23060 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
23068 \begin_layout Description
23070 \begin_inset Flex Code
23073 \begin_layout Plain Layout
23074 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
23082 \begin_layout Subsection
23083 Version control and Document comparison
23086 \begin_layout Standard
23087 One of the typical uses of version control is to inspect the changes between
23088 revisions, usually by creating
23089 \begin_inset Flex Code
23092 \begin_layout Plain Layout
23099 While this is useful for plain text files, it is much less useful in the
23100 case of \SpecialChar LyX
23101 files, which have more a complicated structure.
23102 Hence we provide binding to the Document comparison feature.
23103 There are two ways of calling this feature – either by direct call of
23104 \begin_inset Flex Code
23107 \begin_layout Plain Layout
23114 function (for details see \SpecialChar LyX
23115 functions manual) or by the toolbar icon
23128 One can either compare two chosen revisions of the document or he can simply
23129 compare the current version of edited text with older revisions (where
23131 \begin_inset Flex Noun
23134 \begin_layout Plain Layout
23140 ' revisions back means comparison of the edited file with last commited
23145 \begin_layout Standard
23146 This feature is supported for SVN and RCS though due to the more complicated
23147 versioning scheme of RCS there is a constraint – when addressing the revisions
23148 in dialog, numbers always point to the last number in RCS revision number,
23151 We don't currently support GIT addressing of revisions, one can just compare
23152 edited document with its revision X steps backs, where X is addressed as
23154 \begin_inset Flex Code
23157 \begin_layout Plain Layout
23166 \begin_layout Section
23167 Literate Programming
23170 \begin_layout Standard
23175 (kayvan@sylvan.com)
23179 original documentation written by
23181 Edmar Wienskoski Jr.
23184 (edmar-w-jr@technologist.com)
23187 \begin_layout Subsection
23191 \begin_layout Standard
23192 The main purpose of this documentation is to show you how to use \SpecialChar LyX
23194 programming, where it is assumed that you are familiar with this programming
23195 technique, and know what
23196 \begin_inset Quotes eld
23200 \begin_inset Quotes erd
23204 \begin_inset Quotes eld
23208 \begin_inset Quotes erd
23212 If that is not the case, please follow the web links provided in the following
23214 There is a lot of good documentation out there covering old development
23215 history to the latest tools tips.
23218 \begin_layout Standard
23219 It is also assumed that you are familiar with \SpecialChar LyX
23220 itself to a point that you
23221 are comfortable changing your \SpecialChar LyX
23222 preferences, and X resources file.
23223 If that is not the case please refer to other \SpecialChar LyX
23224 documentation to cover your
23228 \begin_layout Subsection
23229 Literate Programming
23232 \begin_layout Standard
23233 From the Literate Programming FAQ:
23236 \begin_layout Quotation
23237 Literate programming is the combination of documentation and source together
23238 in a fashion suited for reading by human beings.
23239 In fact, literate programs should be enjoyable reading, even inviting!
23240 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
23241 and documentation in a single file.
23242 Literate programming tools then parse the file to produce either readable
23243 documentation or compilable source.
23244 The WEB style of literate programming was created by D.
23245 \begin_inset space \thinspace{}
23249 Knuth during the development of his \SpecialChar TeX
23250 typesetting software.
23254 \begin_layout Standard
23255 Another excerpt says:
23258 \begin_layout Quotation
23261 How is literate programming different from verbose commenting?
23264 \begin_layout Quotation
23265 There are three distinguishing characteristics.
23266 In order of importance, they are:
23270 \begin_layout Itemize
23271 flexible order of elaboration
23274 \begin_layout Itemize
23275 automatic support for browsing
23278 \begin_layout Itemize
23279 typeset documentation, especially diagrams and mathematics
23283 \begin_layout Standard
23284 Now that I sparked your curiosity, take a look in the references.
23287 \begin_layout Subsubsection
23291 \begin_layout Standard
23292 The complete Literate Programming FAQ can be found at:
23295 \begin_layout Quote
23296 Literate Programming FAQ
23297 \begin_inset Flex URL
23300 \begin_layout Plain Layout
23302 http://www.literateprogramming.com/lpfaq.pdf
23310 \begin_layout Standard
23311 The FAQ lists 23 (twenty three!) different literate programming tools.
23312 Where some are specialized or
23313 \begin_inset Quotes eld
23317 \begin_inset Quotes erd
23320 for particular programming languages, while other have general scope.
23325 for my own use for several reasons:
23328 \begin_layout Itemize
23329 It can generate the documentation either in \SpecialChar LaTeX
23333 \begin_layout Itemize
23334 It has a open architecture, i.
23335 \begin_inset space \thinspace{}
23339 \begin_inset space \space{}
23342 it is easy to plug in new filters
23346 \begin_layout Plain Layout
23351 are programs that read a given data stream and output a manipulated data
23353 That way, a WEB file (consisting of literate code) can be turned into a
23354 file consisting only of C program code or \SpecialChar LaTeX
23360 and to perform special processing that you may need.
23364 \begin_layout Itemize
23365 There is a good selection of filters available already (the HTML is one
23369 \begin_layout Itemize
23373 \begin_layout Standard
23374 The Noweb web page can be found at:
23377 \begin_layout Quote
23379 \begin_inset Flex URL
23382 \begin_layout Plain Layout
23384 https://www.cs.tufts.edu/~nr/noweb/
23392 \begin_layout Standard
23393 Starting from there you can reach many other interesting links and even
23394 some literate program examples.
23397 \begin_layout Subsection
23399 and Literate Programming with Noweb
23402 \begin_layout Standard
23403 The \SpecialChar LyX
23404 support for Literate Programming is provided by using the generic \SpecialChar LyX
23406 converters mechanism.
23407 This support is provided in a
23408 \begin_inset Quotes eld
23412 \begin_inset Quotes erd
23416 \begin_inset space \thinspace{}
23420 \begin_inset space \space{}
23423 you will be able to use this new \SpecialChar LyX
23424 feature with some other literate programming
23425 tool of your choice by just changing your \SpecialChar LyX
23429 \begin_layout Subsubsection
23430 Generating documents and code (weaving and tangling)
23433 \begin_layout Paragraph
23434 Using the noweb module
23437 \begin_layout Standard
23438 If you have installed Noweb and \SpecialChar LyX
23439 successfully, whenever you open a new document,
23440 after you have chosen its document class, use the
23442 Document\SpecialChar menuseparator
23446 \begin_inset Quotes eld
23450 \begin_inset Quotes erd
23454 If Noweb is correctly installed, when you click on the
23455 \begin_inset Quotes eld
23459 \begin_inset Quotes erd
23462 link, you will see the
23463 \begin_inset Quotes eld
23467 \begin_inset Quotes erd
23470 module in the available list and you can add it to your document.
23473 \begin_layout Paragraph
23477 \begin_layout Standard
23479 enables you to write code with a custom inset named
23480 \begin_inset Flex Noun
23483 \begin_layout Plain Layout
23490 Noweb delimits chunks like this:
23493 \begin_layout LyX-Code
23497 \begin_layout LyX-Code
23501 \begin_layout LyX-Code
23505 \begin_layout LyX-Code
23509 \begin_layout LyX-Code
23513 \begin_layout Standard
23514 The problem is that whatever is written in between the << and the
23518 must be taken literally, i.
23519 \begin_inset space \thinspace{}
23523 \begin_inset space \space{}
23527 should be prevented from making any special interpretation of what has
23529 This is also handled by
23530 \begin_inset Flex Noun
23533 \begin_layout Plain Layout
23539 , that works like a normal text inset but has a free spacing capability.
23542 \begin_layout Standard
23543 As a special note, you can also use the
23544 \begin_inset Quotes eld
23548 \begin_inset Quotes erd
23551 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
23555 \begin_layout LyX-Code
23559 \begin_layout LyX-Code
23560 def some_function(args):
23563 \begin_layout LyX-Code
23564 "This is the doc string for this function."
23567 \begin_layout LyX-Code
23568 print "My args: ", args
23571 \begin_layout LyX-Code
23572 @ %def some_function
23575 \begin_layout Standard
23576 For an example of this usage and the resulting cross-reference output, look
23577 at the Literate python program in
23579 LIBDIR/examples/listerrors.lyx
23581 which should make this all clear.
23584 \begin_layout Paragraph
23585 Generating the documentation
23588 \begin_layout Standard
23589 At this point you already have a new document file with a proper document
23590 class, and with some code and text on it.
23591 How do I print it? The answer is simple, you select
23593 View\SpecialChar menuseparator
23597 Just like you would do for a plain document.
23598 No special procedure is required.
23601 \begin_layout Standard
23602 To help orientate you, I will now explain what happens inside \SpecialChar LyX
23606 \begin_layout Enumerate
23609 Update\SpecialChar menuseparator
23612 menu option is chosen, a \SpecialChar LaTeX
23618 \begin_layout Standard
23619 If the document is of any literate class the generated file will be named
23620 with an extension name defined by the
23621 \begin_inset Quotes eld
23625 \begin_inset Quotes erd
23628 format (defined in the Preferences panel), otherwise the file will have
23637 \begin_layout Enumerate
23638 Note that the only difference so far is in the name of the file, no special
23639 processing is required by \SpecialChar LyX
23641 Given that you formatted the code using the
23642 \begin_inset Flex Noun
23645 \begin_layout Plain Layout
23651 inset that, by itself, takes care of the business.
23654 \begin_layout Enumerate
23655 If the document is of any literate class \SpecialChar LyX
23656 will then use the internal \SpecialChar LyX
23658 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
23663 \begin_layout Plain Layout
23664 The converters are defined in the
23666 Tools\SpecialChar menuseparator
23670 \begin_inset Quotes eld
23674 \begin_inset Quotes erd
23686 manual for general information about converters.
23691 to generate the \SpecialChar LaTeX
23696 \begin_layout Standard
23697 Otherwise it will just skip this step.
23701 \begin_layout Enumerate
23702 Finally, \SpecialChar LaTeX
23703 is invoked and the regular post processing continues as in a plain
23707 \begin_layout Standard
23708 Independence from a particular
23709 \begin_inset Quotes eld
23713 \begin_inset Quotes erd
23716 is easily achieved by changing the commands that are run by the various
23720 \begin_layout Paragraph
23721 Generating the code
23724 \begin_layout Standard
23725 When the build menu option is chosen or the corresponding button in the
23726 toolbar is pressed, a \SpecialChar LaTeX
23727 file is generated just like step 1 above.
23728 Next, \SpecialChar LyX
23734 This converter needs to be defined by the user and is not installed by
23735 default, though the Program format is.
23736 This converter (like any other converter) will have two parts:
23739 \begin_layout Enumerate
23740 The converter program itself.
23741 This program performs the conversion from the one format to the other (in
23742 this case, from the Noweb format to the Program pseudo-format).
23745 \begin_layout Enumerate
23746 The error log parser.
23747 This is a program whose sole purpose is to rewrite error messages in a
23748 format that \SpecialChar LyX
23750 This makes it possible for \SpecialChar LyX
23751 to place error boxes in the right places in
23755 \begin_layout Standard
23756 The first part, the
23757 \begin_inset Quotes eld
23761 \begin_inset Quotes erd
23764 setting, should be set to
23767 \begin_layout LyX-Code
23775 \begin_layout Standard
23776 This basically means that \SpecialChar LyX
23778 \begin_inset Quotes eld
23782 \begin_inset Quotes erd
23785 (a program or script) with the name of the Noweb file (normally a file
23786 in the \SpecialChar LyX
23787 temp directory) and the directory path of the original \SpecialChar LyX
23792 \begin_layout Standard
23793 This is an implementation of
23794 \begin_inset Quotes eld
23798 \begin_inset Quotes erd
23801 that you can place in a directory on your path:
23804 \begin_layout LyX-Code
23810 \begin_layout LyX-Code
23816 \begin_layout LyX-Code
23819 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
23822 \begin_layout Standard
23823 The next part of the converter setting is the
23824 \begin_inset Quotes eld
23828 \begin_inset Quotes erd
23831 which is to be set to
23834 \begin_layout LyX-Code
23837 parselog=$$s/scripts/listerrors
23840 \begin_layout Standard
23841 This will run any errors that are generated by the
23842 \begin_inset Quotes eld
23846 \begin_inset Quotes erd
23849 process through the
23850 \begin_inset Quotes eld
23854 \begin_inset Quotes erd
23860 \begin_layout Standard
23861 The build will normally take place in \SpecialChar LyX
23862 's temporary directory, so the files
23863 produced by the conversion will be in that directory.
23865 will copy out what it regards as the `main' file, but the
23869 conversion may produce several files, and so most of these would then be
23870 deleted when \SpecialChar LyX
23872 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
23873 the build-script chunk can place the generated files in that location.
23876 \begin_layout Paragraph
23877 Build instructions in the document
23880 \begin_layout Standard
23881 The last piece of the integration between \SpecialChar LyX
23883 \begin_inset Quotes eld
23887 \begin_inset Quotes erd
23891 Generally, the instructions for building your program should be embedded
23892 in a chunk of its own.
23894 \begin_inset Quotes eld
23898 \begin_inset Quotes erd
23901 above uses the notangle command to look for this chunk (called
23902 \begin_inset Quotes eld
23906 \begin_inset Quotes erd
23909 ) and runs its contents through
23910 \begin_inset Quotes eld
23914 \begin_inset Quotes erd
23920 \begin_layout Standard
23921 Typically, such a chunk would look something like this:
23924 \begin_layout LyX-Code
23928 \begin_layout LyX-Code
23930 \begin_inset Newline newline
23933 if [ -z "${NOWEB_SOURCE}" ]
23934 \begin_inset Newline newline
23940 \begin_layout LyX-Code
23941 NOWEB_SOURCE=myfile.nw
23942 \begin_inset Newline newline
23946 \begin_inset Newline newline
23950 code to extract files ...
23951 use NOWEB_OUTPUT_DIR here ...]
23952 \begin_inset Newline newline
23956 code to compile files ...]
23957 \begin_inset Newline newline
23963 \begin_layout Standard
23966 LIBDIR/examples/listerrors.lyx
23970 LIBDIR/examples/Literate.lyx
23972 which implement two versions of the
23973 \begin_inset Quotes eld
23977 \begin_inset Quotes erd
23980 program for some illustrations of how all of these pieces go together or
23983 LIBDIR/examples/noweb2lyx.lyx.
23986 Interestingly, these three files show off the language-indepence of the
23988 literate programming support since they are written in Python, C and Perl
23992 \begin_layout Subsubsection
23993 Configuring \SpecialChar LyX
23997 \begin_layout Standard
23998 All the Literate Programming support is configured by the
24000 Tools\SpecialChar menuseparator
24004 \begin_inset Quotes eld
24008 \begin_inset Quotes erd
24012 The important parts are:
24015 \begin_layout Description
24017 \begin_inset space ~
24021 \begin_inset Quotes eld
24025 \begin_inset Quotes erd
24029 \begin_inset space ~
24032 format Set up via the File Formats tab, this is where the Noweb-specific
24042 , the file extension is set to
24047 This tells \SpecialChar LyX
24048 to create a file with a
24052 extension in the first step of the conversion process.
24055 \begin_layout Description
24057 \begin_inset space ~
24065 \begin_inset space ~
24068 format This is an empty format whose sole purpose is to be the endpoint
24069 of a conversion (which then allows us to set up a converter for it).
24072 \begin_layout Description
24082 This converter performs the
24083 \begin_inset Quotes eld
24087 \begin_inset Quotes erd
24090 of the literate document.
24091 For Noweb, it is set to
24092 \begin_inset Quotes eld
24097 noweave -delay -index $$i > $$o
24100 \begin_inset Quotes erd
24106 \begin_layout Description
24116 \begin_inset Quotes eld
24120 \begin_inset Quotes erd
24124 As stated above, the Converter is set to
24125 \begin_inset Quotes eld
24133 \begin_inset Quotes erd
24136 , with Flags set to
24137 \begin_inset Newline newline
24141 \begin_inset Quotes eld
24146 parselog=$$s/scripts/listerrors
24149 \begin_inset Quotes erd
24155 \begin_layout Subsubsection
24159 \begin_layout Standard
24160 There is also a new function implemented in the \SpecialChar LyX
24162 \begin_inset Quotes eld
24165 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
24169 \begin_layout Standard
24170 When debugging code with ddd/gdb, it is possible to invoke a text editor
24171 at the current execution position with a single key stroke.
24172 The default ddd configuration for that is shift-ctrl-V.
24173 It happens that you can define the editor command line invocation in ddd
24176 Edit\SpecialChar menuseparator
24177 Preferences\SpecialChar menuseparator
24180 dialog and changing the "Edit Sources" entry.
24183 \begin_layout Standard
24184 I take advantage of the newly created \SpecialChar LyX
24185 server function and this ddd feature,
24187 \begin_inset Quotes eld
24191 \begin_inset Quotes erd
24197 \begin_layout LyX-Code
24198 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
24201 \begin_layout Standard
24202 With this, whenever you are using ddd and find a point in the program that
24203 you want to edit, you just press shift-ctrl-V (in the ddd window), and
24204 ddd will forward this information to \SpecialChar LyX
24205 through the \SpecialChar LyX
24206 server and then the
24208 window will show the same file with the cursor at the same position ddd
24210 No more guessing or long scrolling to locate a point in the program back
24214 \begin_layout Standard
24215 Note however that you must enable the \SpecialChar LyX
24216 server to get this feature working
24217 (it is disabled by default).
24219 \begin_inset space ~
24223 \begin_inset CommandInset ref
24225 reference "sec:Starting-the-Server"
24229 explains how to do that.
24232 \begin_layout Subsubsection
24236 \begin_layout Standard
24237 There are six new buttons that can be added to your \SpecialChar LyX
24239 Four of these buttons are short cuts to layout styles:
24257 , one for the custom inset
24262 The last one is a short cut to the
24263 \begin_inset Quotes eld
24267 \begin_inset Quotes erd
24274 \begin_layout Standard
24276 has a range of buttons that are available for tool bar customization.
24277 In my toolbar I like to combine the six short cuts above with two more:
24282 \SpecialChar menuseparator
24287 \SpecialChar menuseparator
24294 Document\SpecialChar menuseparator
24295 View\SpecialChar menuseparator
24299 Here is how it looks like:
24302 \begin_layout LyX-Code
24306 \begin_layout LyX-Code
24310 \begin_layout LyX-Code
24311 Icon "layout Standard"
24314 \begin_layout LyX-Code
24315 Icon "layout Section"
24318 \begin_layout LyX-Code
24319 Icon "layout \SpecialChar LaTeX
24323 \begin_layout LyX-Code
24324 Icon "layout \SpecialChar LyX
24328 \begin_layout LyX-Code
24329 Icon "flex.insert Chunk"
24332 \begin_layout LyX-Code
24336 \begin_layout LyX-Code
24340 \begin_layout LyX-Code
24341 Icon "buffer-typeset"
24344 \begin_layout LyX-Code
24345 Icon "build-program"
24348 \begin_layout LyX-Code
24352 \begin_layout LyX-Code
24356 \begin_layout LyX-Code
24360 \begin_layout LyX-Code
24364 \begin_layout LyX-Code
24368 \begin_layout Subsubsection
24369 Colors customization
24372 \begin_layout Standard
24373 There are a number of colors in \SpecialChar LyX
24374 that can be customized in
24379 One of the things that bothers people is the \SpecialChar LaTeX
24381 The default color is red, since the chunks uses \SpecialChar LaTeX
24382 font, and there is a lot
24383 of chunks in literate documents, you may get tired of seeing everything
24385 You can change it by going to the tabs
24394 \begin_layout Standard
24395 The next thing is the visible presence of the newline character in the screen.
24396 You can choose the color of this particular character and make it blend
24398 I recommend you choosing a color that is close to the background but not
24399 equal, that way you still can see it is there, but it is not bothering
24403 \begin_layout Subsection
24408 \begin_layout Standard
24417 is documented in the
24421 example file and in the Sweave manual (menu
24423 Help\SpecialChar menuseparator
24429 \begin_layout Chapter
24433 \begin_layout Standard
24434 You can do everything with \SpecialChar LyX
24435 that you can do with \SpecialChar LaTeX
24437 However, \SpecialChar LyX
24438 cannot support every \SpecialChar LaTeX
24440 But you can always use \SpecialChar TeX
24442 This chapter shows you some more special things you might want to use.
24443 For other special things you can do with figures, tables, floats, boxes
24444 and notes, have a look at the
24447 \begin_inset space ~
24455 \begin_layout Section
24456 Multiple Text Columns
24459 \begin_layout Standard
24460 This feature is independent of the option
24462 Two-column document
24464 in the document settings under
24469 If you want to have 2
24470 \begin_inset space ~
24473 columns for the whole document, it is recommended to use the
24475 Two-column document
24478 For all other cases use this feature.
24481 \begin_layout Standard
24482 To use multiple text columns in your document, you have to load the module
24489 Document\SpecialChar menuseparator
24490 Settings\SpecialChar menuseparator
24493 ) and must have the \SpecialChar LaTeX
24495 \begin_inset Flex Code
24498 \begin_layout Plain Layout
24507 \begin_layout Standard
24508 Footnotes within multiple columns will be placed at the bottom of the page
24509 and not under each column.
24510 Within the different columns you can use everything, with the limitation
24511 that for floats you need to use the float option
24518 \begin_layout Subsection
24522 \begin_layout Standard
24523 If you want to have 2
24524 \begin_inset space ~
24527 columns in your text, insert a multicolumn inset via the menu
24529 Insert\SpecialChar menuseparator
24531 \begin_inset space ~
24534 Insets\SpecialChar menuseparator
24536 \begin_inset space ~
24541 where the columns should start.
24542 Write all text that should be printed in 2
24543 \begin_inset space ~
24546 columns into this inset.
24549 \begin_layout Standard
24550 Here is an example:
24553 \begin_layout Standard
24555 \begin_inset Flex Multiple Columns
24558 \begin_layout Plain Layout
24563 The Adventure of the Empty House
24566 \begin_inset Newline newline
24569 by Sir Arthur Conan Doyle
24572 \begin_layout Plain Layout
24575 It was in the spring of the year 1894 that all London was interested, and
24576 the fashionable world dismayed, by the murder of the Honourable Ronald
24577 Adair under most unusual and inexplicable circumstances.
24578 The public has already learned those particulars of the crime which came
24579 out in the police investigation, but a good deal was suppressed upon that
24580 occasion, since the case for the prosecution was so overwhelmingly strong
24581 that it was not necessary to bring forward all the facts.
24582 Only now, at the end of nearly ten years, am I allowed to supply those
24583 missing links which make up the whole of that remarkable chain.
24584 The crime was of interest in itself, but that interest was as nothing to
24585 me compared to the inconceivable sequel, which afforded me the greatest
24586 shock and surprise of any event in my adventurous life.
24587 Even now, after this long interval, I find myself thrilling as I think
24588 of it, and feeling once more that sudden flood of joy, amazement, and increduli
24589 ty which utterly submerged my mind.
24590 Let me say to that public, which has shown some interest in those glimpses
24591 which I have occasionally given them of the thoughts and actions of a very
24592 remarkable man, that they are not to blame me if I have not shared my knowledge
24593 with them, for I should have considered it my first duty to do so, had
24594 I not been barred by a positive prohibition from his own lips, which was
24595 only withdrawn upon the third of last month.
24603 \begin_layout Standard
24604 To get 3 or more columns, set the cursor into the multicolumn inset and
24607 Insert\SpecialChar menuseparator
24609 \begin_inset space ~
24613 \begin_inset space ~
24619 The number of the desired columns is written into that inset (for 3
24620 \begin_inset space ~
24624 \begin_inset Quotes eld
24628 \begin_inset Quotes erd
24632 \begin_inset Newline newline
24635 Here is an example with 3
24636 \begin_inset space ~
24642 \begin_layout Standard
24643 \begin_inset Flex Multiple Columns
24646 \begin_layout Plain Layout
24649 \begin_inset Argument 1
24652 \begin_layout Plain Layout
24659 It can be imagined that my close intimacy with Sherlock Holmes had interested
24660 me deeply in crime, and that after his disappearance I never failed to
24661 read with care the various problems which came before the public.
24662 And I even attempted, more than once, for my own private satisfaction,
24663 to employ his methods in their solution, though with indifferent success.
24664 There was none, however, which appealed to me like this tragedy of Ronald
24666 As I read the evidence at the inquest, which led up to a verdict of willful
24667 murder against some person or persons unknown, I realized more clearly
24668 than I had ever done the loss which the community had sustained by the
24669 death of Sherlock Holmes.
24670 There were points about this strange business which would, I was sure,
24671 have specially appealed to him, and the efforts of the police would have
24672 been supplemented, or more probably anticipated, by the trained observation
24673 and the alert mind of the first criminal agent in Europe.
24674 All day, as I drove upon my round, I turned over the case in my mind and
24675 found no explanation which appeared to me to be adequate.
24676 At the risk of telling a twice-told tale, I will recapitulate the facts
24677 as they were known to the public at the conclusion of the inquest.
24685 \begin_layout Standard
24686 You can have up to 10
24687 \begin_inset space ~
24690 columns if you want to, but that might not be very pleasant for the readers
24694 \begin_layout Standard
24695 \begin_inset Newpage newpage
24701 \begin_layout Subsection
24702 Columns inside Columns
24705 \begin_layout Standard
24706 You can also have columns inside columns:
24709 \begin_layout Standard
24710 \begin_inset Flex Multiple Columns
24713 \begin_layout Plain Layout
24716 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
24717 at that time governor of one of the Australian colonies.
24718 Adair's mother had returned from Australia to undergo the operation for
24719 cataract, and she, her son Ronald, and her daughter Hilda were living together
24723 \begin_layout Plain Layout
24724 \begin_inset Flex Multiple Columns
24727 \begin_layout Plain Layout
24730 The youth moved in the best society
24731 \begin_inset space ~
24734 – had, so far as was known, no enemies and no particular vices.
24735 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
24736 had been broken off by mutual consent some months before, and there was
24737 no sign that it had left any very profound feeling behind it.
24738 For the rest {sic} the man's life moved in a narrow and conventional circle,
24739 for his habits were quiet and his nature unemotional.
24740 Yet it was upon this easy-going young aristocrat that death came, in most
24741 strange and unexpected form, between the hours of ten and eleven-twenty
24742 on the night of March 30, 1894.
24750 \begin_layout Plain Layout
24753 Ronald Adair was fond of cards
24754 \begin_inset space ~
24757 – playing continually, but never for such stakes as would hurt him.
24758 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
24759 It was shown that, after dinner on the day of his death, he had played
24760 a rubber of whist at the latter club.
24761 He had also played there in the afternoon.
24766 The evidence of those who had played with him
24767 \begin_inset space ~
24771 Murray, Sir John Hardy, and Colonel Moran
24772 \begin_inset space ~
24775 – showed that the game was whist, and that there was a fairly equal fall
24777 Adair might have lost five pounds, but not more.
24778 His fortune was a considerable one, and such a loss could not in any way
24780 He had played nearly every day at one club or other, but he was a cautious
24781 player, and usually rose a winner.
24782 It came out in evidence that, in partnership with Colonel Moran, he had
24783 actually won as much as four hundred and twenty pounds in a sitting, some
24784 weeks before, from Godfrey Milner and Lord Balmoral.
24785 So much for his recent history as it came out at the inquest.
24793 \begin_layout Subsection
24797 \begin_layout Standard
24798 The examples in this section show some more special features of multiple
24802 \begin_layout Standard
24803 For more features of multiple columns, have a look at the
24804 \begin_inset CommandInset href
24806 name "documentation"
24807 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
24812 of the \SpecialChar LaTeX
24814 \begin_inset Flex Code
24817 \begin_layout Plain Layout
24826 \begin_layout Subsubsection
24830 \begin_layout Standard
24831 To add a preface text for multiple columns, set the cursor into the multicolumn
24832 inset and use the menu
24834 Insert\SpecialChar menuseparator
24838 Write your preface text into that inset.
24839 \begin_inset Newline newline
24842 This is an example with some preface text:
24845 \begin_layout Standard
24846 \begin_inset VSpace bigskip
24852 \begin_layout Standard
24853 \begin_inset Flex Multiple Columns
24856 \begin_layout Plain Layout
24857 \begin_inset Argument 2
24860 \begin_layout Plain Layout
24861 And the story continues and continues and continues and continues\SpecialChar ldots
24869 On the evening of the crime, he returned from the club exactly at ten.
24870 His mother and sister were out spending the evening with a relation.
24871 The servant deposed that she heard him enter the front room on the second
24872 floor, generally used as his sitting-room.
24873 She had lit a fire there, and as it smoked she had opened the window.
24874 No sound was heard from the room until eleven-twenty, the hour of the return
24875 of Lady Maynooth and her daughter.
24876 Desiring to say good-night, she attempted to enter her son's room.
24877 The door was locked on the inside, and no answer could be got to their
24878 cries and knocking.
24879 Help was obtained, and the door forced.
24880 The unfortunate young man was found lying near the table.
24881 His head had been horribly mutilated by an expanding revolver bullet, but
24882 no weapon of any sort was to be found in the room.
24890 \begin_layout Standard
24891 You can also use a section heading as the preface if you use a section command
24892 as \SpecialChar TeX
24894 For example the command
24897 \begin_layout LyX-Code
24900 subsection{subsection title}
24903 \begin_layout Standard
24904 creates a subsection.
24905 In this example the preface is a subsubsection:
24908 \begin_layout Standard
24909 \begin_inset Flex Multiple Columns
24912 \begin_layout Plain Layout
24913 \begin_inset Argument 2
24916 \begin_layout Plain Layout
24920 \begin_layout Plain Layout
24929 This is a subsubsection heading as a preface
24933 \begin_layout Plain Layout
24947 A minute examination of the circumstances served only to make the case more
24949 In the first place, no reason could be given why the young man should have
24950 fastened the door upon the inside.
24951 There was the possibility that the murderer had done this, and had afterwards
24952 escaped by the window.
24953 The drop was at least twenty feet, however, and a bed of crocuses in full
24955 Neither the flowers nor the earth showed any sign of having been disturbed,
24956 nor were there any marks upon the narrow strip of grass which separated
24957 the house from the road.
24958 Apparently, therefore, it was the young man himself who had fastened the
24960 But how did he come by his death? No one could have climbed up to the window
24961 without leaving traces.
24962 Suppose a man had fired through the window, he would indeed be a remarkable
24963 shot who could with a revolver inflict so deadly a wound.
24964 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
24965 a hundred yards of the house.
24966 No one had heard a shot.
24974 \begin_layout Standard
24975 If there is less vertical space than 6
24976 \begin_inset space ~
24979 text lines is left on the page at the beginning of the multiple columns,
24980 a page break will be inserted before the multiple columns.
24981 Depending on the number of lines of the preface text, you might want to
24983 This is done by setting the cursor into the mulitcolumn inset behind the
24984 preface (if there is any) and using the menu
24986 Insert\SpecialChar menuseparator
24988 \begin_inset space ~
24992 \begin_inset space ~
24996 \begin_inset space ~
25002 Insert into that inset the amount of space like e.
25003 \begin_inset space \thinspace{}
25007 \begin_inset space \space{}
25011 \begin_inset Quotes eld
25015 \begin_inset Quotes erd
25019 \begin_inset Newline newline
25022 In this example the space is set to 7
25023 \begin_inset space ~
25026 text lines by using
25027 \begin_inset Flex Code
25030 \begin_layout Plain Layout
25039 \begin_inset Flex Code
25042 \begin_layout Plain Layout
25050 needs to be inserted as \SpecialChar TeX
25054 \begin_layout Standard
25055 \begin_inset Flex Multiple Columns
25058 \begin_layout Plain Layout
25059 \begin_inset Argument 3
25062 \begin_layout Plain Layout
25067 \begin_layout Plain Layout
25083 On the evening of the crime, he returned from the club exactly at ten.
25084 His mother and sister were out spending the evening with a relation.
25085 The servant deposed that she heard him enter the front room on the second
25086 floor, generally used as his sitting-room.
25087 She had lit a fire there, and as it smoked she had opened the window.
25088 No sound was heard from the room until eleven-twenty, the hour of the return
25089 of Lady Maynooth and her daughter.
25090 Desiring to say good-night, she attempted to enter her son's room.
25091 The door was locked on the inside, and no answer could be got to their
25092 cries and knocking.
25093 Help was obtained, and the door forced.
25094 The unfortunate young man was found lying near the table.
25095 His head had been horribly mutilated by an expanding revolver bullet, but
25096 no weapon of any sort was to be found in the room.
25104 \begin_layout Subsubsection
25108 \begin_layout Standard
25109 The amount of space before and after multiple columns can be changed by
25110 changing the length
25111 \begin_inset Flex Code
25114 \begin_layout Plain Layout
25123 For example the command
25126 \begin_layout LyX-Code
25134 \begin_layout Standard
25135 in \SpecialChar TeX
25136 Code changes its value to 3
25137 \begin_inset space \thinspace{}
25141 The change must be made before the multiple columns' start.
25142 The predefined value is 13
25143 \begin_inset space \thinspace{}
25149 \begin_layout Standard
25151 \begin_inset Flex Code
25154 \begin_layout Plain Layout
25163 \begin_inset space \thinspace{}
25169 \begin_layout Standard
25173 \begin_layout Plain Layout
25179 multicolsep}{2.5cm}
25187 \begin_layout Standard
25188 \begin_inset Flex Multiple Columns
25191 \begin_layout Plain Layout
25194 All day I turned these facts over in my mind, endeavouring to hit upon some
25195 theory which could reconcile them all, and to find that line of least resistanc
25196 e which my poor friend had declared to be the starting-point of every investigat
25198 I confess that I made little progress.
25199 In the evening I strolled across the Park, and found myself about six o'clock
25200 at the Oxford Street end of Park Lane.
25201 A group of loafers upon the pavements, all staring up at a particular window,
25202 directed me to the house which I had come to see.
25203 A tall, thin man with coloured glasses, whom I strongly suspected of being
25204 a plain-clothes detective, was pointing out some theory of his own, while
25205 the others crowded round to listen to what he said.
25206 I got as near him as I could, but his observations seemed to me to be absurd,
25207 so I withdrew again in some disgust.
25208 As I did so I struck against an elderly, deformed man, who had been behind
25209 me, and I knocked down several books which he was carrying.
25217 \begin_layout Standard
25218 \begin_inset Note Greyedout
25221 \begin_layout Plain Layout
25226 The values you set with
25227 \begin_inset Flex Code
25230 \begin_layout Plain Layout
25238 will be used for all following multiple columns until you change them again.
25246 \begin_layout Standard
25250 \begin_layout Plain Layout
25262 \begin_inset Note Note
25265 \begin_layout Plain Layout
25266 go back to the default
25274 \begin_layout Standard
25275 \begin_inset Newpage newpage
25281 \begin_layout Subsubsection
25285 \begin_layout Standard
25286 A column break can be forced by inserting the command
25287 \begin_inset Flex Code
25290 \begin_layout Plain Layout
25298 as \SpecialChar TeX
25299 Code to that position in the text where the column should be broken.
25300 Note that this leads in most cases to whitespace in the text.
25301 \begin_inset Newline newline
25304 Here is an example:
25307 \begin_layout Standard
25308 \begin_inset Flex Multiple Columns
25311 \begin_layout Plain Layout
25314 \begin_inset Quotes eld
25317 You're surprised to see me, sir,
25318 \begin_inset Quotes erd
25321 said he, in a strange, croaking voice.
25324 \begin_layout Plain Layout
25327 I acknowledged that I was.
25330 \begin_layout Plain Layout
25333 \begin_inset Quotes eld
25336 Well, I've a conscience, sir, and when I chanced to see you go into this
25337 house, as I came hobbling after you, I thought to myself, I'll just step
25338 in and see that kind gentleman, and tell him that if I was a bit gruff
25339 in my manner there was not any harm meant, and that I am much obliged to
25340 him for picking up my books.
25341 \begin_inset Quotes erd
25347 \begin_layout Plain Layout
25350 \begin_inset Quotes eld
25353 You make too much of a trifle,
25354 \begin_inset Quotes erd
25359 \begin_inset Quotes eld
25362 May I ask how you knew who I was?
25363 \begin_inset Quotes erd
25366 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
25370 \begin_layout Plain Layout
25382 \begin_layout Plain Layout
25385 \begin_inset Quotes eld
25388 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25389 you'll find my little bookshop at the corner of Church Street, and very
25390 happy to see you, I am sure.
25391 Maybe you collect yourself, sir.
25395 \begin_inset space ~
25409 \begin_inset space ~
25412 – a bargain, every one of them.
25413 With five volumes you could just fill that gap on that second shelf.
25414 It looks untidy, does it not, sir?
25415 \begin_inset Quotes erd
25426 \begin_layout Subsubsection
25430 \begin_layout Standard
25431 The width of the columns is automatically calculated, but you can modify
25432 the space between the columns.
25433 This is done by changing the length
25434 \begin_inset Flex Code
25437 \begin_layout Plain Layout
25446 Its predefined value is 10
25447 \begin_inset space \thinspace{}
25451 Here is an example where
25452 \begin_inset Flex Code
25455 \begin_layout Plain Layout
25464 \begin_inset space \thinspace{}
25470 \begin_layout Standard
25474 \begin_layout Plain Layout
25488 \begin_layout Standard
25489 \begin_inset Flex Multiple Columns
25492 \begin_layout Plain Layout
25495 My observations of No.
25496 \begin_inset space \space{}
25499 427 Park Lane did little to clear up the problem in which I was interested.
25500 The house was separated from the street by a low wall and railing, the
25501 whole not more than five feet high.
25502 It was perfectly easy, therefore, for anyone to get into the garden, but
25503 the window was entirely inaccessible, since there was no water pipe or
25504 anything which could help the most active man to climb it.
25505 More puzzled than ever, I retraced my steps to Kensington.
25506 I had not been in my study five minutes when the maid entered to say that
25507 a person desired to see me.
25508 To my astonishment it was none other than my strange old book collector,
25509 his sharp, wizened face peering out from a frame of white hair, and his
25510 precious volumes, a dozen of them at least, wedged under his right arm.
25518 \begin_layout Standard
25522 \begin_layout Plain Layout
25534 \begin_inset Note Note
25537 \begin_layout Plain Layout
25538 go back to the default
25546 \begin_layout Subsubsection
25550 \begin_layout Standard
25551 Between the columns a rule with a width of the length
25552 \begin_inset Flex Code
25555 \begin_layout Plain Layout
25564 If this rule width is set to 0
25565 \begin_inset space \thinspace{}
25568 pt (this is the default), the rule is suppressed.
25569 In the following example the rule is 2
25570 \begin_inset space \thinspace{}
25576 \begin_layout Standard
25580 \begin_layout Plain Layout
25586 columnseprule}{2pt}
25594 \begin_layout Standard
25595 \begin_inset Flex Multiple Columns
25598 \begin_layout Plain Layout
25601 \begin_inset Quotes eld
25604 You're surprised to see me, sir,
25605 \begin_inset Quotes erd
25608 said he, in a strange, croaking voice.
25611 \begin_layout Plain Layout
25614 I acknowledged that I was.
25617 \begin_layout Plain Layout
25620 \begin_inset Quotes eld
25623 Well, I've a conscience, sir, and when I chanced to see you go into this
25624 house, as I came hobbling after you, I thought to myself, I'll just step
25625 in and see that kind gentleman, and tell him that if I was a bit gruff
25626 in my manner there was not any harm meant, and that I am much obliged to
25627 him for picking up my books.
25628 \begin_inset Quotes erd
25634 \begin_layout Plain Layout
25637 \begin_inset Quotes eld
25640 You make too much of a trifle,
25641 \begin_inset Quotes erd
25646 \begin_inset Quotes eld
25649 May I ask how you knew who I was?
25650 \begin_inset Quotes erd
25656 \begin_layout Plain Layout
25659 \begin_inset Quotes eld
25662 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25663 you'll find my little bookshop at the corner of Church Street, and very
25664 happy to see you, I am sure.
25665 Maybe you collect yourself, sir.
25669 \begin_inset space ~
25683 \begin_inset space ~
25686 – a bargain, every one of them.
25687 With five volumes you could just fill that gap on that second shelf.
25688 It looks untidy, does it not, sir?
25689 \begin_inset Quotes erd
25700 \begin_layout Standard
25701 \begin_inset VSpace defskip
25707 \begin_layout Standard
25708 The rule can be colored by redefining the command
25709 \begin_inset Flex Code
25712 \begin_layout Plain Layout
25721 This is done by inserting the command
25724 \begin_layout LyX-Code
25729 columnseprulecolor}{
25734 \begin_layout Standard
25735 as \SpecialChar TeX
25736 Code before the multicolumn inset.
25738 \begin_inset Flex Code
25741 \begin_layout Plain Layout
25747 in this command by a color of your choice.
25748 You can use all pre- and self-defined colors.
25756 \begin_inset space ~
25761 for more information about pre- and self-defined colors.
25762 To go back to the default color insert the command
25765 \begin_layout LyX-Code
25770 columnseprulecolor}{
25775 \begin_layout Standard
25776 Here is the example with a cyan rule and 1
25777 \begin_inset space \thinspace{}
25780 cm column separation:
25783 \begin_layout Standard
25787 \begin_layout Plain Layout
25796 \begin_layout Plain Layout
25802 columnseprulecolor}{
25812 \begin_layout Standard
25813 \begin_inset Flex Multiple Columns
25816 \begin_layout Plain Layout
25819 \begin_inset Quotes eld
25822 You're surprised to see me, sir,
25823 \begin_inset Quotes erd
25826 said he, in a strange, croaking voice.
25829 \begin_layout Plain Layout
25832 I acknowledged that I was.
25835 \begin_layout Plain Layout
25838 \begin_inset Quotes eld
25841 Well, I've a conscience, sir, and when I chanced to see you go into this
25842 house, as I came hobbling after you, I thought to myself, I'll just step
25843 in and see that kind gentleman, and tell him that if I was a bit gruff
25844 in my manner there was not any harm meant, and that I am much obliged to
25845 him for picking up my books.
25846 \begin_inset Quotes erd
25852 \begin_layout Plain Layout
25855 \begin_inset Quotes eld
25858 You make too much of a trifle,
25859 \begin_inset Quotes erd
25864 \begin_inset Quotes eld
25867 May I ask how you knew who I was?
25868 \begin_inset Quotes erd
25874 \begin_layout Plain Layout
25877 \begin_inset Quotes eld
25880 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25881 you'll find my little bookshop at the corner of Church Street, and very
25882 happy to see you, I am sure.
25883 Maybe you collect yourself, sir.
25887 \begin_inset space ~
25901 \begin_inset space ~
25904 – a bargain, every one of them.
25905 With five volumes you could just fill that gap on that second shelf.
25906 It looks untidy, does it not, sir?
25907 \begin_inset Quotes erd
25918 \begin_layout Standard
25922 \begin_layout Plain Layout
25928 columnseprule}{0pt}
25931 \begin_layout Plain Layout
25937 columnseprulecolor}{
25945 \begin_inset Note Note
25948 \begin_layout Plain Layout
25949 go back to the default
25957 \begin_layout Section
25958 Non-standard Paragraph Shapes
25961 \begin_layout Standard
25964 as well as any other text processor uses by default rectangular paragraphs.
25965 For special cases like for example posters, invitation cards or poems you
25966 can modify the paragraph shape to one of your choice.
25967 This can be done by using the \SpecialChar LaTeX
25969 \begin_inset Flex Code
25972 \begin_layout Plain Layout
25978 which is loaded by using in the document settings the module
25980 Custom paragraph shapes
25985 \begin_layout Subsection
25989 \begin_layout Standard
25994 provides the following shapes:
25997 \begin_layout Standard
25998 \begin_inset Tabular
25999 <lyxtabular version="3" rows="13" columns="3">
26000 <features booktabs="true" islongtable="true" longtabularalignment="center">
26001 <column alignment="left" valignment="middle" width="16col%">
26002 <column alignment="left" valignment="middle" width="40col%">
26003 <column alignment="left" valignment="middle" width="35col%">
26004 <row endhead="true">
26005 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26008 \begin_layout Plain Layout
26017 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26020 \begin_layout Plain Layout
26029 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26032 \begin_layout Plain Layout
26042 <row interlinespace="default">
26043 <cell alignment="left" valignment="top" usebox="none">
26046 \begin_layout Plain Layout
26054 <cell alignment="left" valignment="top" usebox="none">
26057 \begin_layout Plain Layout
26060 Circle with circular hole (in the size of a CD/DVD)
26065 <cell alignment="left" valignment="top" usebox="none">
26068 \begin_layout Plain Layout
26071 Cannot be scaled, take care there is not too much text
26077 <row interlinespace="default">
26078 <cell alignment="left" valignment="top" usebox="none">
26081 \begin_layout Plain Layout
26089 <cell alignment="left" valignment="top" usebox="none">
26092 \begin_layout Plain Layout
26100 <cell alignment="left" valignment="top" usebox="none">
26103 \begin_layout Plain Layout
26106 Fragile, calculation might fail
26112 <row interlinespace="default">
26113 <cell alignment="left" valignment="top" usebox="none">
26116 \begin_layout Plain Layout
26124 <cell alignment="left" valignment="top" usebox="none">
26127 \begin_layout Plain Layout
26130 Rhomboid (symbolizing a
26131 \begin_inset Quotes eld
26135 \begin_inset Quotes erd
26143 <cell alignment="left" valignment="top" usebox="none">
26146 \begin_layout Plain Layout
26155 <row interlinespace="default">
26156 <cell alignment="left" valignment="top" usebox="none">
26159 \begin_layout Plain Layout
26167 <cell alignment="left" valignment="top" usebox="none">
26170 \begin_layout Plain Layout
26178 <cell alignment="left" valignment="top" usebox="none">
26181 \begin_layout Plain Layout
26190 <row interlinespace="default">
26191 <cell alignment="left" valignment="top" usebox="none">
26194 \begin_layout Plain Layout
26202 <cell alignment="left" valignment="top" usebox="none">
26205 \begin_layout Plain Layout
26213 <cell alignment="left" valignment="top" usebox="none">
26216 \begin_layout Plain Layout
26225 <row interlinespace="default">
26226 <cell alignment="left" valignment="top" usebox="none">
26229 \begin_layout Plain Layout
26237 <cell alignment="left" valignment="top" usebox="none">
26240 \begin_layout Plain Layout
26243 Nut for bolt (hexagon with circular hole)
26248 <cell alignment="left" valignment="top" usebox="none">
26251 \begin_layout Plain Layout
26260 <row interlinespace="default">
26261 <cell alignment="left" valignment="top" usebox="none">
26264 \begin_layout Plain Layout
26272 <cell alignment="left" valignment="top" usebox="none">
26275 \begin_layout Plain Layout
26283 <cell alignment="left" valignment="top" usebox="none">
26286 \begin_layout Plain Layout
26295 <row interlinespace="default">
26296 <cell alignment="left" valignment="top" usebox="none">
26299 \begin_layout Plain Layout
26307 <cell alignment="left" valignment="top" usebox="none">
26310 \begin_layout Plain Layout
26318 <cell alignment="left" valignment="top" usebox="none">
26321 \begin_layout Plain Layout
26330 <row interlinespace="default">
26331 <cell alignment="left" valignment="top" usebox="none">
26334 \begin_layout Plain Layout
26342 <cell alignment="left" valignment="top" usebox="none">
26345 \begin_layout Plain Layout
26353 <cell alignment="left" valignment="top" usebox="none">
26356 \begin_layout Plain Layout
26365 <row interlinespace="default">
26366 <cell alignment="left" valignment="top" usebox="none">
26369 \begin_layout Plain Layout
26377 <cell alignment="left" valignment="top" usebox="none">
26380 \begin_layout Plain Layout
26383 Normal/reversed rain drop
26388 <cell alignment="left" valignment="top" usebox="none">
26391 \begin_layout Plain Layout
26394 Fragile, calculation might fail
26400 <row interlinespace="default">
26401 <cell alignment="left" valignment="top" usebox="none">
26404 \begin_layout Plain Layout
26413 <cell alignment="left" valignment="top" usebox="none">
26416 \begin_layout Plain Layout
26419 The \SpecialChar TeX
26425 <cell alignment="left" valignment="top" usebox="none">
26428 \begin_layout Plain Layout
26437 <row interlinespace="default">
26438 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
26441 \begin_layout Plain Layout
26445 \begin_inset Newline newline
26453 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
26456 \begin_layout Plain Layout
26459 Triangles in different orientations
26464 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
26467 \begin_layout Plain Layout
26483 \begin_layout Standard
26484 To use a shape for your paragraph, simply select it in \SpecialChar LyX
26486 for environments in the toolbar.
26489 \begin_layout Standard
26490 \begin_inset Newpage newpage
26496 \begin_layout Standard
26497 Here is an example paragraph in the shape of a nut:
26500 \begin_layout Standard
26501 \begin_inset VSpace bigskip
26510 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26511 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26513 At vero eos et accusam et justo duo dolores et ea rebum.
26514 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26516 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26517 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26521 \begin_layout Standard
26522 \begin_inset VSpace bigskip
26528 \begin_layout Standard
26529 \begin_inset Note Greyedout
26532 \begin_layout Plain Layout
26541 paragraphs cannot run over a page break.
26549 \begin_layout Standard
26550 \begin_inset VSpace bigskip
26556 \begin_layout Standard
26558 \begin_inset Flex Code
26561 \begin_layout Plain Layout
26567 takes care that the shape will always be preserved, no matter how much
26568 text is in the paragraph.
26569 Therefore the paragraph size changes with the amount of contained text.
26570 This can lead to paragraph sizes exceeding the page margins.
26571 To demonstrate the size scaling, here is the same example paragraph but
26572 with twice as much text:
26575 \begin_layout Standard
26576 \begin_inset Newpage newpage
26585 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26586 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26588 At vero eos et accusam et justo duo dolores et ea rebum.
26589 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26591 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26592 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26594 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26595 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26597 At vero eos et accusam et justo duo dolores et ea rebum.
26598 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26600 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26601 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26605 \begin_layout Standard
26606 \begin_inset VSpace bigskip
26612 \begin_layout Standard
26613 An exception is the shape
26618 It cannot be scaled because it must fit the size of a CD/DVD.
26619 Therefore the amount of text that fits into the shape is limited.
26620 \begin_inset Newline newline
26631 shape are fragile, meaning that the calculation of their size can fail,
26632 depending on the amount of text.
26633 You will then get the \SpecialChar LaTeX
26635 \begin_inset Quotes eld
26638 Arithmetic overflow
26639 \begin_inset Quotes erd
26643 In this case one can try to remove or add some text; if nothing works one
26644 has to use another shape.
26647 \begin_layout Standard
26648 \begin_inset VSpace bigskip
26654 \begin_layout Standard
26655 For shapes with tips you will maybe see that \SpecialChar LaTeX
26656 's hyphenation routine fails
26657 for text in the tips.
26658 Therefore it is often necessary to add hyphenation points
26663 arg "specialchar-insert hyphenation"
26668 ) to the corresponding text parts.
26671 \begin_layout Standard
26672 \begin_inset VSpace bigskip
26678 \begin_layout Standard
26679 Shapepar paragraphs are either always centered or placed on the page so
26680 that their left border touches the left page margin.
26681 You can therefore not use the paragraph dialog to align such paragraphs.
26682 A solution is to put the paragraph into a minipage or parbox and align
26684 The problem is hereby to find the right width for the box.
26685 Because if it is too wide and you center the box, the paragraph is not
26686 centered too because it sticks at the left side of the box.
26687 So you might have to play a bit with the width until it fits.
26688 Here are two heart-shaped paragraphs, the first one is not aligned, the
26689 second one is right-aligned:
26692 \begin_layout Standard
26693 \begin_inset Newpage newpage
26699 \begin_layout Heart
26703 Lo\SpecialChar softhyphen
26704 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26705 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26707 At vero eos et accusam et justo duo dolores et ea rebum.
26708 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26712 \begin_layout Standard
26713 \begin_inset VSpace bigskip
26719 \begin_layout Standard
26722 \begin_inset Box Frameless
26732 height_special "totalheight"
26737 backgroundcolor "none"
26740 \begin_layout Heart
26744 Lo\SpecialChar softhyphen
26745 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26746 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26748 At vero eos et accusam et justo duo dolores et ea rebum.
26749 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26758 \begin_layout Subsection
26762 \begin_layout Standard
26763 You can define any shape you want.
26764 Doing this manually is a lot of work because every coordinate must be specified.
26765 But there is a way to let the computer calculate the coordinates:
26768 \begin_layout Enumerate
26769 Install the program
26770 \begin_inset CommandInset href
26773 target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
26781 \begin_layout Enumerate
26788 TeX/LaTeX\SpecialChar menuseparator
26789 Settings\SpecialChar menuseparator
26792 and select the font size you are using in your document.
26793 For example this document uses the size 12
26794 \begin_inset space \thinspace{}
26800 \begin_layout Enumerate
26804 \begin_layout Enumerate
26807 TeX/LaTeX\SpecialChar menuseparator
26810 to export the shape to coordinates.
26811 In the appearing dialog use either the outline of your shape for the coordinate
26812 s or the path itself.
26816 \begin_layout Plain Layout
26817 For more information see
26818 \begin_inset CommandInset href
26820 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
26833 \begin_layout Standard
26834 The coordinates are written into a \SpecialChar TeX
26836 To use it for your \SpecialChar LyX
26840 \begin_layout Enumerate
26841 Place the cursor before the first character of your paragraph (or into a
26845 \begin_layout Enumerate
26846 Open in \SpecialChar LyX
26849 Insert\SpecialChar menuseparator
26850 File\SpecialChar menuseparator
26852 \begin_inset space ~
26857 , select the file and use
26866 \begin_layout Standard
26867 \begin_inset VSpace defskip
26873 \begin_layout Standard
26874 \begin_inset Note Greyedout
26877 \begin_layout Plain Layout
26882 : The changed shape only applies to the current paragraph; everything is
26883 reset to normal for the next paragraph.
26884 Therefore the shape definition file must be input into every paragraph
26885 with the desired shape.
26893 \begin_layout Standard
26894 \begin_inset VSpace bigskip
26900 \begin_layout Standard
26901 Here is an example:
26904 \begin_layout Standard
26905 \begin_inset VSpace bigskip
26911 \begin_layout Standard
26912 \begin_inset CommandInset include
26914 filename "SpecialParagraphShape.tex"
26921 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26922 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26924 At vero eos et accusam et justo duo dolores et ea rebum.
26925 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26927 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26928 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26932 \begin_layout Standard
26933 \begin_inset VSpace bigskip
26939 \begin_layout Standard
26944 to draw complexer shapes in
26948 you can draw the shape in a program of your choice and import the resulting
26954 Then you only need to draw a line or spline along the outline of the image.
26957 \begin_layout Standard
26958 \begin_inset VSpace bigskip
26964 \begin_layout Standard
26967 Custom paragraph shapes
26969 also provides the two commands
26977 which can be used to define custom shapes coordinate by coordinate.
26981 \begin_layout Plain Layout
26982 These commands are internally used for all shapes described here.
26987 For information how these styles are used and about further customization
26988 possibilities, have a look at the
26989 \begin_inset CommandInset href
26991 name "documentation"
26992 target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
26998 \begin_inset Flex Code
27001 \begin_layout Plain Layout