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"
133 \author 244031559 "Yuriy"
134 \author 630872221 "Jean-Pierre Chrétien" jeanpierre.chretien@free.fr
135 \author 1075283030 "Thibaut"
136 \author 1119979965 "Joel A. Kulesza"
142 Additional \SpecialChar LyX
146 \begin_layout Subtitle
148 \change_deleted 630872221 1622909155
150 \change_inserted 630872221 1622909155
157 by the \SpecialChar LyX
162 \begin_layout Plain Layout
164 Principal maintainer of this file is
166 Richard Kimberly Heck
169 If you have comments or error corrections, please send them to the \SpecialChar LyX
172 \begin_inset Flex Code
175 \begin_layout Plain Layout
176 <lyx-docs@lists.lyx.org>
189 \begin_layout Standard
190 \begin_inset CommandInset toc
191 LatexCommand tableofcontents
198 \begin_layout Chapter
202 \begin_layout Standard
203 This manual is essentially Part II of the
205 User's Guide\SpecialChar endofsentence
208 The reason for separating the two documents is simple: the
212 is already quite lengthy, and it contains information on all of the basic
213 features one needs to know in order to prepare most documents.
214 However, the \SpecialChar LyX
215 Team has worked to make \SpecialChar LyX
216 extensible through various configuration
217 files and external packages.
218 That means that if you want to support the Fizzwizzle \SpecialChar LaTeX
220 create a layout file (or module) for it without having to alter \SpecialChar LyX
222 We've already had contributions of several new features this way, and some
223 of them are documented here.
224 There are also some more `advanced' features, such as how to control the
225 presentation of bibliographies and how to work with multi-part documents,
226 that are not covered in the
230 and are discussed here.
233 \begin_layout Standard
234 This manual also documents some special features, like fax support
235 \change_deleted 244031559 1603802929
237 \change_inserted 244031559 1603802931
241 \change_deleted 244031559 1603802954
244 , which require additional software to work properly.
245 There is also a chapter on \SpecialChar LyX
247 And lastly, there's a chapter of \SpecialChar LaTeX
248 tools and tips, things you can use to
249 spruce up your documents by directly using the powerful features of \SpecialChar LaTeX
251 After all, \SpecialChar LyX
256 only WYSIWYM and will only ever interface to some, not all, \SpecialChar LaTeX
260 \begin_layout Standard
261 If you haven't read the
265 yet, you are definitely in the wrong manual.
270 is the first place to go, since it describes the notation and format of
272 You should also be thoroughly familiar with the
276 and all of the basic features of \SpecialChar LyX
277 before attempting to read this one.
280 \begin_layout Standard
281 Since many of the topics in this manual depend heavily on \SpecialChar LyX
283 with \SpecialChar LaTeX
284 , this first chapter covers the inner workings of \SpecialChar LyX
287 to generate exactly the \SpecialChar LaTeX
289 It is obviously for more seasoned \SpecialChar LyX
293 \begin_layout Chapter
295 and \SpecialChar LaTeX
299 \begin_layout Section
301 Uses \SpecialChar LaTeX
305 \begin_layout Standard
306 This chapter is for both \SpecialChar TeX
307 -nicians and the \SpecialChar LaTeX
309 In it, we'll explain how \SpecialChar LyX
310 and \SpecialChar LaTeX
311 work together to produce printable output.
312 This is the only place in any of the manuals where we assume you know something
313 about \SpecialChar LaTeX
317 \begin_layout Standard
318 At one time, \SpecialChar LyX
320 \begin_inset Quotes eld
323 WYSIWYM frontend to \SpecialChar LaTeX
325 \begin_inset Quotes erd
328 but that's no longer true.
329 There are frontends to \SpecialChar LaTeX
334 \begin_layout Plain Layout
335 Some familar ones are \SpecialChar TeX
336 maker and kile, on Linux, and \SpecialChar TeX
338 There are also the \SpecialChar LaTeX
339 modes for vi and emacs, of course.
344 These are basically text editors with the ability to run \SpecialChar LaTeX
346 errors in the file you're editing.
347 Although \SpecialChar LyX
356 run \SpecialChar LaTeX
357 , and it also indicates errors in the file, it also does much, much
359 For one thing, you don't need to know \SpecialChar LaTeX
360 to use \SpecialChar LyX
363 has added its own extensions to \SpecialChar LaTeX
365 Try the following sometime: select
366 \begin_inset Flex Noun
369 \begin_layout Plain Layout
370 Export\SpecialChar menuseparator
377 \begin_inset Flex Noun
380 \begin_layout Plain Layout
387 \begin_inset Flex Noun
390 \begin_layout Plain Layout
391 View\SpecialChar menuseparator
401 ), then look at the preamble of the resulting
402 \begin_inset Flex Code
405 \begin_layout Plain Layout
412 You'll notice a variety of new macros defined specifically by \SpecialChar LyX
414 These macros are defined automatically, according to the features you use
418 \begin_layout Standard
419 There are several commands that automatically invoke \SpecialChar LaTeX
424 \begin_layout Itemize
425 \begin_inset Flex Noun
428 \begin_layout Plain Layout
429 Document\SpecialChar menuseparator
438 \begin_layout Itemize
439 \begin_inset Flex Noun
442 \begin_layout Plain Layout
443 Document\SpecialChar menuseparator
452 \begin_layout Standard
453 They will only invoke \SpecialChar LaTeX
454 if the file has changed since the last time \SpecialChar LaTeX
460 \begin_layout Standard
461 When \SpecialChar LyX
462 runs \SpecialChar LaTeX
463 on the file you're editing, it performs these steps:
466 \begin_layout Enumerate
467 Convert the document to \SpecialChar LaTeX
468 and save to a file with the extension
469 \begin_inset Flex Code
472 \begin_layout Plain Layout
479 \begin_inset Flex Code
482 \begin_layout Plain Layout
491 \begin_layout Enumerate
492 Run \SpecialChar LaTeX
494 \begin_inset Flex Code
497 \begin_layout Plain Layout
503 file (maybe several times), and run any other commands (such as
504 \begin_inset Flex Code
507 \begin_layout Plain Layout
514 \begin_inset Flex Code
517 \begin_layout Plain Layout
523 ) needed to compile the \SpecialChar LaTeX
527 \begin_layout Enumerate
528 If there are any errors, show the error log.
531 \begin_layout Standard
532 If you have run \SpecialChar LaTeX
534 \begin_inset Flex Noun
537 \begin_layout Plain Layout
538 View\SpecialChar menuseparator
545 then runs a DVI viewer to display the DVI-file.
547 \begin_inset Flex Noun
550 \begin_layout Plain Layout
551 View\SpecialChar menuseparator
558 performs further steps:
561 \begin_layout Enumerate
563 \begin_inset Flex Code
566 \begin_layout Plain Layout
572 to convert the DVI file to PostScript.
575 \begin_layout Enumerate
576 Run a PostScript viewer, such as
577 \begin_inset Flex Code
580 \begin_layout Plain Layout
586 , to display the PostScript file.
589 \begin_layout Standard
591 does similar things when viewing, or exporting, other formats.
594 \begin_layout Section
595 Translating \SpecialChar LaTeX
596 files into \SpecialChar LyX
600 \begin_layout Standard
601 You can import a \SpecialChar LaTeX
602 file into \SpecialChar LyX
604 \begin_inset Flex Noun
607 \begin_layout Plain Layout
608 File\SpecialChar menuseparator
609 Import\SpecialChar menuseparator
615 command in \SpecialChar LyX
617 This will call a program named
618 \begin_inset Flex Code
621 \begin_layout Plain Layout
627 which will create a file
628 \begin_inset Flex Code
631 \begin_layout Plain Layout
638 \begin_inset Flex Code
641 \begin_layout Plain Layout
649 will then open that file.
653 \begin_layout Plain Layout
654 \begin_inset Flex Code
657 \begin_layout Plain Layout
663 can also be run from the command line, of course.
671 \begin_layout Standard
672 \begin_inset Flex Code
675 \begin_layout Plain Layout
681 will translate most legal \SpecialChar LaTeX
682 , but not everything.
683 It will put things it doesn't understand into \SpecialChar TeX
684 code, so after translating
686 \begin_inset Flex Code
689 \begin_layout Plain Layout
695 , you can look for \SpecialChar TeX
696 code and hand-edit it until it looks right.
699 \begin_layout Standard
700 If you don't know what \SpecialChar TeX
701 code is, read the next section.
704 \begin_layout Section
705 \begin_inset CommandInset label
707 name "sec:Inserting-TeX-Code"
711 Inserting \SpecialChar TeX
712 Code into \SpecialChar LyX
716 \begin_layout Standard
717 Anything you can do in \SpecialChar LaTeX
718 you can do in \SpecialChar LyX
719 , for a very simple reason: You can
720 always insert \SpecialChar TeX
721 code into any \SpecialChar LyX
724 cannot, and will never be able to, display every possible \SpecialChar LaTeX
726 If ever you need to insert \SpecialChar LaTeX
727 commands into your \SpecialChar LyX
728 document, you can use the
730 \begin_inset Flex Code
733 \begin_layout Plain Layout
740 box, which you can insert into your document with
741 \begin_inset Flex Noun
744 \begin_layout Plain Layout
745 Insert\SpecialChar menuseparator
755 or the keyboard shortcut
764 \begin_layout Standard
765 Here's an example of inserting \SpecialChar LaTeX
766 commands in a \SpecialChar LyX
768 The code looks like this:
771 \begin_layout LyX-Code
775 \begin_inset Newline newline
781 \begin_inset Newline newline
784 This is an example of a minipage environment.
786 \begin_inset Newline newline
789 can put nearly everything in it, even (non-floating)
790 \begin_inset Newline newline
795 \begin_inset Newline newline
801 \begin_inset Newline newline
805 \begin_inset Newline newline
811 \begin_inset Newline newline
817 \begin_inset Newline newline
823 \begin_inset Newline newline
828 \begin_inset Newline newline
834 \begin_inset Newline newline
840 \begin_inset Newline newline
846 \begin_inset Newline newline
854 \begin_layout LyX-Code
858 \begin_layout Standard
860 \begin_inset Flex Code
863 \begin_layout Plain Layout
870 box containing this text is directly after this paragraph.
871 Those of you reading the manual in \SpecialChar LyX
872 will only see the \SpecialChar TeX
874 Those reading a printed version of the manuals will see the actual results:
875 \begin_inset VSpace bigskip
881 \begin_layout Standard
885 \begin_layout Plain Layout
892 \begin_layout Plain Layout
899 \begin_layout Plain Layout
901 This is an example of a minipage environment.
902 You can put nearly everything in it, even (non-floating) figures and tables.
906 \begin_layout Plain Layout
913 \begin_layout Plain Layout
918 \begin_layout Plain Layout
925 \begin_layout Plain Layout
932 \begin_layout Plain Layout
939 \begin_layout Plain Layout
945 \begin_layout Plain Layout
952 \begin_layout Plain Layout
959 \begin_layout Plain Layout
966 \begin_layout Plain Layout
976 \begin_inset VSpace bigskip
982 \begin_layout Standard
983 In addition to using \SpecialChar TeX
984 code, you can also create a separate file containing
985 some complex \SpecialChar LaTeX
986 structure and then use
987 \begin_inset Flex Noun
990 \begin_layout Plain Layout
991 Insert\SpecialChar menuseparator
1001 to include your file (you should select the type
1002 \begin_inset Flex Code
1005 \begin_layout Plain Layout
1012 We recommend that you only do this if you have a
1013 \begin_inset Flex Code
1016 \begin_layout Plain Layout
1027 Otherwise, you'll have a big job tracking down \SpecialChar LaTeX
1031 \begin_layout Standard
1032 There are a few last points to emphasize:
1035 \begin_layout Itemize
1041 check if your \SpecialChar LaTeX
1045 \begin_layout Itemize
1046 Beware of reinventing the wheel.
1049 \begin_layout Standard
1050 On that last point, \SpecialChar LyX
1051 does have quite a few features tucked into it, and
1053 Be sure to check the manuals to make sure that \SpecialChar LyX
1054 doesn't have such-and-such
1055 feature before you decide you have to do it by hand.
1056 Moreover, there are numerous \SpecialChar LaTeX
1057 packages out there to do all sorts of things,
1058 from labels to envelopes to fancy multipage tables.
1060 \change_inserted 244031559 1603815732
1062 \begin_inset CommandInset href
1065 target "https://www.ctan.org/"
1071 \change_deleted 244031559 1603815732
1073 \begin_inset CommandInset href
1076 target "http://www.ctan.org/"
1086 \begin_layout Standard
1087 If you do need to do some wild and fancy things within your document, be
1088 sure to check out a good \SpecialChar LaTeX
1089 book for assistance.
1090 There are a number of them listed in the bibliography of the
1097 \begin_layout Section
1099 and the \SpecialChar LaTeX
1103 \begin_layout Subsection
1104 About the \SpecialChar LaTeX
1108 \begin_layout Standard
1109 If you already know \SpecialChar LaTeX
1110 , there is no need to explain here what the preamble
1112 If you don't, the following will give you some ideas—we recommend again
1113 that you consult a \SpecialChar LaTeX
1114 book for further information.
1115 In any case, you should read the points below, because they explain what
1116 you can do and what you don't need to do in the \SpecialChar LaTeX
1117 preamble of a \SpecialChar LyX
1121 \begin_layout Standard
1122 The \SpecialChar LaTeX
1123 preamble comes at the very beginning of a document,
1131 \begin_layout Itemize
1132 Declare the document class.
1134 \begin_inset Newline newline
1138 already does this for you.
1139 If you're a seasoned \SpecialChar LaTeX
1140 -nician, and you have a custom document class you
1141 want to use, check out the
1143 Customization Manual
1145 for information on how to make \SpecialChar LyX
1149 \begin_layout Itemize
1150 Declare the usage of packages.
1152 \begin_inset Newline newline
1156 packages provide special commands, which are only available within a document
1157 when the package has been declared in the preamble.
1158 In addition to providing special commands, the inclusion of a package can
1159 change the document.
1160 For example, the package
1161 \begin_inset Flex Code
1164 \begin_layout Plain Layout
1170 forces all paragraphs to be indented.
1171 There are other packages for labels, envelopes, margins, etc.
1175 \begin_layout Itemize
1176 Set counters, variables, lengths and widths.
1178 \begin_inset Newline newline
1181 There are several \SpecialChar LaTeX
1182 counters and variables that
1186 be set globally from within the preamble in order to have the desired effect.
1187 (There are variables that you can set and reset inside the document, too.)
1188 Margins are a good example of something that must be set in the preamble.
1189 Another example is the label format for lists.
1190 You can actually set these just about anywhere, but it's best to do it
1191 just once, inside the preamble.
1194 \begin_layout Itemize
1195 Declare user defined commands (with
1196 \begin_inset Flex Code
1199 \begin_layout Plain Layout
1208 \begin_inset Flex Code
1211 \begin_layout Plain Layout
1220 \begin_inset Newline newline
1223 These are abbreviations for \SpecialChar LaTeX
1224 commands which appear very often inside a document.
1225 Although the preamble is a good place to declare such commands, they
1229 be declared anywhere (before they are used for the first time, of course).
1230 This can be useful if there is a lot of raw \SpecialChar LaTeX
1231 code in your document, which
1232 normally should not be the case.
1235 \begin_layout Standard
1237 adds its own set of definitions to the preamble of the
1238 \begin_inset Flex Code
1241 \begin_layout Plain Layout
1248 This makes \SpecialChar LaTeX
1249 files generated by \SpecialChar LyX
1253 \begin_layout Subsection
1254 Changing the Preamble
1257 \begin_layout Standard
1258 The commands which \SpecialChar LyX
1259 adds to the preamble of a \SpecialChar LaTeX
1260 file are fixed; you can't
1261 change them without patching \SpecialChar LyX
1263 You can, however, add your own stuff to the preamble by selecting
1264 \begin_inset Flex Noun
1267 \begin_layout Plain Layout
1270 \begin_inset space ~
1279 \begin_inset Flex Noun
1282 \begin_layout Plain Layout
1283 Document\SpecialChar menuseparator
1291 adds anything in the
1292 \begin_inset Flex Noun
1295 \begin_layout Plain Layout
1301 dialog to its own built-in preamble.
1302 Before adding your own declarations in the preamble, you should make sure
1303 that \SpecialChar LyX
1304 doesn't already support what you want to do.
1305 (Remember what we said about reinventing the wheel?) Also,
1307 make sure your preamble code is correct
1311 doesn't check it for you.
1312 If there is an error, you're likely to get an error like
1313 \begin_inset Quotes eld
1317 \begin_inset Flex Code
1320 \begin_layout Plain Layout
1329 \begin_inset Quotes erd
1333 If you see this error, check your preamble.
1336 \begin_layout Subsection
1340 \begin_layout Standard
1341 Here are some examples of what you can add to a preamble, and what they
1345 \begin_layout Subsubsection
1349 \begin_layout Standard
1350 There are two variables under \SpecialChar LaTeX
1351 that control page position:
1352 \begin_inset Flex Code
1355 \begin_layout Plain Layout
1364 \begin_inset Flex Code
1367 \begin_layout Plain Layout
1376 Their names should be self-explanatory.
1377 These variables are useful if you think for a moment about computer labels.
1378 Sometimes, the size of a print medium and the area of the medium that you
1379 can actually print on aren't the same.
1381 \begin_inset Flex Code
1384 \begin_layout Plain Layout
1393 \begin_inset Flex Code
1396 \begin_layout Plain Layout
1407 \begin_layout Standard
1408 The default values for
1409 \begin_inset Flex Code
1412 \begin_layout Plain Layout
1421 \begin_inset Flex Code
1424 \begin_layout Plain Layout
1433 \begin_inset space \thinspace{}
1437 \begin_inset space \thinspace{}
1441 \begin_inset space \space{}
1444 the page isn't shifted.
1445 Unfortunately, some DVI drivers always seem to shift the page.
1446 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1447 If you're using \SpecialChar LyX
1448 on a system that you don't personally maintain, and your
1449 sysadmin is a doofus,
1450 \begin_inset Flex Code
1453 \begin_layout Plain Layout
1462 \begin_inset Flex Code
1465 \begin_layout Plain Layout
1474 Suppose your left and top margins are always 0.5
1475 \begin_inset space \thinspace{}
1479 You can add this to the preamble:
1482 \begin_layout LyX-Code
1490 \begin_layout LyX-Code
1498 \begin_layout Standard
1499 and your margins should now be correct.
1502 \begin_layout Subsubsection
1506 \begin_layout Standard
1507 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1508 There's a rather nice package, available at your nearest CTAN archive,
1509 for printing sheets of labels:
1510 \begin_inset Flex Code
1513 \begin_layout Plain Layout
1520 Now, your system may not have this package installed by default.
1521 We leave that up to you to check.
1522 You'll also want to read the documentation for it; we're not going to do
1524 Since this is an example, however, we'll give you an example of how you
1528 \begin_layout Standard
1529 First, make sure you're using the
1530 \begin_inset Flex Code
1533 \begin_layout Plain Layout
1540 Next, you need to put the following in your preamble:
1543 \begin_layout LyX-Code
1549 \begin_layout LyX-Code
1555 \begin_layout LyX-Code
1561 \begin_layout LyX-Code
1567 \begin_layout LyX-Code
1573 \begin_layout LyX-Code
1579 \begin_layout LyX-Code
1585 \begin_layout Standard
1586 This sets things up for Avery label sheets, stock #5360.
1587 You're now ready to print labels, but you'll need to insert \SpecialChar LaTeX
1590 \begin_inset Flex Code
1593 \begin_layout Plain Layout
1602 \begin_inset Flex Code
1605 \begin_layout Plain Layout
1613 around each label text.
1614 This and other special features of
1615 \begin_inset Flex Code
1618 \begin_layout Plain Layout
1624 are explained in its documentation.
1627 \begin_layout Standard
1628 Someday, someone may write a \SpecialChar LyX
1629 layout file to support this package directly.
1630 Maybe that someone is you.
1633 \begin_layout Subsubsection
1634 Example #3: Paragraph Indentation
1637 \begin_layout Standard
1638 Americans are trained to indent the first line of
1643 As with all of their other weird quirks, most Americans will whine and
1644 moan until they can have their way and indent the first line of all paragraphs.
1653 \begin_layout Standard
1654 Of course, this behavior isn't standard typography.
1655 In books, you typically only indent the first line of a paragraph
1659 it follows another one.
1660 The idea behind indenting the first line of a paragraph is to distinguish
1661 neighboring paragraphs from one another.
1662 If there is no previous paragraph—for example, if it follows a figure or
1663 is the first paragraph in a section—then there is no need for indentation.
1667 \begin_layout Standard
1668 If you're a typical American (we're still joking!), though, you don't care
1669 about such esoteric things; you want your indentation! Add this to the
1673 \begin_layout LyX-Code
1676 usepackage{indentfirst}
1679 \begin_layout Standard
1680 If your \SpecialChar TeX
1681 distribution isn't braindead, you'll have this package, and all
1682 of your paragraphs will get the indentation the Founding Fathers intended
1686 \begin_layout Subsubsection
1687 Example #4: This Document
1690 \begin_layout Standard
1691 You can also check out the preamble of this document to get an idea of some
1692 of the advanced things you can do.
1695 \begin_layout Section
1697 and \SpecialChar LaTeX
1701 \begin_layout Standard
1702 When \SpecialChar LyX
1703 calls \SpecialChar LaTeX
1704 , it tells \SpecialChar LaTeX
1705 to blithely ignore any errors and keep going.
1706 It then uses the logfile from the \SpecialChar LaTeX
1707 run to do a post-mortem.
1708 After analyzing the logfile, \SpecialChar LyX
1709 displays a dialog listing the errors.
1710 Clicking on any one of them will take you to the position in your \SpecialChar LyX
1712 where the error occurred.
1716 \begin_layout Plain Layout
1718 Analyzing the logfile is a tough job, and \SpecialChar LyX
1719 doesn't always go to the right
1721 There are also cases where \SpecialChar LaTeX
1722 reports the error on one line, but the actual
1724 This is not unlike forgetting a closing brace in a program: You'll get
1725 an error, but only later.
1733 \begin_layout Standard
1734 Some folks also like to look at the log file directly: It is available from
1736 \begin_inset Flex Noun
1739 \begin_layout Plain Layout
1740 Document\SpecialChar menuseparator
1742 \begin_inset space ~
1751 There are some fairly common error messages and warnings.
1752 We'll cover those here.
1753 You should look at a good \SpecialChar LaTeX
1754 book for a complete listing.
1757 \begin_layout Itemize
1758 \begin_inset Flex Code
1761 \begin_layout Plain Layout
1768 \begin_inset Newline newline
1771 Anything beginning with these words is a warning message for the purpose
1773 \begin_inset Quotes eld
1777 \begin_inset Quotes erd
1780 the \SpecialChar LaTeX
1782 You'll get messages like this if you added or changed cross-references
1783 or bibliography entries, in which case, \SpecialChar LaTeX
1784 is trying to tell you that you
1785 need to make another run.
1786 You can by-and-large ignore these.
1789 \begin_layout Itemize
1790 \begin_inset Flex Code
1793 \begin_layout Plain Layout
1800 \begin_inset Newline newline
1803 Another warning message, this time about fonts which \SpecialChar LaTeX
1805 The rest of the message will often say something about a replacement font
1806 that \SpecialChar LaTeX
1808 You can safely ignore these, too.
1811 \begin_layout Itemize
1812 \begin_inset Flex Code
1815 \begin_layout Plain Layout
1824 \begin_inset Newline newline
1833 It seems to generate at least one of these messages for just about any
1835 They are warnings about lines that were too long and run past the right
1837 This happens if \SpecialChar LaTeX
1838 does not find a reasonable way to break the lines (notoriously
1839 often with typewriter font, since this does not allow for automatic break
1841 In many cases, this is unnoticeable in the final output.
1842 (It can be just a point or two.) Sometimes, however, the lines run rather
1843 visibly into the margin; something you will not want to have in your final
1846 \begin_inset Newline newline
1849 There are several global ways to try to minimize the overfull lines.
1852 Enable micro-typographic extensions
1856 Document\SpecialChar menuseparator
1857 Settings\SpecialChar menuseparator
1860 might already improve things a lot.
1861 Furthermore, \SpecialChar LaTeX
1862 code such as the following in
1864 Document\SpecialChar menuseparator
1865 Settings\SpecialChar menuseparator
1868 usually reduces the overfull lines drastically (we use this in the preamble
1873 \begin_layout LyX-Code
1877 \begin_inset Newline newline
1883 \begin_inset Newline newline
1888 emergencystretch 1.5em
1889 \begin_inset Newline newline
1897 \begin_layout Standard
1898 In some cases, however, you eventually have to rewrite the text to get the
1899 line breaking right.
1903 \begin_layout Plain Layout
1904 For more information, see
1905 \begin_inset Flex URL
1908 \begin_layout Plain Layout
1910 http://www.tex.ac.uk/FAQ-overfull.html
1923 \begin_layout Standard
1924 In any case, you should check the respective lines, at least for the final
1925 version of your document.
1926 Your eyes will tell you if there's a problem with something that's too
1931 \begin_layout Plain Layout
1932 You can also enable the `draft' option in
1933 \begin_inset Flex Noun
1936 \begin_layout Plain Layout
1937 Document\SpecialChar menuseparator
1943 , and then \SpecialChar LaTeX
1944 will draw a black box in the margin of lines that are overfull.
1953 \begin_layout Itemize
1954 \begin_inset Flex Code
1957 \begin_layout Plain Layout
1966 \begin_inset Newline newline
1969 Not quite as common as its cousin.
1970 This happens again if \SpecialChar LaTeX
1971 does not find a reasonable break point and consequently
1972 generates too loose lines.
1973 As with the overfull lines, you should check if this is a visible problem.
1976 \begin_layout Itemize
1977 \begin_inset Flex Code
1980 \begin_layout Plain Layout
1989 \begin_inset Flex Code
1992 \begin_layout Plain Layout
2001 \begin_inset Newline newline
2004 Warnings about troubles breaking the page.
2005 Once again, just look at the output.
2006 Your eyes will tell you where something has gone wrong.
2009 \begin_layout Itemize
2010 \begin_inset Flex Code
2013 \begin_layout Plain Layout
2015 \begin_inset Quotes els
2019 \begin_inset Quotes ers
2028 \begin_inset Newline newline
2032 \begin_inset Quotes eld
2036 \begin_inset Quotes erd
2039 isn't installed on this system.
2040 This usually appears because some package your document needs isn't installed.
2041 If you didn't touch the preamble or didn't use the
2042 \begin_inset Flex Code
2045 \begin_layout Plain Layout
2053 command, then one of the packages \SpecialChar LyX
2054 tried to load is missing.
2056 \begin_inset Flex Noun
2059 \begin_layout Plain Layout
2060 Help\SpecialChar menuseparator
2067 to get a list of packages that \SpecialChar LyX
2069 This file is updated whenever you reconfigure \SpecialChar LyX
2071 \begin_inset Flex Noun
2074 \begin_layout Plain Layout
2075 Tools\SpecialChar menuseparator
2081 ) and tells you which packages have been detected and what they do.
2082 \begin_inset Newline newline
2086 \begin_inset Flex Code
2089 \begin_layout Plain Layout
2097 command and the package in question isn't installed, then you'll need to
2098 install it yourself.
2101 \begin_layout Itemize
2102 \begin_inset Flex Code
2105 \begin_layout Plain Layout
2106 LaTeX Error: Unknown option
2112 \begin_inset Newline newline
2115 Error messages beginning with this are trying to tell you that you specified
2116 a bad or undefined option to a package.
2117 Check the package's documentation.
2120 \begin_layout Itemize
2121 \begin_inset Flex Code
2124 \begin_layout Plain Layout
2125 Undefined control sequence
2131 \begin_inset Newline newline
2134 If you've inserted \SpecialChar LaTeX
2135 code into your document, but made a typo, you'll get
2137 You may have forgotten to load a package.
2138 In any case, this error message usually means that you used an undefined
2143 \begin_layout Standard
2144 There are other error and warning messages.
2145 Some are self-explanatory.
2146 These are usually \SpecialChar LaTeX
2148 Others are downright cryptic.
2149 These are usually \SpecialChar TeX
2150 error messages, and we really have
2154 what they mean or how to decipher them.
2158 \begin_layout Standard
2159 There's a general sequence you should follow if you get error messages:
2162 \begin_layout Enumerate
2163 Look at the \SpecialChar LaTeX
2164 code you inserted for typos.
2167 \begin_layout Enumerate
2168 If there are no typos, check that you used the command(s) correctly.
2171 \begin_layout Enumerate
2172 If you get a bunch of error boxes piled up at the very top of the document—and
2173 especially if you see a
2174 \begin_inset Quotes eld
2178 \begin_inset Flex Code
2181 \begin_layout Plain Layout
2190 \begin_inset Quotes erd
2193 error—it means that there are errors in the preamble.
2194 Start debugging your preamble.
2197 \begin_layout Enumerate
2198 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2200 document, the first suspect is your \SpecialChar LaTeX
2201 distribution itself.
2202 Check for missing packages and install them.
2205 \begin_layout Enumerate
2206 Okay, so there are no missing packages.
2207 Did you use any of the fine-tuning options in \SpecialChar LyX
2208 ? Specifically, did you
2212 any of them, like trying to manually insert lots of
2213 \begin_inset Flex Code
2216 \begin_layout Plain Layout
2218 \begin_inset space ~
2227 \begin_inset Flex Code
2230 \begin_layout Plain Layout
2237 \begin_inset Flex Code
2240 \begin_layout Plain Layout
2246 ? Did you try to kludge something together with these instead of using the
2247 appropriate paragraph environment?
2250 \begin_layout Enumerate
2251 All right, you didn't use any of the fine-tuning options, you played by
2253 Did you try to pull a fancy maneuver? Did you do something funky inside
2254 a table or an equation, like inserting a graphic into a table cell?
2257 \begin_layout Enumerate
2258 Do you have long sections of text where \SpecialChar LaTeX
2259 cannot find a place to break a
2260 line? By default, \SpecialChar LaTeX
2261 is rather strict about how much extra inter-word spacing
2262 it will add in order to break a line.
2263 Preferably, you should rework the paragraph to avoid the problem.
2266 \begin_layout Enumerate
2267 Did you go overboard with the nesting? \SpecialChar LyX
2268 (currently) doesn't check to make
2269 sure you're in the limits for nesting environments.
2270 If you nested a bunch of environments to the
2271 \begin_inset Formula $17^{\mathrm{th}}$
2274 level, that's the problem.
2275 (The limit in \SpecialChar LaTeX
2279 \begin_layout Enumerate
2280 Okay, you didn't get any error messages, but your output looks awful.
2281 If you have a table or figure that's too wide or long for the page, you
2286 \begin_layout Enumerate
2287 rescale the figure so it fits.
2290 \begin_layout Enumerate
2291 trim down the table so it fits.
2295 \begin_layout Enumerate
2296 If something else is wrong with the output, and you didn't try to pull anything
2297 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2300 \begin_layout Standard
2301 If all this doesn't help—well, then
2305 you might have found a bug in \SpecialChar LyX
2310 \begin_layout Chapter
2314 \begin_layout Section
2315 Customizing Bibliographies with Bib\SpecialChar TeX
2319 \begin_layout Standard
2320 The most basic information about how to use Bib\SpecialChar TeX
2325 with \SpecialChar LyX
2326 is contained in the section
2328 Bibliography databases
2335 The following subsections explain special bibliography features supported
2340 \begin_layout Subsection
2341 Alternative Citation Styles
2344 \begin_layout Standard
2345 Standard Bib\SpecialChar TeX
2347 \begin_inset space \thinspace{}
2351 \begin_inset space \space{}
2355 \begin_inset Quotes eld
2359 \begin_inset Quotes erd
2362 ) to refer to a cited work.
2363 However, in many scientific disciplines, other citation styles are in use.
2364 The most common one is the author-year style (e.
2365 \begin_inset space \thinspace{}
2369 \begin_inset space \space{}
2373 \begin_inset Quotes eld
2377 \begin_inset Quotes erd
2382 supports three packages that provide this style,
2383 \begin_inset Flex Code
2386 \begin_layout Plain Layout
2393 \begin_inset Flex Code
2396 \begin_layout Plain Layout
2403 \begin_inset Flex Code
2406 \begin_layout Plain Layout
2413 Each of these packages has their pros and cons, which cannot be listed
2415 If you only want to have simple author-year (or author-numerical) style,
2416 or if you want to use one of the countless style files for
2417 \begin_inset Flex Code
2420 \begin_layout Plain Layout
2426 , then the established
2427 \begin_inset Flex Code
2430 \begin_layout Plain Layout
2436 package is probably your choice.
2437 If you look for specific citation styles common in law studies, you might
2439 \begin_inset Flex Code
2442 \begin_layout Plain Layout
2449 If you want to have full control over the formatting or look for advanced
2450 features such as ibidem, footnote citations, full title citations, advanced
2451 date formats (such as 400 BC) or full localization to other languages than
2452 English, you should definitely consider
2453 \begin_inset Flex Code
2456 \begin_layout Plain Layout
2462 , which exceeds all other packages in terms of features, but is also quite
2463 heavy and more resource-hungry.
2466 \begin_layout Standard
2467 The handling of these packages in \SpecialChar LyX
2468 is basically the same.
2470 \begin_inset Flex Noun
2473 \begin_layout Plain Layout
2474 Document\SpecialChar menuseparator
2481 \begin_inset Flex Noun
2484 \begin_layout Plain Layout
2491 \begin_inset Flex Noun
2494 \begin_layout Plain Layout
2501 \begin_inset Flex Noun
2504 \begin_layout Plain Layout
2511 \begin_inset Flex Noun
2514 \begin_layout Plain Layout
2521 \begin_inset Flex Noun
2524 \begin_layout Plain Layout
2525 Biblatex (Natbib mode)
2531 \begin_inset Flex Noun
2534 \begin_layout Plain Layout
2541 \begin_inset Flex Noun
2544 \begin_layout Plain Layout
2551 \begin_inset space ~
2554 6.5.3 in the User's Guide for more information on these choices).
2555 With all these packages, you will get some extra features in the citation
2556 dialog and you can select the style of the reference (
2557 \begin_inset Quotes eld
2561 \begin_inset Quotes erd
2565 \begin_inset Quotes eld
2569 \begin_inset Quotes erd
2573 \begin_inset Quotes eld
2577 \begin_inset Quotes erd
2581 \begin_inset Quotes eld
2585 \begin_inset Quotes erd
2589 Note that either package needs specifically designed style files.
2590 They all ship their own, but there are lots of additional style files,
2591 and there is even an interactive style file builder
2595 \begin_layout Plain Layout
2597 \begin_inset Flex URL
2600 \begin_layout Plain Layout
2602 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2613 \begin_inset Flex Code
2616 \begin_layout Plain Layout
2625 \begin_layout Subsection
2626 Subdivided Bibliographies
2629 \begin_layout Standard
2630 Sometimes you might need to divide your bibliography into several sections.
2631 If you are for instance a historian, the possibility to separate sources
2632 and scientific works is most likely a
2633 \begin_inset Quotes eld
2637 \begin_inset Quotes erd
2641 Unfortunately, Bib\SpecialChar TeX
2642 itself does not allow you to do this.
2643 But with the help of some \SpecialChar LaTeX
2644 packages, Bib\SpecialChar TeX
2645 can be extended to fit your needs.
2648 \begin_layout Standard
2650 provides native support for one of these packages,
2658 \begin_layout Plain Layout
2660 \begin_inset Flex URL
2663 \begin_layout Plain Layout
2665 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2675 The advantage of this package (compared to other packages such as
2679 ) is that you don't need to define new citation commands.
2680 Instead, you need to prepare different bibliographic databases which include
2681 the entries for the different sections of the bibliography.
2682 For example: If you want to divide your bibliography into the sections
2684 \begin_inset Quotes eld
2688 \begin_inset Quotes erd
2692 \begin_inset Quotes eld
2696 \begin_inset Quotes erd
2699 , you first need to create two bibliographic databases, e.
2700 \begin_inset space \thinspace{}
2704 \begin_inset space \space{}
2708 \begin_inset Flex Code
2711 \begin_layout Plain Layout
2718 \begin_inset Flex Code
2721 \begin_layout Plain Layout
2731 \begin_layout Standard
2733 \begin_inset Flex Noun
2736 \begin_layout Plain Layout
2737 Document\SpecialChar menuseparator
2744 \begin_inset Flex Noun
2747 \begin_layout Plain Layout
2754 \begin_inset Flex Noun
2757 \begin_layout Plain Layout
2758 Subdivided bibliography
2764 Now you can insert multiple Bib\SpecialChar TeX
2765 bibliographies, one for each section of
2767 Returning to our example: Insert the Bib\SpecialChar TeX
2769 \begin_inset Flex Code
2772 \begin_layout Plain Layout
2778 and a second one for the database
2779 \begin_inset Flex Code
2782 \begin_layout Plain Layout
2789 You are free to use the same or different styles for each section.
2790 Additionally, you can choose if the bibliography section should contain
2792 \begin_inset Quotes eld
2795 all cited references
2796 \begin_inset Quotes erd
2799 of the specified database(s) (which is the default),
2800 \begin_inset Quotes eld
2803 all uncited references
2804 \begin_inset Quotes erd
2808 \begin_inset Quotes eld
2812 \begin_inset Quotes erd
2816 This might be useful if you would like to separate your bibliography into
2818 \begin_inset Quotes eld
2822 \begin_inset Quotes erd
2826 \begin_inset Quotes eld
2830 \begin_inset Quotes erd
2834 \begin_inset Quotes eld
2838 \begin_inset Quotes erd
2842 The titles for the sections can be added as ordinary sections or subsections.
2844 \begin_inset Flex Code
2847 \begin_layout Plain Layout
2853 removes the bibliography title, you have to manually re-add that, too (as
2854 a chapter* or section*, for instance).
2857 \begin_layout Standard
2862 , the procedure is a bit different.
2871 , the aforementioned
2872 \begin_inset Flex Noun
2875 \begin_layout Plain Layout
2876 Subdivided bibliography
2881 option is disabled if you use
2890 provides its own means to generate subdivided bibliographies.
2891 You can either add keywords to bibliography entries via the
2892 \begin_inset Flex Code
2895 \begin_layout Plain Layout
2901 entry option and then filter bibliography sections by keyword (by adding
2903 \begin_inset Flex Code
2906 \begin_layout Plain Layout
2913 \begin_inset Flex Noun
2916 \begin_layout Plain Layout
2922 field of the dialog that opens if you left-click on the
2923 \begin_inset Flex Noun
2926 \begin_layout Plain Layout
2927 Biblatex Generated Bibliography
2932 button), or you can filter by entry types (such as
2941 \begin_inset space \thinspace{}
2946 \begin_inset Flex Code
2949 \begin_layout Plain Layout
2956 \begin_inset Flex Code
2959 \begin_layout Plain Layout
2966 \begin_inset Flex Noun
2969 \begin_layout Plain Layout
2975 field, or you can create so-called
2976 \begin_inset Quotes eld
2979 Bibliography Categories
2980 \begin_inset Quotes erd
2983 to which you can assign individual entries.
2984 Please refer to the Biblatex manual, section
2986 Subdivided Bibliographies
2991 \begin_layout Subsection
2992 Multiple Bibliographies
2993 \begin_inset CommandInset label
2995 name "subsec:Multiple-Bibliographies"
3002 \begin_layout Standard
3003 Multiple bibliographies, e.
3004 \begin_inset space \thinspace{}
3008 \begin_inset space \space{}
3011 a bibliography for each part, chapter, section, subsection or child (sub-documen
3012 t) of the document, are also supported by \SpecialChar LyX
3014 In order to enable it, go to
3015 \begin_inset Flex Noun
3018 \begin_layout Plain Layout
3019 Document\SpecialChar menuseparator
3020 Settings\SpecialChar menuseparator
3026 and select the relevant unit (e.
3027 \begin_inset space \thinspace{}
3031 \begin_inset Quotes eld
3035 \begin_inset Quotes erd
3039 \begin_inset Flex Noun
3042 \begin_layout Plain Layout
3043 Multiple Bibliographies
3049 Then add a Bib(la)\SpecialChar TeX
3050 bibliography to each unit (e.
3051 \begin_inset space \thinspace{}
3054 g., section) of your document.
3055 In the output, a separate bibliography, containing only the references
3056 done in the current unit is generated.
3059 \begin_layout Standard
3060 If you use Bib\SpecialChar TeX
3062 \begin_inset Flex Code
3065 \begin_layout Plain Layout
3072 \begin_inset Flex Code
3075 \begin_layout Plain Layout
3081 package is used to create multiple bibliographies.
3082 The former package is used if you select
3083 \begin_inset Quotes eld
3087 \begin_inset Quotes erd
3095 \begin_inset Flex Noun
3098 \begin_layout Plain Layout
3099 Sectioned Bibliography
3106 \begin_inset Flex Code
3109 \begin_layout Plain Layout
3119 \begin_layout Plain Layout
3120 An alternative approach, if you are willing to use some
3121 \begin_inset Flex Noun
3124 \begin_layout Plain Layout
3132 \begin_inset space ~
3136 \begin_inset CommandInset ref
3138 reference "sec:Inserting-TeX-Code"
3143 \begin_inset Flex Code
3146 \begin_layout Plain Layout
3158 \begin_inset Flex Code
3161 \begin_layout Plain Layout
3167 is used, \SpecialChar LyX
3168 encloses the specified units in
3169 \begin_inset Flex Code
3172 \begin_layout Plain Layout
3179 \begin_inset Flex Code
3182 \begin_layout Plain Layout
3191 \begin_inset Flex Code
3194 \begin_layout Plain Layout
3202 in order to create the units.
3203 Note that this approach has some limitations.
3204 First, every citation reference has to be inside some
3205 \begin_inset Flex Code
3208 \begin_layout Plain Layout
3215 So citations outside a defined unit (e.
3216 \begin_inset space \thinspace{}
3219 g., before the first section if you use
3220 \begin_inset Quotes eld
3224 \begin_inset Quotes erd
3228 \begin_inset Quotes eld
3232 \begin_inset Quotes erd
3236 You can also create your own units by entering
3237 \begin_inset Flex Code
3240 \begin_layout Plain Layout
3249 \begin_inset Flex Code
3252 \begin_layout Plain Layout
3261 code (for instance to work around the mentioned limitation).
3263 \begin_inset Flex Code
3266 \begin_layout Plain Layout
3273 A second limitation is that
3274 \begin_inset Flex Code
3277 \begin_layout Plain Layout
3283 always processes all references of a bibliography database, even if they
3285 This can result in odd labels (e.
3286 \begin_inset space \thinspace{}
3291 \begin_inset Quotes eld
3295 \begin_inset Quotes erd
3298 if two works of this author from 2014 are in the database, even if only
3302 \begin_layout Standard
3308 \begin_inset Flex Code
3311 \begin_layout Plain Layout
3317 option is used instead.
3318 If you need specific units, you can start them with the \SpecialChar TeX
3320 \begin_inset Flex Code
3323 \begin_layout Plain Layout
3332 \begin_inset Flex Code
3335 \begin_layout Plain Layout
3344 If you also want to control the end of the unit, use the environment
3345 \begin_inset Flex Code
3348 \begin_layout Plain Layout
3358 \begin_inset Flex Code
3361 \begin_layout Plain Layout
3371 \begin_inset Flex Code
3374 \begin_layout Plain Layout
3381 In addition to the individual bibliography of the current unit,
3385 also provides an easy way to output all bibliographies, subsequently, at
3387 \begin_inset space \thinspace{}
3390 g., at the end of the document).
3392 \begin_inset Quotes eld
3396 \begin_inset Quotes erd
3399 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve
3405 manual for more information on this topic.
3408 \begin_layout Section
3412 \begin_layout Subsection
3416 \begin_layout Standard
3417 When you are working on a large file with many sections, it is often convenient
3418 to break up the document into several files, or perhaps you have something
3419 where a table may change from time to time, but the preceding text does
3421 In these cases, you should seriously consider using multipart documents.
3422 For example, scientific papers often have five major sections: the introduction
3423 , observations, results, discussion, and conclusion.
3424 Each of these could be its own separate \SpecialChar LyX
3426 \begin_inset Quotes eld
3430 \begin_inset Quotes erd
3433 file which contains the title, authors, abstract, references, etc., plus
3434 the five included files.
3435 It is important to note that each of these files is a full \SpecialChar LyX
3437 can be formatted and printed on its own, as well as included in a master
3439 Each of these files must have the same document class, however—don't attempt
3440 to mix book classes with article classes.
3441 You may also include \SpecialChar LaTeX
3442 files; however, these files must not have their own
3444 \begin_inset space \thinspace{}
3448 \begin_inset space \space{}
3451 everything up to and including the
3452 \begin_inset Flex Code
3455 \begin_layout Plain Layout
3464 \begin_inset Flex Code
3467 \begin_layout Plain Layout
3475 line must be deleted) or else errors will be generated when you try to
3479 \begin_layout Standard
3481 allows you to include files quite easily with
3482 \begin_inset Flex Noun
3485 \begin_layout Plain Layout
3486 Insert\SpecialChar menuseparator
3488 \begin_inset space ~
3497 When you click on this selection a small box is inserted into the file
3498 at the current cursor location.
3499 Clicking on the box raises a dialog which allows you to select the file
3500 to be included, and the method of its inclusion.
3504 \begin_layout Standard
3505 The file selection box should by now be obvious.
3506 The three inclusion methods are
3507 \begin_inset Quotes eld
3511 \begin_inset Quotes erd
3515 \begin_inset Quotes eld
3519 \begin_inset Quotes erd
3523 \begin_inset Quotes eld
3527 \begin_inset Quotes erd
3532 \begin_inset Quotes eld
3536 \begin_inset Quotes erd
3540 \begin_inset Quotes eld
3544 \begin_inset Quotes erd
3547 are similar in many ways, but there are also some notable differences:
3550 \begin_layout Enumerate
3552 \begin_inset Quotes eld
3556 \begin_inset Quotes erd
3559 are typeset beginning on a new page, while files that are
3560 \begin_inset Quotes eld
3564 \begin_inset Quotes erd
3567 are typeset starting on the current page.
3570 \begin_layout Enumerate
3571 \begin_inset Quotes eld
3575 \begin_inset Quotes erd
3578 files cannot themselves
3579 \begin_inset Quotes eld
3583 \begin_inset Quotes erd
3587 \begin_inset Quotes eld
3591 \begin_inset Quotes erd
3596 \begin_inset Quotes eld
3600 \begin_inset Quotes erd
3603 , on the other hand, infinite sub-inputting is possible.
3606 \begin_layout Enumerate
3607 \begin_inset Quotes eld
3611 \begin_inset Quotes erd
3614 allow for the output of only selected
3615 \begin_inset Quotes eld
3619 \begin_inset Quotes erd
3622 files, while maintaining the actual counters (pagination etc.) and references
3623 (please refer to the section
3626 \begin_inset space ~
3634 \begin_inset space ~
3639 manual for details).
3642 \begin_layout Standard
3644 \begin_inset Quotes eld
3648 \begin_inset Quotes erd
3651 is the preferred method for chapters that are outsourced to child documents,
3653 \begin_inset Quotes eld
3657 \begin_inset Quotes erd
3660 is more suitable for arbitrary file inheritance.
3663 \begin_layout Standard
3665 \begin_inset Quotes eld
3669 \begin_inset Quotes erd
3672 included file allows you to include a file typeset exactly as it appears
3674 \begin_inset space \thinspace{}
3678 \begin_inset space \space{}
3682 \begin_inset Flex Code
3685 \begin_layout Plain Layout
3691 mode, with the characters set in a fixed-width typewriter font.
3692 Normally, spaces in this file are invisible, though two consecutive spaces
3693 are conserved, unlike \SpecialChar LyX
3694 's normal treatment of spaces.
3695 However, setting the
3696 \begin_inset Flex Noun
3699 \begin_layout Plain Layout
3701 \begin_inset space ~
3705 \begin_inset space ~
3709 \begin_inset space ~
3717 checkbox typesets a mark to unambiguously define the presence of a space.
3721 \begin_layout Standard
3722 Generally, the master file is converted into a full \SpecialChar LaTeX
3723 file before typesetting,
3724 while the included files are converted to \SpecialChar LaTeX
3725 files that do not have all the
3726 preamble information.
3729 \begin_layout Subsection
3730 Cross-References Between Files
3733 \begin_layout Standard
3734 \begin_inset Box Shadowbox
3744 height_special "totalheight"
3749 backgroundcolor "none"
3752 \begin_layout Plain Layout
3753 This section is somewhat out of date.
3754 Need to describe default master documents and how children are opened when
3764 \begin_layout Standard
3765 It is possible to set up cross-references between the different files.
3766 First, open all the files in question: let's call them A and B in a two
3767 file example, where B is included in A.
3768 Let's say you insert a label in A, then want to reference it in B.
3769 Open the cross-reference dialog whilst in document B, and you can select
3771 \begin_inset Quotes eld
3775 \begin_inset Quotes erd
3781 \begin_layout Subsection
3782 Bibliography Lists in all Subdocuments
3785 \begin_layout Standard
3786 If you work with child documents, you might want to have only one main bibliogra
3787 phy at the end, but still be able to have a selected bibliography for the
3788 child if you output it on its own.
3789 Here is how to achieve this.
3792 \begin_layout Standard
3793 For the main document, you just insert a bibliography inset at the place
3794 where the main bibliography has to appear (within the master file or within
3796 If the bibliography inset is in the master file, the references will be
3797 inherited by all children, so they are available in the citation dialog
3801 \begin_layout Standard
3802 For child-specific bibliographies, insert bibliography insets within the
3803 child documents, at the place where the bibliography should appear when
3804 the child is compiled separately.
3805 However, the trick is to insert them into a branch (
3807 Insert\SpecialChar menuseparator
3808 Branch\SpecialChar menuseparator
3809 Insert New Branch...
3812 \begin_inset space \thinspace{}
3817 \begin_inset Quotes eld
3821 \begin_inset Quotes erd
3825 Within the children, activate the branch (
3827 Document\SpecialChar menuseparator
3828 Settings...\SpecialChar menuseparator
3832 Within the master, deactivate the branch (
3834 Document\SpecialChar menuseparator
3835 Settings...\SpecialChar menuseparator
3839 Now the child's bibliography will be ignored by the master, but considered
3843 \begin_layout Standard
3844 If you need multiple bibliographies (e.
3845 \begin_inset space \thinspace{}
3848 g., one per child in the
3852 ), please refer to sec.
3853 \begin_inset space ~
3857 \begin_inset CommandInset ref
3859 reference "subsec:Multiple-Bibliographies"
3866 \begin_layout Section
3871 \begin_layout Standard
3872 Users sometimes need to be able to
3873 \begin_inset Quotes eld
3877 \begin_inset Quotes erd
3881 file together with all the images (and other files) on which it depends,
3882 either for sending to a publisher or for sharing with a co-author.
3884 includes a Python script (
3885 \begin_inset Flex Code
3888 \begin_layout Plain Layout
3894 ) that automates this process.
3895 To use it, you must have either the
3896 \begin_inset Flex Code
3899 \begin_layout Plain Layout
3906 \begin_inset Flex Code
3909 \begin_layout Plain Layout
3915 python modules installed on your system.
3916 By default, the script prefers the
3917 \begin_inset Flex Code
3920 \begin_layout Plain Layout
3927 \begin_inset Flex Code
3930 \begin_layout Plain Layout
3936 format on Unix-like systems and the
3937 \begin_inset Flex Code
3940 \begin_layout Plain Layout
3949 \begin_layout Standard
3951 's configuration process will set the script up to export a `\SpecialChar LyX
3953 and this format will then be available under
3954 \begin_inset Flex Code
3957 \begin_layout Plain Layout
3958 File\SpecialChar menuseparator
3967 \begin_layout Standard
3968 Independently of the platform, the generation of a particular archive format
3969 can be forced by adding either the
3970 \begin_inset Flex Code
3973 \begin_layout Plain Layout
3980 \begin_inset Flex Code
3983 \begin_layout Plain Layout
3990 \begin_inset Flex Code
3993 \begin_layout Plain Layout
4000 \begin_inset Flex Code
4003 \begin_layout Plain Layout
4009 format) switch to the
4010 \begin_inset Flex Code
4013 \begin_layout Plain Layout
4015 \SpecialChar menuseparator
4023 \begin_inset Flex Code
4026 \begin_layout Plain Layout
4027 Tools\SpecialChar menuseparator
4028 Preferences\SpecialChar menuseparator
4029 File Handling\SpecialChar menuseparator
4036 (Make sure you add the switch after the script name, not before it.)
4039 \begin_layout Section
4040 Fancy Headers and Footers
4043 \begin_layout Standard
4044 The default page layout is rather plain; for an
4045 \begin_inset Flex Code
4048 \begin_layout Plain Layout
4054 document class, all you get is a centered page number at the bottom of
4056 This document uses KOMA-script's book class, so it appears to be a bit
4058 But to really put on a show, you need to set the document page style to
4060 \begin_inset Quotes eld
4064 \begin_inset Quotes erd
4067 , as mentioned in the
4072 This section describes the \SpecialChar LaTeX
4073 code you need to insert in your \SpecialChar LaTeX
4075 order to get the desired effects.
4078 \begin_layout Standard
4079 For more information on fancy headers, see the
4080 \begin_inset Flex Code
4083 \begin_layout Plain Layout
4089 package documentation.
4091 \begin_inset Flex URL
4094 \begin_layout Plain Layout
4096 https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
4104 \begin_layout Standard
4105 The page header is divided into three fields, not surprisingly labeled
4106 \begin_inset Quotes eld
4110 \begin_inset Quotes erd
4114 \begin_inset Quotes eld
4118 \begin_inset Quotes erd
4122 \begin_inset Quotes eld
4126 \begin_inset Quotes erd
4130 The footer is also divided into these three fields.
4131 The \SpecialChar LaTeX
4132 commands to set these fields in the simplest manner are
4133 \begin_inset Flex Code
4136 \begin_layout Plain Layout
4145 \begin_inset Flex Code
4148 \begin_layout Plain Layout
4157 \begin_inset Flex Code
4160 \begin_layout Plain Layout
4169 \begin_inset Flex Code
4172 \begin_layout Plain Layout
4181 Suppose you wish to put your name in the upper left hand corner of each
4183 Simply insert the following command in the preamble:
4186 \begin_layout Standard
4195 \begin_layout Standard
4196 You will now see your name in the upper left.
4197 If a field has a default entry that you would like to get rid of (often
4198 the page number appears in the central footer) simply include a command
4199 with a blank argument, e.
4200 \begin_inset space \thinspace{}
4206 \begin_layout Standard
4214 \begin_layout Standard
4215 Let's get really fancy: lets put the section number with the word
4216 \begin_inset Quotes eld
4220 \begin_inset Quotes erd
4224 \begin_inset space \thinspace{}
4228 \begin_inset space \space{}
4231 Section 3) in the upper left, the page number (e.
4232 \begin_inset space \thinspace{}
4236 \begin_inset space \space{}
4239 Page 4) in the upper right, your name in the lower left, and the date in
4241 The following commands should now appear in the preamble:
4244 \begin_layout Standard
4254 \begin_layout Standard
4262 \begin_layout Standard
4272 \begin_layout Standard
4281 \begin_layout Standard
4289 \begin_layout Standard
4299 \begin_layout Standard
4301 \begin_inset Flex Code
4304 \begin_layout Plain Layout
4313 \begin_inset Flex Code
4316 \begin_layout Plain Layout
4324 access \SpecialChar LaTeX
4325 's section and page counters, and so print out the current section
4328 \begin_inset Flex Code
4331 \begin_layout Plain Layout
4339 simply prints out today's date.
4342 \begin_layout Standard
4343 The thicknesses of the horizontal rules drawn beneath the header and above
4344 the footer can also be modified.
4345 If you don't want one of the rules, set its thickness to 0.
4346 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
4352 \begin_inset Flex Code
4355 \begin_layout Plain Layout
4360 headrulewidth}{0.4pt}
4366 \begin_inset Flex Code
4369 \begin_layout Plain Layout
4374 footrulewidth}{0.4pt}
4379 to set the thicknesses.
4382 \begin_layout Standard
4383 You can switch the header/footer settings on and off for individual pages
4385 \begin_inset Flex Code
4388 \begin_layout Plain Layout
4391 thispagestyle{empty}
4397 \begin_inset Flex Code
4400 \begin_layout Plain Layout
4403 thispagestyle{plain}
4409 \begin_inset Flex Code
4412 \begin_layout Plain Layout
4415 thispagestyle{fancy}
4421 Simply insert them in the text on the page you want changed and mark them
4424 In fact, title pages are marked as plain by default, while following pages
4425 are marked fancy when using the global fancy setting.
4428 \begin_layout Standard
4429 As a final example, it is possible to include an image in the header or
4431 Suppose you want to put a company logo in the upper lefthand corner.
4432 You might try something like
4435 \begin_layout Standard
4444 includegraphics{logo.eps}}}
4447 \begin_layout Standard
4449 (you may need to preface this with
4450 \begin_inset Flex Code
4453 \begin_layout Plain Layout
4456 usepackage{graphics}
4461 if you don't include graphics elsewhere in your document).
4464 \begin_layout Section
4465 Itemize Bullet Selection
4466 \begin_inset CommandInset label
4475 \begin_layout Standard
4481 \begin_layout Subsection
4485 \begin_layout Standard
4487 provides 216 bullet shapes that can be accessed from a simple dialog.
4488 Using this dialog you can easily specify what bullet shape to use at each
4489 level of an itemized list.
4490 These settings are document-wide so you won't be able to specify different
4491 sets of bullets for different paragraphs.
4495 \begin_layout Plain Layout
4496 Well, actually you can but you'll have to do it by hand.
4504 \begin_layout Subsection
4508 \begin_layout Standard
4509 Open the dialog by selecting the
4510 \begin_inset Flex Noun
4513 \begin_layout Plain Layout
4514 Document\SpecialChar menuseparator
4520 menu item and then select the
4521 \begin_inset Flex Noun
4524 \begin_layout Plain Layout
4533 \begin_layout Standard
4534 The dialog provides you with a table of bullet shapes.
4535 A column of buttons on the left of the table provides access to the six
4536 different panels of bullet shapes.
4537 The row of buttons across the top is used to select which bullet depth
4540 \change_deleted 244031559 1603875981
4541 A text entry under the table shows the currently selected bullet shape's
4543 equivalent and this can be edited if desired.
4544 If you do modify the text you will also need to specify any needed packages
4545 in the \SpecialChar LaTeX
4551 \begin_layout Standard
4552 The six panels are divided up by the packages they require.
4553 The following table shows the mappings from button name to \SpecialChar LaTeX
4557 \begin_layout Standard
4559 \begin_inset Tabular
4560 <lyxtabular version="3" rows="7" columns="2">
4561 <features tabularvalignment="middle">
4562 <column alignment="center" valignment="top" width="0pt">
4563 <column alignment="center" valignment="top" width="0pt">
4565 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4568 \begin_layout Plain Layout
4583 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4586 \begin_layout Plain Layout
4603 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4606 \begin_layout Plain Layout
4621 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4624 \begin_layout Plain Layout
4633 base \SpecialChar LaTeX
4641 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4644 \begin_layout Plain Layout
4659 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4662 \begin_layout Plain Layout
4679 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4682 \begin_layout Plain Layout
4697 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4700 \begin_layout Plain Layout
4717 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4720 \begin_layout Plain Layout
4735 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4738 \begin_layout Plain Layout
4755 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4758 \begin_layout Plain Layout
4773 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4776 \begin_layout Plain Layout
4793 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4796 \begin_layout Plain Layout
4811 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4814 \begin_layout Plain Layout
4837 \begin_layout Standard
4839 doesn't stop you using bullets from packages you don't have.
4840 If you get errors from \SpecialChar LaTeX
4841 when you try to view or print the file, then it
4842 is likely you are missing a package.
4846 \begin_layout Plain Layout
4848 doesn't restrict your use since you may be editing locally and exporting
4857 \begin_layout Subsection
4861 \begin_layout Standard
4862 Select which bullet depth you want to change then select the bullet shape
4864 Any changes will not be visible in \SpecialChar LyX
4865 , but are visible when viewing the document.
4868 \begin_layout Standard
4869 You can reset a bullet shape to the default simply by clicking your right
4870 mouse button on the appropriate bullet depth button.
4874 \begin_layout Plain Layout
4879 want to have multiple sets of paragraphs with different sets of bullets
4880 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
4882 The bullet selection dialog can help though because it provides you with
4883 the \SpecialChar LaTeX
4884 code for a wide range of bullet shapes.
4885 To make your own custom paragraphs you have the following options:
4888 \begin_layout Plain Layout
4892 \begin_layout Plain Layout
4908 \begin_layout Plain Layout
4912 \begin_layout Plain Layout
4934 \begin_layout Itemize
4935 Use the \SpecialChar LaTeX
4937 \begin_inset Flex Code
4940 \begin_layout Plain Layout
4948 to specify a new bullet shape for a given depth.
4949 You'll also need to save the current bullet shape so you can restore it
4951 In this itemized list the following \SpecialChar LaTeX
4952 code was used to change the bullet
4953 used for the first depth.
4957 \begin_layout LyX-Code
4967 \begin_layout LyX-Code
4984 \begin_layout Itemize
4985 Note that the itemize depth is specified in Roman numerals as part of the
4995 \begin_layout Itemize
4996 \begin_inset Argument item:1
4999 \begin_layout Plain Layout
5003 \begin_layout Plain Layout
5021 Specify each individual entry by starting each item with the bullet shape
5023 \begin_inset Quotes eld
5027 \begin_inset Quotes erd
5032 Insert\SpecialChar menuseparator
5036 \begin_inset Flex Noun
5039 \begin_layout Plain Layout
5047 For example, this item was started with
5048 \begin_inset Flex Code
5051 \begin_layout Plain Layout
5066 \begin_layout Plain Layout
5070 \begin_layout Plain Layout
5086 \begin_layout Plain Layout
5087 You'll also need to revert the labelitem back to its previous setting for
5088 the global bullet shape settings to remain in effect.
5089 The way used here was:
5092 \begin_layout LyX-Code
5107 \begin_layout Chapter
5109 and the World Wide Web
5112 \begin_layout Standard
5114 has long supported the export of documents to various web-friendly formats,
5116 Before version 2.0, however, HTML export was always accomplished by the
5117 use of external converters.
5121 \begin_layout Plain Layout
5122 For details on the use of external converters with \SpecialChar LyX
5127 section of the Customization manual.
5132 These fall into two large groups: there are converters that use \SpecialChar LaTeX
5134 intermediate format, such as
5135 \begin_inset Flex Code
5138 \begin_layout Plain Layout
5145 \begin_inset Flex Code
5148 \begin_layout Plain Layout
5155 \begin_inset Flex Code
5158 \begin_layout Plain Layout
5164 , relying upon \SpecialChar LyX
5165 to produce the \SpecialChar LaTeX
5166 ; and there is a converter that works directly
5169 \begin_inset Flex Code
5172 \begin_layout Plain Layout
5180 All of these have different advantages and disadvantages.
5184 \begin_layout Standard
5185 The \SpecialChar LaTeX
5186 -based converters have the advantage that, in principle, they know everythin
5187 g about the exported document that \SpecialChar LaTeX
5189 Such converters do not care, for example, if a certain block of code was
5190 produced by \SpecialChar LyX
5191 or was Evil Red Text.
5192 These converters know about
5193 \begin_inset Flex Code
5196 \begin_layout Plain Layout
5202 files, counters, and references, and can often make use of the
5203 \begin_inset Flex Code
5206 \begin_layout Plain Layout
5212 files generated by Bib\SpecialChar TeX
5214 On the other hand, \SpecialChar LaTeX
5215 is a very hard language to parse—it is sometimes said
5216 that only \SpecialChar TeX
5217 itself understands \SpecialChar TeX
5218 —and \SpecialChar LaTeX
5219 -based converters will often choke on
5220 what seem to be quite simple constructs; complex ones can throw them completely
5221 , and as of this writing, for example, the
5225 manual will not export with
5226 \begin_inset Flex Code
5229 \begin_layout Plain Layout
5235 , though the others will.
5236 The other issue concerns how math is handled.
5237 These converters typically convert the formulae into little pictures that
5238 are then linked from the HTML document.
5239 Since these are actually generated by \SpecialChar LaTeX
5240 , they are accurate.
5241 But they do not scale well, and just getting them to look as if they are
5242 actually meant to be in your document—so that the font sizes seem to be
5243 roughly the same—can be a challenge.
5246 \begin_layout Standard
5248 \begin_inset Flex Code
5251 \begin_layout Plain Layout
5259 \begin_inset CommandInset href
5261 name "http://pinchito.es/elyxer/"
5262 target "http://pinchito.es/elyxer/"
5267 ) solves some of these problems.
5268 In particular, the formulae it produces scale perfectly, since it renders
5269 math using a combination of HTML and CSS rather than converting the formulae
5271 But even moderately complex formula are rendered less well than with
5272 \begin_inset Flex Code
5275 \begin_layout Plain Layout
5281 ; this reflects the limitations of HTML.
5285 \begin_layout Plain Layout
5287 \begin_inset Flex Code
5290 \begin_layout Plain Layout
5297 can also use jsMath and MathJax for equations, but this setting is only
5298 available globally and requires one to have access to a server that runs
5304 More importantly (as of version 1.1.1, at least),
5305 \begin_inset Flex Code
5308 \begin_layout Plain Layout
5315 has limited support for math macros and no support for user-defined paragraph
5316 or character styles.
5317 These limitations make
5318 \begin_inset Flex Code
5321 \begin_layout Plain Layout
5328 unsuitable for many of the documents \SpecialChar LyX
5330 In principle, of course, these problems could be solved, but the \SpecialChar LyX
5332 have decided to follow a different path and have made \SpecialChar LyX
5334 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
5335 , DocBook, and plaintext.
5338 \begin_layout Standard
5339 As of this writing, XHTML output remains under development and should probably
5341 \begin_inset Quotes eld
5345 \begin_inset Quotes erd
5352 \begin_layout Plain Layout
5354 \begin_inset Flex Code
5357 \begin_layout Plain Layout
5358 development/HTML/HTML.notes
5363 , which can be found in the \SpecialChar LyX
5365 \begin_inset CommandInset href
5367 name "accessed online"
5368 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
5373 , usually contains up-to-date information about the state of XHTML output.
5374 See also the list of XHTML bugs on
5375 \begin_inset CommandInset href
5377 name "the bug tracker"
5378 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"
5388 Still, the developers have chosen this approach because it has several
5389 potential advantages over the other two.
5392 \begin_layout Standard
5393 These advantages are primarily due to the fact that the XHTML output routines,
5394 since they are part of \SpecialChar LyX
5395 , know everything \SpecialChar LyX
5396 knows about the document being
5401 \begin_layout Plain Layout
5402 Another advantage is that, since these routines are internal to \SpecialChar LyX
5404 immune to changes in \SpecialChar LyX
5405 's file format, or to changes in the semantics of
5411 So they know about the table of contents (as displayed in the outline),
5412 about the counters associated with different paragraph styles, and about
5413 user-defined styles.
5414 The XHTML output routines know what \SpecialChar LyX
5415 knows about internationalization,
5416 too, so they will output
5417 \begin_inset Quotes eld
5421 \begin_inset Quotes erd
5425 \begin_inset Quotes eld
5433 \begin_inset Quotes erd
5436 , depending upon the language in effect at the time.
5440 \begin_layout Standard
5441 Quite generally, the output routines know what \SpecialChar LyX
5442 knows about document layout,
5443 that is, about how the document is to be rendered on screen.
5444 We use this information when we output the document as XHTML.
5445 In particular, \SpecialChar LyX
5450 generates CSS style information corresponding to the layout information
5451 it uses to render the document on screen: if section headings are supposed
5452 to be sans-serif and bold as seen in \SpecialChar LyX
5453 , then (by default) they will be sans-seri
5454 f and bold when viewed in a web browser, too.
5455 And this is true not just for pre-defined styles, like Section, but for
5456 any style, including user-defined styles.
5457 Indeed, the XHTML output routines make no distinction between user-defined
5459 \change_deleted 244031559 1603876931
5461 \change_inserted 244031559 1603876940
5464 styles and \SpecialChar LyX
5465 's own pre-defined styles: in each case, everything \SpecialChar LyX
5467 the styles is contained in the layout files.
5468 And much the same is true as regards pre-defined textual insets, such as
5469 footnotes, and various custom insets.
5473 \begin_layout Standard
5474 The result is that XHTML output can be customized and extended in exactly
5475 the same way \SpecialChar LaTeX
5476 output can be customized and extended: through layout files
5478 See chapter five of the
5482 manual for the details.
5485 \begin_layout Standard
5486 The remainder of this chapter contains more detailed information on XHTML
5487 output, its limitations, and ways to work around those limitations.
5490 \begin_layout Section
5491 Math Output in XHTML
5494 \begin_layout Standard
5496 offers four choices for how math is rendered.
5497 These have various advantages and disadvantages:
5500 \begin_layout Itemize
5502 \begin_inset Newline newline
5505 MathML is a dialect of XML designed specifically for mathematics on the
5506 web, and it typically renders very well in browsers that support it.
5507 The disadvantage is that not all browsers support MathML, and support is
5508 not complete even in the Gecko-based browsers, such as Firefox.
5509 \begin_inset Newline newline
5513 is unable to render a formula as MathML—for example, if the formula
5515 \begin_inset Flex Code
5518 \begin_layout Plain Layout
5524 package or ERT—then it will instead output the formula as an image.
5528 \begin_layout Itemize
5530 \begin_inset Newline newline
5534 \begin_inset Flex Code
5537 \begin_layout Plain Layout
5543 outputs math as HTML, styled by CSS.
5547 \begin_layout Plain Layout
5549 has borrowed some of the CSS for its HTML output from
5550 \begin_inset Flex Code
5553 \begin_layout Plain Layout
5564 For simple formulae, this can work quite well, though with more complicated
5565 formulae it tends to break down.
5566 Still, this method has the advantage that it is very widely supported and
5567 so it may be appropriate for documents that contain only a little, fairly
5569 \begin_inset Newline newline
5572 If Lyx is unable to render a formula as HTML—for example, if the formula
5574 \begin_inset Flex Code
5577 \begin_layout Plain Layout
5583 package or ERT—then it will instead output the formula as an image.
5587 \begin_layout Itemize
5589 \begin_inset Newline newline
5593 \begin_inset Flex Code
5596 \begin_layout Plain Layout
5603 will output formulae as images, the very same images, in fact, that are
5604 used for instant preview.
5608 \begin_layout Plain Layout
5609 Instant preview does
5613 have to be on for images to be output, however.
5618 The advantage to this method is that the images are simply generated by
5620 , so they are very accurate.
5621 The disadvantage, as mentioned earlier, is that these are bitmapped images,
5622 so they do not scale terribly well, and one cannot copy them, etc.
5623 \begin_inset Newline newline
5626 The size of the images can be controlled by setting the
5627 \begin_inset Quotes eld
5631 \begin_inset Quotes erd
5635 \begin_inset Flex Noun
5638 \begin_layout Plain Layout
5639 Document\SpecialChar menuseparator
5640 Settings\SpecialChar menuseparator
5650 \begin_layout Plain Layout
5651 For those who want to know, this controls the resolution of the image in
5652 dots per inch and is based upon a default of 75 dpi.
5658 \begin_inset Newline newline
5662 for some reason fails to create an image for a formula (e.g., if a required
5664 package is not installed), then it will fall back to outputing the raw
5669 \begin_layout Itemize
5672 \begin_inset Newline newline
5675 Finally, \SpecialChar LyX
5676 will happily output math as \SpecialChar LaTeX
5678 As well as being the output of last resort, this method can be used with
5680 \begin_inset CommandInset href
5683 target "http://www.math.union.edu/~dpvc/jsMath/"
5688 , which uses JavaScript to render \SpecialChar LaTeX
5689 embedded in HTML documents.
5691 wraps the \SpecialChar LaTeX
5693 \begin_inset Flex Code
5696 \begin_layout Plain Layout
5702 (for inline formulas) or
5703 \begin_inset Flex Code
5706 \begin_layout Plain Layout
5712 (for displayed formulas) with
5713 \begin_inset Flex Code
5716 \begin_layout Plain Layout
5722 , as is required for jsMath.
5725 \begin_layout Standard
5726 One of these output methods must be selected under
5727 \begin_inset Flex Noun
5730 \begin_layout Plain Layout
5731 Document\SpecialChar menuseparator
5732 Settings\SpecialChar menuseparator
5739 By default, \SpecialChar LyX
5741 This is a document-wide setting, therefore.
5744 \begin_layout Standard
5745 Eventually, \SpecialChar LyX
5746 will offer the user the option to select an alternate output
5747 method for a particular inset, say, one that isn't being rendered very
5752 \begin_layout Plain Layout
5753 That said, since \SpecialChar LyX
5754 falls back to images if the inset contains ERT, then one
5755 can force output as an image by putting some harmless ERT into the math,
5757 \begin_inset Formula $a=b\relax$
5768 \begin_layout Section
5769 Bibliography and Citations
5772 \begin_layout Standard
5773 XHTML output fully supports bibliographies and citations.
5777 \begin_layout Standard
5778 Citation labels are generated by the same machinery that generates \SpecialChar LyX
5780 labels, so the labels will look in the output much as they do in \SpecialChar LyX
5783 If you are using numerical citations, then \SpecialChar LyX
5784 will output numerical labels,
5785 such as [1] or [17], rather than simply showing the citation key in square
5786 brackets, as it does on-screen.
5787 If you are using author-year citations, then \SpecialChar LyX
5788 will add lowercase letters
5789 to the years, just as Bib\SpecialChar TeX
5790 does, if it finds more than one citation for
5791 a given author-year combination.
5792 The labels will be printed with the bibliography entries.
5793 Note that there is, at present, no way to customize the appearance of the
5794 labels, for example, to choose between square brackets and parentheses.
5797 \begin_layout Standard
5798 Bibliography output is handled by the same machinery that handles the presentati
5799 on of reference information in the citation dialog, so you will see in the
5800 XHTML output pretty much what you would see if you were to look at a given
5801 entry in the citation dialog.
5802 The formatting can be customized in your layout file or, preferably, in
5808 manual for the details.
5811 \begin_layout Standard
5812 The main defect at present is that cross-referenced information is printed
5813 with every entry with which it is associated.
5814 So you can see things like this:
5819 \begin_inset Quotes eld
5822 Context and Logical Form
5823 \begin_inset Quotes erd
5828 Language in Context: Selected Essays
5830 (Oxford: Oxford University Press, 2007), pp.
5836 \begin_inset Quotes eld
5839 Semantics in Context
5840 \begin_inset Quotes erd
5845 Language in Context: Selected Essays
5847 (Oxford: Oxford University Press, 2007), pp.
5851 \begin_layout Standard
5852 This should be fixed before long.
5855 \begin_layout Standard
5856 There is no support at present for sectioned bibliographies.
5857 If you have multiple bibliographies, then \SpecialChar LyX
5858 will print the same bibliography
5862 \begin_layout Section
5866 \begin_layout Standard
5868 will happily export indexes as XHTML, but with certain limitations at the
5872 \begin_layout Standard
5873 Index export will be most reliable when you do not attempt to use the fancy
5874 constructs that are described in the section on indexes in the
5882 \begin_layout Plain Layout
5883 The main issue here is that \SpecialChar LyX
5884 itself does not really handle these.
5885 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
5891 We'll describe how they are handled using the subsection headings from
5895 \begin_layout Itemize
5896 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
5897 makes an effort to support these,
5898 but the entries must be separated by
5899 \begin_inset Quotes eld
5903 \begin_inset Quotes erd
5906 , that is, there must be spaces around the exclamation point.
5907 This is because it is otherwise too difficult to check for escaped exclamation
5908 points, ones in math, and so forth.
5911 \begin_layout Itemize
5912 Page Ranges: There is no support at all for page ranges, since these make
5913 no sense with XHMTL.
5914 Instead, you will just get two index entries, one at either end.
5917 \begin_layout Itemize
5918 Cross-referencing: There is no support for cross-referencing.
5920 finds an entry containing the
5921 \begin_inset Quotes eld
5924 |see\SpecialChar ldots
5926 \begin_inset Quotes erd
5929 construct, it is just dropped, and the rest is treated as an ordinary index
5933 \begin_layout Itemize
5934 Index Entry Order: \SpecialChar LyX
5935 does support attempts to fix the sorting order.
5936 It will take what is before the first `@' it finds and use that for sorting,
5937 taking what follows the first `@' to be the actual entry.
5938 At present, \SpecialChar LyX
5939 does not check for escaped `@', so do not try to index email
5943 \begin_layout Itemize
5944 Index Entry Layout: You can format entries by using the text style dialog,
5945 or by using any other method available within \SpecialChar LyX
5947 There is no support for constructs like:
5948 \begin_inset Quotes eld
5952 \begin_inset Quotes erd
5956 Indeed, if \SpecialChar LyX
5957 finds a pipe symbol, `|', in an entry, it will delete it and
5958 everything that follows it.
5961 \begin_layout Itemize
5962 Multiple Indexes: There is no support for multiple indexes.
5963 Rather, all index entries will be printed as one large index.
5964 To avoid our printing several versions of the index, we print only the
5965 main index, so make sure you have one.
5968 \begin_layout Section
5969 Nomenclature and Glossary
5972 \begin_layout Standard
5973 There is at present no support for glossaries.
5974 Adding it would be fairly trivial, and welcome.
5977 \begin_layout Chapter
5979 \change_inserted 1075283030 1616534180
5983 \begin_layout Standard
5985 \change_inserted 1075283030 1616534386
5986 Apart from HTML, \SpecialChar LyX
5987 can generate documents in the DocBook XML vocabulary.
5988 With versions 2.3 and before, only select templates could be used to generate
5989 DocBook documents (only version 4).
5990 Starting with \SpecialChar LyX
5991 2.4, most \SpecialChar LyX
5992 layouts can generate valid DocBook documents (only
5994 This feature is built into \SpecialChar LyX
5995 and does not require the use of external tools.
5998 \begin_layout Standard
6000 \change_inserted 1075283030 1616534437
6001 The result is that the DocBook output can be customized and extended in
6002 exactly the same way \SpecialChar LaTeX
6003 output can be customized and extended: through layout
6005 See chapter five of the
6009 manual for the details.
6012 \begin_layout Standard
6014 \change_inserted 1075283030 1616534475
6015 Most \SpecialChar LyX
6016 features are supported with DocBook, like math output.
6019 \begin_layout Itemize
6021 \change_inserted 1075283030 1616534741
6022 Math output is performed mostly in MathML (the major exception being constructio
6023 ns not supported by \SpecialChar LyX
6026 All formulae are also available in raw \SpecialChar TeX
6027 in the DocBook output for further
6031 \begin_layout Itemize
6033 \change_inserted 1075283030 1616534852
6034 Bibliographies and citations are implemented, including with an external
6036 Bibliography entries are not prerendered when the detailed information
6037 are available, but rather output with the standard DocBook constructs.
6038 The external DocBook processor is expected to handle the rendering of entries.
6041 \begin_layout Itemize
6043 \change_inserted 1075283030 1616534863
6044 Indexes are supported, including multiple indices.
6049 ), page ranges, and cross-references (
6053 ) are supported, with the exception of the same symbols escaped.
6062 ) are not supported.
6063 There is no support for escaping of index entries.
6066 \begin_layout Itemize
6068 \change_inserted 1075283030 1616534884
6069 Glossaries are implemented.
6072 \begin_layout Standard
6074 \change_inserted 1075283030 1616534894
6075 Two major parameters can be set at the document level.
6078 \begin_layout Itemize
6080 \change_inserted 1075283030 1616534948
6081 Format for tables: \SpecialChar LyX
6082 can generate tables either as HTML (default value) or
6083 CALS, depending on the user's requirements.
6084 Most DocBook processors accept both formats.
6087 \begin_layout Itemize
6089 \change_inserted 1075283030 1616535006
6090 MathML prefix: in DocBook, MathML is included within its own name space,
6092 The implication is that there must be an indication of the tags belonging
6093 to the MathML standard.
6094 Three choices are offered:
6098 \begin_layout Itemize
6100 \change_inserted 1075283030 1616535044
6101 Inline: the MathML name space is defined for each formula (using the
6105 attribute on each formula)
6108 \begin_layout Itemize
6110 \change_inserted 1075283030 1616535090
6115 prefix (default): the MathML name space is defined at the document level
6120 attribute on the root element).
6121 Each MathML is prefixed with
6130 \begin_layout Itemize
6132 \change_inserted 1075283030 1616620405
6137 prefix: similar to the
6146 \begin_layout Standard
6148 \change_inserted 1075283030 1616620470
6149 This option is especially useful if you want \SpecialChar LyX
6150 to match your personal style
6151 or to work with buggy software that only accepts one prefix for MathML.
6157 \begin_layout Chapter
6158 The \SpecialChar LyX
6162 \begin_layout Section
6166 \begin_layout Standard
6167 The `\SpecialChar LyX
6168 server' allows other programs to talk to \SpecialChar LyX
6169 , invoke \SpecialChar LyX
6170 commands, and retrieve
6171 information about the \SpecialChar LyX
6173 This is only intended for advanced users, but they should find it useful.
6174 It is by writing to the \SpecialChar LyX
6175 server, for example, that bibliography managers,
6176 such as JabRef, are able to
6177 \begin_inset Quotes eld
6181 \begin_inset Quotes erd
6184 citations to \SpecialChar LyX
6188 \begin_layout Section
6189 Starting the \SpecialChar LyX
6191 \begin_inset CommandInset label
6193 name "sec:Starting-the-Server"
6200 \begin_layout Standard
6201 The \SpecialChar LyX
6202 server works through the use of a pair of named pipes.
6203 These are usually located in
6204 \begin_inset Flex Code
6207 \begin_layout Plain Layout
6213 , (except on Windows, where
6217 named pipes are special objects located in
6218 \begin_inset Flex Code
6221 \begin_layout Plain Layout
6233 ) and have the names
6234 \begin_inset Quotes eld
6238 \begin_inset Flex Code
6241 \begin_layout Plain Layout
6248 \begin_inset Quotes erd
6252 \begin_inset Quotes eld
6256 \begin_inset Flex Code
6259 \begin_layout Plain Layout
6266 \begin_inset Quotes erd
6270 External programs write into
6271 \begin_inset Flex Code
6274 \begin_layout Plain Layout
6280 and read back data from
6281 \begin_inset Flex Code
6284 \begin_layout Plain Layout
6291 The stem of the pipe names can be defined in the
6292 \begin_inset Flex Noun
6295 \begin_layout Plain Layout
6296 Tools\SpecialChar menuseparator
6303 \begin_inset Flex Code
6306 \begin_layout Plain Layout
6307 "/home/myhome/lyxpipe"
6313 \begin_inset Flex Code
6316 \begin_layout Plain Layout
6330 on Windows (where any working path instead of lyxpipe can be used, for
6332 \begin_inset Flex Code
6335 \begin_layout Plain Layout
6358 configure this manually in order for the server to start.
6361 \begin_layout Standard
6364 \begin_inset Flex Code
6367 \begin_layout Plain Layout
6374 \begin_inset Flex Code
6377 \begin_layout Plain Layout
6383 ' to create the pipes.
6384 If one of the pipes already exists, \SpecialChar LyX
6385 will assume that another \SpecialChar LyX
6387 is already running and will not start the server.
6388 On POSIX (Unix like) systems, if for some other reason, an unused
6389 \begin_inset Quotes eld
6393 \begin_inset Quotes erd
6396 pipe is left in existence when \SpecialChar LyX
6397 closes, then \SpecialChar LyX
6398 will try to delete it.
6399 If this fails for some reason, you will need to delete the pipes manually
6400 and then restart \SpecialChar LyX
6402 On Windows, pipes are deleted by the OS on program termination or crash,
6404 \begin_inset Quotes eld
6408 \begin_inset Quotes erd
6411 pipes should not be possible.
6414 \begin_layout Standard
6415 To have several \SpecialChar LyX
6416 processes with servers at the same time, you have to use
6417 different configurations, perhaps by using separate user directories, each
6419 \begin_inset Flex Code
6422 \begin_layout Plain Layout
6428 file, for each process.
6431 \begin_layout Standard
6432 If you are developing a client program, you might find it useful to enable
6433 debugging information from the \SpecialChar LyX
6435 Do this by starting \SpecialChar LyX
6437 \begin_inset Flex Code
6440 \begin_layout Plain Layout
6449 \begin_layout Standard
6450 You can find a complete example client written in C++ in the source distribution
6452 \begin_inset Flex Code
6455 \begin_layout Plain Layout
6456 development/lyxserver/server_monitor.cpp
6464 \begin_layout Standard
6465 Another useful tool is the command-line based client found in
6466 \begin_inset Flex Code
6469 \begin_layout Plain Layout
6470 src/client/lyxclient
6478 \begin_layout Section
6479 Normal communication
6482 \begin_layout Standard
6483 To issue a \SpecialChar LyX
6484 call, the client writes a line of ASCII text into the input
6486 This line has the following format:
6503 \begin_layout Description
6504 clientname is a name that the client can choose arbitrarily.
6505 Its only use is that \SpecialChar LyX
6506 will echo it if it sends an answer—so a client can
6507 dispatch results from different requesters.
6510 \begin_layout Description
6511 function is the function you want \SpecialChar LyX
6513 It is the same as the commands you'd use in the minibuffer.
6516 \begin_layout Description
6517 argument is an optional argument which is meaningful only to some functions
6519 \begin_inset Quotes eld
6523 \begin_inset Quotes erd
6526 LFUN will insert the argument as text at the cursor position).
6529 \begin_layout Standard
6530 The answer from \SpecialChar LyX
6531 will arrive in the output pipe and be of the form
6548 \begin_layout Standard
6557 are just echoed from the command request, while
6561 is more or less useful information filled according to how the command
6562 execution worked out.
6563 Some commands, such as
6564 \begin_inset Quotes eld
6568 \begin_inset Quotes erd
6571 , will return information about the internal state of \SpecialChar LyX
6573 return an empty data-response.
6574 This means that the command execution went fine.
6577 \begin_layout Standard
6578 In case of errors, the response from \SpecialChar LyX
6596 \begin_layout Standard
6601 should contain an explanation of why the command failed.
6604 \begin_layout Standard
6608 \begin_layout LyX-Code
6609 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
6610 \begin_inset Newline newline
6613 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
6614 \begin_inset Newline newline
6617 read a <~/.lyxpipe.out
6618 \begin_inset Newline newline
6624 \begin_layout Subsection
6625 AppleScript (Mac OS X)
6628 \begin_layout Standard
6629 Since \SpecialChar LyX
6630 2.1, \SpecialChar LyX
6631 supports basic interactions with AppleScript for normal communicatio
6632 n through the command run.
6633 This command takes a direct argument (the
6637 to perform) and an optional argument.
6638 It either returns the output of the function or triggers an error with
6639 the error message and code.
6642 \begin_layout Standard
6646 \begin_layout LyX-Code
6647 tell application "\SpecialChar LyX
6651 \begin_layout LyX-Code
6655 \begin_layout LyX-Code
6656 -- Stores the current file name into f
6659 \begin_layout LyX-Code
6660 set f to (run "server-get-filename" with argument "")
6663 \begin_layout LyX-Code
6664 on error the error_message number the error_number
6667 \begin_layout LyX-Code
6668 display dialog "Error: " & the error_number & ".
6672 \begin_layout LyX-Code
6673 & the error_message buttons {"OK"} default button 1
6676 \begin_layout LyX-Code
6680 \begin_layout LyX-Code
6684 \begin_layout Section
6688 \begin_layout Standard
6690 can notify clients of events going on asynchronously.
6691 Currently it will only do this if the user binds a key sequence with the
6693 \begin_inset Quotes eld
6697 \begin_inset Quotes erd
6701 The format of the string \SpecialChar LyX
6702 sends is as follows:
6706 \begin_inset Flex Code
6709 \begin_layout Plain Layout
6720 \begin_layout Standard
6725 is the printed representation of the key sequence that was actually typed
6729 \begin_layout Standard
6730 This mechanism can be used to extend \SpecialChar LyX
6731 's command set and implement macros.
6732 Bind some key sequence to
6733 \begin_inset Quotes eld
6737 \begin_inset Quotes erd
6741 Then start a client that listens on the output pipe, dispatches the command
6742 according to the sequence, and starts a function that may use \SpecialChar LyX
6745 requests to issue a command or a series of commands to \SpecialChar LyX
6749 \begin_layout Section
6750 The simple \SpecialChar LyX
6754 \begin_layout Standard
6756 implements a simple protocol that can be used for session management.
6757 All messages are of the form
6770 \begin_layout Standard
6776 \begin_inset Quotes eld
6780 \begin_inset Quotes erd
6784 \begin_inset Quotes eld
6788 \begin_inset Quotes erd
6793 \begin_inset Quotes eld
6797 \begin_inset Quotes erd
6800 is received from a client, \SpecialChar LyX
6801 will report back to inform the client that
6802 it's listening to it's messages, while
6803 \begin_inset Quotes eld
6807 \begin_inset Quotes erd
6810 sent from \SpecialChar LyX
6811 will inform clients that \SpecialChar LyX
6815 \begin_layout Section
6816 Reverse DVI/PDF search
6819 \begin_layout Standard
6820 Some DVI/PDF viewers
6824 \begin_layout Plain Layout
6825 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
6826 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
6835 facility (also called
6840 This means that you can tell \SpecialChar LyX
6841 to put the cursor to a specific line in the
6842 document by clicking at the respective position in the DVI/PDF output.
6843 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
6845 This is done via the \SpecialChar LyX
6846 server either by using the named pipe (
6850 ), or the UNIX domain socket (
6854 ) that \SpecialChar LyX
6855 creates in its temporary directory (this is the way the
6856 \begin_inset Flex Code
6859 \begin_layout Plain Layout
6865 program communicates with \SpecialChar LyX
6867 In some cases, you need a helper script that mediates between the viewer
6868 and \SpecialChar LyX
6869 , in others, the viewer can communicate with \SpecialChar LyX
6871 This depends on the selected viewer and on your operating system.
6872 The same applies to the way viewers need to be configured and the way the
6873 reverse search is actually performed.
6874 In what follows, we will thus describe how to setup reverse search for
6876 Before we turn to this, though, we will explain what needs to be done generally
6877 to enable reverse search in the DVI/PDF output.
6880 \begin_layout Subsection
6882 \begin_inset CommandInset label
6884 name "subsec:rev-search"
6891 \begin_layout Standard
6892 In most cases \SpecialChar LyX
6893 will do the work for you by pressing the following button
6897 arg "buffer-toggle-output-sync"
6901 Alternatively, you can also enable the feature by checking
6903 Synchronize with Output
6906 \begin_inset Flex Noun
6909 \begin_layout Plain Layout
6910 Document\SpecialChar menuseparator
6911 Settings\SpecialChar menuseparator
6918 In such a case \SpecialChar LyX
6919 will automatically insert the necessary Sync\SpecialChar TeX
6921 PDF) or load the srcltx package (for DVI) respectively.
6922 This option can be easily reached also on
6923 \begin_inset Flex Code
6926 \begin_layout Plain Layout
6935 \begin_layout Standard
6936 If you need a different setting, you can select or input a custom macro
6937 from the drop down box just below
6938 \begin_inset Flex Noun
6941 \begin_layout Plain Layout
6942 Document\SpecialChar menuseparator
6943 Settings\SpecialChar menuseparator
6944 Output\SpecialChar menuseparator
6945 Synchronize with Output
6953 \begin_layout Standard
6954 Note that the method
6955 \begin_inset Flex Code
6958 \begin_layout Plain Layout
6966 enables gzip compression.
6967 If your viewer does not support it, you should instead use
6968 \begin_inset Flex Code
6971 \begin_layout Plain Layout
6982 \begin_layout Standard
6983 Please also note that including the
6984 \begin_inset Flex Code
6987 \begin_layout Plain Layout
6994 \begin_inset Flex Code
6997 \begin_layout Plain Layout
7003 sometimes has an undesired impact on the typesetting.
7004 Thus, you should switch output synchronization off for the final typesetting
7006 \begin_inset Flex Code
7009 \begin_layout Plain Layout
7016 \begin_inset Flex Code
7019 \begin_layout Plain Layout
7029 \begin_layout Standard
7030 In case you need some more special settings that are not covered by the
7031 automatic settings, read the next section about how to set up output synchroniz
7033 If the automatic setup suits your needs, you can readily jump to section
7034 \begin_inset space ~
7038 \begin_inset CommandInset ref
7040 reference "subsec:configuring-viewers"
7044 , where the necessary configuration steps in your viewer – needed both with
7045 the automatic and the manual setup – are described.
7048 \begin_layout Subsection
7052 \begin_layout Standard
7054 provides several different methods for reverse search.
7055 Some are built-in in the
7056 \begin_inset Flex Code
7059 \begin_layout Plain Layout
7065 program, some are provided by external packages.
7066 Your choice depends on whether your \SpecialChar LaTeX
7067 distribution already provides a given
7068 method (the built-in methods are rather new) and whether your viewer can
7070 The available methods are described in the following.
7073 \begin_layout Subsubsection*
7074 Built-in DVI-search via src-specials (DVI only)
7077 \begin_layout Standard
7078 This method provides the DVI file with the necessary information for reverse
7080 It is available in \SpecialChar LaTeX
7081 since quite some time (any somewhat recent \SpecialChar LaTeX
7083 should include it), and it works reliably.
7084 To enable it, change the
7085 \begin_inset Flex Noun
7088 \begin_layout Plain Layout
7099 \begin_inset Flex Noun
7102 \begin_layout Plain Layout
7113 \begin_inset Flex Noun
7116 \begin_layout Plain Layout
7117 Preferences\SpecialChar menuseparator
7118 File Handling\SpecialChar menuseparator
7125 \begin_inset Flex Code
7128 \begin_layout Plain Layout
7129 latex -src-specials $$i
7135 If this doesn't work, check if your \SpecialChar TeX
7136 engine needs different options (the
7137 syntax might differ in some distributions).
7140 \begin_layout Subsubsection*
7141 External Packages (PDFSync and scrltx)
7144 \begin_layout Standard
7153 provide reverse search facility for PDF output (via pdflatex) and DVI output,
7155 In order to enable it, load the packages in the \SpecialChar LyX
7159 \begin_layout Itemize
7160 \begin_inset Flex Code
7163 \begin_layout Plain Layout
7171 for reverse PDF search,
7174 \begin_layout Itemize
7175 \begin_inset Flex Code
7178 \begin_layout Plain Layout
7181 usepackage[active]{srcltx}
7186 for reverse DVI search.
7189 \begin_layout Standard
7190 If you want to be able to perform both DVI and PDF reverse searches, you
7191 can also insert in the preamble the following lines
7194 \begin_layout LyX-Code
7198 \begin_inset Newline newline
7204 \begin_inset Newline newline
7210 \begin_inset Newline newline
7216 \begin_inset Newline newline
7221 usepackage[active]{srcltx}
7222 \begin_inset Newline newline
7230 \begin_layout Standard
7231 This way, you can preview the file as either DVI or PDF (pdflatex) and the
7232 right package will be used.
7235 \begin_layout Standard
7236 Note that PDFSync might affect the output layout of your document.
7237 It is therefore advised to disable PDFsync for final documents.
7240 \begin_layout Subsubsection*
7241 Built-in reverse search via Sync\SpecialChar TeX
7245 \begin_layout Standard
7247 \begin_inset Flex Code
7250 \begin_layout Plain Layout
7256 have built-in support for both PDF and DVI reverse search.
7259 Sync\SpecialChar TeX
7262 facility is basically the result of the integration of the PDFSync package
7263 to the pdftex program and its merge with the
7268 You need at least \SpecialChar TeX
7269 Live 2008 or a recent Mik\SpecialChar TeX
7270 distribution in order to use
7275 \begin_layout Plain Layout
7276 For some reason, Mik\SpecialChar TeX
7277 does not understand/obey the command \SpecialChar LyX
7279 the preamble when you check the "Enable Forward/Reverse Search" button
7280 in the toolbar and does not generate the necessary info.
7283 \begin_layout Plain Layout
7284 The generation of the required info can be forced by changing the converter
7286 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
7287 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
7288 the -synctex=1 switch).
7293 Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
7294 Skim on the Mac, SumatraPDF on Windows; see the next section for details)
7295 already provide Sync\SpecialChar TeX
7299 \begin_layout Standard
7300 To enable Sync\SpecialChar TeX
7301 for DVI output, change the
7302 \begin_inset Flex Noun
7305 \begin_layout Plain Layout
7316 \begin_inset Flex Noun
7319 \begin_layout Plain Layout
7330 \begin_inset Flex Noun
7333 \begin_layout Plain Layout
7334 Preferences\SpecialChar menuseparator
7335 File Handling\SpecialChar menuseparator
7342 \begin_inset Flex Code
7345 \begin_layout Plain Layout
7346 latex -synctex=1 $$i
7351 , and for PDF output, change the
7352 \begin_inset Flex Noun
7355 \begin_layout Plain Layout
7360 (pdflatex) -> PDF (pdflatex)
7366 \begin_inset Flex Code
7369 \begin_layout Plain Layout
7370 pdflatex -synctex=1 $$i
7376 Should your viewer not be considered in the following description, or in
7377 case of missing success, please check the documentation of your viewer
7378 whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
7383 \begin_layout Plain Layout
7384 Note that the option
7385 \begin_inset Flex Code
7388 \begin_layout Plain Layout
7394 option enables gzip compression.
7395 If your viewer does not support it, you should instead use
7396 \begin_inset Flex Code
7399 \begin_layout Plain Layout
7413 \begin_layout Subsection
7414 Configuring and using specific viewers
7415 \begin_inset CommandInset label
7417 name "subsec:configuring-viewers"
7424 \begin_layout Subsubsection*
7425 Xdvi (all platforms)
7428 \begin_layout Standard
7430 \begin_inset Flex Code
7433 \begin_layout Plain Layout
7439 , you don't need to do anything else for performing a reverse DVI search,
7441 already provides the necessary hooks for automatically using the
7442 \begin_inset Flex Code
7445 \begin_layout Plain Layout
7452 Just setup your document as described above (reverse search is triggered
7453 by Ctrl-click or Alt-click on Mac OSX, respectively).
7456 \begin_layout Standard
7457 However, if for whatever reason you want to use the named pipe instead of
7458 the socket for communicating with \SpecialChar LyX
7459 , simply change the DVI viewer in
7460 \begin_inset Flex Noun
7463 \begin_layout Plain Layout
7464 Preferences\SpecialChar menuseparator
7465 File Handling\SpecialChar menuseparator
7475 \begin_layout Plain Layout
7476 On Mac OSX you have to use
7477 \begin_inset Flex Code
7480 \begin_layout Plain Layout
7481 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
7492 \begin_inset Flex Code
7495 \begin_layout Plain Layout
7496 xdvi -editor "lyxeditor.sh %f %l"
7502 \begin_inset Flex Code
7505 \begin_layout Plain Layout
7511 is a suitable script.
7512 For example, a minimal shell script is the following one:
7515 \begin_layout LyX-Code
7517 \begin_inset Newline newline
7520 LYXPIPE="/path/to/lyxpipe"
7521 \begin_inset Newline newline
7524 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
7525 \begin_inset Newline newline
7528 echo "$COMMAND" > "${LYXPIPE}".in || exit
7529 \begin_inset Newline newline
7532 read TMP < "${LYXPIPE}".out || exit
7535 \begin_layout Standard
7537 \begin_inset Flex Code
7540 \begin_layout Plain Layout
7546 is the LyXServer pipe path specified in
7547 \begin_inset Flex Noun
7550 \begin_layout Plain Layout
7551 Preferences\SpecialChar menuseparator
7561 \begin_layout Plain Layout
7563 \begin_inset Flex Code
7566 \begin_layout Plain Layout
7572 folder of a source distribution you can find a
7573 \begin_inset Flex Code
7576 \begin_layout Plain Layout
7582 script which is able to locate the
7586 based on your preferences.
7594 \begin_layout Subsubsection*
7598 \begin_layout Standard
7600 \begin_inset Flex Code
7603 \begin_layout Plain Layout
7604 /Applications/MacDviX_Folder/calleditor.script
7609 , add the following lines:
7612 \begin_layout LyX-Code
7613 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
7614 \begin_inset Newline newline
7620 \begin_layout Standard
7621 Modify the lines accordingly if you install \SpecialChar LyX
7622 somewhere else than in the
7623 Applications folder.
7626 \begin_layout Standard
7627 Reverse search is triggered by Alt-click (OPTION-click).
7630 \begin_layout Subsubsection*
7634 \begin_layout Standard
7636 \begin_inset Flex Code
7639 \begin_layout Plain Layout
7640 open -a Skim.app $$i
7645 to the viewer setting in
7646 \begin_inset Flex Noun
7649 \begin_layout Plain Layout
7650 Preferences\SpecialChar menuseparator
7651 File Handling\SpecialChar menuseparator
7652 File formats\SpecialChar menuseparator
7659 \begin_inset Flex Noun
7662 \begin_layout Plain Layout
7663 Skim\SpecialChar menuseparator
7664 Preferences\SpecialChar menuseparator
7671 \begin_inset Flex Noun
7674 \begin_layout Plain Layout
7680 preset and enter command
7681 \begin_inset Flex Noun
7684 \begin_layout Plain Layout
7685 /Applications/\SpecialChar LyX
7686 .app/Contents/MacOS/lyxeditor
7694 \begin_layout Standard
7695 Reverse search is triggered by COMMAND-SHIFT-click
7698 \begin_layout Subsubsection*
7702 \begin_layout Standard
7703 Reverse search with evince does not work out of the box, but it can be achieved
7704 by means of some third party helper scripts.
7706 \begin_inset CommandInset href
7708 target "https://wiki.lyx.org/LyX/SyncTeX"
7716 \begin_layout Subsubsection*
7720 \begin_layout Standard
7722 \begin_inset Flex Noun
7725 \begin_layout Plain Layout
7726 Settings\SpecialChar menuseparator
7727 Configure Okular\SpecialChar menuseparator
7734 \begin_inset Quotes erd
7738 This inserts the appropriate command (
7739 \begin_inset Flex Code
7742 \begin_layout Plain Layout
7751 \begin_layout Standard
7752 Reverse search is triggered by SHIFT-click.
7754 \change_inserted -712698321 1578211026
7755 Note that this only works if Okular is in
7756 \begin_inset Quotes eld
7760 \begin_inset Quotes erd
7764 \begin_inset space \thinspace{}
7767 e., the hand symbol is clicked).
7772 \begin_layout Subsubsection*
7776 \begin_layout Standard
7777 Qpdfview supports Sync\SpecialChar TeX
7778 since version 0.3.5.
7780 \begin_inset Flex Noun
7783 \begin_layout Plain Layout
7784 Edit\SpecialChar menuseparator
7785 Settings\SpecialChar menuseparator
7791 , click on the input field of the
7792 \begin_inset Quotes eld
7796 \begin_inset Quotes erd
7799 item and add the command
7800 \begin_inset Flex Code
7803 \begin_layout Plain Layout
7812 \begin_layout Standard
7813 Reverse search is triggered by double-click or, in more recent versions,
7817 \begin_layout Subsubsection*
7821 \begin_layout Standard
7822 Launch yap, choose its
7823 \begin_inset Flex Noun
7826 \begin_layout Plain Layout
7827 View\SpecialChar menuseparator
7834 \begin_inset Quotes eld
7838 \begin_inset Quotes erd
7843 \begin_inset Quotes eld
7846 New\SpecialChar ldots
7848 \begin_inset Quotes erd
7851 button and, in the window that opens, enter
7852 \begin_inset Quotes eld
7857 \begin_inset Quotes erd
7860 (or any other name you like) in the
7861 \begin_inset Quotes eld
7865 \begin_inset Quotes erd
7869 Now click on the button labeled
7870 \begin_inset Quotes eld
7875 \begin_inset Quotes erd
7878 to open a file dialog and navigate to the directory containing the batch
7880 \begin_inset Flex Code
7883 \begin_layout Plain Layout
7891 \begin_inset Flex Code
7894 \begin_layout Plain Layout
7900 and then specify the program arguments as
7901 \begin_inset Flex Code
7904 \begin_layout Plain Layout
7912 \begin_inset Flex Code
7915 \begin_layout Plain Layout
7921 wrapper is used for communicating with \SpecialChar LyX
7929 \begin_layout LyX-Code
7931 \begin_inset Newline newline
7934 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
7943 \begin_inset Newline newline
7957 \begin_layout Standard
7958 Make sure that the \SpecialChar LyX
7959 Server pipe path you specified in \SpecialChar LyX
7961 \begin_inset Flex Code
7964 \begin_layout Plain Layout
7978 , otherwise change the
7979 \begin_inset Flex Code
7982 \begin_layout Plain Layout
7988 wrapper accordingly.
7991 \begin_layout Standard
7992 In yap, reverse search is triggered by double-click.
7995 \begin_layout Subsubsection*
7996 SumatraPDF (Windows)
7999 \begin_layout Standard
8000 In order to use SumatraPDF for inverse search, enter
8001 \begin_inset Flex Code
8004 \begin_layout Plain Layout
8005 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
8010 in the viewer setting in
8011 \begin_inset Flex Noun
8014 \begin_layout Plain Layout
8015 Preferences\SpecialChar menuseparator
8016 File Handling\SpecialChar menuseparator
8017 File formats\SpecialChar menuseparator
8024 \begin_inset Flex Code
8027 \begin_layout Plain Layout
8033 is the previous wrapper.
8034 If SumatraPDF.exe is not in your command PATH, use its full file name.
8037 \begin_layout Standard
8038 Reverse search is triggered by double-click.
8041 \begin_layout Subsubsection*
8045 \begin_layout Standard
8046 First of all, make sure that yap is your default DVI viewer in the Windows
8047 environment, then launch it, choose its
8048 \begin_inset Flex Noun
8051 \begin_layout Plain Layout
8052 View\SpecialChar menuseparator
8059 \begin_inset Quotes eld
8063 \begin_inset Quotes erd
8068 \begin_inset Quotes eld
8071 New\SpecialChar ldots
8073 \begin_inset Quotes erd
8076 button and, in the window that opens, enter
8077 \begin_inset Quotes eld
8082 \begin_inset Quotes erd
8085 (or any other name you like) in the
8086 \begin_inset Quotes eld
8090 \begin_inset Quotes erd
8094 Now click on the button labeled
8095 \begin_inset Quotes eld
8100 \begin_inset Quotes erd
8103 to open a file dialog and navigate to the directory containing the
8104 \begin_inset Flex Code
8107 \begin_layout Plain Layout
8113 program (which is installed by default on Cygwin along with the \SpecialChar LyX
8116 \begin_inset Flex Code
8119 \begin_layout Plain Layout
8125 and then specify the program arguments as
8126 \begin_inset Flex Code
8129 \begin_layout Plain Layout
8136 In this way, you will be using the
8140 for communicating with \SpecialChar LyX
8142 If, for whatever reason, you want to use the
8147 \begin_inset Flex Code
8150 \begin_layout Plain Layout
8156 option and be sure to specify the \SpecialChar LyX
8157 Server pipe path in the \SpecialChar LyX
8161 \begin_layout Standard
8162 In yap, reverse search is triggered by double-click.
8165 \begin_layout Subsubsection*
8169 \begin_layout Standard
8170 In order to use SumatraPDF for inverse search, enter
8171 \begin_inset Flex Code
8174 \begin_layout Plain Layout
8175 SumatraPDF -inverse-search "lyxeditor -g %f %l"
8180 in the viewer setting in
8181 \begin_inset Flex Noun
8184 \begin_layout Plain Layout
8185 Preferences\SpecialChar menuseparator
8186 File Handling\SpecialChar menuseparator
8187 File formats\SpecialChar menuseparator
8194 If SumatraPDF.exe is not in your command PATH, use its full posix path.
8196 \begin_inset Flex Code
8199 \begin_layout Plain Layout
8205 enables communication via the
8211 \begin_inset Flex Code
8214 \begin_layout Plain Layout
8220 option if you want to use the
8224 , and be sure to specify the \SpecialChar LyX
8225 Server pipe path in the \SpecialChar LyX
8229 \begin_layout Standard
8230 Reverse search is triggered by double-click.
8233 \begin_layout Section
8237 \begin_layout Standard
8238 Forward search is, as the name implies, in a sense the
8239 \begin_inset Quotes eld
8243 \begin_inset Quotes erd
8247 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
8249 If forward search is set up (as described in what follows), you can put
8250 the cursor anywhere in your \SpecialChar LyX
8252 \begin_inset Flex Noun
8255 \begin_layout Plain Layout
8256 Navigate\SpecialChar menuseparator
8263 \begin_inset Flex Noun
8266 \begin_layout Plain Layout
8272 in the context menu via right mouse click), and then the viewer will jump
8273 to that position as well.
8274 This implies, of course, that your viewer supports this function.
8277 \begin_layout Standard
8278 To make forward search possible, you first need to provide the generated
8279 output PDF/DVI file with additional information about the \SpecialChar TeX
8281 This can be done via the methods described in the section
8282 \begin_inset CommandInset ref
8284 reference "subsec:rev-search"
8291 \begin_layout Standard
8292 Additionally, you need to configure \SpecialChar LyX
8293 for using your viewers in
8294 \begin_inset Flex Noun
8297 \begin_layout Plain Layout
8298 Tools\SpecialChar menuseparator
8299 Preferences\SpecialChar menuseparator
8300 Output\SpecialChar menuseparator
8307 We provide a range of tested configurations for some viewers, which you
8308 can select from the drop down list.
8309 If none of these configurations suits you, you have to find out and enter
8310 a suitable configuration yourself.
8311 The definition syntax uses the following placeholders:
8314 \begin_layout Itemize
8316 \begin_inset Flex Code
8319 \begin_layout Plain Layout
8328 \begin_layout Itemize
8330 \begin_inset Flex Code
8333 \begin_layout Plain Layout
8339 : name of the (temporary) exported .tex file (without path)
8342 \begin_layout Itemize
8344 \begin_inset Flex Code
8347 \begin_layout Plain Layout
8353 : name of the (temporary) exported .tex file (including path)
8356 \begin_layout Itemize
8358 \begin_inset Flex Code
8361 \begin_layout Plain Layout
8367 : name of the exported output file (either dvi or pdf, depending on which
8368 one exists in the temporary directory)
8371 \begin_layout Standard
8372 Note that only some of the viewers provide full and usable forward search
8373 functionality out of the box, among them yap, xdvi, okular
8377 \begin_layout Plain Layout
8378 You might want to set
8379 \begin_inset Flex Code
8382 \begin_layout Plain Layout
8389 \begin_inset Flex Noun
8392 \begin_layout Plain Layout
8393 Tools\SpecialChar menuseparator
8394 Preferences\SpecialChar menuseparator
8395 File Handling\SpecialChar menuseparator
8397 \begin_inset space ~
8410 , qpdfview, and SumatraPDF
8414 \begin_layout Plain Layout
8415 SumatraPDF can also use DDE commands through the external program CMCDDE
8417 \begin_inset CommandInset href
8419 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
8430 Others, such as evince
8434 \begin_layout Plain Layout
8435 Forward search with evince can be achieved by means of third party helper
8438 \begin_inset CommandInset href
8440 target "https://wiki.lyx.org/LyX/SyncTeX"
8450 , require some extra tools in order to use forward search.
8451 While many of the widespread PDF viewers (most notably Adobe Reader) do
8452 not support forward search at all, some other viewers – e.
8453 \begin_inset space \thinspace{}
8457 xpdf – allow at least to reload the document and jump to a specific page
8458 of the file, so you can at least navigate
8459 \begin_inset Quotes eld
8463 \begin_inset Quotes erd
8467 This latter functionality is provided by an external call of synctex (see
8468 the predefined example configurations).
8472 \begin_layout Standard
8473 Forward search works both with DVI and PDF output.
8475 simply checks which preview format you have used before (i.
8476 \begin_inset space \thinspace{}
8479 e., which format is already there in the temporary directory) and chooses
8480 the appropriate configuration for the respective format.
8483 \begin_layout Chapter
8484 Special Document Classes
8487 \begin_layout Section
8491 \begin_layout Standard
8497 \begin_layout Subsection
8501 \begin_layout Standard
8502 This section describes how \SpecialChar LyX
8503 can be used to write articles for submission
8504 to the scientific journal
8506 Astronomy and Astrophysics
8509 \begin_inset Flex URL
8512 \begin_layout Plain Layout
8514 https://www.aanda.org/
8519 ) using Version 5.01 of the document class
8524 This package can be downloaded from the ftp site
8527 \begin_layout Standard
8528 \begin_inset VSpace medskip
8534 \begin_layout Standard
8536 \begin_inset Flex URL
8539 \begin_layout Plain Layout
8541 ftp://ftp.edpsciences.org/pub/aa/readme.html
8549 \begin_layout Standard
8550 \begin_inset VSpace medskip
8556 \begin_layout Standard
8557 A manual comes together with that package, and this text is not meant to
8558 replace the original manual but is merely a short guide in how to realize
8559 the correct form of your paper.
8563 \begin_layout Standard
8564 Please note that the publisher of the journal was changed from Springer
8565 to EDP Sciences starting January 1, 2001.
8566 That change involved also some slight changes to the style files, namely
8567 the removal of the thesaurus command.
8568 The \SpecialChar LyX
8569 class aa supports the newest version of these style files, V 5.01.
8570 If you have an older version installed, please upgrade.
8571 For compatibility, the old (version 4) layout has been kept as
8576 Please refer to the comments in
8579 Dir/layouts/aapaper.layout
8584 \begin_layout Subsection
8588 \begin_layout Standard
8589 It is recommended you start from the example template distributed with \SpecialChar LyX
8591 If you are not using a template, note the following settings:
8594 \begin_layout Itemize
8601 Document\SpecialChar menuseparator
8604 dialog (OK, that one was obvious).
8607 \begin_layout Itemize
8608 Don't change the option
8611 \begin_inset space ~
8621 The whole layout is done by the macros, you shouldn't change anything.
8624 \begin_layout Subsection
8628 \begin_layout Standard
8629 First thing to enter is the header information.
8630 It consists of seven entries, of which some are optional.
8634 \begin_layout Itemize
8642 \begin_layout Itemize
8650 \begin_layout Itemize
8658 \begin_layout Itemize
8666 \begin_layout Itemize
8671 : [optional] if more than one author: whom to contact for offprint requests.
8674 \begin_layout Itemize
8679 : [optional] mail address for contacts.
8682 \begin_layout Itemize
8690 Received: <date>; Accepted <date>
8693 \begin_layout Standard
8694 There is no need to issue the
8700 command, this is done automatically by \SpecialChar LyX
8701 when the header is finished.
8702 Although the order of the single header entries doesn't matter it is advised
8703 to keep the above sequence, just to get the best optics and meets the layout
8704 of the real document.
8707 \begin_layout Standard
8708 If you want to place footnotes in the header block, e.
8709 \begin_inset space \thinspace{}
8713 \begin_inset space \space{}
8716 to state your present address, just use the standard footnote via the menu
8719 Insert\SpecialChar menuseparator
8724 will automagically use the term
8733 \begin_layout Standard
8736 Edit\SpecialChar menuseparator
8739 , you'll find two insets which are relevant for the titling:
8742 \begin_layout Itemize
8749 to mark corresponding author\SpecialChar breakableslash
8751 The institutes are numbered sequentially as they appear in the
8755 field, so you have to put a marker to each author.
8758 \begin_layout Itemize
8763 to supply an email address for fast contact.
8766 \begin_layout Standard
8767 In addition to these topics, the macros use one additional \SpecialChar LaTeX
8769 has no counterpart in \SpecialChar LyX
8773 \begin_layout Itemize
8780 to separate different names for more than one author and institute, respectivel
8784 \begin_layout Standard
8785 The appropriate command has to be entered in \SpecialChar LyX
8786 and marked as \SpecialChar LaTeX
8792 \begin_layout Subsection
8796 \begin_layout Standard
8797 The abstract should immediately follow the header block.
8798 With version 5 the abstract environment was changed to a command, and there
8799 is now a restriction to only one paragraph.
8800 In addition, it should contain an entry with the keywords.
8801 This is done via the paragraph style
8806 Refer to the example paper.
8809 \begin_layout Subsection
8810 Supported environments
8813 \begin_layout Standard
8814 The A&A paper layout supports the following environments for structuring
8818 \begin_layout Itemize
8824 \begin_layout Itemize
8830 \begin_layout Itemize
8836 \begin_layout Itemize
8842 \begin_layout Itemize
8848 \begin_layout Itemize
8854 \begin_layout Itemize
8860 \begin_layout Itemize
8866 \begin_layout Itemize
8872 \begin_layout Itemize
8878 \begin_layout Itemize
8884 \begin_layout Itemize
8891 \begin_layout Subsection
8892 Commands not supported by \SpecialChar LyX
8896 \begin_layout Standard
8897 Some commands are not yet supported by the
8901 layout for \SpecialChar LyX
8903 Some have already been mentioned.
8904 For the sake of completeness, they are listed all together here:
8907 \begin_layout Itemize
8915 \begin_layout Itemize
8923 \begin_layout Itemize
8931 \begin_layout Itemize
8939 \begin_layout Standard
8940 If you want to use any of these commands, you have to enter them yourself.
8943 Do not forget to mark them as \SpecialChar LaTeX
8947 \begin_layout Subsection
8948 Figure and Table Floats
8951 \begin_layout Standard
8953 provides support for the necessary float environments
8955 figure, figure*, table
8961 , therefore we won't tell much about it here.
8965 \begin_inset space ~
8971 Just remember that tables should be left-aligned.
8972 For that, select the table and change the alignment in
8974 Edit\SpecialChar menuseparator
8976 \begin_inset space ~
8982 \begin_layout Standard
8983 There is only one special thing: the figures with caption besides the figure.
8984 To create such a figure, you have to do the following:
8987 \begin_layout Enumerate
8988 Create a wide figure float:
8990 Insert\SpecialChar menuseparator
8991 Float\SpecialChar menuseparator
8994 , then right click in the figure and select
8997 \begin_inset space ~
9005 \begin_layout Enumerate
9006 Enter your caption text.
9009 \begin_layout Enumerate
9014 to move the cursor above the caption.
9017 \begin_layout Enumerate
9021 \begin_layout Enumerate
9022 Position the cursor behind the figure and insert a horizontal fill:
9024 Insert\SpecialChar menuseparator
9026 \begin_inset space ~
9029 Character\SpecialChar menuseparator
9031 \begin_inset space ~
9039 \begin_layout Enumerate
9040 Switch to \SpecialChar LaTeX
9044 \begin_inset space ~
9052 \begin_layout Enumerate
9062 Do not close the brace!
9065 \begin_layout Enumerate
9066 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
9071 \begin_inset space ~
9083 \begin_layout Standard
9084 Also, refer to the figures in the example paper.
9087 \begin_layout Subsection
9091 \begin_layout Standard
9092 For submission, the paper has to be formated in a special double-spacing
9094 For this purpose, you have to give the option
9098 to the document class.
9099 This must be done using the custom class options field in the
9101 Document\SpecialChar menuseparator
9105 Just enter the string
9112 \begin_layout Subsection
9116 \begin_layout Standard
9121 directory contains an example paper written with \SpecialChar LyX
9123 It is the example paper from the original macro package, translated to
9126 Use it for inspiration, and compare the original \SpecialChar LaTeX
9127 code with \SpecialChar LyX
9131 \begin_layout Section
9136 \begin_layout Standard
9142 \begin_layout Subsection
9146 \begin_layout Standard
9148 is a set of macros produced by the American Astronomical Society to
9149 facilitate electronic manuscript submission to the three journals they
9150 publish: the Astrophysical Journal (including the Letters and Supplement),
9151 the Astronomical Journal, and the Publications of the Astronomical Society
9154 has proven to be an excellent tool for generating these documents, especially
9155 given its equation, citation, and figure handling capabilities.
9157 requires version 5.0 (or higher) of these macros; preferably 6.0, which
9158 is the version described here, or higher.
9159 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
9160 2.09 and are fundamentally
9161 incompatible with \SpecialChar LyX
9163 The AAS\SpecialChar TeX
9164 package may be downloaded from the AAS\SpecialChar TeX
9168 \begin_layout Standard
9169 \begin_inset VSpace medskip
9175 \begin_layout Standard
9177 \begin_inset Flex URL
9180 \begin_layout Plain Layout
9182 https://aas.org/aastex/aastex-downloads
9190 \begin_layout Standard
9191 \begin_inset VSpace medskip
9197 \begin_layout Standard
9198 A complete user guide is contained in that package and you should familiarize
9199 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
9202 will not reduce the need to figure out all the AAS\SpecialChar TeX
9203 commands, it will only
9204 reduce the drudgery of typing everything in.
9205 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
9207 completely to the requirements of the journal to which you are submitting
9211 \begin_layout Subsection
9212 Starting a New Paper
9215 \begin_layout Standard
9216 I strongly suggest that you start with the AAS\SpecialChar TeX
9220 File\SpecialChar menuseparator
9227 , enter the new file name, then choose the
9232 This will show the most common fields found in a manuscript.
9233 Simply overwrite the existing text (including the brackets,
9237 ) with the correct information.
9238 Many of the AAS\SpecialChar TeX
9239 commands and environments can be implemented directly in
9242 For commands such as these, the \SpecialChar LaTeX
9243 code must be entered directly and marked
9245 Such commands are referred to as \SpecialChar TeX
9246 code, or Evil Red Text.
9247 I tried to minimize the amount of \SpecialChar TeX
9248 code needed in an AAS\SpecialChar TeX
9252 \begin_layout Subsection
9253 Finishing Your Paper
9256 \begin_layout Standard
9257 When the paper is finished to your satisfaction and previews/prints correctly,
9259 \begin_inset Quotes eld
9263 \begin_inset Quotes erd
9266 actions which need to be done before you submit it to the journals.
9270 \begin_layout Enumerate
9271 Export your paper as a \SpecialChar LaTeX
9274 File\SpecialChar menuseparator
9275 Export\SpecialChar menuseparator
9283 \begin_layout Enumerate
9288 file with your favorite text editor
9292 \begin_layout Enumerate
9293 remove the comment lines before the
9302 \begin_layout Enumerate
9307 usepackage...{fontenc}
9309 line if it appears (usually just after
9324 \begin_layout Enumerate
9325 remove everything between (and including) the
9337 commands, except for any commands you specifically put into the \SpecialChar LaTeX
9339 (which should appear immediately after the
9340 \begin_inset Quotes eld
9343 User specified \SpecialChar LaTeX
9345 \begin_inset Quotes erd
9356 \begin_layout Enumerate
9357 Run the resulting file through \SpecialChar LaTeX
9358 to make sure it still processes correctly.
9361 \begin_layout Enumerate
9362 Reread the journal requirements to make sure your filenames and formats
9366 \begin_layout Enumerate
9370 \begin_layout Subsection
9371 Comments On Specific Commands
9374 \begin_layout Standard
9375 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
9382 ) gives a good description of each.
9383 Thus it's probably easiest for me to go down the list as found in the guide
9384 and offer comments where necessary.
9385 So let's begin \SpecialChar ldots
9389 \begin_layout Subsubsection
9390 Things that work as expected
9393 \begin_layout Standard
9394 Because they work as you might expect, I simply list them and the section
9495 begin{thebibliography}
9503 (2.13.2), all the cite commands and their variations (2.13.2), the generic
9504 graphicx figure commands (2.14.1),
9528 (2.15.4, amongst other places),
9555 \begin_layout Standard
9556 The following style options also work correctly:
9577 Simply put them in the
9583 Layout\SpecialChar menuseparator
9589 \begin_layout Subsubsection
9590 Things that work, but require more comment
9593 \begin_layout Standard
9594 The following items work, but require a little more discussion:
9597 \begin_layout Itemize
9598 These items are reserved for use by the journal editors, but you can put
9599 them into the \SpecialChar LaTeX
9600 preamble if you feel compelled to do so:
9633 \begin_layout Itemize
9634 These items may be placed in the \SpecialChar LaTeX
9635 preamble, and are included as blanks in
9657 \begin_layout Itemize
9664 (2.3) – can only be used
9665 \begin_inset Quotes eld
9669 \begin_inset Quotes erd
9672 , not in the middle of a paragraph.
9673 Use \SpecialChar TeX
9674 code if you need to embed it.
9677 \begin_layout Itemize
9684 (2.3) – will have extra {} after it.
9685 This should not cause an error.
9688 \begin_layout Itemize
9695 (2.6) – can only be used
9696 \begin_inset Quotes eld
9700 \begin_inset Quotes erd
9703 , not in the middle of a paragraph.
9704 Use \SpecialChar TeX
9705 code if you need to embed it.
9708 \begin_layout Itemize
9715 (2.8) – can't insert a cross-reference tag, you must type the tag name by
9719 \begin_layout Itemize
9733 \begin_layout Itemize
9740 (2.9) – will have extra {} after it.
9741 This should not cause an error.
9744 \begin_layout Itemize
9751 (2.11) – will have extra {} after it.
9752 This should not cause an error.
9755 \begin_layout Itemize
9762 (2.14.2) – you can insert an optional filename argument by placing the cursor
9763 at the beginning of the text and selecting
9765 Insert\SpecialChar menuseparator
9770 \begin_inset Quotes eld
9774 \begin_inset Quotes erd
9777 inserts an optional argument of the type needed by
9784 Hopefully it will be renamed someday.
9787 \begin_layout Itemize
9800 for the catalog ID optional parameter
9803 \begin_layout Itemize
9816 for the catalog ID optional parameter
9819 \begin_layout Subsubsection
9820 Things not implemented, use \SpecialChar TeX
9824 \begin_layout Standard
9835 setcounter{equation}
9837 (2.12), Journal name abbreviations (2.13.4),
9873 (2.15.4, insert it as the first element in the lefthand cell after where
9875 Don't use any of \SpecialChar LyX
9876 's rules in the table),
9888 (2.15.5), much of Misc (2.17, except
9939 \begin_layout Subsubsection
9940 Things that cannot be implemented
9943 \begin_layout Standard
9945 at least in any meaningful sort of way, so I suggest ignoring them.
9946 They are the references environment (2.13.3), and the deluxetable environment
9948 If you really, really need to use deluxetable, I suggest editing it in
9949 a separate file with a text editor, then using
9951 Insert\SpecialChar menuseparator
9953 \begin_inset space ~
9958 to include it in your \SpecialChar LyX
9964 file to see an example of this.
9967 \begin_layout Subsection
9968 FAQs, Tips, Tricks, and Other Ruminations
9971 \begin_layout Subsubsection
9972 Getting \SpecialChar LyX
9973 and AAS\SpecialChar TeX
9977 \begin_layout Standard
9978 It can be a bit tricky to get \SpecialChar LyX
9979 to recognize a new layout and document class.
9980 When all else fails, do this:
9983 \begin_layout Enumerate
9984 Make certain that \SpecialChar LaTeX
9985 can find AAS\SpecialChar TeX
9987 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
9989 directory completely unrelated to \SpecialChar LaTeX
9990 or AAS\SpecialChar TeX
9991 and run \SpecialChar LaTeX
9999 \begin_layout Enumerate
10004 appears in \SpecialChar LyX
10012 \begin_layout Enumerate
10015 Tools\SpecialChar menuseparator
10018 in \SpecialChar LyX
10019 , then restart \SpecialChar LyX
10023 \begin_layout Enumerate
10024 Open a regular new file, not from a template.
10025 Does AAS\SpecialChar TeX
10026 appear in the class list in
10028 Document\SpecialChar menuseparator
10034 \begin_layout Standard
10035 If you get a warning from an existing AAS\SpecialChar TeX
10036 document about not being able
10037 to find the AAS\SpecialChar TeX
10038 layout or a message about
10039 \begin_inset Quotes eld
10042 You should not mix title layouts with normal ones
10043 \begin_inset Quotes erd
10046 , things haven't been installed correctly.
10049 \begin_layout Subsubsection
10051 error processing a table
10054 \begin_layout Standard
10056 , by default, attempts to center the table caption/title.
10057 This seems to produce a bad interaction in AAS\SpecialChar TeX
10058 so you should click somewhere
10059 in the caption/title, then select
10061 Edit\SpecialChar menuseparator
10063 \begin_inset space ~
10077 This took care of it for me.
10080 \begin_layout Subsubsection
10084 \begin_layout Standard
10085 A couple of things: 1) I have noticed some funny spacing in the reference
10086 entries in the text.
10087 When you enter the bibliography item data, make sure their is
10091 space between the last author and the parenthesis setting off the year;
10095 \begin_inset space \thinspace{}
10099 \begin_inset space \space{}
10113 2) Entering the references at all is not obvious.
10114 The easiest thing is to start typing your first reference at the end of
10115 the document, then mark it as type
10120 That will put a small gray box in front of what you just typed.
10121 Click on the box to fill in the rest of the information.
10122 For new references, go to the end of an existing reference and press return.
10123 That will create a new line with its own box, etc.
10126 \begin_layout Subsubsection
10127 Including EPS files
10130 \begin_layout Standard
10131 Even though AAS\SpecialChar TeX
10132 provides its own figure commands (
10138 , for example), I much prefer \SpecialChar LaTeX
10139 's standard figure commands (with the default
10148 \begin_inset space ~
10151 commands as \SpecialChar TeX
10152 code into a Figure Float box if you desire, but I never have
10153 much luck getting the layout right.
10154 With the standard graphics, \SpecialChar LyX
10159 usepackage{graphicx}
10161 command into the \SpecialChar LaTeX
10162 preamble and handle the figures in the standard \SpecialChar LaTeX2e
10164 interspersing the figures in the text.
10165 I believe ApJ accepts figures exactly this way now; AJ might still use
10167 \begin_inset Quotes eld
10170 stack everything at the end
10171 \begin_inset Quotes erd
10177 \begin_layout Subsubsection
10178 Things I could have done, but didn't
10181 \begin_layout Standard
10183 \begin_inset Quotes eld
10187 \begin_inset Quotes erd
10190 things I could have implemented, but chose not to.
10191 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
10193 even though it is double-spaced in the paper manuscript.
10194 Also, I chose not to make separate layouts for the preprint and preprint2
10196 Since I assume you will spend most of your time in the plain manuscript
10197 mode anyway, I decided not to chew up more disk space with this.
10201 \begin_layout Subsection
10205 \begin_layout Standard
10206 Your mileage may vary.
10207 I've now had papers published by both ApJ and AJ that have had 98% of the
10208 effort done in \SpecialChar LyX
10209 ; the last 2% was the \SpecialChar LaTeX
10210 post-processing and a few cleanups.
10211 I have had no trouble with the submission process, and I'm sure the journals
10212 were never aware that there might be a difference.
10213 So, go forth and publish!
10216 \begin_layout Section
10217 AMS \SpecialChar LaTeX
10221 \begin_layout Standard
10228 Richard Kimberly Heck
10231 \begin_layout Standard
10232 \begin_inset VSpace bigskip
10238 \begin_layout Standard
10240 The AMS \SpecialChar LaTeX
10241 layouts are set up to conform to suggested styles for mathematical
10242 papers to be submitted to American Mathematical Society publications.
10243 The layouts are not tailored to a specific journal, but easily can be.
10244 You should refer to the AMS documentation for specific instructions for
10245 each journal (usually it will entail only changing a single line in the
10248 That documentation is available on the Web at
10249 \begin_inset Flex URL
10252 \begin_layout Plain Layout
10260 \begin_inset Flex URL
10263 \begin_layout Plain Layout
10265 ftp://ftp.ams.org/pub/tex/amslatex/
10271 These layouts are appropriate, and useful, for any mathematical writing.
10275 \begin_layout Standard
10276 There are two basic AMS \SpecialChar LaTeX
10280 \begin_layout Itemize
10281 amsart: The standard AMS article format.
10284 \begin_layout Itemize
10285 amsbook: the standard AMS book (really, monograph) format.
10289 \begin_layout Standard
10290 The layouts themselves contain only the minimum necessary to use the AMS
10292 They do not, in particular, contain any of the `theorem' environments used
10293 for setting theorems, lemmas, and the like.
10294 These are contained, instead, in the
10295 \begin_inset Flex Code
10298 \begin_layout Plain Layout
10304 module, which is loaded by default when you select one of the AMS classes.
10305 (It can also be used with other classes and can be removed, if you would
10306 rather use something else.) Less commonly used environments are in the
10307 \begin_inset Flex Code
10310 \begin_layout Plain Layout
10311 Theorems (AMS-Extended)
10316 module, which must be loaded manually.
10319 \begin_layout Standard
10320 By default, theorems and the like are numbered consecutively throughout
10321 the document, but this may be modified by loading the module
10322 \begin_inset Flex Code
10325 \begin_layout Plain Layout
10326 Theorems (Order by Section)
10331 or, if you are using
10332 \begin_inset Flex Code
10335 \begin_layout Plain Layout
10342 \begin_inset Flex Code
10345 \begin_layout Plain Layout
10346 Theorems (Order by Chapter)
10352 These will number the results as
10353 \begin_inset Formula $n.m$
10356 , where the first number refers to the section (or chapter) and the second
10357 refers to the total number of results so far in that section (or chapter).
10358 Many environments are also available unnumbered.
10359 These are indicated by an asterisk at the end.
10360 If you happen to want
10364 unnumbered results, the module
10365 \begin_inset Flex Code
10368 \begin_layout Plain Layout
10374 provides that option.
10377 \begin_layout Standard
10378 Note that these modules do not
10382 to be used with the AMS classes.
10383 It is perfectly possible to use the
10384 \begin_inset Flex Code
10387 \begin_layout Plain Layout
10393 module, and the others mentioned, with other classes, such as
10394 \begin_inset Flex Code
10397 \begin_layout Plain Layout
10404 \begin_inset Flex Code
10407 \begin_layout Plain Layout
10414 \begin_inset Flex Code
10417 \begin_layout Plain Layout
10426 \begin_layout Subsection
10427 What these layouts provide
10430 \begin_layout Standard
10431 There is a long list of included environments provided by these layouts.
10432 In AMS-\SpecialChar LaTeX
10433 , there is, in fact, an opportunity to define an unlimited variety
10434 of `theorem' environments.
10435 However, the AMS recommends the environments that are available in \SpecialChar LyX
10440 \begin_layout Standard
10441 The following environments—as well as the standard environments, such as
10443 \begin_inset Flex Noun
10446 \begin_layout Plain Layout
10453 \begin_inset Flex Noun
10456 \begin_layout Plain Layout
10463 \begin_inset Flex Noun
10466 \begin_layout Plain Layout
10473 \begin_inset Flex Noun
10476 \begin_layout Plain Layout
10483 \begin_inset Flex Noun
10486 \begin_layout Plain Layout
10493 \begin_inset Flex Code
10496 \begin_layout Plain Layout
10503 \begin_inset Flex Code
10506 \begin_layout Plain Layout
10515 \begin_layout Description
10516 Address This should be the author's permanent address.
10519 \begin_layout Description
10521 \begin_inset space ~
10524 Address This should be the author's temporary address at the time of submission,
10525 if different from the Address.
10528 \begin_layout Description
10529 Email Author's e-mail address
10532 \begin_layout Description
10533 URL Author's Web address, if desired.
10536 \begin_layout Description
10537 Keywords Key words or phrases used to identify specific topics discussed
10541 \begin_layout Description
10542 Subjectclass These refer to the AMS Subject Classifications, published and
10545 Mathematical Reviews
10548 These are also available online at the AMS cites listed above.
10551 \begin_layout Description
10555 \begin_layout Description
10559 \begin_layout Description
10563 \begin_layout Standard
10564 The following environments are provided by both the
10565 \begin_inset Flex Code
10568 \begin_layout Plain Layout
10575 \begin_inset Flex Code
10578 \begin_layout Plain Layout
10584 modules, in the latter case in both starred (unnumbered) and unstarred
10585 (numbered) versions.
10586 These same environments are provided only in the starred versions by the
10588 \begin_inset Flex Code
10591 \begin_layout Plain Layout
10600 \begin_layout Theorem
10601 This is typically used for the statements of major results.
10605 \begin_layout Corollary*
10606 This is used for statements which follow fairly directly from previous statement
10608 Again, these can be major results.
10612 \begin_layout Lemma
10613 These are smaller results needed to prove other statements.
10616 \begin_layout Proposition
10617 These are less major results which (hopefully) add to the general theory
10621 \begin_layout Conjecture
10622 These are statements provided without justification, which the author does
10623 not know how to prove, but which seem to be true (to the author, at least).
10626 \begin_layout Definition*
10627 Guess what this is for.
10628 The font is different for this environment than for the previous ones.
10632 \begin_layout Example*
10633 Used for examples illustrating proven results.
10636 \begin_layout Problem
10637 It's not really known what this is for.
10638 You should figure it out.
10641 \begin_layout Exercise*
10642 Write a description for this one.
10645 \begin_layout Remark
10646 This environment is also a type of theorem, usually a lesser sort of observation.
10649 \begin_layout Claim*
10650 Often used in the course of giving a proof of a larger result.
10654 Generally, these are used to break up long arguments, using specific instances
10660 The numbering scheme for cases is on its own, not together with other numbered
10665 \begin_layout Proof
10666 At the end of this environment, a QED symbol (usually a square, but it can
10667 vary with different styles) is placed.
10668 If you want to have other environments within this one—for example, Case
10669 environments—and have the QED symbol appear only after them, then the other
10670 environments need to be nested within the proof environment.
10673 Nesting Environments
10679 for information on nesting.
10682 \begin_layout Standard
10683 And these environments are provided by
10684 \begin_inset Flex Code
10687 \begin_layout Plain Layout
10688 Theorems (AMS-Extended)
10696 \begin_layout Criterion*
10697 A required condition.
10700 \begin_layout Algorithm*
10701 A general procedure to be used.
10704 \begin_layout Axiom*
10705 This is a property or statement taken as true within the system being discussed.
10708 \begin_layout Condition*
10709 Sometimes used to state a condition assumed within the present context of
10713 \begin_layout Note*
10714 Similar to a Remark.
10717 \begin_layout Notation*
10718 Used for the explanation of, yes, notation.
10721 \begin_layout Summary
10722 Do we really need to tell you?
10725 \begin_layout Acknowledgement*
10729 \begin_layout Conclusion*
10730 Sometimes used at the end of a long train of argument.
10734 Used in a way similar to Proposition, though perhaps lower on the scale.
10737 \begin_layout Standard
10738 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
10741 They need to be available on your system in order to use these environments.
10744 \begin_layout Section
10748 \begin_layout Standard
10754 \begin_layout Subsection
10758 \begin_layout Standard
10759 Broadway is for writing plays.
10760 The format is more decorative than Hollywood, and much less standardized.
10761 This format should be suitable for workshops.
10764 \begin_layout Subsection
10768 \begin_layout Standard
10769 The same as in Hollywood.
10772 \begin_layout Subsection
10776 \begin_layout Standard
10781 names as labels then cross-reference the label to insert the name.
10782 The cross-reference dialog will show the current cast of characters.
10785 \begin_layout Subsection
10786 Paper size and Margins
10789 \begin_layout Standard
10790 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
10793 \begin_layout Subsection
10797 \begin_layout Standard
10798 The following environments are available.
10799 You can use broadway.bind to get the bind keys shown at the right.
10802 \begin_layout Itemize
10806 \begin_inset Newline newline
10811 You should not have to use this, but it is here for anything that does not
10815 \begin_layout Itemize
10819 \begin_inset space \hfill{}
10823 \begin_inset Newline newline
10828 Used to describe stage setting and the action.
10829 First use of speaker names in all CAPs.
10832 \begin_layout Itemize
10836 \begin_inset space \hfill{}
10840 \begin_inset Newline newline
10845 Automatically numbered.
10846 On screen it will be arabic, but will print as Roman.
10849 \begin_layout Itemize
10853 \begin_inset space \hfill{}
10857 \begin_inset Newline newline
10867 It is just centered text.
10870 \begin_layout Itemize
10874 \begin_inset space \hfill{}
10878 \begin_inset Newline newline
10883 Not automatically numbered.
10884 You supply the number.
10885 This is because I couldn't figure out how.
10888 \begin_layout Itemize
10892 \begin_inset space \hfill{}
10896 \begin_inset Newline newline
10901 A special case of Narrative to describe the setting and action as the curtain
10905 \begin_layout Itemize
10909 \begin_inset space \hfill{}
10913 \begin_inset Newline newline
10918 The speaker's (actor's) title, centered in all CAPS.
10921 \begin_layout Itemize
10925 \begin_inset space \hfill{}
10929 \begin_inset Newline newline
10934 Instructions to the speaker.
10935 The parentheses are automatically inserted.
10936 The ( will appear on screen, but both will be in the printed play.
10937 This environment is only used within
10944 \begin_layout Itemize
10948 \begin_inset space \hfill{}
10952 \begin_inset Newline newline
10957 What the Speaker says.
10960 \begin_layout Itemize
10964 \begin_inset space \hfill{}
10968 \begin_inset Newline newline
10973 The curtain comes down.
10976 \begin_layout Itemize
10980 \begin_inset space \hfill{}
10986 \begin_layout Itemize
10990 \begin_inset space \hfill{}
10996 \begin_layout Itemize
11000 \begin_inset space \hfill{}
11006 \begin_layout Standard
11010 \begin_layout Section
11014 \begin_layout Standard
11019 can be used to type letters according to German conventions.
11020 A template file is included in
11022 .../lyx/share/templates
11024 for you to use as a starting point.
11027 \begin_layout Section
11031 \begin_layout Standard
11032 See the \SpecialChar LyX
11038 It contains all infos you need.
11041 \begin_layout Section
11044 Foil\SpecialChar TeX
11048 \begin_inset CommandInset label
11057 \begin_layout Standard
11063 \begin_layout Subsection
11067 \begin_layout Standard
11068 This section describes how to use \SpecialChar LyX
11069 to make slides for overhead projectors.
11070 There are two document classes that can do this: the default slides class
11073 Foil\SpecialChar TeX
11077 This section documents the latter.
11080 \begin_layout Standard
11081 I'm going to say this again, nice and clear, so that there's no misunderstanding
11085 \begin_layout Standard
11086 \begin_inset VSpace bigskip
11092 \begin_layout Standard
11096 This section documents the class
11097 \begin_inset Quotes eld
11105 \begin_inset Quotes erd
11113 \begin_layout Standard
11114 \begin_inset VSpace bigskip
11120 \begin_layout Standard
11121 If you're looking for the documentation for
11122 \begin_inset Quotes eld
11130 \begin_inset Quotes erd
11133 , check out section
11134 \begin_inset space ~
11138 \begin_inset CommandInset ref
11140 reference "sec:slitex"
11145 If your machine doesn't have the
11153 installed, you'll probably have to use the default
11157 class, which isn't quite as good as
11162 \begin_layout Standard
11167 class is designed for use with version
11168 \begin_inset space ~
11176 class file which is now an integral part of \SpecialChar LaTeX2e
11180 \begin_layout Subsection
11184 \begin_layout Standard
11185 Obviously, to use this document class, you need to select
11196 \begin_inset space ~
11202 There are some settings in the
11205 \begin_inset space ~
11210 dialog that you should know about that are specific to this class:
11213 \begin_layout Itemize
11214 Don't change the options
11225 \begin_inset space ~
11231 They're ignored by the
11238 \begin_layout Itemize
11239 The default font size is 20
11240 \begin_inset space \thinspace{}
11243 pt with the other options being 17
11244 \begin_inset space \thinspace{}
11248 \begin_inset space \thinspace{}
11252 \begin_inset space \thinspace{}
11258 \begin_layout Itemize
11259 The default font is
11267 but all math equations are still typeset in the usual roman font.
11270 \begin_layout Itemize
11273 Foil\SpecialChar TeX
11276 supports A4 and Letter paper sizes as well as a special size for working
11278 \begin_inset space \thinspace{}
11282 It doesn't support A5, B5, legal or executive paper sizes.
11285 \begin_layout Itemize
11286 Don't bother changing the
11290 settings because they are ignored anyway.
11291 All floats appear where they are defined in the text.
11294 \begin_layout Itemize
11299 setting behaves a bit differently for this class.
11302 Foil\SpecialChar TeX
11305 provides extensive footer and header capabilities including a user-defined
11308 \begin_inset space ~
11312 \begin_inset CommandInset ref
11314 reference "sec:foilfoot"
11319 The title page is treated differently to all other pages in the document
11328 has the logo centered at the bottom of the page (if one is defined).
11329 The possible page style choices and what they do are as follows:
11333 \begin_layout Labeling
11334 \labelwidthstring MMMMMMM
11341 The final output contains no page numbers, or other headers or footers
11342 (except footnotes of course).
11346 \begin_layout Labeling
11347 \labelwidthstring MMMMMMM
11354 The final output contains page numbers centered at the bottom of the page.
11355 No other headings or footers (other than footnotes).
11358 \begin_layout Labeling
11359 \labelwidthstring MMMMMMM
11364 Page numbers in lower right corner.
11365 Additional headers and footers are also shown.
11366 This is also the default.
11369 \begin_layout Labeling
11370 \labelwidthstring MMMMMMM
11375 Gives you access to the
11379 package although its use with
11381 Foil\SpecialChar TeX
11384 is discouraged by the writer of the
11386 Foil\SpecialChar TeX
11389 package because of some potential page layout clashes.
11393 \begin_layout Subsubsection
11397 \begin_layout Standard
11398 The following options may be used in the extra class options in the
11400 Document\SpecialChar menuseparator
11406 \begin_layout Labeling
11407 \labelwidthstring MMMMMMx
11412 This sets up the page layout for 7.33
11413 \begin_inset space \thinspace{}
11417 \begin_inset space \thinspace{}
11420 in paper, which is about the same aspect ratio as a 35
11421 \begin_inset space \thinspace{}
11424 mm slide, making it a bit easier to work with this medium.
11427 \begin_layout Labeling
11428 \labelwidthstring MMMMMMx
11433 Places a rule across the page below the header on every page except the
11437 \begin_layout Labeling
11438 \labelwidthstring MMMMMMx
11443 Places a rule across the page above the footer on every page except the
11447 \begin_layout Labeling
11448 \labelwidthstring MMMMMMx
11453 This is automatically set each time you create a new
11460 Foil\SpecialChar TeX
11463 to use the dvips driver to rotate those pages that are set as landscape
11467 \begin_layout Labeling
11468 \labelwidthstring MMMMMMx
11473 Simply changes the page dimensions to those of a landscape page but doesn't
11475 Thus if you use this option you need to use an external program to rotate
11476 each page or feed your paper through your printer as landscape.
11477 Note that this option effectively reverses the roles of the
11485 environments (don't worry these are described in the next section).
11488 \begin_layout Labeling
11489 \labelwidthstring MMMMMMx
11494 Equation numbers on the left.
11497 \begin_layout Labeling
11498 \labelwidthstring MMMMMMx
11503 Flush-left equations.
11506 \begin_layout Subsection
11507 Supported Environments
11510 \begin_layout Standard
11511 Most of the environments commonly supported in other classes are also supported
11517 There are several additional environments provided by
11519 Foil\SpecialChar TeX
11522 as well as a couple added by \SpecialChar LyX
11524 The following environments are shared with other classes:
11527 \begin_layout Standard
11528 \begin_inset Flex Multiple Columns
11531 \begin_layout Itemize
11537 \begin_layout Itemize
11543 \begin_layout Itemize
11549 \begin_layout Itemize
11555 \begin_layout Itemize
11561 \begin_layout Itemize
11568 \begin_layout Itemize
11574 \begin_layout Itemize
11580 \begin_layout Itemize
11586 \begin_layout Itemize
11592 \begin_layout Itemize
11598 \begin_layout Itemize
11604 \begin_layout Itemize
11610 \begin_layout Itemize
11616 \begin_layout Itemize
11627 \begin_layout Standard
11628 That is, all the major environments apart from the sectioning environments.
11629 Since foils are essentially self-contained sections, with a title and body,
11632 Foil\SpecialChar TeX
11635 provides specific commands for starting new foils and these are:
11638 \begin_layout Itemize
11644 \begin_layout Itemize
11650 \begin_layout Standard
11652 also provides slightly modified versions of these two environments called:
11655 \begin_layout Itemize
11661 \begin_layout Itemize
11664 ShortRotatefoilhead
11667 \begin_layout Standard
11668 and the differences will be explained in the next section.
11671 \begin_layout Standard
11672 Since foils are often used in presenting ideas or new theorems and such
11675 Foil\SpecialChar TeX
11678 also provides a comprehensive box of goodies for presenting them:
11681 \begin_layout Standard
11682 \begin_inset Flex Multiple Columns
11685 \begin_layout Itemize
11691 \begin_layout Itemize
11697 \begin_layout Itemize
11703 \begin_layout Itemize
11709 \begin_layout Itemize
11715 \begin_layout Itemize
11721 \begin_layout Itemize
11727 \begin_layout Itemize
11733 \begin_layout Itemize
11739 \begin_layout Itemize
11745 \begin_layout Itemize
11756 \begin_layout Standard
11757 The starred versions are unnumbered while the unstarred versions are numbered.
11758 There are also two list environments added by \SpecialChar LyX
11762 \begin_layout Itemize
11768 \begin_layout Itemize
11774 \begin_layout Standard
11777 Foil\SpecialChar TeX
11780 provides some powerful header and footer capabilities that are best set
11781 in the preamble although they may be set at any point in a document.
11782 If you want to change these settings in your document the best place to
11783 do so is at the very top of a foil, i.
11784 \begin_inset space \thinspace{}
11790 \begin_inset space \space{}
11795 straight after the foilhead.
11798 \begin_layout Standard
11799 For this purpose, the following command styles are provided [
11806 \begin_layout Standard
11807 \begin_inset Flex Multiple Columns
11810 \begin_layout Itemize
11814 \begin_inset space ~
11820 \begin_layout Itemize
11826 \begin_layout Itemize
11830 \begin_inset space ~
11836 \begin_layout Itemize
11840 \begin_inset space ~
11846 \begin_layout Itemize
11850 \begin_inset space ~
11857 \begin_layout Plain Layout
11858 \begin_inset space ~
11870 \begin_layout Standard
11871 There are also a few commands provided by
11873 Foil\SpecialChar TeX
11876 that aren't directly supported by \SpecialChar LyX
11877 but I'll tell you what they do and how
11878 to use them in section
11879 \begin_inset space ~
11883 \begin_inset CommandInset ref
11885 reference "sec:unsuppfoils"
11892 \begin_layout Subsection
11893 Building a Set of Foils
11896 \begin_layout Standard
11897 This section will give a simple introduction to using the different environments
11898 to build a set of foils.
11899 If you want to see an example set of foils, take a look at the
11903 file you find in \SpecialChar LyX
11911 \begin_layout Subsubsection
11912 Give It a Title Page
11915 \begin_layout Standard
11916 Unlike other classes that provide
11936 creates the title on a page of its own.
11937 If you leave out the
11941 environment \SpecialChar LaTeX
11942 will substitute the current date (every time you regenerate
11946 \begin_layout Subsubsection
11950 \begin_layout Standard
11951 As I mentioned earlier, there are four ways of starting a new foil.
11952 For portrait foils you should use
11961 The difference between these two environments is the amount of space between
11962 the title of the foil (the foilhead) and the body of the foil.
11965 \begin_layout Standard
11966 Landscape foils are generated using the
11972 ShortRotatefoilhead
11975 Again the only difference is the spacing between foilhead and body.
11976 Both of the short versions have 0.5
11977 \begin_inset space ~
11980 inches less separation between the foilhead and the body.
11984 \begin_layout Standard
11985 One problem with the support for landscape foils is the requirement that
11986 you have to use the
11990 driver to generate the PostScript output otherwise the foils won't be rotated.
11991 It is possible to get landscape foils even if you haven't got the
11995 driver provided you can feed your foils sideways through your printer ;-)
11998 \begin_layout Subsubsection
11999 Theorems, Lemmas, Proofs and more
12002 \begin_layout Standard
12003 You can't have two of the same type of these environments directly following
12005 If you use a normal paragraph break, , you will just be extending the previous
12006 environment as if you had merged the two environments together.
12007 Rather than that, you need to insert a so-called separator.
12008 Please refer to the section entitled
12019 \begin_layout Subsubsection
12023 \begin_layout Standard
12024 You get all the commonly supported list styles found in other classes as
12025 well as two new ones.
12026 I'll only describe the new ones here.
12027 If you want to find out more about the other list environments check out
12033 If you intend to use itemized lists you might also want to read about the
12037 \begin_inset space ~
12041 \begin_inset space ~
12046 dialog described above in section
12047 \begin_inset space ~
12051 \begin_inset CommandInset ref
12053 reference "sec:bullet"
12060 \begin_layout Standard
12061 The two new list styles,
12069 , are designed to make it easier for you to create lists of do's and don'ts
12070 or right and wrong by providing dedicated environments that use a tick
12071 or a cross as the label of the list.
12072 These lists are in fact dedicated variants of the
12077 They do however require that you have the
12081 packages installed.
12084 \begin_layout Subsubsection
12088 \begin_layout Standard
12091 Foil\SpecialChar TeX
12094 redefines the floating tables and figures so that they appear exactly where
12095 they are in the text rather than pushing them to the top of the page or
12096 to some user specified location.
12097 In fact if you change the float placement settings they are simply ignored.
12100 \begin_layout Subsubsection
12101 Page Headers and Footers
12102 \begin_inset CommandInset label
12104 name "sec:foilfoot"
12111 \begin_layout Standard
12115 \begin_inset space ~
12124 are two commands used to control the left-footer text string.
12125 The first is meant to allow you to include a graphic logo on your foils
12127 \begin_inset Quotes eld
12132 Foil\SpecialChar TeX
12136 \begin_inset Quotes erd
12140 While the second is meant to provide a classification for the audience,
12144 \begin_inset space \thinspace{}
12150 \begin_inset space \space{}
12154 It is empty by default.
12157 \begin_layout Standard
12158 The remaining page corners can be filled by
12161 \begin_inset space ~
12166 (which defaults to page numbers),
12169 \begin_inset space ~
12177 \begin_inset space ~
12185 \begin_layout Subsection
12188 Foil\SpecialChar TeX
12192 \begin_inset CommandInset label
12194 name "sec:unsuppfoils"
12201 \begin_layout Standard
12202 All the commands mentioned below need to be set in a
12212 within another environment.
12215 \begin_layout Subsubsection
12219 \begin_layout Standard
12220 All lengths are adjusted using the
12243 should be replaced by the name given to the length you want to change and
12248 is the length value.
12249 All lengths should be specified in units of length such as inches (
12261 ) or relative to some document or font-based length such as
12271 \begin_layout Standard
12272 It's possible to change the spacing between a foilhead and the body of the
12273 foil by adjusting the length specified by
12280 For example, to make
12285 \begin_inset space \space{}
12288 in closer to their bodies put the following in the preamble:
12294 foilheadskip}{-0.5in}
12297 \begin_layout Standard
12298 The spacings around floats can be adjusted by setting these lengths:
12301 \begin_layout Labeling
12302 \labelwidthstring MMMMMMMMMMM
12309 Separation between the text and the top of the float
12312 \begin_layout Labeling
12313 \labelwidthstring MMMMMMMMMMM
12320 Separation between the float and the caption
12323 \begin_layout Labeling
12324 \labelwidthstring MMMMMMMMMMM
12331 Separation between the caption and the following text
12334 \begin_layout Labeling
12335 \labelwidthstring MMMMMMMMMMM
12342 You can make the captions narrower than the surrounding text by adjusting
12344 Best done relative to
12353 \begin_layout Standard
12354 There are also several title page related lengths that you may find useful
12355 if you have a long title or several authors:
12358 \begin_layout Labeling
12359 \labelwidthstring MMMMMMMMMMM
12366 Separation from headers to
12371 \begin_layout Labeling
12372 \labelwidthstring MMMMMMMMMMM
12390 \begin_layout Labeling
12391 \labelwidthstring MMMMMMMMMMM
12405 \begin_layout Labeling
12406 \labelwidthstring MMMMMMMMMMM
12422 \begin_layout Labeling
12423 \labelwidthstring MMMMMMMMMMM
12439 \begin_layout Standard
12440 The last length related command affects all the list environments.
12451 a list environment then all the vertical spacing between the list items
12453 Note that this is a command not a length so it doesn't require
12459 like the stuff mentioned above.
12462 \begin_layout Subsubsection
12463 Headers and Footers
12466 \begin_layout Standard
12479 commands control whether the logo in the
12483 definition appear on a given page.
12490 in the preamble then none of the foils will have the logo on them.
12491 If you don't want the logo on a particular page place the
12497 directly after the foilhead of that page and the
12503 directly after the next foilhead.
12506 \begin_layout Standard
12507 If you decide to use the
12511 page style setting in the
12514 \begin_inset space ~
12519 dialog you should probably add
12529 to your preamble so headers and footers on landscape pages are correctly
12530 placed when rotated.
12531 This is due to some clashes between the page layouts provided by the
12542 \begin_layout Section
12543 Hollywood (Hollywood spec scripts)
12546 \begin_layout Standard
12552 \begin_layout Subsection
12556 \begin_layout Standard
12557 Getting the format of a Hollywood script right is a
12558 \begin_inset Quotes eld
12562 \begin_inset Quotes erd
12565 It is designed to make the readers focus on content and to be easy and
12566 familiar for the actors to read.
12567 Each page of a script should be one minute of film.
12568 Nothing goes in a script that you cannot see or hear on screen.
12569 The courier 12 pt font should be used throughout.
12573 \begin_layout Subsection
12577 \begin_layout Standard
12578 Speakers' lines should NEVER break in mid-sentence.
12579 If a speaker's lines continue over a page break, repeat the
12583 title followed by (Cont'd).
12586 \begin_layout Subsection
12590 \begin_layout Standard
12595 names as labels then cross-reference the label to insert the name.
12596 The cross-reference dialog will show the current cast of characters.
12597 You can use this to insert the speaker name in narratives also.
12600 \begin_layout Subsection
12601 Paper size and Margins
12604 \begin_layout Standard
12605 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12608 \begin_layout Subsection
12612 \begin_layout Standard
12613 The following environments are available.
12614 You can use hollywood.bind to get the bind keys shown at the right.
12617 \begin_layout Itemize
12621 \begin_inset Newline newline
12626 Used where nothing else works.
12630 \begin_layout Itemize
12636 \begin_inset space \hfill{}
12644 \begin_inset Newline newline
12647 Usually followed by something like
12648 \begin_inset Quotes eld
12651 on Sally waking up.
12652 \begin_inset Quotes erd
12658 \begin_layout Itemize
12662 \begin_inset space \hfill{}
12666 \begin_inset Newline newline
12671 Introduces a new INTERIOR camera set-up.
12672 Always followed by DAY or NIGHT, or something similar to define the lighting
12674 Everthing on this line in CAPS.
12677 \begin_layout Itemize
12681 \begin_inset space \hfill{}
12685 \begin_inset Newline newline
12690 Introduces a new EXTERIOR camera set-up.
12691 Everthing on this line in CAPS.
12694 \begin_layout Itemize
12698 \begin_inset space \hfill{}
12702 \begin_inset Newline newline
12707 The character speaking.
12710 \begin_layout Itemize
12714 \begin_inset space \hfill{}
12718 \begin_inset Newline newline
12723 Instructions to the speaker.
12724 The () are automatically inserted.
12727 \begin_layout Itemize
12731 \begin_inset space \hfill{}
12735 \begin_inset Newline newline
12747 \begin_layout Itemize
12751 \begin_inset space \hfill{}
12755 \begin_inset Newline newline
12760 Camera movement instruction.
12762 \begin_inset space \thinspace{}
12766 \begin_inset space \space{}
12772 \begin_layout Itemize
12776 \begin_inset space \hfill{}
12782 \begin_layout Itemize
12786 \begin_inset space \hfill{}
12792 \begin_layout Itemize
12796 \begin_inset space \hfill{}
12802 \begin_layout Itemize
12806 \begin_inset space \hfill{}
12812 \begin_layout Subsection
12816 \begin_layout Itemize
12820 \begin_layout Itemize
12824 \begin_layout Itemize
12826 \begin_inset space \thinspace{}
12833 \begin_layout Itemize
12838 \begin_layout Itemize
12839 PAN — camera movement
12842 \begin_layout Itemize
12843 INSERT — cut to close-up of
12846 \begin_layout Section
12850 \begin_layout Standard
12853 Panayotis Papasotiriou
12856 \begin_layout Subsection
12860 \begin_layout Standard
12861 The ijmpc package is a set of macros that facilitates electronic manuscript
12864 International Journal of Modern Physics C
12867 Similarly, the ijmpd package is for creating manuscripts to be submitted
12870 International Journal of Modern Physics D
12873 Both journals are published by World Scientific.
12874 The corresponding document classes are named
12883 These files, together with instructions for the authors, can be downloaded
12885 \begin_inset Flex URL
12888 \begin_layout Plain Layout
12890 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
12896 \begin_inset Flex URL
12899 \begin_layout Plain Layout
12901 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
12907 Both packages are modified versions of the standard
12908 \begin_inset Quotes eld
12912 \begin_inset Quotes erd
12915 package, and they are almost (but not exactly) identical.
12916 Most of their features are supported by \SpecialChar LyX
12918 I have used \SpecialChar LyX
12919 successfully to write articles submitted to both journals
12920 without any problem.
12923 \begin_layout Subsection
12927 \begin_layout Standard
12928 As usual, the easiest way to write a paper is to start with a template.
12931 File\SpecialChar menuseparator
12947 This will give an (almost) empty document that includes the most common
12948 fields found in a manuscript.
12949 Simply overwrite the existing text (including the brackets,
12954 You should keep in mind the following remarks.
12957 \begin_layout Enumerate
12959 won't let you change the font size and the page style of the document,
12960 because such modifications are not allowed by both packages.
12963 \begin_layout Enumerate
12964 The language of the document should not be changed.
12965 Before previewing your paper, be sure that the babel package is not used.
12966 To do this, click on
12969 arg "dialog-show document"
12974 \SpecialChar menuseparator
12978 \begin_inset Quotes eld
12982 \begin_inset Quotes erd
12992 \begin_layout Enumerate
12994 \begin_inset Quotes eld
12998 \begin_inset Quotes erd
13001 style must be used to define keywords.
13004 \begin_layout Enumerate
13005 The ijmpc package provides a style named
13006 \begin_inset Quotes eld
13009 Classification Codes
13010 \begin_inset Quotes erd
13013 , which can be used to define classification codes, such as PACS numbers.
13014 Note that this facility is not supported by the ijmpd package.
13017 \begin_layout Enumerate
13018 Several new environments are available:
13019 \begin_inset Quotes eld
13023 \begin_inset Quotes erd
13027 \begin_inset Quotes eld
13031 \begin_inset Quotes erd
13035 \begin_inset Quotes eld
13039 \begin_inset Quotes erd
13043 \begin_inset Quotes eld
13047 \begin_inset Quotes erd
13051 \begin_inset Quotes eld
13055 \begin_inset Quotes erd
13059 \begin_inset Quotes eld
13063 \begin_inset Quotes erd
13067 \begin_inset Quotes eld
13071 \begin_inset Quotes erd
13075 \begin_inset Quotes eld
13079 \begin_inset Quotes erd
13083 \begin_inset Quotes eld
13087 \begin_inset Quotes erd
13091 \begin_inset Quotes eld
13095 \begin_inset Quotes erd
13099 \begin_inset Quotes eld
13103 \begin_inset Quotes erd
13107 \begin_inset Quotes eld
13111 \begin_inset Quotes erd
13115 \begin_inset Quotes eld
13119 \begin_inset Quotes erd
13123 \begin_inset Quotes eld
13127 \begin_inset Quotes erd
13131 Their use is more or less obvious.
13133 supports all these environments; it will use the proper label, text style,
13134 and numbering scheme for each of them.
13137 \begin_layout Enumerate
13138 Both packages use basic citations; the natbib package should not be used.
13139 In \SpecialChar LyX
13140 , citation references are shown as usual; in the output, citations are
13141 shown as superscripts.
13142 If you want to use a citation as normal text, you should use the
13147 \begin_inset space \thinspace{}
13151 \begin_inset space \space{}
13155 \begin_inset Quotes eld
13159 \begin_inset space \space{}
13169 \begin_inset Quotes erd
13175 \begin_layout Enumerate
13177 \begin_inset Quotes eld
13181 \begin_inset Quotes erd
13184 section in both packages.
13185 To put acknowledgments, just use the
13186 \begin_inset Quotes eld
13190 \begin_inset Quotes erd
13196 \begin_layout Enumerate
13197 Appendices may be added to the paper,
13201 the Acknowledgments and
13207 provides a special environment, called
13208 \begin_inset Quotes eld
13212 \begin_inset Quotes erd
13215 which marks the beginning of the appendices.
13216 This environment should be left blank; it just sends a \SpecialChar LaTeX
13217 command, but nothing
13219 In \SpecialChar LyX
13221 \begin_inset Quotes eld
13225 \begin_inset Quotes erd
13228 is printed with blue letters, as a signal that all sections after that
13229 point are appendices.
13230 To write an appendix, use the
13231 \begin_inset Quotes eld
13235 \begin_inset Quotes erd
13240 will number each appendix with capital letters, as required by both journals.
13242 \begin_inset Quotes eld
13246 \begin_inset Quotes erd
13253 be present before the first appendix; if not, all appendices will be numbered
13254 as normal sections in the output.
13257 \begin_layout Enumerate
13258 The ijmpc and the ijmpd packages use the
13262 command to implement table captions.
13263 As a result, a table created by \SpecialChar LyX
13264 is printed correctly, but its caption
13266 However, you can use some \SpecialChar TeX
13267 code to overcome this problem, so that captions
13268 are printed as expected.
13269 To do so, create a float table as usual, remove the caption, and replace
13270 it with the \SpecialChar TeX
13281 (sic); you must also the \SpecialChar TeX
13286 immediately after the tabular material.
13287 Study the example table included in the template files to see how this
13288 trick is implemented.
13289 Alternatively, If you need table captions, you should implement the whole
13294 file, then include this file to the \SpecialChar LyX
13297 Insert\SpecialChar menuseparator
13298 File\SpecialChar menuseparator
13300 \begin_inset space ~
13306 Details on how to create a table float can be found in the files
13314 , included in the corresponding packages.
13317 \begin_layout Subsection
13318 Preparing a paper for submission
13321 \begin_layout Standard
13322 Before you submit your paper you must export the \SpecialChar LyX
13323 document as a \SpecialChar LaTeX
13326 File\SpecialChar menuseparator
13327 Export\SpecialChar menuseparator
13335 \begin_layout Plain Layout
13336 Actually you have the choice between \SpecialChar LaTeX
13337 (plain) and pdflatex.
13338 If you intend to use pdflatex to prepare the paper, you should use the
13339 pdflatex option so that included graphics are converted to PDF format,
13340 ready for use by pdflatex.
13345 , then make the following changes to the resulting
13352 \begin_layout Enumerate
13353 Remove the comment lines before the
13362 \begin_layout Enumerate
13363 Remove everything between (and including) the
13375 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13379 \begin_layout Standard
13384 file should be saved and processed through \SpecialChar LaTeX
13385 as many times as necessary.
13386 You may also want to check the resulting
13393 \begin_layout Section
13397 \begin_layout Standard
13403 \begin_layout Subsection
13407 \begin_layout Standard
13408 The iopart package provides a document class to create electronic manuscript
13409 submission to the journals published by the Institute of Physics.
13410 Instructions for the authors how to create a paper using the iopart class
13411 can be downloaded together with the iopart package from the site
13412 \begin_inset Flex URL
13415 \begin_layout Plain Layout
13417 ftp://ftp.iop.org/pub/journals/latex2e
13425 \begin_layout Subsection
13429 \begin_layout Standard
13430 The easiest way to write a paper is to start with the template
13434 that is available via
13436 File\SpecialChar menuseparator
13439 The template explains how to use the special text environments.
13440 Here are the most important advices:
13443 \begin_layout Itemize
13444 To be able to compile your document to a PDF, PS, or DVI, ensure that the
13445 no AMS packages are loaded in
13447 Document\SpecialChar menuseparator
13448 Settings\SpecialChar menuseparator
13454 \begin_layout Itemize
13457 The title environment defines the kind of your paper.
13458 So use one of the following environments for the title:
13462 \begin_layout Itemize
13471 \begin_layout Itemize
13480 \begin_layout Itemize
13486 for a Topical review
13489 \begin_layout Itemize
13498 \begin_layout Itemize
13507 \begin_layout Itemize
13513 for a Paper (same as Title)
13516 \begin_layout Itemize
13522 for a Preliminary communication
13525 \begin_layout Itemize
13531 for a Rapid communication
13534 \begin_layout Itemize
13540 for a Letter to the editor
13544 \begin_layout Itemize
13547 All title environments except of
13551 can have an optional short title.
13554 \begin_layout Itemize
13555 There is a general title environment
13559 which is not directly supported by \SpecialChar LyX
13561 This can be used as \SpecialChar TeX
13562 code when your document doesn't fit into one of the
13566 \begin_layout Standard
13567 For more informations like hints for special table and formula formatting,
13568 look at the IOP author guidelines.
13571 \begin_layout Section
13575 \begin_layout Standard
13578 Panayotis Papasotiriou
13581 \begin_layout Subsection
13585 \begin_layout Standard
13586 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
13587 that facilitates electronic manuscript submission to the journals they
13589 Most known of them (at least in my domain of interest) are
13591 Astrophysics and Space Science
13597 , but there are many others (see a complete list at
13598 \begin_inset Flex URL
13601 \begin_layout Plain Layout
13603 http://www.wkap.nl/jrnllist.htm/JRNLHOME
13609 The Kluwer package may be downloaded from the site
13610 \begin_inset Flex URL
13613 \begin_layout Plain Layout
13615 http://www.wkap.nl/kaphtml.htm/STYLEFILES
13621 A complete user guide is contained in that package (but it can also be
13622 downloaded separately).
13625 \begin_layout Standard
13627 supports many features of the package but not everything.
13628 However, the \SpecialChar TeX
13629 code needed is reduced to some
13630 \begin_inset Quotes eld
13634 \begin_inset Quotes erd
13637 commands of the package (see
13638 \begin_inset space ~
13642 \begin_inset CommandInset ref
13644 reference "subsec:kluwer_peculiarities"
13649 I have recently used \SpecialChar LyX
13650 to write an article submitted to the
13652 Astrophysics and Space Science
13654 without any problem.
13657 \begin_layout Subsection
13661 \begin_layout Standard
13662 The easiest way to write a paper is to start with the Kluwer template file.
13665 File\SpecialChar menuseparator
13677 This will give an (almost) empty document that includes the most common
13678 fields found in a manuscript and a short description of their use.
13679 As in most templates, simply overwrite the existing text (including the
13684 ) with the correct information.
13687 \begin_layout Subsection
13688 Preparing a paper for submission
13691 \begin_layout Standard
13692 As in the AAS\SpecialChar TeX
13693 package, before you submit your paper to a journal you must
13695 \begin_inset Quotes eld
13699 \begin_inset Quotes erd
13705 \begin_layout Enumerate
13706 Export your paper as a \SpecialChar LaTeX
13708 To do this, click on
13710 File\SpecialChar menuseparator
13711 Export\SpecialChar menuseparator
13719 \begin_layout Enumerate
13724 file with a text editor and make the following changes
13728 \begin_layout Enumerate
13729 remove the comment lines before the
13738 \begin_layout Enumerate
13739 remove everything between (and including) the
13751 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13755 \begin_layout Standard
13764 \begin_layout Enumerate
13769 file through \SpecialChar LaTeX
13770 as many times as necessary (usually up to three).
13773 \begin_layout Enumerate
13779 \begin_inset space \thinspace{}
13783 \begin_inset space \space{}
13790 , and check if everything is OK (it should, if you didn't make any mistake).
13793 \begin_layout Subsection
13794 \begin_inset Quotes eld
13798 \begin_inset Quotes erd
13801 of the Kluwer package
13802 \begin_inset CommandInset label
13804 name "subsec:kluwer_peculiarities"
13811 \begin_layout Standard
13812 The Kluwer package has the following
13813 \begin_inset Quotes eld
13817 \begin_inset Quotes erd
13823 \begin_layout Enumerate
13824 It is possible to write multiple articles in the same \SpecialChar LaTeX
13829 \begin_layout Plain Layout
13830 I can't imagine any good reason to do this.
13836 Each article must be included in the environment
13837 \begin_inset Quotes eld
13841 \begin_inset Quotes erd
13845 Unfortunately, this environment cannot be omitted, even if you write just
13847 Therefore, each article starts with the command
13853 and, obviously, ends with the command
13860 Although this can be implemented in \SpecialChar LyX
13861 , I didn't included it, since it looks
13862 ugly and can confuse the novice user.
13863 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
13866 \begin_inset Quotes eld
13871 \begin_inset Quotes erd
13877 \begin_layout Enumerate
13878 Information given at the beginning of the article (i.
13879 \begin_inset space \thinspace{}
13883 \begin_inset space \space{}
13886 title, subtitle, author, institution, running title, running author, abstract
13887 and keywords) must be included in an environment called
13888 \begin_inset Quotes eld
13892 \begin_inset Quotes erd
13896 This is not implemented in \SpecialChar LyX
13897 , so you must enter title, subtitle etc.
13898 \begin_inset space ~
13901 between two \SpecialChar TeX
13917 \begin_layout Enumerate
13918 According to the user manual, the label of each bibliography item must be
13942 \begin_layout Standard
13947 template takes care of all these
13948 \begin_inset Quotes eld
13952 \begin_inset Quotes erd
13956 If you start a new paper using this template you don't need to do anything
13961 \begin_layout Enumerate
13962 don't delete the \SpecialChar TeX
13963 code included in the template, and
13966 \begin_layout Enumerate
13967 copy the example bibliography item included in the template and modify it
13968 as necessary to enter new bibliography items.
13971 \begin_layout Section
13975 \begin_layout Standard
13981 \begin_layout Subsection
13985 \begin_layout Standard
13986 The \SpecialChar LyX
13989 article (koma-script)
13993 report (koma-script)
14011 correspond to the \SpecialChar LaTeX
14029 \begin_inset space ~
14032 of the Koma-Script family.
14033 They are replacements for the standard document classes
14049 , resp., and fit better to European typography conventions in a number of
14053 \begin_layout Itemize
14054 Standard character size is 11pt in
14056 article (koma-script)
14060 report (koma-script)
14068 letter (koma-script)
14073 \begin_layout Itemize
14074 Headings, labels of the description environment, and a number of elements
14077 letter (koma-script)
14079 document class are set in a bold sans serif font.
14083 \begin_layout Plain Layout
14084 There is a big difference between the bold sans serif old cm fonts and new
14085 ec fonts, especially in the appearance of headings.
14086 In comparison, the ec bold sans serif fonts look a bit thin.
14087 Here the \SpecialChar LaTeX
14096 helps to produce the
14097 \begin_inset Quotes eld
14101 \begin_inset Quotes erd
14104 appearance when using the ec fonts.
14109 The numbering of chapter headings is made in the same way as the numbering
14110 of section headings, that is without the extra line
14111 \begin_inset Quotes eld
14114 Chapter\SpecialChar ldots
14116 \begin_inset Quotes erd
14120 In addition, the appearance of the headings can be modified by using a
14121 number of options (in \SpecialChar LyX
14122 to be entered in the field
14125 \begin_inset space ~
14132 Layout\SpecialChar menuseparator
14139 \begin_layout Itemize
14140 The main means in the Koma-Script document classes to design the type area
14149 (in \SpecialChar LyX
14150 to be entered in the extra class options field in the dialog
14152 Document\SpecialChar menuseparator
14156 They make a clearer modification of page margins possible as do the options
14159 Document\SpecialChar menuseparator
14166 \begin_layout Itemize
14167 The \SpecialChar LaTeX
14168 document classes of the Koma-Script family define a number of additional
14170 Those part of it which makes sense in \SpecialChar LyX
14171 is implemented in corresponding
14175 \begin_layout Standard
14176 Detailed descriptions of the \SpecialChar LaTeX
14177 document classes of the Koma-Script family
14178 can be found in the Koma-Script documentation
14189 \begin_layout Subsection
14190 article (koma-script), report (koma-script), and book (koma-script)
14193 \begin_layout Standard
14194 The document classes
14196 article (koma-script)
14200 report (koma-script)
14210 are implemented in the layout files
14223 They contain all the paragraph types of the corresponding standard document
14236 , resp., partly modified, with the exception of the \SpecialChar LyX
14241 -type, which is replaced by the new
14245 -type having the same functionality.
14250 -Type there is a number of new paragraph types added.
14257 letter (koma-script)
14262 \begin_layout Itemize
14271 : are equivalents to
14279 , resp., additionally inserting an entry in the table of contents.
14288 are not contained in
14290 article (koma-script)
14295 \begin_layout Itemize
14304 : behave exactly as
14312 , resp., additionally clearing running heads.
14317 is not contained in
14319 article (koma-script)
14325 \begin_layout Plain Layout
14338 report (koma-script)
14340 , but since this is identical to
14344 , is has not been implemented in \SpecialChar LyX
14353 \begin_layout Itemize
14358 : generates a heading directly above the following paragraph in the standard
14359 character size without affecting the structure of the document.
14362 \begin_layout Itemize
14371 are special captions which respect the different space settings needed
14372 for captions placed above or below an element (if you follow strict typographic
14373 rules, you might want to place table captions always above the table).
14374 You can also use the class option
14378 , which will switch
14391 You need at least Koma-Script version 2.8q to use this.
14394 \begin_layout Itemize
14399 : can be used to set a bonmot, e.
14400 \begin_inset space \thinspace{}
14404 \begin_inset space \space{}
14407 at the beginning of a chapter.
14408 If you use the optional argument (
14410 Insert\SpecialChar menuseparator
14412 \begin_inset space ~
14417 ), you can insert the dictum's author there.
14418 Dictum and author are separated by a line.
14419 You need at least Koma-Script version 2.8q to use this.
14424 is not contained in
14426 article (koma-script)
14431 \begin_layout Standard
14432 The following types, together with the standard types
14444 , form the title area of the document.
14445 They must be entered ahead of the first
14446 \begin_inset Quotes eld
14450 \begin_inset Quotes erd
14457 \begin_layout Plain Layout
14458 The corresponding \SpecialChar LaTeX
14459 commands must appear before the
14470 When such a type is used more than once, the latter usage overwrites the
14471 former one, that means, for every type only the latest usage is valid.
14472 The order of the different types however has, like
14484 , no effect on the appearance of the produced document.
14487 \begin_layout Itemize
14492 : produces a centered paragraph above the ordinary title (
14504 ) for the subject of the document.
14507 \begin_layout Itemize
14512 : produces a centered paragraph below the ordinary title (
14524 ) for the publishers' name.
14527 \begin_layout Itemize
14534 report (koma-script)
14540 produces a centered paragraph on its own page behind the title page, or
14543 article (koma-script)
14545 produces a centered paragraph below the ordinary title (
14561 ) for a dedication.
14564 \begin_layout Itemize
14569 : produces a left aligned paragraph above the ordinary title (
14585 ) for a document`s head.
14588 \begin_layout Itemize
14593 : produces in a double-sided print in
14595 report (koma-script)
14601 a left-aligned paragraph at the top of the title page`s back or has no
14602 effect in a single-sided print or in
14604 article (koma-script)
14609 \begin_layout Itemize
14614 : produces in a double-sided print in
14616 report (koma-script)
14622 a left-aligned paragraph at the bottom of the title page`s back or has
14623 no effect in a single-sided print or in
14625 article (koma-script)
14630 \begin_layout Itemize
14635 : produces a special
14636 \begin_inset Quotes eld
14640 \begin_inset Quotes erd
14643 page ahead of the actual document containing a paragraph without special
14647 \begin_layout Standard
14648 The layout files for the document classes
14650 article (koma-script)
14654 report (koma-script)
14660 do include the file
14665 This is thought of as a place to define your own types.
14670 in your personal layout directory and edit the file!
14673 \begin_layout Subsection
14674 letter (koma-script)
14677 \begin_layout Description
14678 Note: This section discusses the obsolete
14680 KOMA-Script-Letter (v.
14681 \begin_inset space ~
14686 , which is not even included anymore in recent KOMA releases.
14687 Please refer to the next section for the current KOMA-Script-Letter class
14689 \begin_inset space ~
14695 \begin_layout Standard
14699 letter (koma-script)
14701 is implemented in the layout file
14706 It contains all the paragraph types of the corresponding standard document
14711 , partly modified, with the exception of the \SpecialChar LyX
14725 type, which is replaced by the new
14730 In addition, it contains, in contrast to the standard document class, the
14749 Furthermore, there are a number of new letter specific types.
14752 \begin_layout Standard
14753 The appearance of the letter produced by this document class can be controlled
14754 by a number of \SpecialChar LaTeX
14755 commands, which you can put in the \SpecialChar LaTeX
14760 \begin_layout Plain Layout
14761 For example, the standard appearance of the letter`s heading, consisting
14762 of name and address, is quite self-willed.
14764 \begin_inset Quotes eld
14768 \begin_inset Quotes erd
14771 heading is produced by the following \SpecialChar LaTeX
14772 commands in the preamble:
14775 \begin_layout LyX-Code
14785 \begin_layout LyX-Code
14801 \begin_layout LyX-Code
14811 \begin_layout LyX-Code
14831 A detailed German description of such \SpecialChar LaTeX
14832 commands can be found in the Koma-Script
14838 With it, the letter's author can produce his personal letter layout.
14841 \begin_layout Standard
14850 define the beginning of the letter and must be used in every letter.
14851 To emphasize them in the \SpecialChar LyX
14852 document class, they are marked with the letter
14862 \begin_inset space ~
14865 in the left margin.
14866 It is possible to write any number of letters in one file.
14871 type produces a new letter using the same addressee and a
14875 type produces a new addressee.
14892 are ordinary paragraph types and can also be used several times in one
14893 and the same letter.
14896 \begin_layout Itemize
14901 : produces a paragraph for the addressee and implicitly defines the beginning
14905 \begin_layout Itemize
14910 : produces a paragraph for the form of address and implicitly produces a
14914 \begin_layout Itemize
14919 : produces a paragraph for a close.
14922 \begin_layout Itemize
14927 : produces a paragraph for a postscript.
14930 \begin_layout Itemize
14935 : produces a paragraph for a distribution list.
14938 \begin_layout Itemize
14943 : produces a paragraph for enclosures.
14946 \begin_layout Standard
14987 are input types provided with a label to enter information, which will
14988 be processed by the document class.
14992 \begin_layout Plain Layout
14993 It could be seen as a matter of inconsequence, that the types
15001 described above are not such input types as well.
15002 Because of the special meaning of those types, however, I have implemented
15003 them as ordinary paragraph types with a one letter mark in the left margin.
15004 Moreover, it would affect my feeling of symmetry, if the
15012 type had such a serious different appearance.
15017 The types must be used ahead of the corresponding
15024 \begin_layout Standard
15025 An implementation of these types in a WYSIWYG fashion does not seem to make
15026 sense, because the real appearance of the produced letter does not only
15027 depend on the usage of the particular type, but also on other factors.
15028 For example, a signature entered in the
15032 type will in the standard behavior appear in the produced letter only,
15033 when in the same letter also a
15038 The entered value of the
15042 type will in the standard behavior not appear in the produced letter at
15044 The possibility to design the letter`s heading freely is already indicated
15045 in a footnote above.
15048 \begin_layout Standard
15049 The input types can also be used as empty paragraphs.
15050 This makes sense e.
15051 \begin_inset space \thinspace{}
15055 \begin_inset space \space{}
15067 type is not used at all, in the standard behavior the value of the
15071 type is used as signature, whereas if an empty
15075 type is used, no signature value is defined.
15078 \begin_layout Standard
15079 By using the input types it is possible to write a letter template, containing
15080 filled input types with your personal dates (name, address, etc.) and empty
15081 input types for other dates you want to enter.
15084 \begin_layout Itemize
15089 : sender's name, in the standard behavior appears as a centered paragraph
15090 in small caps in the letter`s heading.
15093 \begin_layout Itemize
15098 : sender's signature, in the standard behavior appears below the
15107 type is used, the value of the
15111 type appears instead.
15114 \begin_layout Itemize
15119 : sender's address, in the standard behavior appears in a centered paragraph
15120 in the letter`s heading below the sender's name.
15123 \begin_layout Itemize
15128 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
15139 \begin_layout Itemize
15144 : place of the letter`s making.
15147 \begin_layout Itemize
15152 : date of the letter`s making.
15161 , in the standard behavior, produce the place and the date in a right-aligned
15162 line below the addressee's field.
15167 type is used, neither place nor date appear, independent of the value of
15177 type is used, the date of the letter `s production is used.
15180 \begin_layout Itemize
15185 : sender`s back address, in the standard behavior appears above the addressee's
15186 field in a small sans serif font.
15189 \begin_layout Itemize
15194 : special mail information, in the standard behavior appears underlined
15195 above the addressee's field below the back address.
15198 \begin_layout Itemize
15203 : additional information, in the standard behavior appears on right side
15204 below the addressee`s field.
15207 \begin_layout Itemize
15212 : the letter's title, in the standard behavior appears in a big, bold, sans
15213 serif font above the subject.
15216 \begin_layout Itemize
15221 : the letter's subject, in the standard behavior appears in a bold font
15229 \begin_layout Standard
15250 produce a business letter like line above the
15254 line containing the fields
15255 \begin_inset Quotes eld
15259 \begin_inset Quotes erd
15263 \begin_inset Quotes eld
15267 \begin_inset Quotes erd
15271 \begin_inset Quotes eld
15275 \begin_inset Quotes erd
15279 \begin_inset Quotes eld
15283 \begin_inset Quotes erd
15287 \begin_inset Quotes eld
15291 \begin_inset Quotes erd
15295 \begin_inset Quotes eld
15299 \begin_inset Quotes erd
15303 For the date field, the value of the
15309 \begin_inset Quotes eld
15312 business letter types
15313 \begin_inset Quotes erd
15316 is used, the value of the
15320 type however does not appear, but only the \SpecialChar LaTeX
15328 The ordinary output of place and date in a right-aligned line below the
15329 addressee`s field is suppressed.
15330 The types are implemented as input types provided with a label and must
15331 be used ahead of the corresponding
15338 \begin_layout Itemize
15346 \begin_layout Itemize
15354 \begin_layout Itemize
15362 \begin_layout Itemize
15370 \begin_layout Itemize
15378 \begin_layout Subsection
15379 The new letter class: letter (koma-script v.2)
15382 \begin_layout Standard
15388 \begin_layout Standard
15389 \begin_inset VSpace medskip
15395 \begin_layout Standard
15397 Koma-Script version 2.8 has introduced a new letter class
15401 which supersedes the now unsupported
15406 It has — on the \SpecialChar LaTeX
15407 side — a completely new interface and is not compatible
15408 with the old class.
15409 Therefore, \SpecialChar LyX
15410 supports both, though it is recommended you use the new class.
15413 \begin_layout Standard
15414 This class covers the same functionality as
15416 letter (koma-script),
15419 The basic items are
15423 (receiver's address, same as
15427 in the old layout),
15440 will start a new letter (i.
15441 \begin_inset space \thinspace{}
15445 \begin_inset space \space{}
15448 you can write several letters per document).
15449 New elements are sender's
15465 and the possibility to use a
15471 Insert\SpecialChar menuseparator
15477 \begin_layout Standard
15478 The biggest improvement is, though, that the letter's layout is configurable
15479 to meet almost any needs.
15480 This can be done via the preamble or with a special style file (Letter
15481 Class Option, extension
15485 ), that will be read in as a class option.
15489 \begin_layout Plain Layout
15490 The KOMA package comes with some default
15495 There is, for instance, a
15499 file that follows german typesetting rules, or a
15503 that provides the default layout of the old
15508 The latter can be loaded with the class option
15514 Layout\SpecialChar menuseparator
15515 Document\SpecialChar menuseparator
15527 template that is included in \SpecialChar LyX
15529 A detailed description is to be found in the Koma-Script documentation
15537 \begin_layout Subsection
15541 \begin_layout Standard
15542 Visualizing the Koma-Script document classes in \SpecialChar LyX
15543 , the \SpecialChar LyX
15544 internals cause some
15548 \begin_layout Itemize
15549 The chapter number of a
15553 type appears on a line of its own above the chapter heading instead of
15554 appearing in the same line ahead of it.
15555 The cause for that is the \SpecialChar LyX
15556 internal behavior for the labeltype
15560 in the layout file.
15563 \begin_layout Itemize
15564 The headings of the types
15572 are only put in the
15573 \begin_inset Quotes eld
15577 \begin_inset Quotes erd
15581 table of contents, but not in the \SpecialChar LyX
15582 table of contents (
15584 Document\SpecialChar menuseparator
15586 \begin_inset space ~
15590 \begin_inset space ~
15598 \begin_layout Itemize
15599 The paragraphs in a
15603 document class appear in a skip separation mode, not indented.
15604 This is the standard behavior, no special \SpecialChar LaTeX
15605 commands are needed for that.
15608 Document\SpecialChar menuseparator
15611 dialog the corresponding radio button indicates
15620 value always has the effect that extra \SpecialChar LaTeX
15621 commands are inserted in the document
15622 to produce the gap, which is not what is wanted in this case.
15625 \begin_layout Section
15629 \begin_layout Standard
15635 \begin_layout Subsection
15639 \begin_layout Standard
15640 Memoir is a very powerful and constantly evolving class.
15641 It has been designed with regard to fictional and non-fictional literature.
15642 Its aim is to let the user have maximum control over the typesetting of
15644 Memoir is based on the standard book class, but it can also emulate the
15645 article class (see below).
15648 \begin_layout Standard
15649 Peter Wilson, the developer of Memoir, is known as the author of lots of
15650 useful packages in the \SpecialChar LaTeX
15652 Most of them have been merged with Memoir.
15653 Therefore, it is much easier to layout the table of contents, appendices,
15654 chapter designs and such.
15656 , though, does not support all of these goodies natively.
15657 Some of them might be added to forthcoming releases
15661 \begin_layout Plain Layout
15662 You are invited to send suggestions to
15663 \begin_inset Flex URL
15666 \begin_layout Plain Layout
15668 lyx-devel@lists.lyx.org
15678 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
15680 Of course you can still use all features with the help of some native \SpecialChar LaTeX
15682 commands (\SpecialChar TeX
15687 \begin_layout Plain Layout
15692 \begin_layout Plain Layout
15702 \begin_inset space ~
15706 \begin_inset CommandInset ref
15708 reference "sec:Inserting-TeX-Code"
15718 In this section, we can only list those features that are natively supported
15719 by \SpecialChar LyX
15721 For detailed descriptions (and for the rest of features) we recommend you
15722 have a look at the detailed manual of the Memoir class
15726 \begin_layout Plain Layout
15731 \begin_layout Plain Layout
15741 \begin_inset Flex URL
15744 \begin_layout Plain Layout
15746 CTAN:/macros/latex/memoir/memman.pdf
15756 , which is not only a user guide for the class, but also both a comprehensive
15757 description on good typesetting and a superb example for good typesetting
15761 \begin_layout Subsection
15762 Basic features and restrictions
15765 \begin_layout Standard
15766 Memoir supports basically all features of the standard book classes.
15767 There are, however, some differences, as follows:
15770 \begin_layout Description
15772 \begin_inset space ~
15775 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
15778 \begin_layout Description
15780 \begin_inset space ~
15783 style: The fancy page style is not supported, due to a command clash between
15784 Memoir and the fancyhdr package (they both define a command with the same
15785 name, which confuses \SpecialChar LaTeX
15787 Instead, Memoir comes with a number of its own page styles (see
15789 Document\SpecialChar menuseparator
15790 Settings\SpecialChar menuseparator
15792 \begin_inset space ~
15798 If you want to use these for the chapter pages, you have to use the command
15805 in the main text or in preamble (e.
15806 \begin_inset space \thinspace{}
15810 \begin_inset space \space{}
15817 chapterstyle{companion}
15822 \begin_layout Description
15823 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
15824 optional argument in the standard classes.
15825 With this, you can specify an alternative version of the title for the
15826 table of contents and the headers (for instance, if the title is too long).
15827 In \SpecialChar LyX
15828 , you can do this via
15830 Insert\SpecialChar menuseparator
15832 \begin_inset space ~
15837 at the beginning of a chapter/section.
15838 Memoir features a second optional argument and thus separates the table
15839 of contents from the header.
15840 You can define three variants of a title with this: one for the main text,
15841 one for the table of contents, and one for the headers.
15843 makes these available in form of specific
15854 \begin_layout Description
15855 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
15856 of contents, the list of figures and the list of table start a new page
15858 Memoir does not follow this route.
15859 You have to insert a page break yourself, if you want to have one.
15862 \begin_layout Description
15863 Titlepage: For some unknown reason, Memoir uses pagination on the title
15864 page (in the standard classes, title pages are
15865 \begin_inset Quotes eld
15869 \begin_inset Quotes erd
15873 If you want an empty title page, type
15877 aliaspagestyle{title}{empty}
15882 \begin_layout Description
15883 Article: With the class option
15889 Document\SpecialChar menuseparator
15890 Settings\SpecialChar menuseparator
15891 Class Settings\SpecialChar menuseparator
15893 \begin_inset space ~
15898 ), you can emulate article style.
15899 That is, counters (footnotes, figures, tables etc.) will not be reset on
15900 new chapters, chapters don't start a new page (but are—in contrary to
15901 \begin_inset Quotes eld
15905 \begin_inset Quotes erd
15908 article classes—still allowed), parts, though, use their own page, as in
15912 \begin_layout Description
15913 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
15914 font commands, which have been used in the old \SpecialChar LaTeX
15916 \begin_inset space \thinspace{}
15920 \begin_inset space \space{}
15936 It produces an error and stops \SpecialChar LaTeX
15937 whenever such a command appears.
15942 reallows the commands and spits out warnings instead (which does at least
15943 not stop \SpecialChar LaTeX
15945 Since a lot of packages and particularly Bib\SpecialChar TeX
15946 style files are still using
15947 those commands, we have decided to use this option by default.
15950 \begin_layout Subsection
15954 \begin_layout Standard
15955 We will only describe the features supported by \SpecialChar LyX
15956 (which is not much currently).
15957 Please consult the Memoir manual
15961 \begin_layout Plain Layout
15966 \begin_layout Plain Layout
15976 \begin_inset Flex URL
15979 \begin_layout Plain Layout
15981 CTAN:/macros/latex/memoir/memman.pdf
15994 \begin_layout Description
15995 Abstract: You may wonder why an abstract is an extra feature.
15996 Well, it is in book class.
15997 Usually books don't have abstracts.
15998 Memoir, however, has.
15999 You can use it wherever and how often you like.
16002 \begin_layout Description
16003 Chapterprecis: You may know this older typesetting style: The contents of
16004 a chapter are summarized below the title and also in the table of contents
16006 \begin_inset space \thinspace{}
16010 \begin_inset space \space{}
16015 Our hero arrives in Troia; he loses some friends; he finds others
16018 Chapterprecis does exactly this.
16019 It is therefore only sensible below a chapter.
16022 \begin_layout Description
16023 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
16024 The epigraph environment provides an elegant way of typesetting such a
16026 The motto itself (text) and its (optional) author (source) are divided
16028 The author (source) can be inserted via
16030 Insert\SpecialChar menuseparator
16037 \begin_layout Description
16038 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
16039 complex figurative poems).
16041 can only support a few of them.
16042 One is poemtitle, which is a centered title for poems, which will also
16043 be added to the table of contents (verse is the standard environment for
16045 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
16047 because they have to be nested inside regular verse environments, which
16048 is not possible with \SpecialChar LyX
16052 \begin_layout Description
16053 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
16056 \begin_layout Section
16057 Article (mwart), book (mwbk) and report (mwrep)
16058 \begin_inset Argument status
16061 \begin_layout Plain Layout
16074 \begin_layout Standard
16080 \begin_layout Standard
16081 The \SpecialChar LyX
16098 correspond to the \SpecialChar LaTeX
16112 They are replacements for the standard document classes
16124 , resp., and fit better to Polish typography conventions in a number of points.
16128 \begin_layout Standard
16132 \begin_layout Itemize
16133 Unnumbered titles (with star, e.
16134 \begin_inset space \thinspace{}
16138 \begin_inset space \space{}
16145 ) are added into table of contents,
16148 \begin_layout Itemize
16149 Additional page styles:
16153 \begin_layout Description
16154 uheadings header with separated lines,
16157 \begin_layout Description
16158 myheadings custom header, contents headers via commands:
16173 \begin_layout Description
16174 myuheadings custom header with separated lines,
16177 \begin_layout Description
16178 outer page number is placed on outer side of page
16182 \begin_layout Itemize
16187 \begin_layout Description
16188 rmheadings serif titles — default,
16191 \begin_layout Description
16192 sfheadings sansserif titles,
16195 \begin_layout Description
16196 authortitle on title page first placed is author next title — default,
16199 \begin_layout Description
16200 titleauthor on title page first placed is title next author,
16203 \begin_layout Description
16204 withmarginpar reserve place on page for margins.
16208 \begin_layout Section
16212 \begin_layout Standard
16217 provides an alternative to the standard
16222 It provides similar functionality, but you might prefer this layout with
16223 sans serif sections, headings, and more.
16226 \begin_layout Section
16227 Rev\SpecialChar TeX
16231 \begin_layout Standard
16237 \begin_layout Standard
16238 \begin_inset VSpace bigskip
16244 \begin_layout Standard
16249 \begin_inset space ~
16254 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
16256 \begin_inset Formula $\beta$
16259 release of May, 1999) class.
16262 \begin_layout Standard
16268 textclass, which works with Rev\SpecialChar TeX
16270 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
16272 That means that it doesn't interact very well with \SpecialChar LyX
16273 , which requires \SpecialChar LaTeX2e
16275 it has been kludged to work.
16276 Since Rev\SpecialChar TeX
16277 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
16282 Rev\SpecialChar TeX
16284 \begin_inset space ~
16289 textclass should also be pretty easy to use.
16292 \begin_layout Standard
16293 These documents are supposed to be used in
16297 to the Rev\SpecialChar TeX
16298 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
16300 and assume you'll know what to put in the preamble if necessary.
16303 \begin_layout Subsection
16307 \begin_layout Standard
16308 All you need to do is install Rev\SpecialChar TeX
16309 4, as described in the package's README
16311 The package can be found at The Rev\SpecialChar TeX
16313 \begin_inset Flex URL
16316 \begin_layout Plain Layout
16318 http://publish.aps.org/revtex4/
16324 Install it somewhere that \SpecialChar LaTeX
16326 Test it by trying to \SpecialChar LaTeX
16327 a short Rev\SpecialChar TeX
16328 4 document in some random directory (i.
16329 \begin_inset space \thinspace{}
16333 \begin_inset space \space{}
16336 not the directory where you installed the class file.) Then, if you reconfigure
16338 , it will find the class file and let you use the Rev\SpecialChar TeX
16342 \begin_layout Standard
16343 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
16352 \begin_inset space ~
16357 template, found in the templates directory.
16360 \begin_layout Subsection
16364 \begin_layout Standard
16365 Optional arguments to
16372 \begin_inset Quotes eld
16376 \begin_inset Quotes erd
16380 \begin_inset Quotes eld
16384 \begin_inset Quotes erd
16390 \begin_inset space ~
16398 \begin_inset space ~
16404 Remember that in Rev\SpecialChar TeX
16405 , at least one optional argument is required!
16408 \begin_layout Standard
16409 Other preamble matter, like
16416 \begin_inset space ~
16423 \begin_inset space ~
16428 dialog, also as usual.
16431 \begin_layout Subsection
16435 \begin_layout Standard
16436 The layouts basically correspond to the commands in Rev\SpecialChar TeX
16438 For example, the Email layout corresponds to
16445 Note that (at least as of Rev\SpecialChar TeX
16454 layouts are exactly equivalent, so you shouldn't need to use both.
16458 \begin_layout Plain Layout
16459 In case you're curious, both were included so that
16463 would be able to translate both
16483 \begin_layout Subsection
16487 \begin_layout Standard
16488 There are a couple of important unique aspects of Rev\SpecialChar TeX
16489 4 which might cause
16490 bugs that will be even more confusing in \SpecialChar LyX
16494 \begin_layout Standard
16495 In Rev\SpecialChar TeX
16513 The \SpecialChar LyX
16514 equivalent is that there is a separate Thanks layout.
16519 write footnotes in the
16523 layout, or weird things may happen.
16524 See the Rev\SpecialChar TeX
16525 4 documentation for more details.
16528 \begin_layout Standard
16532 \begin_inset space ~
16540 \begin_inset space ~
16549 layouts must be placed
16557 layout and the corresponding
16574 , the \SpecialChar LaTeX
16578 \begin_layout Section
16579 Springer Journals (
16586 \begin_layout Standard
16592 \begin_layout Subsection
16596 \begin_layout Standard
16597 These are the layout files for some of the journal formats used by Springer
16598 Verlag and listed on
16599 \begin_inset Flex URL
16602 \begin_layout Plain Layout
16604 http://www.springer.de/author/tex/help-journals.html
16609 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
16611 It is a modular system: the things common to all journals are implemented
16616 , which journal-specific layout files (such as, e.
16617 \begin_inset space \thinspace{}
16621 \begin_inset space \space{}
16628 for Journal of Geodesy) can include.
16631 \begin_layout Standard
16632 This means that implementing support for any other Springer journal on this
16633 list is as simple as writing your own
16641 file following the outline given in
16649 \begin_layout Standard
16650 It is reasonably well tested only for the Journal of Geodesy.
16659 come with the standard \SpecialChar LyX
16661 Install the relevant class file (downloaded from Springer) in a proper
16662 directory, reconfigure \SpecialChar LaTeX
16663 (in the te\SpecialChar TeX
16668 , as root if necessary — doesn't \SpecialChar LyX
16669 take care of this?), reconfigure \SpecialChar LyX
16674 \begin_layout Subsection
16678 \begin_layout Standard
16679 A large number of theorem-like styles —
16691 \begin_layout Standard
16694 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
16695 _Title, Author_Running, Institute,
16696 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
16699 See the Springer class file documentation for details.
16702 \begin_layout Subsection
16706 \begin_layout Itemize
16718 \begin_layout Itemize
16721 Probability Theory and Related Fields
16727 — Jean-Marc Lasgouttes
16730 \begin_layout Standard
16731 Add your own, it isn't so hard!
16734 \begin_layout Subsection
16738 \begin_layout Standard
16739 These files are partly based on the older
16743 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
16745 file from Springer.
16750 layout, are now defunct.
16751 Jean-Marc Lasgouttes helped out big in making me find my way around the
16753 layout file mechanism.
16756 \begin_layout Subsection
16760 \begin_layout Standard
16762 But probably less than in the old hacked-\SpecialChar LaTeX
16770 \begin_layout Section
16773 Sli\SpecialChar TeX
16777 \begin_inset CommandInset label
16786 \begin_layout Standard
16794 \begin_layout Subsection
16798 \begin_layout Standard
16799 This section describes how to use \SpecialChar LyX
16800 to make slides for overhead projectors.
16801 There are two document classes that can do this: the default slides class
16804 Foil\SpecialChar TeX
16808 This section documents the former.
16811 \begin_layout Standard
16812 I'm going to say this again, nice and clear, so that there's no misunderstanding
16816 \begin_layout Standard
16817 \begin_inset VSpace bigskip
16823 \begin_layout Standard
16827 This section documents the class
16828 \begin_inset Quotes eld
16836 \begin_inset Quotes erd
16844 \begin_layout Standard
16845 \begin_inset VSpace bigskip
16851 \begin_layout Standard
16852 If you're looking for the documentation for
16853 \begin_inset Quotes eld
16858 slides (Foil\SpecialChar TeX
16862 \begin_inset Quotes erd
16865 , check out section
16866 \begin_inset space ~
16870 \begin_inset CommandInset ref
16872 reference "sec:foiltex"
16882 \begin_inset Quotes eld
16887 slides (Foil\SpecialChar TeX
16891 \begin_inset Quotes erd
16894 ] is actually somewhat better than the default
16902 \begin_layout Plain Layout
16904 or so I've been told repeatedly by its advocates.
16905 Having never used it, I have no idea if this claim is true or not.
16910 which this section documents.
16913 \begin_layout Standard
16914 This class is the \SpecialChar LaTeX2e
16915 improvement of the old
16917 Sli\SpecialChar TeX
16921 Every \SpecialChar LaTeX2e
16922 distribution includes this class [which I'll just refer to as
16923 \begin_inset Quotes eld
16931 \begin_inset Quotes erd
16934 from now on], so you're bound to have it.
16935 As I noted earlier, there are other classes, such as
16939 , which also produce slides for overhead projectors and do a better job
16941 However, there are some things which
16945 can do which the others can't, such as generate overlays.
16946 Read on to learn more!
16949 \begin_layout Subsection
16951 \begin_inset CommandInset label
16953 name "sec:slidesetup"
16960 \begin_layout Standard
16961 Obviously, to use this document class, you need to select
16962 \begin_inset Quotes eld
16970 \begin_inset Quotes erd
16973 from the class list in the
16975 Document\SpecialChar menuseparator
16979 There are some other special things you should know about this class:
16982 \begin_layout Itemize
16983 Don't bother changing the options
16988 They're not supported by the
16995 \begin_layout Itemize
16999 \begin_inset space ~
17004 behaves a bit differently for this class.
17005 The possible choices and what they do are as follows:
17009 \begin_layout Description
17014 The final output contains page numbers in the lower right corner.
17017 \begin_layout Description
17026 , but also prints out any time markers you've put in.
17027 This is the default.
17030 \begin_layout Description
17035 The final output contains no page numbers, time markers, or alignment markers.
17039 \begin_layout Itemize
17044 class has an extra option:
17050 \begin_inset Quotes eld
17058 \begin_inset Quotes erd
17061 in the extra class options.
17065 \begin_layout Standard
17066 Using this options allows you to add time markers to
17072 \begin_inset space ~
17076 \begin_inset CommandInset ref
17078 reference "sec:slideNote"
17086 \begin_layout Standard
17087 You can also use the template file
17088 \begin_inset Quotes eld
17096 \begin_inset Quotes erd
17099 to automatically set up a document to use the
17105 File\SpecialChar menuseparator
17107 \begin_inset space ~
17111 \begin_inset space ~
17116 to open your new document].
17117 The template file also contains some examples of the special paragraph
17118 environments used by this class.
17119 I'll describe those next.
17122 \begin_layout Subsection
17123 Paragraph Environments
17126 \begin_layout Subsubsection
17127 Supported Environments
17130 \begin_layout Standard
17131 The first thing you'll notice when you start up a new
17135 document is the font size and type: it's the equivalent of the size
17136 \begin_inset Quotes eld
17144 \begin_inset Quotes erd
17150 \begin_inset space ~
17156 This is also what's used in the output.
17158 \begin_inset Quotes eld
17162 \begin_inset Quotes erd
17165 to remind you that this is a slide.
17166 Your final slides will use a larger font; ergo, you'll have less space.
17167 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
17170 \begin_layout Standard
17171 The next thing that becomes obvious is the changes to the paragraph environment
17172 pull-down box [at the far-left end of the toolbar].
17173 Most of the paragraph environments you're used to seeing are missing.
17174 There are also five new ones.
17179 class itself only supports certain paragraph environments:
17182 \begin_layout Itemize
17188 \begin_layout Itemize
17194 \begin_layout Itemize
17200 \begin_layout Itemize
17206 \begin_layout Itemize
17212 \begin_layout Itemize
17218 \begin_layout Itemize
17224 \begin_layout Itemize
17230 \begin_layout Itemize
17236 \begin_layout Itemize
17243 \begin_layout Standard
17244 All of the other standard environments, including the section-heading environmen
17245 ts, aren't used in the
17252 \begin_layout Standard
17253 On the other hand, you'll notice the following new environments:
17256 \begin_layout Itemize
17262 \begin_layout Itemize
17268 \begin_layout Itemize
17274 \begin_layout Itemize
17280 \begin_layout Itemize
17286 \begin_layout Standard
17287 These five are kind of quirky, due to a
17288 \begin_inset Quotes eld
17292 \begin_inset Quotes erd
17295 in \SpecialChar LyX
17297 You see, \SpecialChar LyX
17298 doesn't permit you to nest any other paragraph environment into
17299 an empty environment.
17300 Now, that's fine and dandy, but it means that you wouldn't be able to start
17301 a slide with anything except plain text.
17302 To deal with this, I've performed a little
17303 \begin_inset Quotes eld
17308 \begin_inset Quotes erd
17314 \begin_layout Subsubsection
17315 Quirks of the New Environments
17316 \begin_inset CommandInset label
17318 name "sec:slideQuirk"
17325 \begin_layout Standard
17326 All five of the new paragraph environments are somewhat quirky due to inherent
17327 limitiations in the current version of \SpecialChar LyX
17329 As I just mentioned, \SpecialChar LyX
17330 forbids environments that begin with another environment.
17331 To get around this, the
17335 environment isn't a paragraph environment as described in the
17343 \begin_layout Standard
17344 You should consider
17357 \begin_inset Quotes eld
17360 pseudo-environments.
17361 \begin_inset Quotes erd
17364 They look like a section heading or a
17365 \begin_inset Quotes eld
17373 \begin_inset Quotes erd
17376 but really begin a [and, if necessary, end the previous] paragraph environment.
17386 \begin_inset Quotes eld
17390 \begin_inset Quotes erd
17393 These two perform some action.
17396 \begin_layout Standard
17397 A common feature of all five environments,
17417 , is a rather long-ish label.
17418 The text following this label — ordinarily the contents of the paragraph
17419 environment — is utterly irrelevant for
17441 completely ignores it.
17442 In fact, you can leave these five environments completely empty.
17446 \begin_layout Standard
17451 to put any text after the rather long-ish label, you might want to.
17452 This could be a short description of the contents of the
17457 In that case, enter your descriptive comment and hit
17461 as you normally would.
17464 \begin_layout Standard
17465 If, on the other hand, you don't want to enter any descriptive text, you'll
17466 hit another \SpecialChar LyX
17469 , like nature, abhors a vacuum, and will not let you start a new paragraph
17470 environment until you put something in the old one.
17474 \begin_layout Itemize
17475 Start entering the text that will
17503 \begin_layout Itemize
17504 Now move to the beginning of that paragraph.
17508 \begin_layout Itemize
17517 \begin_layout Itemize
17518 Finally, change this new, empty paragraph to a
17542 \begin_layout Standard
17543 Some future version of \SpecialChar LyX
17544 will, hopefully, resolve this quirkiness\SpecialChar ldots
17548 \begin_layout Subsection
17549 Making a Presentation with
17562 \begin_layout Subsubsection
17570 \begin_layout Standard
17571 If you're expecting this section to teach you how to actually make a presentatio
17572 n, you'll be sorely disappointed.
17573 Naturally, I'll describe all of the ways the
17577 class can assist you in preparing the materials for a presentation.
17578 Filling in the contents, however, is up to you.
17583 the \SpecialChar LyX
17587 \begin_layout Standard
17592 environment [in the manner described in section
17593 \begin_inset space ~
17597 \begin_inset CommandInset ref
17599 reference "sec:slideQuirk"
17603 ] tells \SpecialChar LyX
17604 to begin a new slide [duh].
17605 The label for this environment/
17606 \begin_inset Quotes erd
17610 \begin_inset Quotes erd
17614 \begin_inset Quotes eld
17618 \begin_inset Quotes erd
17621 in cool blue, followed by the label,
17622 \begin_inset Quotes eld
17626 \begin_inset Quotes erd
17630 Any text or paragraph environments that follow this one go on the new slide.
17634 \begin_layout Standard
17635 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
17637 (this can be specified in the
17642 In fact, you'll want to, once you finish entering the contents of one slide.
17643 If you've entered more text than can physically fit on a slide, the extra
17644 overflows onto a new slide.
17645 I don't recommend doing this, however, since the overflow slide won't have
17646 any page number on it.
17647 Furthermore, it may interfere with any
17651 you've made to accompany the oversized
17658 \begin_layout Standard
17667 environments work the same way as the
17672 They both create an
17673 \begin_inset Quotes eld
17677 \begin_inset Quotes erd
17680 followed by a label [
17681 \begin_inset Quotes eld
17685 \begin_inset Quotes erd
17689 \begin_inset Quotes eld
17693 \begin_inset Quotes erd
17697 The color is a stunning magenta instead of blue, and the
17698 \begin_inset Quotes eld
17702 \begin_inset Quotes erd
17705 will look different, in style and in length.
17706 The label fonts of all three also differ from one another.
17709 \begin_layout Standard
17714 , if the contents of a
17722 exceed the physical size of a slide or sheet of paper, the extra will overflow
17724 Again, you should avoid this.
17725 It defeats the whole purpose of
17736 \begin_layout Subsubsection
17746 \begin_layout Standard
17751 is a slide that sits atop another slide.
17752 Perhaps you wish to discuss a figure on the main
17756 before displaying the text associated with it.
17757 One way to accomplish this is tape a flap of dark paper over the part of
17762 you want to display later.
17763 This method fails, however, if you wish to overlap one graph with another,
17765 You would then have to fumble while speaking to align the two separate,
17770 s to align the two graphs.
17775 environment in both cases makes life much easier.
17778 \begin_layout Standard
17783 receives the page number of its
17784 \begin_inset Quotes eld
17788 \begin_inset Quotes erd
17796 \begin_inset Quotes eld
17804 \begin_inset Quotes erd
17811 \begin_layout Plain Layout
17812 Presumably, mutliple
17817 \begin_inset Quotes eld
17825 \begin_inset Quotes erd
17829 \begin_inset Quotes eld
17837 \begin_inset Quotes erd
17841 \begin_inset Quotes eld
17849 \begin_inset Quotes erd
17853 \begin_inset space ~
17856 appended to the page number of the parent
17866 Clearly, you want the contents of both the
17874 to each fit on a single physical slide! You should probably consider an
17880 \begin_inset Quotes eld
17884 \begin_inset Quotes erd
17892 Indeed, the \SpecialChar LyX
17897 class provides a visual cue for this: the label at the start of an
17901 is shorter than that at the start of a
17906 Lastly, when you generate printable output, you'll find alignment markers
17907 in all four corners of both the
17911 page and its parent
17916 These will assist you in lining up the two physical slides.
17919 \begin_layout Standard
17920 The major problem in overlaying two slides is aligning the contents of the
17921 two transparencies.
17922 How much space should you leave for that graph on the second slide? Worse
17923 still, what if you want a graph and a sentence on second slide, but there
17924 is text on the main transparency that goes in between them? You could try
17925 and insert vertical space of the right size.
17926 The better way is to use
17937 \begin_layout Standard
17938 As their names imply,
17946 are two command-like paragraph environments that make all subsequent text
17947 invisible and visible, respectively.
17949 \begin_inset space ~
17953 \begin_inset CommandInset ref
17955 reference "sec:slideQuirk"
17959 that you don't place anything
17963 these two environments, however.
17968 , it inserts a centered, sky-blue label into the page reading
17969 \begin_inset Quotes eld
17972 <Invisible Text Follows>
17973 \begin_inset Quotes erd
17977 For paragraphs following this label, the parts of the
17985 ; it doesn't matter which] where they would be contain instead blank space.
17989 \begin_layout Standard
17994 , the corresponding centered label is
17995 \begin_inset Quotes eld
17998 <Visible Text Follows>
17999 \begin_inset Quotes erd
18003 Paragraphs following this label behave normally.
18004 Note that the beginning of a new
18016 automatically shuts off an
18021 It's therefore not necessary to use
18032 \begin_layout Standard
18033 By now, it should be obvious how to create overlay transparencies using
18034 the proper combination of
18053 \begin_layout Enumerate
18058 , including everything that will appear on it, whether on the main slide
18066 \begin_layout Enumerate
18067 Before each figure or paragraph that will appear only on the
18076 If necessary, insert a
18080 environment after the
18087 \begin_layout Enumerate
18092 immediately following the
18099 \begin_layout Enumerate
18100 Copy the contents of this
18111 \begin_layout Enumerate
18116 , change all of the
18127 \begin_layout Standard
18129 You've just made an
18136 \begin_layout Standard
18137 There's one problem with the way I've designed the \SpecialChar LyX
18142 class: you can't make text in the middle of a paragraph invisible, nor
18143 make text in the middle of an invisible paragraph visible again.
18144 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
18149 \begin_layout Plain Layout
18150 The commands of interest are:
18153 \begin_layout Itemize
18158 invisible \SpecialChar ldots
18162 \begin_layout Itemize
18167 visible \SpecialChar ldots
18171 \begin_layout Plain Layout
18173 and need to be marked as \SpecialChar TeX
18176 \begin_inset Quotes eld
18180 \begin_inset Quotes erd
18183 you wish to change goes in between the brackets [and after the
18196 If you don't know how to mark text as \SpecialChar TeX
18197 , see the appropriate section of
18210 \begin_layout Subsubsection
18220 \begin_inset CommandInset label
18222 name "sec:slideNote"
18229 \begin_layout Standard
18238 is associated with a
18239 \begin_inset Quotes eld
18243 \begin_inset Quotes erd
18251 Here, too, the \SpecialChar LyX
18256 class provides visual cues.
18261 is shorter than that of a
18265 [yet longer than that of an
18269 ] and, like the label of an
18273 is shockingly magenta.
18274 Additionally, the printed
18278 has the page number of its
18279 \begin_inset Quotes eld
18283 \begin_inset Quotes erd
18291 \begin_inset Quotes eld
18299 \begin_inset Quotes erd
18303 \begin_inset Quotes eld
18311 \begin_inset Quotes erd
18315 \begin_inset Quotes eld
18323 \begin_inset Quotes erd
18327 You can have multiple
18331 s associated with a single
18343 , you'll probably want to break up long
18347 s so that they fit on a single sheet of paper.
18350 \begin_layout Standard
18355 is obvious: it contains anything additional you might want to say about
18361 It could also be used as a sheet of reminders for a particular
18366 In the case of the latter, you might want to make use of time markers.
18367 Currently, the \SpecialChar LyX
18373 \begin_inset Quotes eld
18377 \begin_inset Quotes erd
18380 support for time markers, a
18382 Sli\SpecialChar TeX
18386 So, you'll have to resort to using the \SpecialChar LaTeX
18390 \begin_layout Standard
18391 To use time markers, you'll need to specify the extra class option
18392 \begin_inset Quotes eld
18400 \begin_inset Quotes erd
18404 \begin_inset space ~
18408 \begin_inset CommandInset ref
18410 reference "sec:slidesetup"
18415 This option turns on timing marks, which will appear in the lower-left-hand
18421 To set what appears in the time marker, you use the \SpecialChar LaTeX
18423 \begin_inset Quotes eld
18433 \begin_inset Quotes erd
18437 \begin_inset Quotes eld
18447 \begin_inset Quotes erd
18451 The arguments of both commands are time measured in seconds.
18453 \begin_inset Quotes eld
18463 \begin_inset Quotes erd
18466 sets the time marker to a given time.
18468 \begin_inset Quotes eld
18478 \begin_inset Quotes erd
18481 increments the time marker by the specified amount.
18482 Using time markers and
18486 s in this fashion, you can remind yourself how much time to spend on a particula
18494 \begin_layout Standard
18495 There's one last feature to describe.
18496 Clearly, you'd like to print out all of your
18504 s on transparencies while printing all of your
18521 with which it is associated.
18522 What's a person to do?
18525 \begin_layout Standard
18526 Luckily, there are two \SpecialChar LaTeX
18527 commands that allow you to select what to print
18529 Both must be placed into the preamble of your document.
18531 \begin_inset Quotes eld
18543 \begin_inset Quotes erd
18546 will cause the output to contain only the
18555 Correspondingly, the command
18556 \begin_inset Quotes eld
18568 \begin_inset Quotes erd
18571 prevents the output of anything but
18576 I'd advise placing both commands in the preamble and initially comment
18578 You can then preview your entire presentation as you write.
18579 When you're done writing, you can then uncomment one of the two to select
18580 what you want to print.
18581 I like to uncomment
18582 \begin_inset Quotes eld
18594 \begin_inset Quotes erd
18597 , print to a file with
18598 \begin_inset Quotes eld
18606 \begin_inset Quotes erd
18609 in its name, comment it back out, then uncomment
18610 \begin_inset Quotes eld
18622 \begin_inset Quotes erd
18626 \begin_inset Quotes eld
18634 \begin_inset Quotes erd
18638 I can then send either file to a printer, loading transparencies or plain
18639 paper as appropriate.
18642 \begin_layout Standard
18643 You can also provide other arguments to the
18644 \begin_inset Quotes eld
18654 \begin_inset Quotes erd
18658 \begin_inset Quotes eld
18668 \begin_inset Quotes erd
18672 See a good \SpecialChar LaTeX
18676 \begin_layout Subsection
18681 Class Template File
18684 \begin_layout Standard
18685 I have also provided a template file,
18686 \begin_inset Quotes eld
18694 \begin_inset Quotes erd
18702 To use it, begin your new presentation with
18704 File\SpecialChar menuseparator
18706 \begin_inset space ~
18710 \begin_inset space ~
18716 Your new \SpecialChar LyX
18717 presentation file will contain an example
18738 additionally contain an example of the use of
18747 Lastly, the preamble will contain:
18750 \begin_layout LyX-Code
18751 % Uncomment to print out only slides and overlays
18754 \begin_layout LyX-Code
18758 \begin_layout LyX-Code
18764 \begin_inset Newline newline
18770 \begin_layout LyX-Code
18771 % Uncomment to print out only notes
18774 \begin_layout LyX-Code
18778 \begin_layout LyX-Code
18786 \begin_layout Standard
18787 One final thing: I created this class to support the \SpecialChar LaTeX2e
18789 \begin_inset Quotes eld
18794 Sli\SpecialChar TeX
18798 \begin_inset Quotes erd
18801 class, one of the built-in \SpecialChar LaTeX2e
18803 Neither I nor the rest of the \SpecialChar LyX
18804 Team endorse or oppose the use of this built-in
18806 It's here if you want it or need it.
18807 There exist other \SpecialChar LaTeX2e
18808 classes for creating presentations, such as the
18813 \begin_inset space ~
18817 \begin_inset CommandInset ref
18819 reference "sec:foiltex"
18824 \begin_inset Quotes eld
18832 \begin_inset Quotes erd
18835 package [present on some \SpecialChar TeX
18837 The latter is not yet supported under \SpecialChar LyX
18842 \begin_layout Plain Layout
18843 Perhaps you can take on the task\SpecialChar ldots
18849 I know nothing about these other classes.
18850 Try them out to see what sort of alternative they provide.
18853 \begin_layout Chapter
18855 Features needing Extra Software
18858 \begin_layout Section
18859 Checking \SpecialChar TeX
18863 \begin_layout Standard
18869 \begin_layout Subsection
18873 \begin_layout Standard
18882 \begin_layout Plain Layout
18887 is not yet available when you are using the \SpecialChar LaTeX
18888 distribution MiK\SpecialChar TeX
18894 , you'll find in the
18901 \begin_inset space ~
18912 \begin_inset Newline newline
18916 \begin_inset CommandInset href
18918 target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
18926 \begin_layout Standard
18929 Chk\SpecialChar TeX
18932 package is a program that was written by
18933 \begin_inset Flex Noun
18936 \begin_layout Plain Layout
18938 \begin_inset space ~
18946 in frustration because some constructs in \SpecialChar LaTeX
18947 are sometimes non-intuitive,
18948 and easy to forget.
18949 The program runs over your \SpecialChar LaTeX
18950 file, checks the integrity of the file, and
18951 flags some common errors.
18952 In other technical words, it is
18956 for \SpecialChar LaTeX
18960 \begin_layout Standard
18961 Well, what is a syntax checker doing in \SpecialChar LyX
18962 which is supposed to produce correct
18964 anyways? The answer is simple: Just as
18968 not only checks the
18972 of C programs, but also does
18976 checks for type-errors,
18978 Chk\SpecialChar TeX
18981 catches some common
18985 errors, in addition to the syntactical ones.
18988 Chk\SpecialChar TeX
18991 is capable of detecting several common errors, such as
18994 \begin_layout Itemize
18995 Ellipsis detection:
18996 \begin_inset Newline newline
18999 Use \SpecialChar ldots
19003 \begin_layout Itemize
19004 No space in front of/after parenthesis:
19005 \begin_inset Newline newline
19011 \begin_layout Itemize
19012 Enforcement of normal space after common abbreviations:
19013 \begin_inset Newline newline
19017 \begin_inset space \thinspace{}
19021 \begin_inset space \space{}
19024 is too wide spacing.
19027 \begin_layout Itemize
19028 Enforcement of end-of-sentence space when the last sentence ends with a
19030 \begin_inset Newline newline
19034 And this is wrong spacing.
19037 \begin_layout Itemize
19038 Space in front of labels and similar commands:
19039 \begin_inset Newline newline
19042 The label should stick right up to the text to avoid falling to a wrong
19045 \begin_inset CommandInset label
19055 \begin_layout Plain Layout
19056 This footnote is in danger of falling off to a wrong page
19061 The label is separated too much.
19064 \begin_layout Itemize
19065 Space in front of references, instead of hard spaces:
19066 \begin_inset Newline newline
19069 If you have bad luck, the text will break right between the referenced text
19070 and reference number, and that's a pity.
19072 \begin_inset CommandInset ref
19074 reference "sec:chktex"
19081 \begin_layout Itemize
19083 \begin_inset Quotes eld
19087 \begin_inset Quotes erd
19091 \begin_inset Formula $\times$
19095 \begin_inset Newline newline
19098 2x2 looks cheap compared to
19099 \begin_inset Formula $2\times2$
19105 \begin_layout Standard
19106 and more \SpecialChar ldots
19107 It is an invaluable tool when you are
19108 \begin_inset Quotes eld
19112 \begin_inset Quotes erd
19115 your document before printing, and you should run it right after the obligatory
19116 spelling check, and before you go fine tuning the typesetting.
19119 \begin_layout Subsection
19123 \begin_layout Standard
19124 If you have the program installed, usage is as simple as choosing
19126 Tools\SpecialChar menuseparator
19128 \begin_inset space ~
19134 This will make \SpecialChar LyX
19135 generate a \SpecialChar LaTeX
19136 file of your document, start
19138 Chk\SpecialChar TeX
19141 to check it, and then make \SpecialChar LyX
19143 \begin_inset Quotes eld
19147 \begin_inset Quotes erd
19150 with the warnings from
19152 Chk\SpecialChar TeX
19155 , if there were any.
19156 The warnings will be placed close to the point of the mistake, and you
19157 can quickly find them by using the
19159 Navigate\SpecialChar menuseparator
19162 menu item, or the shortcut key
19171 Open the error boxes by clicking on them with the mouse, or use the shortcut
19180 bindings, or the corresponding
19189 Read the warning and correct the mistake, if it is a mistake.
19190 If you have trouble understanding what the warning is about, you can safely
19192 Remember that there is a hidden layer between the document on screen and
19193 the technical details in invoking
19195 Chk\SpecialChar TeX
19198 , and this gap can make some warnings seem arcane or just plain silly.
19201 \begin_layout Standard
19202 This document is an excellent testing bed for the feature, and it should
19203 provide quite a few warnings for you to fiddle with.
19204 Since computers are only so smart, expect most of the warnings to be false
19208 \begin_layout Subsection
19209 How to fine tune it
19212 \begin_layout Standard
19213 Sometimes, you'll find that
19215 Chk\SpecialChar TeX
19218 makes more noise than suits your mood.
19219 Then you can choose not to use it, wait until your mood changes, or try
19222 Chk\SpecialChar TeX
19225 to get better along with you.
19228 \begin_layout Standard
19231 Chk\SpecialChar TeX
19238 very configurable and extensible, you should not expect to solve all problems
19241 Chk\SpecialChar TeX
19244 in \SpecialChar LyX
19246 Since \SpecialChar LyX
19247 has to generate a somewhat special \SpecialChar LaTeX
19248 file to be able to match the
19249 line numbers from the
19251 Chk\SpecialChar TeX
19258 \begin_layout Plain Layout
19259 You can inspect the specific output from
19265 Document\SpecialChar menuseparator
19268 \begin_inset space ~
19282 to the internal document structure, some of the warnings will not appear
19284 There are two things you can do about this:
19287 \begin_layout Itemize
19290 Chk\SpecialChar TeX
19293 invocation command line in
19294 \begin_inset Flex Noun
19297 \begin_layout Plain Layout
19298 Tools\SpecialChar menuseparator
19299 Preferences\SpecialChar menuseparator
19300 Output\SpecialChar menuseparator
19301 LaTeX\SpecialChar menuseparator
19309 Chk\SpecialChar TeX
19312 installation configuration file (usually with the file
19317 See below to learn what warnings can be enabled and disabled on the command
19321 \begin_layout Itemize
19322 Export your document as a raw \SpecialChar LaTeX
19325 File\SpecialChar menuseparator
19326 Export\SpecialChar menuseparator
19335 Invoked in this way, it can be a hassle to find the corresponding place
19336 in the document inside \SpecialChar LyX
19337 , but with a little patience, you should be able
19341 \begin_layout Standard
19342 Here follows the warning messages that can be enabled and disabled in
19351 to disable a warning, and
19355 to enable a warning.
19356 The emphasized entries are disabled by default, because the default is
19359 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
19364 \begin_layout Standard
19365 Notice that you should only use the options that enable and disable warnings,
19366 because \SpecialChar LyX
19367 relies on some of the other command line parameters to be set
19368 in a specific way to have a chance to communicate with
19375 \begin_layout Enumerate
19379 Command terminated with space.
19382 \begin_layout Enumerate
19385 Non-breaking space (
19386 \begin_inset Quotes eld
19394 \begin_inset Quotes erd
19397 ) should have been used.
19400 \begin_layout Enumerate
19404 You should enclose the previous parenthesis with
19405 \begin_inset Quotes eld
19413 \begin_inset Quotes erd
19419 \begin_layout Enumerate
19422 Italic correction (
19423 \begin_inset Quotes eld
19433 \begin_inset Quotes erd
19436 ) found in non-italic buffer.
19439 \begin_layout Enumerate
19442 Italic correction (
19443 \begin_inset Quotes eld
19453 \begin_inset Quotes erd
19456 ) found more than once.
19459 \begin_layout Enumerate
19463 No italic correction (
19464 \begin_inset Quotes eld
19474 \begin_inset Quotes erd
19480 \begin_layout Enumerate
19484 \begin_inset Quotes eld
19492 \begin_inset Quotes erd
19496 \begin_inset Quotes eld
19504 \begin_inset Quotes erd
19510 \begin_layout Enumerate
19513 Wrong length of dash may have been used.
19516 \begin_layout Enumerate
19520 \begin_inset Quotes eld
19528 \begin_inset Quotes erd
19532 \begin_inset Quotes eld
19540 \begin_inset Quotes erd
19546 \begin_layout Enumerate
19550 \begin_inset Quotes eld
19558 \begin_inset Quotes erd
19564 \begin_layout Enumerate
19568 \begin_inset Quotes eld
19576 \begin_inset Quotes erd
19579 to achieve an ellipsis.
19582 \begin_layout Enumerate
19585 Inter-word spacing (
19586 \begin_inset Quotes eld
19596 \begin_inset Quotes eld
19599 ) should perhaps be used.
19602 \begin_layout Enumerate
19605 Inter-sentence spacing (
19606 \begin_inset Quotes eld
19616 \begin_inset Quotes erd
19619 ) should perhaps be used.
19622 \begin_layout Enumerate
19625 Could not find argument for command.
19628 \begin_layout Enumerate
19632 \begin_inset Quotes eld
19640 \begin_inset Quotes erd
19646 \begin_layout Enumerate
19649 Math mode still on at end of \SpecialChar LaTeX
19653 \begin_layout Enumerate
19657 \begin_inset Quotes eld
19665 \begin_inset Quotes erd
19668 doesn't match the number of
19669 \begin_inset Quotes eld
19677 \begin_inset Quotes erd
19683 \begin_layout Enumerate
19686 You should use either
19689 \begin_inset Quotes eld
19697 \begin_inset Quotes erd
19702 as an alternative to
19703 \begin_inset Quotes eld
19711 \begin_inset Quotes erd
19717 \begin_layout Enumerate
19724 " (ASCII 39) instead of "
19731 \begin_layout Enumerate
19734 User-specified pattern found.
19737 \begin_layout Enumerate
19740 This command might not be intended.
19743 \begin_layout Enumerate
19750 \begin_layout Enumerate
19768 \begin_layout Enumerate
19771 Delete this space to maintain correct page references.
19774 \begin_layout Enumerate
19778 You might wish to put this between a pair of
19779 \begin_inset Quotes eld
19787 \begin_inset Quotes erd
19793 \begin_layout Enumerate
19796 You ought to remove spaces in front of punctuation.
19799 \begin_layout Enumerate
19802 Could not execute \SpecialChar LaTeX
19806 \begin_layout Enumerate
19815 in front of small punctuation.
19818 \begin_layout Enumerate
19826 may look prettier here.
19829 \begin_layout Enumerate
19833 Multiple spaces detected in output.
19836 \begin_layout Enumerate
19839 This text may be ignored.
19842 \begin_layout Enumerate
19848 \begin_inset Quotes eld
19853 to begin quotation, not
19860 \begin_layout Enumerate
19867 to end quotation, not
19870 \begin_inset Quotes eld
19878 \begin_layout Enumerate
19884 \begin_layout Enumerate
19887 You should perhaps use
19888 \begin_inset Quotes eld
19896 \begin_inset Quotes erd
19902 \begin_layout Enumerate
19905 You should put a space in front of/after parenthesis.
19908 \begin_layout Enumerate
19911 You should avoid spaces in front of/after parenthesis.
19914 \begin_layout Enumerate
19918 You should not use punctuation in front of/after quotes.
19921 \begin_layout Enumerate
19924 Double space found.
19927 \begin_layout Enumerate
19930 You should put punctuation outside inner/inside display math mode.
19933 \begin_layout Enumerate
19936 You ought to not use primitive \SpecialChar TeX
19937 in \SpecialChar LaTeX
19941 \begin_layout Enumerate
19944 You should remove spaces in front of
19945 \begin_inset Quotes eld
19953 \begin_inset Quotes erd
19959 \begin_layout Enumerate
19962 \begin_inset Quotes eld
19970 \begin_inset Quotes erd
19973 is normally not followed by
19974 \begin_inset Quotes eld
19982 \begin_inset Quotes erd
19988 \begin_layout Standard
19989 In later versions of \SpecialChar LyX
19990 , we hope to provide a more complete interface to this
19991 tool (and it's smaller cousin
19995 ) to exploit the full power of it.
19996 But it's not exactly useless as it is now: go try it on one of your existing
19997 documents of a certain length and be surprised.
20000 \begin_layout Section
20001 Version Control in \SpecialChar LyX
20005 \begin_layout Standard
20008 Lars Gullik Bjønnes
20015 \begin_layout Subsection
20019 \begin_layout Standard
20021 supports some of the most basic RCS/CVS/SVN/GIT commands.
20022 If you need something a bit more sophisticated you will have to do that
20023 manually in a terminal.
20026 \begin_layout Standard
20027 Also note that CVS support is not as good as subversion support, so we advise
20029 A good place to start learning Subversion is the SVN Book
20033 \begin_layout Plain Layout
20034 \begin_inset CommandInset href
20036 target "http://svnbook.red-bean.com/"
20047 In the case of RCS you should read
20048 \begin_inset Quotes eld
20052 \begin_inset Quotes erd
20055 (a man file, read it with
20060 This file describes all the basic features of RCS.
20061 You should especially notice the comment about a RCS directory, and the
20062 notion of a master RCS file (the file ending in
20069 \begin_layout Standard
20070 Before you begin to use the version control features in \SpecialChar LyX
20072 familiar with RCS/CVS/SVN/GIT usage.
20073 The implementation in \SpecialChar LyX
20074 assumes a recent version of the GNU RCS or CVS/SVN
20075 package — no guarantees are made for older versions.
20076 Most of the log messages are not currently displayed after operations —
20077 you can check them in the Messages pane if you are unsure.
20078 Regular users of version control will appreciate the VC toolbar, which
20081 View\SpecialChar menuseparator
20082 Toolbars\SpecialChar menuseparator
20084 \begin_inset space ~
20092 \begin_layout Standard
20093 For introducing your own external commands consult
20094 \begin_inset Flex Code
20097 \begin_layout Plain Layout
20111 \begin_layout Standard
20112 It is strongly recommended to store documents in uncompressed format if
20113 using version control (uncheck
20115 Document\SpecialChar menuseparator
20118 if it is checked): Uncompressed LyX documents are text files and therefore
20119 for merging two different versions by version control systems.
20120 Compressed LyX documents are binary files, which cannot be merged by version
20124 \begin_layout Subsection
20125 RCS commands in \SpecialChar LyX
20129 \begin_layout Standard
20130 The following sections describe the RCS commands supported by \SpecialChar LyX
20132 You can find them in the
20134 File\SpecialChar menuseparator
20136 \begin_inset space ~
20143 was tested against RCS 5.7/5.8.
20146 \begin_layout Subsubsection
20152 \begin_layout Standard
20153 If your document is not under revision control, this is the only item shown
20155 And if it is under revision control, the
20159 item is not visible.
20163 \begin_layout Standard
20164 This command registers your document with RCS (unless you are under the
20165 directory managed by CVS)\SpecialChar endofsentence
20166 You are asked interactively to supply an initial
20167 description of the document.
20168 The document is now set in Read-Only mode and you have to
20171 \begin_inset space ~
20175 \begin_inset space ~
20179 \begin_inset space ~
20184 , before making any changes to it.
20185 A document under revision control has a
20186 \begin_inset Quotes eld
20189 [RCS:<version> <locker>]
20190 \begin_inset Quotes erd
20193 item tagged to the filename in the minibuffer.
20196 \begin_layout Standard
20197 RCS command that is run:
20200 \begin_layout LyX-Code
20203 ci -q -u -i -t-"<initial description>" <file-name>
20206 \begin_layout Standard
20211 to understand the switches.
20215 \begin_layout Subsubsection
20221 \begin_layout Standard
20222 When you are finished editing a file, you check in your changes.
20223 When you do this, you are asked for a description of the changes.
20224 This is stored in the history log.
20225 The version number is bumped, your changes are applied to the master RCS
20226 file, the document is unlocked and set to Read-Only mode.
20229 \begin_layout Itemize
20232 ci -q -u -m"<description>" <file-name>
20235 \begin_layout Subsubsection
20241 \begin_layout Standard
20242 By doing this you lock the document so that only you can edit it.
20243 This will also make the document Read-Write only for you.
20244 You will usually continue editing for a while and when you are finished
20245 you check in your changes.
20246 The status line is changed to reflect that you have locked the file.
20249 \begin_layout Itemize
20252 co -q -l <file-name>
20255 \begin_layout Subsubsection
20258 Revert To Repository Version
20261 \begin_layout Standard
20262 This will discard all changes made to the document since the last check
20264 You get a warning before changes are discarded.
20267 \begin_layout Itemize
20270 co -f -u<version> <file-name>
20273 \begin_layout Subsubsection
20279 \begin_layout Standard
20280 This will create a copy of the current document.
20281 Since RCS does not support copy operations natively, the version history
20282 is not preserved, and the copy is added as a new file.
20283 It requires a clean document without any changes since the last checkin.
20284 You are asked for a file name and a description of the copy operation.
20285 After that the copy is created, both locally and in the repository.
20286 If the parent directories of the copied and original document differ, all
20287 relative paths of included files of the copy are adjusted (like in
20289 File\SpecialChar menuseparator
20294 Finally, the copy is loaded instead of the original document.
20297 \begin_layout Labeling
20298 \labelwidthstring 00.00.0000
20300 \begin_inset space ~
20304 \begin_inset space ~
20308 \begin_inset Newline newline
20312 \begin_inset Flex Code
20315 \begin_layout Plain Layout
20318 \begin_inset Quotes qld
20322 \begin_inset Quotes qld
20331 \begin_inset Flex Code
20334 \begin_layout Plain Layout
20337 \begin_inset Quotes qld
20341 \begin_inset Quotes qld
20350 \begin_inset Newline newline
20354 \begin_inset Flex Code
20357 \begin_layout Plain Layout
20361 \begin_inset Quotes qld
20365 \begin_inset Quotes qld
20376 \begin_layout Subsubsection
20382 \begin_layout Standard
20383 This makes as if the last check in never happened.
20384 No changes are made to the document loaded into \SpecialChar LyX
20385 , but the last version
20386 is removed from the master RCS file.
20389 \begin_layout Itemize
20392 rcs -o<version> <file-name>
20395 \begin_layout Subsubsection
20401 \begin_layout Standard
20402 This shows the complete history of the RCS document.
20407 is shown in a browser.
20415 \begin_layout Subsubsection
20419 \begin_layout Standard
20421 supports RCS version number, author name, date and time of last commit.
20422 All those are extracted from
20424 rlog -r <file-name>
20428 \begin_inset CommandInset ref
20430 reference "subsec:VCS-Revision-Information"
20437 \begin_layout Subsection
20438 CVS commands in \SpecialChar LyX
20442 \begin_layout Standard
20443 A subset of CVS operations is supported by \SpecialChar LyX
20445 You can find the commands in the
20447 File\SpecialChar menuseparator
20449 \begin_inset space ~
20455 The version control system SVN is more powerful, so please use it instead
20456 of CVS if possible.
20459 \begin_layout Subsubsection
20465 \begin_layout Standard
20466 If you start from scratch with CVS you have to create your repository and
20467 checkout the working copy with external tools.
20468 If you're using a client-server setup you may need to login before doing
20469 the first repository checkout.
20472 \begin_layout Standard
20473 If your documents are under revision control and others are using the same
20474 repository problems arise when different changes to the same document at
20475 the same location happen.
20476 Standard CVS repositories don't operate with a file locking mechanism.
20477 This may be surprising, but conflicts only occur if people disagree on
20478 the proper content of the same part of a document.
20479 So, if co-workers are used to communicate regularly, these conflicts occur
20481 If they don't communicate they have a fundamental problem anyway.
20482 Nevertheless some people like to work with so called
20483 \begin_inset Quotes eld
20487 \begin_inset Quotes erd
20491 If they do so the working copy of all files is readonly when checked out
20492 first and the user starts editing after using a special command to make
20493 the working copy writable.
20494 When the changes are checked in the working copy returns to readonly state.
20495 With \SpecialChar LyX
20496 one has to edit the
20497 \begin_inset Flex Code
20500 \begin_layout Plain Layout
20506 file and add the line
20507 \begin_inset Flex Code
20510 \begin_layout Plain Layout
20516 to work with reserved checkouts.
20517 The benefit is the possibility to see who is using a writable copy of some
20519 It's not guaranteed only one user makes a copy writable.
20522 \begin_layout Standard
20524 tries to guess if you're using reserved or non-reserved checkouts.
20525 If your working copy is readonly or it is writable and an additional copy
20526 of your document exists in the CVS/Base sub-directory a reserved otherwise
20527 a non-reserved checkout is assumed.
20528 When a reserved checkout is detected you have to use
20529 \begin_inset Flex Noun
20532 \begin_layout Plain Layout
20538 to make your working copy writable if it's readonly.
20540 \begin_inset Flex Noun
20543 \begin_layout Plain Layout
20549 operation is possible and that makes your working copy readonly again after
20550 transferring your changes to the repository.
20553 \begin_layout Standard
20554 More information about CVS can be found here
20555 \begin_inset Flex URL
20558 \begin_layout Plain Layout
20560 http://www.nongnu.org/cvs
20566 \begin_inset Flex URL
20569 \begin_layout Plain Layout
20571 http://ximbiot.com/cvs
20579 \begin_layout Standard
20584 to understand the sub-commands and the switches mentioned below.
20587 \begin_layout Subsubsection
20593 \begin_layout Standard
20594 If your document is not under revision control, this is the only item shown
20596 And if it is under revision control, the
20600 item is not visible.
20604 \begin_layout Standard
20605 This command registers in CVS your document
20606 \begin_inset Flex Strong
20609 \begin_layout Plain Layout
20617 in the case you have already the documents directory under CVS control
20623 This means you have to create or checkout the archive by yourself using
20625 (In case you forget that step \SpecialChar LyX
20626 registers the document with RCS.)
20629 \begin_layout Standard
20630 Then you are asked interactively to supply an initial description of the
20632 Don't forget that registered file is not yet checked in.
20635 \begin_layout Standard
20636 CVS command that is run:
20638 cvs -q add -m"<entered message>" "<file-name>"
20641 \begin_layout Standard
20646 above and for all other CVS commands is an abbreviation for
20647 \begin_inset Quotes eld
20650 change the current working directory to file location and use the file name
20651 without path component as argument
20652 \begin_inset Quotes erd
20658 \begin_layout Subsubsection
20664 \begin_layout Standard
20665 When you are finished editing a file, you commit your changes.
20666 When you do this and you had changed the document, you are asked for a
20667 description of the changes.
20668 After that changes are written to the repository.
20669 In case you didn't change the document and a reserved checkout is detected
20670 the reservation made on
20671 \begin_inset Flex Noun
20674 \begin_layout Plain Layout
20683 \begin_layout Labeling
20684 \labelwidthstring 00.00.0000
20686 \begin_inset space ~
20690 \begin_inset space ~
20694 \begin_inset Newline newline
20698 \begin_inset Flex Code
20701 \begin_layout Plain Layout
20704 -q commit -m"<description>" "<file-name>"
20710 \begin_inset Newline newline
20714 \begin_inset Flex Code
20717 \begin_layout Plain Layout
20728 \begin_layout Subsubsection
20734 \begin_layout Standard
20735 When you are sharing a repository with others, you may have to incorporate
20736 their changes into your working copy.
20739 \begin_layout Standard
20742 cvs -q update "<file-name>"
20745 \begin_layout Standard
20746 If a readonly checkout is detected the working copy is made writable and
20750 \begin_layout Standard
20753 cvs -q edit "<file-name>"
20756 \begin_layout Subsubsection
20759 Revert To Repository Version
20762 \begin_layout Standard
20763 This will discard all changes made to the document since the last check
20765 You get a warning before changes are discarded.
20766 Firstly the file is deleted, secondly CVS update command is run.
20769 \begin_layout Standard
20772 cvs -q update "<file-name>"
20775 \begin_layout Standard
20776 If a reserved checkout is detected and the working copy has no changes only
20777 the reservation is undone.
20780 \begin_layout Standard
20783 cvs -q unedit "<file-name>"
20786 \begin_layout Subsubsection
20792 \begin_layout Standard
20793 This will create a copy of the current document.
20794 Since CVS does not support copy operations natively, the version history
20795 is not preserved, and the copy is added as a new file.
20796 It requires a clean document without any changes since the last checkin.
20797 You are asked for a file name and a description of the copy operation.
20798 After that the copy is created, both locally and in the repository.
20799 If the parent directories of the copied and original document differ, all
20800 relative paths of included files of the copy are adjusted (like in
20802 File\SpecialChar menuseparator
20807 Finally, the copy is loaded instead of the original document.
20810 \begin_layout Labeling
20811 \labelwidthstring 00.00.0000
20813 \begin_inset space ~
20817 \begin_inset space ~
20821 \begin_inset Newline newline
20825 \begin_inset Flex Code
20828 \begin_layout Plain Layout
20835 \begin_inset Flex Code
20838 \begin_layout Plain Layout
20845 \begin_inset Newline newline
20849 \begin_inset Flex Code
20852 \begin_layout Plain Layout
20853 cvs -q add "<new-file-name>"
20861 \begin_layout Subsubsection
20867 \begin_layout Standard
20868 This will rename the current document.
20869 Since CVS does not support rename operations natively, the version history
20870 is not preserved, the renamed document is added as a new file, and the
20871 original document is deleted.
20872 It requires a clean document without any changes since the last checkin.
20873 You are asked for a file name and a description of the rename operation.
20874 After that the document is renamed, both locally and in the repository.
20875 If the parent directories of the new and old file names differ, all relative
20876 paths of included files are adjusted (like in
20878 File\SpecialChar menuseparator
20883 Finally, the document is reloaded using the new name.
20886 \begin_layout Labeling
20887 \labelwidthstring 00.00.0000
20889 \begin_inset space ~
20893 \begin_inset space ~
20897 \begin_inset Newline newline
20901 \begin_inset Flex Code
20904 \begin_layout Plain Layout
20911 \begin_inset Flex Code
20914 \begin_layout Plain Layout
20921 \begin_inset Newline newline
20925 \begin_inset Flex Code
20928 \begin_layout Plain Layout
20929 cvs -q add "<new-file-name>"
20935 \begin_inset Newline newline
20939 \begin_inset Flex Code
20942 \begin_layout Plain Layout
20943 cvs -q remove "<file-name>"
20951 \begin_layout Subsubsection
20952 Update of the local directory checkout from repository
20955 \begin_layout Standard
20956 Once your documents gets more complex, containing sub-documents and pictures,
20958 \begin_inset Flex Code
20961 \begin_layout Plain Layout
20967 files and so on using version control becomes more complicated.
20969 supports updating the whole tree in which resides the document.
20970 This become especially useful once you cooperate with people which neither
20971 have detailed knowledge about CVS usage nor they have ambition to commit
20972 additional material to the repository.
20973 You have to organize the files structure so that all external files are
20974 in the same directory or subdirectories of the document.
20975 It's good practice anyway to store multipart documents in an extra directory.
20978 \begin_layout Standard
20980 \begin_inset Flex Code
20983 \begin_layout Plain Layout
20984 Update local directory from repository
20989 command updates the whole directory.
20990 If local changes are detected user is warned before update starts.
20991 In case of merge conflicts both versions of the conflicting document parts
20992 are placed in the final document.
20993 You have to review and correct the result of the merge.
20994 You'll find the conflicts enclosed in pairs of
20995 \begin_inset Flex Code
20998 \begin_layout Plain Layout
21005 \begin_inset Flex Code
21008 \begin_layout Plain Layout
21015 \begin_inset Flex Code
21018 \begin_layout Plain Layout
21025 The first part is your version as before the update operation with the
21026 document name prepended.
21027 The second one is the repository version with the version number after
21029 \begin_inset Flex Code
21032 \begin_layout Plain Layout
21041 \begin_layout Labeling
21042 \labelwidthstring 00.00.0000
21044 \begin_inset space ~
21048 \begin_inset space ~
21052 \begin_inset Newline newline
21056 \begin_inset Flex Code
21059 \begin_layout Plain Layout
21067 (Ask if changes are detected.)
21068 \begin_inset Newline newline
21072 \begin_inset Flex Code
21075 \begin_layout Plain Layout
21076 cd $path; cvs -q update
21086 \begin_layout Standard
21088 \begin_inset Flex Code
21091 \begin_layout Plain Layout
21097 stands for the path to the document.
21100 \begin_layout Subsubsection
21106 \begin_layout Standard
21107 This shows the complete history of the CVS document.
21110 cvs log "<file-name>"
21112 is shown in a browser.
21115 \begin_layout Subsubsection
21119 \begin_layout Standard
21121 supports CVS version number, author name, date and time of last commit.
21122 All those are extracted from
21124 cvs log -r <file-name>
21128 \begin_inset CommandInset ref
21130 reference "subsec:VCS-Revision-Information"
21137 \begin_layout Subsection
21138 SVN commands in \SpecialChar LyX
21142 \begin_layout Standard
21143 SVN is now partially supported by \SpecialChar LyX
21145 You can find the commands in the
21147 File\SpecialChar menuseparator
21149 \begin_inset space ~
21155 Please note that if you use password protected access to repository via
21156 ssh, you will be asked in terminal window.
21158 was tested against SVN 1.5, 1.6, 1.7 and 1.8
21162 \begin_layout Plain Layout
21163 Most of the commands will work with 1.4 too, see
21164 \begin_inset CommandInset ref
21166 reference "subsec:SVN-Repo-Update"
21171 There seems to be currently unresolved permissions problem under SVN 1.8
21172 with reverting changes when file is locked.
21180 \begin_layout Subsubsection
21186 \begin_layout Standard
21187 If your document is not under revision control, this is the only item shown
21189 And if it is under revision control, the
21193 item is not visible.
21196 \begin_layout Standard
21197 This command registers in SVN your document ONLY in case you have already
21198 the documents directory under SVN control (in particular
21203 This means you have to checkout the archive by yourself.
21206 \begin_layout Standard
21207 Then you are asked interactively to supply an initial description of the
21209 Don't forget that registered file is not yet commited.
21212 \begin_layout Standard
21213 SVN command that is run:
21216 \begin_inset Quotes qld
21220 \begin_inset Quotes qld
21226 \begin_layout Standard
21231 to understand the switches.
21234 \begin_layout Subsubsection
21240 \begin_layout Standard
21241 When you are finished editing a file, you commit your changes.
21242 When you do this, you are asked for a description of the changes.
21243 After that changes are commited.
21246 \begin_layout Standard
21251 \begin_layout Plain Layout
21252 In case locking is not enabled.
21254 \begin_inset CommandInset ref
21256 reference "subsec:SVN-File-Locking"
21267 svn commit -q -m"<description>" <file-name>
21270 \begin_layout Subsubsection
21276 \begin_layout Standard
21277 Updates the changes of this file from the repository.
21278 Be sure you understand SVN merging and conflicts resolving before using
21279 this function, because all conflicts has to be resolved manually by you!
21282 \begin_layout Standard
21287 \begin_layout Plain Layout
21295 svn update --non-interactive
21296 \begin_inset Quotes qld
21300 \begin_inset Quotes qld
21306 \begin_layout Subsubsection
21309 Revert To Repository Version
21312 \begin_layout Standard
21313 This will discard all changes made to the document since the last check
21315 You get a warning before changes are discarded.
21318 \begin_layout Standard
21322 \begin_inset Quotes qld
21326 \begin_inset Quotes qld
21332 \begin_layout Subsubsection
21338 \begin_layout Standard
21339 This will create a copy of the current document including the version history.
21340 It requires a clean document without any changes since the last checkin.
21341 You are asked for a file name and a description of the copy operation.
21342 After that the copy is created, both locally and in the repository.
21343 If the parent directories of the copied and original document differ, all
21344 relative paths of included files of the copy are adjusted (like in
21346 File\SpecialChar menuseparator
21351 Finally, the copy is loaded instead of the original document.
21354 \begin_layout Labeling
21355 \labelwidthstring 00.00.0000
21357 \begin_inset space ~
21361 \begin_inset space ~
21365 \begin_inset Newline newline
21369 \begin_inset Flex Code
21372 \begin_layout Plain Layout
21376 \begin_inset Quotes qld
21380 \begin_inset Quotes qld
21384 \begin_inset Quotes qld
21388 \begin_inset Quotes qld
21397 \begin_inset Newline newline
21401 \begin_inset Flex Code
21404 \begin_layout Plain Layout
21413 \begin_layout Subsubsection
21419 \begin_layout Standard
21420 This will rename the current document including the version history.
21421 It requires a clean document without any changes since the last checkin.
21422 You are asked for a file name and a description of the rename operation.
21423 After that the document is renamed, both locally and in the repository.
21424 If the parent directories of the new and old file names differ, all relative
21425 paths of included files are adjusted (like in
21427 File\SpecialChar menuseparator
21432 Finally, the document is reloaded using the new name.
21435 \begin_layout Labeling
21436 \labelwidthstring 00.00.0000
21438 \begin_inset space ~
21442 \begin_inset space ~
21446 \begin_inset Newline newline
21450 \begin_inset Flex Code
21453 \begin_layout Plain Layout
21457 \begin_inset Quotes qld
21461 \begin_inset Quotes qld
21465 \begin_inset Quotes qld
21469 \begin_inset Quotes qld
21478 \begin_inset Newline newline
21482 \begin_inset Flex Code
21485 \begin_layout Plain Layout
21494 \begin_layout Subsubsection
21495 \begin_inset CommandInset label
21497 name "subsec:SVN-Repo-Update"
21501 Update of the local directory checkout from repository
21505 \begin_layout Plain Layout
21506 Note that this command will work only with subversion
21507 \begin_inset Formula $\geqq1.5$
21518 \begin_layout Standard
21519 All the commands above have one shortcoming – they deal with the current
21521 Once your document contains pictures, includes external
21522 \begin_inset Flex Code
21525 \begin_layout Plain Layout
21531 files and so on administration becomes more complicated.
21533 now supports updating the whole tree in which resides the document
21537 \begin_layout Plain Layout
21538 One need to organize the files structure so that all external files are
21539 in the same directory or subdirectories of the document.
21546 This become especially useful once you cooperate with people which neither
21547 know about subversion management nor they have ambition to commit additional
21548 material to the repository.
21552 \begin_layout Standard
21553 \begin_inset Flex Code
21556 \begin_layout Plain Layout
21557 Update local directory from repository
21562 command updates the whole directory and in case of merge conflicts local
21563 version of the files are left, so no unintended data loss occurs.
21564 If local changes are detected user is warned before update starts.
21567 \begin_layout Labeling
21568 \labelwidthstring 00.00.0000
21570 \begin_inset space ~
21574 \begin_inset space ~
21578 \begin_inset Newline newline
21582 \begin_inset Flex Code
21585 \begin_layout Plain Layout
21591 (Ask if changes are detected.)
21592 \begin_inset Newline newline
21596 \begin_inset Flex Code
21599 \begin_layout Plain Layout
21600 svn update --accept mine-full $path
21608 \begin_layout Standard
21610 \begin_inset Flex Code
21613 \begin_layout Plain Layout
21619 stands for the path to the document.
21622 \begin_layout Subsubsection
21628 \begin_layout Standard
21629 This shows the complete history of the SVN document.
21633 \begin_inset Quotes qld
21637 \begin_inset Quotes qld
21642 is shown in a browser.
21645 \begin_layout Subsubsection
21647 \begin_inset CommandInset label
21649 name "subsec:SVN-File-Locking"
21656 \begin_layout Standard
21657 The file exchange through various revision control systems brings the problem
21658 of merge conflicts in case two different users try to edit the same (parts
21660 When such a conflict happens it needs manual resolving and one reasonable
21661 alternative is to provide some kind of locking mechanism, which guarantees
21662 that only one user is allowed to edit file at the given time.
21665 \begin_layout Standard
21666 SVN has two such mechanisms to provide mutual exclusivity for file access
21667 – locks and automatic setting of write permissions (see sec.
21669 \begin_inset CommandInset ref
21671 reference "subsec:Automatical-Locking-Property"
21676 \begin_inset Flex Code
21679 \begin_layout Plain Layout
21689 \begin_layout Plain Layout
21690 \begin_inset Flex URL
21693 \begin_layout Plain Layout
21695 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
21706 If this property is detected for a given document \SpecialChar LyX
21707 starts to use SVN locks
21708 for document editing automatically and the whole check-in/out mechanism
21709 switches to the same regimen as for RCS.
21710 This in particular means there are two different modes of file use in \SpecialChar LyX
21714 \begin_layout Itemize
21716 The loaded file is in the read-only mode.
21717 For editing on needs to check-out.
21722 consists of updating from the repository and gaining write lock.
21723 If the lock is not possible to obtain, we remain in unlocked state.
21726 \begin_layout Itemize
21728 The loaded file is in the
21729 \begin_inset Quotes els
21733 \begin_inset Quotes ers
21737 No other user is allowed to edit the file.
21742 consists of commiting changes and releasing write-lock.
21743 If no changes have been made to the document, no commit will be produced
21747 \begin_layout Plain Layout
21748 Don't be puzzled by the fact that you will be asked for commit message anyway.
21753 and only the write-lock will be released.
21756 \begin_layout Standard
21760 \begin_layout Labeling
21761 \labelwidthstring 00.00.0000
21764 svn commit -q -m"<description>" "<file-name>"
21765 \begin_inset Newline newline
21768 svn unlock "<file-name>"
21771 \begin_layout Labeling
21772 \labelwidthstring 00.00.0000
21775 svn update "<file-name>"
21776 \begin_inset Newline newline
21779 svn lock "<file-name>"
21782 \begin_layout Subsubsection
21785 \begin_inset CommandInset label
21787 name "subsec:Automatical-Locking-Property"
21793 Automatic Locking Property
21796 \begin_layout Standard
21797 The above mentioned automatic setting of write permissions of the .lyx file
21800 File\SpecialChar menuseparator
21802 \begin_inset space ~
21805 Control\SpecialChar menuseparator
21806 Use Locking Property
21809 This command is active only when the file is not locked on the svn server
21811 you need to check-out before proceeding).
21814 \begin_layout Labeling
21815 \labelwidthstring 00.00.0000
21817 \begin_inset space ~
21823 \begin_layout Labeling
21824 \labelwidthstring 00.00.0000
21827 svn propset svn:needs-lock ON "<file-name>"
21830 \begin_layout Labeling
21831 \labelwidthstring 00.00.0000
21834 svn propdel svn:needs-lock "<file-name>"
21837 \begin_layout Subsubsection
21838 \begin_inset CommandInset label
21840 name "subsec:VCS-Revision-Information"
21844 Revision Information in Documents
21847 \begin_layout Standard
21848 There are more possibilities how to activate revision information in our
21852 \begin_layout Itemize
21858 \begin_layout Itemize
21859 tree revision information (
21860 \begin_inset Flex Code
21863 \begin_layout Plain Layout
21870 The result is the output of the
21871 \begin_inset Flex Code
21874 \begin_layout Plain Layout
21880 command, the following table gives you an idea, how to read the results.
21883 \begin_layout Standard
21885 \begin_inset Tabular
21886 <lyxtabular version="3" rows="6" columns="2">
21887 <features tabularvalignment="middle">
21888 <column alignment="left" valignment="top">
21889 <column alignment="left" valignment="top">
21891 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21894 \begin_layout Plain Layout
21902 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21905 \begin_layout Plain Layout
21915 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
21918 \begin_layout Plain Layout
21924 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21927 \begin_layout Plain Layout
21928 mixed revision working copy
21935 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
21938 \begin_layout Plain Layout
21944 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21947 \begin_layout Plain Layout
21948 modified working copy
21955 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
21958 \begin_layout Plain Layout
21964 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21967 \begin_layout Plain Layout
21968 switched working copy
21975 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
21978 \begin_layout Plain Layout
21984 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21987 \begin_layout Plain Layout
21988 partial working copy, from a sparse checkout
21995 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21998 \begin_layout Plain Layout
22004 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
22007 \begin_layout Plain Layout
22008 mixed revision, modified, switched working copy
22021 \begin_layout Itemize
22022 file revision information.
22023 The result comes from parsing the output of
22024 \begin_inset Flex Code
22027 \begin_layout Plain Layout
22029 \begin_inset space ~
22033 \begin_inset space ~
22037 \begin_inset space ~
22046 Supported flags are:
22050 \begin_layout Itemize
22051 version number of the last commit (
22052 \begin_inset Flex Code
22055 \begin_layout Plain Layout
22064 \begin_layout Itemize
22065 author of the last commit (
22066 \begin_inset Flex Code
22069 \begin_layout Plain Layout
22078 \begin_layout Itemize
22079 date of the last commit (
22080 \begin_inset Flex Code
22083 \begin_layout Plain Layout
22092 \begin_layout Itemize
22093 time of the last commit (
22094 \begin_inset Flex Code
22097 \begin_layout Plain Layout
22107 \begin_layout Standard
22108 You can obtain this info via InsetInfo (
22109 \change_inserted 5863208 1564400022
22112 Insert\SpecialChar menuseparator
22113 Field\SpecialChar menuseparator
22114 Version Control Revision
22115 \change_deleted 5863208 1564399852
22120 \begin_inset Flex Code
22123 \begin_layout Plain Layout
22124 info-insert buffer vcs-date
22132 The information will be available only when you have the file stored under
22133 svn managment (i.e.
22135 \begin_inset Flex Code
22138 \begin_layout Plain Layout
22144 directory is available with your document).
22148 \begin_layout Itemize
22149 Another—a hacking one—possibility is to use svn keywords
22153 \begin_layout Plain Layout
22154 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
22160 In short – you set file keywords property (e.g.
22163 svn propset svn:keywords 'Rev' file.lyx
22165 ) and then paste keyword \SpecialChar TeX
22170 \begin_layout Plain Layout
22171 This is an easy way how to ensure that \SpecialChar LyX
22172 won't break the line in the middle
22178 tag in your document (e.g.
22180 \begin_inset Flex Code
22183 \begin_layout Plain Layout
22190 This way svn client will automatically substitute revision number (e.g.
22192 \begin_inset Flex Code
22195 \begin_layout Plain Layout
22201 ) after each update and commit.
22202 There are more problems with this approach.
22203 Firstly, the '$' character is used in \SpecialChar TeX
22204 world for math equations, so any
22205 occurence of math formula
22206 \begin_inset Formula $Rev$
22210 \begin_inset Formula $Rev:59$
22213 in your \SpecialChar LyX
22215 Similarly for other keywords like Id, Date, Author, etc.
22216 Secondly svn output is dependent on your locales, so its very easy that
22217 svn would produce some problematic strings once Date is used.
22218 Thirdly you get the whole 'Rev: 59' string in your document instead of
22220 Until subversion implements user's custom keywords it will be hard to use
22221 this approach reliably or let \SpecialChar LyX
22222 to support it directly.
22225 \begin_layout Subsection
22226 SVN and Windows Environment
22229 \begin_layout Quote
22230 My inclination is to say that if the user cannot figure out the command
22231 line operations on their own fairly quickly, they would be well advised
22232 to use TortoiseSVN.
22238 \begin_layout Subsubsection
22242 \begin_layout Standard
22243 In addition to installing \SpecialChar LyX
22244 , and having access to a Subversion repository,
22245 the user will need to install the Subversion client program.
22246 A Windows installer for the client program is available from
22247 \begin_inset CommandInset href
22250 target "http://www.collab.net/nonav/downloads/subversion/"
22256 The user may also want to install
22257 \begin_inset CommandInset href
22260 target "http://tortoisesvn.tigris.org/"
22265 , which integrates Subversion operations into the context (rightclick) menu
22266 of Windows Explorer.
22267 Operations done outside \SpecialChar LyX
22268 will typically be more convenient using the Explorer
22270 Note that TortoiseSVN is not a replacement for the client program, which
22271 is what \SpecialChar LyX
22275 \begin_layout Subsubsection
22276 Bringing a document under Subversion control
22279 \begin_layout Standard
22280 Before a \SpecialChar LyX
22281 document can be brought under version control in Subversion, its
22282 parent directory needs to be under version control.
22283 If the document is being added to a project already in the repository,
22284 this is accomplished by checking the project out to the directory where
22285 the new document will be placed.
22286 If the project itself is not yet under version control (for instance, if
22287 this document starts a new project), the directory must be imported into
22289 This is done outside \SpecialChar LyX
22291 Both import and checkout are easily accomplished from the Explorer context
22292 menu using TortoiseSVN, or alternatively can be done using the command
22293 line client at a DOS prompt.
22294 The procedure for importing the project using TortoiseSVN is described
22295 below, assuming an existing repository and a new project being started
22303 For information on using the Subversion client program, run
22310 \begin_layout Enumerate
22317 in Windows Explorer, right click it, and select
22319 TortoiseSVN\SpecialChar menuseparator
22323 If necessary, adjust the URL for the repository, then click OK.
22326 \begin_layout Enumerate
22327 Right click the level of the repository under which you want to place the
22328 new project folder (typically the top level) and click
22332 Supply a name for the project folder and click OK.
22333 Add a message for the log file if desired, then click OK again.
22334 The new project folder should appear in the repository.
22335 Finally, click OK again to exit the repository browser.
22338 \begin_layout Enumerate
22339 Once again right click
22345 , this time selecting SVN Checkout\SpecialChar ldots
22346 Select the URL of the project folder
22347 you just created in the repository, and set the checkout directory to
22355 You will be warned about a non-empty folder; click OK to proceed.
22356 You should now have a
22367 \begin_layout Enumerate
22368 Create or open your document in \SpecialChar LyX
22371 File\SpecialChar menuseparator
22373 \begin_inset space ~
22376 Control\SpecialChar menuseparator
22380 Add a log message and click OK to commit the document to version control.
22383 \begin_layout Standard
22384 From this point onward, you should have full functionality in the
22386 File\SpecialChar menuseparator
22388 \begin_inset space ~
22394 You also have the option of checking the document in and out, viewing its
22396 using the TortoiseSVN context menu in Windows Explorer or the Subversion
22397 client program from a command prompt.
22400 \begin_layout Subsubsection
22401 SSH tunnel used with SVN under Windows
22404 \begin_layout Standard
22405 Compared with Linux setting up an svn client to communicate over ssh under
22406 Windows is a rather troublesome task.
22407 We will at least offer some hints how to setup the client side but prior
22408 knowledge about ssh and the Windows command line is needed, also be prepared
22409 for a great deal of frustration\SpecialChar ldots
22413 \begin_layout Enumerate
22414 Get an svn client for windows, as described in the previous sections.
22415 When it is a fresh install run some svn command (e.g.
22417 \begin_inset Flex Code
22420 \begin_layout Plain Layout
22426 ) to create config files, which you will need to change later on.
22429 \begin_layout Enumerate
22430 Choose an ssh client for Windows.
22431 There are several possibilities, we will use the one from Putty tools
22435 \begin_layout Plain Layout
22436 \begin_inset Flex URL
22439 \begin_layout Plain Layout
22441 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
22452 You will need to set the connection up so that the client doesn't ask for
22453 any password from you.
22454 To keep things easy we will use only keys without any additional password
22459 \begin_layout Enumerate
22461 \begin_inset Flex Code
22464 \begin_layout Plain Layout
22471 Save your private .ppk key file and put the public one on the server side.
22472 If the SVN server runs on Linux, note that the format of the public key
22473 is not compatible with Linux openssh and you will need to direcly copy-paste
22475 \begin_inset Quotes eld
22480 Public key for pasting into OpenSSH authorized_keys file
22483 \begin_inset Quotes erd
22486 edit field into the server's
22487 \begin_inset Flex Code
22490 \begin_layout Plain Layout
22491 ~/.ssh/authorized_keys
22497 \begin_inset Flex Code
22500 \begin_layout Plain Layout
22509 \begin_layout Enumerate
22511 \begin_inset Flex Code
22514 \begin_layout Plain Layout
22521 In the SVN config file
22525 \begin_layout Plain Layout
22526 Exact path depends on Windows version, usually somewhere around
22527 \begin_inset Flex Code
22530 \begin_layout Plain Layout
22533 Documents and Settings
22547 \begin_inset Flex Code
22550 \begin_layout Plain Layout
22565 , section [tunnels], setup ssh command, e.g.
22567 \begin_inset Flex Code
22570 \begin_layout Plain Layout
22571 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
22580 \begin_layout Plain Layout
22581 It will usually take a lot of time to get exact command right and it depends
22583 For example do not have some remote server saved as a default session in
22585 If things fail, try to connect via plink without SVN first.
22594 \begin_layout Enumerate
22595 Checkout the SVN archive, e.
22596 \begin_inset space \thinspace{}
22600 \begin_inset Newline newline
22604 \begin_inset Flex Code
22607 \begin_layout Plain Layout
22608 svn co svn+ssh://user@server/repository_path
22616 \begin_layout Subsubsection
22617 End-of-Line Conversions
22620 \begin_layout Standard
22621 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
22623 use different line endings inside the .lyx files.
22624 This is not a problem as far as \SpecialChar LyX
22625 functionality is concerned, but the commit
22626 diffs will be huge and merge-conflicts prone.
22627 Fortunately SVN itself knows
22631 \begin_layout Plain Layout
22632 \begin_inset Flex URL
22635 \begin_layout Plain Layout
22637 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
22647 how to deal with CR/LF problems when switching .lyx files to the
22648 \begin_inset Flex Code
22651 \begin_layout Plain Layout
22661 \begin_layout Plain Layout
22663 \begin_inset Flex Code
22666 \begin_layout Plain Layout
22667 svn propset svn:eol-style native FILE_NAME
22680 \begin_layout Subsection
22681 GIT commands in \SpecialChar LyX
22685 \begin_layout Standard
22686 A minimal subset of GIT commands is now supported by \SpecialChar LyX
22688 You can find the commands in the
22690 File\SpecialChar menuseparator
22692 \begin_inset space ~
22698 Please note that if you use password protected access to repository via
22699 ssh, you will be asked in terminal window.
22701 was tested against GIT 1.7.
22705 \begin_layout Plain Layout
22706 Windows users please note that you need to ensure that git is on the path.
22707 This can be set from within \SpecialChar LyX
22710 Tools\SpecialChar menuseparator
22711 Preferences\SpecialChar menuseparator
22712 Paths\SpecialChar menuseparator
22723 \begin_layout Standard
22724 One big difference of GIT and the other supported version control systems
22725 is the distributed nature of GIT: With traditional version control systems
22726 there is one central server which hosts the repository.
22727 Users commit their changes to the server, and get updates made by other
22729 With GIT, users commit to a local repository.
22730 The local repository can be synchronized with one or more remote repositories
22732 \begin_inset Flex Code
22735 \begin_layout Plain Layout
22742 \begin_inset Flex Code
22745 \begin_layout Plain Layout
22753 does not interact in any way with remote GIT repositories.
22754 It works exclusively with the local repository in a very similar way as
22755 with a central CVS or SVN repository.
22756 If you use remote GIT repositories you need to do the
22757 \begin_inset Flex Code
22760 \begin_layout Plain Layout
22767 \begin_inset Flex Code
22770 \begin_layout Plain Layout
22776 operations with your favourite GIT client.
22779 \begin_layout Subsubsection
22785 \begin_layout Standard
22786 If your document is not under revision control, this is the only item shown
22788 And if it is under revision control, the
22792 item is not visible.
22795 \begin_layout Standard
22796 This command registers in GIT your document ONLY in case you have already
22797 the documents directory under GIT control (in particular
22802 This means you have to checkout the archive by yourself.
22805 \begin_layout Standard
22806 Then you are asked interactively to supply an initial description of the
22808 Don't forget that registered file is not yet committed.
22811 \begin_layout Standard
22812 GIT command that is run:
22815 \begin_inset Quotes qld
22819 \begin_inset Quotes qld
22825 \begin_layout Standard
22830 to understand the switches.
22833 \begin_layout Subsubsection
22839 \begin_layout Standard
22840 When you are finished editing a file, you commit your changes.
22841 When you do this, you are asked for a description of the changes.
22842 After that changes are committed.
22845 \begin_layout Standard
22848 git commit -q -m"<description>" <file-name>
22851 \begin_layout Subsubsection
22854 Revert To Repository Version
22857 \begin_layout Standard
22858 This will discard all changes made to the document since the last check
22860 You get a warning before changes are discarded.
22863 \begin_layout Standard
22867 \begin_inset Quotes qld
22871 \begin_inset Quotes qld
22877 \begin_layout Subsubsection
22883 \begin_layout Standard
22884 This will rename the current document including the version history.
22885 It requires a clean document without any changes since the last checkin.
22886 You are asked for a file name and a description of the rename operation.
22887 After that the document is renamed, both locally and in the repository.
22888 If the parent directories of the new and old file names differ, all relative
22889 paths of included files are adjusted (like in
22891 File\SpecialChar menuseparator
22896 Finally, the document is reloaded using the new name.
22899 \begin_layout Labeling
22900 \labelwidthstring 00.00.0000
22902 \begin_inset space ~
22906 \begin_inset space ~
22910 \begin_inset Newline newline
22914 \begin_inset Flex Code
22917 \begin_layout Plain Layout
22921 \begin_inset Quotes qld
22925 \begin_inset Quotes qld
22929 \begin_inset Quotes qld
22933 \begin_inset Quotes qld
22942 \begin_inset Newline newline
22946 \begin_inset Flex Code
22949 \begin_layout Plain Layout
22958 \begin_layout Subsubsection
22964 \begin_layout Standard
22965 This shows the complete history of the GIT document.
22969 \begin_inset Quotes qld
22973 \begin_inset Quotes qld
22978 is shown in a browser.
22981 \begin_layout Subsubsection
22985 \begin_layout Standard
22987 supports GIT hash number of the last commit to the file,
22988 \change_inserted 1119979965 1564297456
22989 its abbreviated form,
22991 author name, date and time of last commit.
22992 All those are extracted from
22994 git log -n 1 --pretty=format:%H%n
22995 \change_inserted 1119979965 1564297427
23001 Tree version information is obtained via
23003 git describe --abbrev --dirty --long
23007 \begin_inset CommandInset ref
23009 reference "subsec:VCS-Revision-Information"
23016 \begin_layout Subsection
23020 \begin_layout Standard
23021 With the recent addition of the
23022 \begin_inset Flex Code
23025 \begin_layout Plain Layout
23031 function \SpecialChar LyX
23032 power users are allowed to create their own commands for revision
23036 \begin_layout Standard
23037 As an example you can see how two TortoiseSVN commands could be integrated
23041 \begin_layout Description
23043 \begin_inset Flex Code
23046 \begin_layout Plain Layout
23047 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
23055 \begin_layout Description
23057 \begin_inset Flex Code
23060 \begin_layout Plain Layout
23061 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
23069 \begin_layout Subsection
23070 Version control and Document comparison
23073 \begin_layout Standard
23074 One of the typical uses of version control is to inspect the changes between
23075 revisions, usually by creating
23076 \begin_inset Flex Code
23079 \begin_layout Plain Layout
23086 While this is useful for plain text files, it is much less useful in the
23087 case of \SpecialChar LyX
23088 files, which have more a complicated structure.
23089 Hence we provide binding to the Document comparison feature.
23090 There are two ways of calling this feature – either by direct call of
23091 \begin_inset Flex Code
23094 \begin_layout Plain Layout
23101 function (for details see \SpecialChar LyX
23102 functions manual) or by the toolbar icon
23115 One can either compare two chosen revisions of the document or he can simply
23116 compare the current version of edited text with older revisions (where
23118 \begin_inset Flex Noun
23121 \begin_layout Plain Layout
23127 ' revisions back means comparison of the edited file with last commited
23132 \begin_layout Standard
23133 This feature is supported for SVN and RCS though due to the more complicated
23134 versioning scheme of RCS there is a constraint – when addressing the revisions
23135 in dialog, numbers always point to the last number in RCS revision number,
23138 We don't currently support GIT addressing of revisions, one can just compare
23139 edited document with its revision X steps backs, where X is addressed as
23141 \begin_inset Flex Code
23144 \begin_layout Plain Layout
23153 \begin_layout Section
23154 Literate Programming
23157 \begin_layout Standard
23162 (kayvan@sylvan.com)
23166 original documentation written by
23168 Edmar Wienskoski Jr.
23171 (edmar-w-jr@technologist.com)
23174 \begin_layout Subsection
23178 \begin_layout Standard
23179 The main purpose of this documentation is to show you how to use \SpecialChar LyX
23181 programming, where it is assumed that you are familiar with this programming
23182 technique, and know what
23183 \begin_inset Quotes eld
23187 \begin_inset Quotes erd
23191 \begin_inset Quotes eld
23195 \begin_inset Quotes erd
23199 If that is not the case, please follow the web links provided in the following
23201 There is a lot of good documentation out there covering old development
23202 history to the latest tools tips.
23205 \begin_layout Standard
23206 It is also assumed that you are familiar with \SpecialChar LyX
23207 itself to a point that you
23208 are comfortable changing your \SpecialChar LyX
23209 preferences, and X resources file.
23210 If that is not the case please refer to other \SpecialChar LyX
23211 documentation to cover your
23215 \begin_layout Subsection
23216 Literate Programming
23219 \begin_layout Standard
23220 From the Literate Programming FAQ:
23223 \begin_layout Quotation
23224 Literate programming is the combination of documentation and source together
23225 in a fashion suited for reading by human beings.
23226 In fact, literate programs should be enjoyable reading, even inviting!
23227 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
23228 and documentation in a single file.
23229 Literate programming tools then parse the file to produce either readable
23230 documentation or compilable source.
23231 The WEB style of literate programming was created by D.
23232 \begin_inset space \thinspace{}
23236 Knuth during the development of his \SpecialChar TeX
23237 typesetting software.
23241 \begin_layout Standard
23242 Another excerpt says:
23245 \begin_layout Quotation
23248 How is literate programming different from verbose commenting?
23251 \begin_layout Quotation
23252 There are three distinguishing characteristics.
23253 In order of importance, they are:
23257 \begin_layout Itemize
23258 flexible order of elaboration
23261 \begin_layout Itemize
23262 automatic support for browsing
23265 \begin_layout Itemize
23266 typeset documentation, especially diagrams and mathematics
23270 \begin_layout Standard
23271 Now that I sparked your curiosity, take a look in the references.
23274 \begin_layout Subsubsection
23278 \begin_layout Standard
23279 The complete Literate Programming FAQ can be found at:
23282 \begin_layout Quote
23283 Literate Programming FAQ
23284 \begin_inset Flex URL
23287 \begin_layout Plain Layout
23289 http://www.literateprogramming.com/lpfaq.pdf
23297 \begin_layout Standard
23298 The FAQ lists 23 (twenty three!) different literate programming tools.
23299 Where some are specialized or
23300 \begin_inset Quotes eld
23304 \begin_inset Quotes erd
23307 for particular programming languages, while other have general scope.
23312 for my own use for several reasons:
23315 \begin_layout Itemize
23316 It can generate the documentation either in \SpecialChar LaTeX
23320 \begin_layout Itemize
23321 It has a open architecture, i.
23322 \begin_inset space \thinspace{}
23326 \begin_inset space \space{}
23329 it is easy to plug in new filters
23333 \begin_layout Plain Layout
23338 are programs that read a given data stream and output a manipulated data
23340 That way, a WEB file (consisting of literate code) can be turned into a
23341 file consisting only of C program code or \SpecialChar LaTeX
23347 and to perform special processing that you may need.
23351 \begin_layout Itemize
23352 There is a good selection of filters available already (the HTML is one
23356 \begin_layout Itemize
23360 \begin_layout Standard
23361 The Noweb web page can be found at:
23364 \begin_layout Quote
23366 \begin_inset Flex URL
23369 \begin_layout Plain Layout
23371 https://www.cs.tufts.edu/~nr/noweb/
23379 \begin_layout Standard
23380 Starting from there you can reach many other interesting links and even
23381 some literate program examples.
23384 \begin_layout Subsection
23386 and Literate Programming with Noweb
23389 \begin_layout Standard
23390 The \SpecialChar LyX
23391 support for Literate Programming is provided by using the generic \SpecialChar LyX
23393 converters mechanism.
23394 This support is provided in a
23395 \begin_inset Quotes eld
23399 \begin_inset Quotes erd
23403 \begin_inset space \thinspace{}
23407 \begin_inset space \space{}
23410 you will be able to use this new \SpecialChar LyX
23411 feature with some other literate programming
23412 tool of your choice by just changing your \SpecialChar LyX
23416 \begin_layout Subsubsection
23417 Generating documents and code (weaving and tangling)
23420 \begin_layout Paragraph
23421 Using the noweb module
23424 \begin_layout Standard
23425 If you have installed Noweb and \SpecialChar LyX
23426 successfully, whenever you open a new document,
23427 after you have chosen its document class, use the
23429 Document\SpecialChar menuseparator
23433 \begin_inset Quotes eld
23437 \begin_inset Quotes erd
23441 If Noweb is correctly installed, when you click on the
23442 \begin_inset Quotes eld
23446 \begin_inset Quotes erd
23449 link, you will see the
23450 \begin_inset Quotes eld
23454 \begin_inset Quotes erd
23457 module in the available list and you can add it to your document.
23460 \begin_layout Paragraph
23464 \begin_layout Standard
23466 enables you to write code with a custom inset named
23467 \begin_inset Flex Noun
23470 \begin_layout Plain Layout
23477 Noweb delimits chunks like this:
23480 \begin_layout LyX-Code
23484 \begin_layout LyX-Code
23488 \begin_layout LyX-Code
23492 \begin_layout LyX-Code
23496 \begin_layout LyX-Code
23500 \begin_layout Standard
23501 The problem is that whatever is written in between the << and the
23505 must be taken literally, i.
23506 \begin_inset space \thinspace{}
23510 \begin_inset space \space{}
23514 should be prevented from making any special interpretation of what has
23516 This is also handled by
23517 \begin_inset Flex Noun
23520 \begin_layout Plain Layout
23526 , that works like a normal text inset but has a free spacing capability.
23529 \begin_layout Standard
23530 As a special note, you can also use the
23531 \begin_inset Quotes eld
23535 \begin_inset Quotes erd
23538 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
23542 \begin_layout LyX-Code
23546 \begin_layout LyX-Code
23547 def some_function(args):
23550 \begin_layout LyX-Code
23551 "This is the doc string for this function."
23554 \begin_layout LyX-Code
23555 print "My args: ", args
23558 \begin_layout LyX-Code
23559 @ %def some_function
23562 \begin_layout Standard
23563 For an example of this usage and the resulting cross-reference output, look
23564 at the Literate python program in
23566 LIBDIR/examples/listerrors.lyx
23568 which should make this all clear.
23571 \begin_layout Paragraph
23572 Generating the documentation
23575 \begin_layout Standard
23576 At this point you already have a new document file with a proper document
23577 class, and with some code and text on it.
23578 How do I print it? The answer is simple, you select
23580 View\SpecialChar menuseparator
23584 Just like you would do for a plain document.
23585 No special procedure is required.
23588 \begin_layout Standard
23589 To help orientate you, I will now explain what happens inside \SpecialChar LyX
23593 \begin_layout Enumerate
23596 Update\SpecialChar menuseparator
23599 menu option is chosen, a \SpecialChar LaTeX
23605 \begin_layout Standard
23606 If the document is of any literate class the generated file will be named
23607 with an extension name defined by the
23608 \begin_inset Quotes eld
23612 \begin_inset Quotes erd
23615 format (defined in the Preferences panel), otherwise the file will have
23624 \begin_layout Enumerate
23625 Note that the only difference so far is in the name of the file, no special
23626 processing is required by \SpecialChar LyX
23628 Given that you formatted the code using the
23629 \begin_inset Flex Noun
23632 \begin_layout Plain Layout
23638 inset that, by itself, takes care of the business.
23641 \begin_layout Enumerate
23642 If the document is of any literate class \SpecialChar LyX
23643 will then use the internal \SpecialChar LyX
23645 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
23650 \begin_layout Plain Layout
23651 The converters are defined in the
23653 Tools\SpecialChar menuseparator
23657 \begin_inset Quotes eld
23661 \begin_inset Quotes erd
23673 manual for general information about converters.
23678 to generate the \SpecialChar LaTeX
23683 \begin_layout Standard
23684 Otherwise it will just skip this step.
23688 \begin_layout Enumerate
23689 Finally, \SpecialChar LaTeX
23690 is invoked and the regular post processing continues as in a plain
23694 \begin_layout Standard
23695 Independence from a particular
23696 \begin_inset Quotes eld
23700 \begin_inset Quotes erd
23703 is easily achieved by changing the commands that are run by the various
23707 \begin_layout Paragraph
23708 Generating the code
23711 \begin_layout Standard
23712 When the build menu option is chosen or the corresponding button in the
23713 toolbar is pressed, a \SpecialChar LaTeX
23714 file is generated just like step 1 above.
23715 Next, \SpecialChar LyX
23721 This converter needs to be defined by the user and is not installed by
23722 default, though the Program format is.
23723 This converter (like any other converter) will have two parts:
23726 \begin_layout Enumerate
23727 The converter program itself.
23728 This program performs the conversion from the one format to the other (in
23729 this case, from the Noweb format to the Program pseudo-format).
23732 \begin_layout Enumerate
23733 The error log parser.
23734 This is a program whose sole purpose is to rewrite error messages in a
23735 format that \SpecialChar LyX
23737 This makes it possible for \SpecialChar LyX
23738 to place error boxes in the right places in
23742 \begin_layout Standard
23743 The first part, the
23744 \begin_inset Quotes eld
23748 \begin_inset Quotes erd
23751 setting, should be set to
23754 \begin_layout LyX-Code
23762 \begin_layout Standard
23763 This basically means that \SpecialChar LyX
23765 \begin_inset Quotes eld
23769 \begin_inset Quotes erd
23772 (a program or script) with the name of the Noweb file (normally a file
23773 in the \SpecialChar LyX
23774 temp directory) and the directory path of the original \SpecialChar LyX
23779 \begin_layout Standard
23780 This is an implementation of
23781 \begin_inset Quotes eld
23785 \begin_inset Quotes erd
23788 that you can place in a directory on your path:
23791 \begin_layout LyX-Code
23797 \begin_layout LyX-Code
23803 \begin_layout LyX-Code
23806 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
23809 \begin_layout Standard
23810 The next part of the converter setting is the
23811 \begin_inset Quotes eld
23815 \begin_inset Quotes erd
23818 which is to be set to
23821 \begin_layout LyX-Code
23824 parselog=$$s/scripts/listerrors
23827 \begin_layout Standard
23828 This will run any errors that are generated by the
23829 \begin_inset Quotes eld
23833 \begin_inset Quotes erd
23836 process through the
23837 \begin_inset Quotes eld
23841 \begin_inset Quotes erd
23847 \begin_layout Standard
23848 The build will normally take place in \SpecialChar LyX
23849 's temporary directory, so the files
23850 produced by the conversion will be in that directory.
23852 will copy out what it regards as the `main' file, but the
23856 conversion may produce several files, and so most of these would then be
23857 deleted when \SpecialChar LyX
23859 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
23860 the build-script chunk can place the generated files in that location.
23863 \begin_layout Paragraph
23864 Build instructions in the document
23867 \begin_layout Standard
23868 The last piece of the integration between \SpecialChar LyX
23870 \begin_inset Quotes eld
23874 \begin_inset Quotes erd
23878 Generally, the instructions for building your program should be embedded
23879 in a chunk of its own.
23881 \begin_inset Quotes eld
23885 \begin_inset Quotes erd
23888 above uses the notangle command to look for this chunk (called
23889 \begin_inset Quotes eld
23893 \begin_inset Quotes erd
23896 ) and runs its contents through
23897 \begin_inset Quotes eld
23901 \begin_inset Quotes erd
23907 \begin_layout Standard
23908 Typically, such a chunk would look something like this:
23911 \begin_layout LyX-Code
23915 \begin_layout LyX-Code
23917 \begin_inset Newline newline
23920 if [ -z "${NOWEB_SOURCE}" ]
23921 \begin_inset Newline newline
23927 \begin_layout LyX-Code
23928 NOWEB_SOURCE=myfile.nw
23929 \begin_inset Newline newline
23933 \begin_inset Newline newline
23937 code to extract files ...
23938 use NOWEB_OUTPUT_DIR here ...]
23939 \begin_inset Newline newline
23943 code to compile files ...]
23944 \begin_inset Newline newline
23950 \begin_layout Standard
23953 LIBDIR/examples/listerrors.lyx
23957 LIBDIR/examples/Literate.lyx
23959 which implement two versions of the
23960 \begin_inset Quotes eld
23964 \begin_inset Quotes erd
23967 program for some illustrations of how all of these pieces go together or
23970 LIBDIR/examples/noweb2lyx.lyx.
23973 Interestingly, these three files show off the language-indepence of the
23975 literate programming support since they are written in Python, C and Perl
23979 \begin_layout Subsubsection
23980 Configuring \SpecialChar LyX
23984 \begin_layout Standard
23985 All the Literate Programming support is configured by the
23987 Tools\SpecialChar menuseparator
23991 \begin_inset Quotes eld
23995 \begin_inset Quotes erd
23999 The important parts are:
24002 \begin_layout Description
24004 \begin_inset space ~
24008 \begin_inset Quotes eld
24012 \begin_inset Quotes erd
24016 \begin_inset space ~
24019 format Set up via the File Formats tab, this is where the Noweb-specific
24029 , the file extension is set to
24034 This tells \SpecialChar LyX
24035 to create a file with a
24039 extension in the first step of the conversion process.
24042 \begin_layout Description
24044 \begin_inset space ~
24052 \begin_inset space ~
24055 format This is an empty format whose sole purpose is to be the endpoint
24056 of a conversion (which then allows us to set up a converter for it).
24059 \begin_layout Description
24069 This converter performs the
24070 \begin_inset Quotes eld
24074 \begin_inset Quotes erd
24077 of the literate document.
24078 For Noweb, it is set to
24079 \begin_inset Quotes eld
24084 noweave -delay -index $$i > $$o
24087 \begin_inset Quotes erd
24093 \begin_layout Description
24103 \begin_inset Quotes eld
24107 \begin_inset Quotes erd
24111 As stated above, the Converter is set to
24112 \begin_inset Quotes eld
24120 \begin_inset Quotes erd
24123 , with Flags set to
24124 \begin_inset Newline newline
24128 \begin_inset Quotes eld
24133 parselog=$$s/scripts/listerrors
24136 \begin_inset Quotes erd
24142 \begin_layout Subsubsection
24146 \begin_layout Standard
24147 There is also a new function implemented in the \SpecialChar LyX
24149 \begin_inset Quotes eld
24152 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
24156 \begin_layout Standard
24157 When debugging code with ddd/gdb, it is possible to invoke a text editor
24158 at the current execution position with a single key stroke.
24159 The default ddd configuration for that is shift-ctrl-V.
24160 It happens that you can define the editor command line invocation in ddd
24163 Edit\SpecialChar menuseparator
24164 Preferences\SpecialChar menuseparator
24167 dialog and changing the "Edit Sources" entry.
24170 \begin_layout Standard
24171 I take advantage of the newly created \SpecialChar LyX
24172 server function and this ddd feature,
24174 \begin_inset Quotes eld
24178 \begin_inset Quotes erd
24184 \begin_layout LyX-Code
24185 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
24188 \begin_layout Standard
24189 With this, whenever you are using ddd and find a point in the program that
24190 you want to edit, you just press shift-ctrl-V (in the ddd window), and
24191 ddd will forward this information to \SpecialChar LyX
24192 through the \SpecialChar LyX
24193 server and then the
24195 window will show the same file with the cursor at the same position ddd
24197 No more guessing or long scrolling to locate a point in the program back
24201 \begin_layout Standard
24202 Note however that you must enable the \SpecialChar LyX
24203 server to get this feature working
24204 (it is disabled by default).
24206 \begin_inset space ~
24210 \begin_inset CommandInset ref
24212 reference "sec:Starting-the-Server"
24216 explains how to do that.
24219 \begin_layout Subsubsection
24223 \begin_layout Standard
24224 There are six new buttons that can be added to your \SpecialChar LyX
24226 Four of these buttons are short cuts to layout styles:
24244 , one for the custom inset
24249 The last one is a short cut to the
24250 \begin_inset Quotes eld
24254 \begin_inset Quotes erd
24261 \begin_layout Standard
24263 has a range of buttons that are available for tool bar customization.
24264 In my toolbar I like to combine the six short cuts above with two more:
24269 \SpecialChar menuseparator
24274 \SpecialChar menuseparator
24281 Document\SpecialChar menuseparator
24282 View\SpecialChar menuseparator
24286 Here is how it looks like:
24289 \begin_layout LyX-Code
24293 \begin_layout LyX-Code
24297 \begin_layout LyX-Code
24298 Icon "layout Standard"
24301 \begin_layout LyX-Code
24302 Icon "layout Section"
24305 \begin_layout LyX-Code
24306 Icon "layout \SpecialChar LaTeX
24310 \begin_layout LyX-Code
24311 Icon "layout \SpecialChar LyX
24315 \begin_layout LyX-Code
24316 Icon "flex.insert Chunk"
24319 \begin_layout LyX-Code
24323 \begin_layout LyX-Code
24327 \begin_layout LyX-Code
24328 Icon "buffer-typeset"
24331 \begin_layout LyX-Code
24332 Icon "build-program"
24335 \begin_layout LyX-Code
24339 \begin_layout LyX-Code
24343 \begin_layout LyX-Code
24347 \begin_layout LyX-Code
24351 \begin_layout LyX-Code
24355 \begin_layout Subsubsection
24356 Colors customization
24359 \begin_layout Standard
24360 There are a number of colors in \SpecialChar LyX
24361 that can be customized in
24366 One of the things that bothers people is the \SpecialChar LaTeX
24368 The default color is red, since the chunks uses \SpecialChar LaTeX
24369 font, and there is a lot
24370 of chunks in literate documents, you may get tired of seeing everything
24372 You can change it by going to the tabs
24381 \begin_layout Standard
24382 The next thing is the visible presence of the newline character in the screen.
24383 You can choose the color of this particular character and make it blend
24385 I recommend you choosing a color that is close to the background but not
24386 equal, that way you still can see it is there, but it is not bothering
24390 \begin_layout Subsection
24395 \begin_layout Standard
24404 is documented in the
24408 example file and in the Sweave manual (menu
24410 Help\SpecialChar menuseparator
24416 \begin_layout Chapter
24420 \begin_layout Standard
24421 You can do everything with \SpecialChar LyX
24422 that you can do with \SpecialChar LaTeX
24424 However, \SpecialChar LyX
24425 cannot support every \SpecialChar LaTeX
24427 But you can always use \SpecialChar TeX
24429 This chapter shows you some more special things you might want to use.
24430 For other special things you can do with figures, tables, floats, boxes
24431 and notes, have a look at the
24434 \begin_inset space ~
24442 \begin_layout Section
24443 Multiple Text Columns
24446 \begin_layout Standard
24447 This feature is independent of the option
24449 Two-column document
24451 in the document settings under
24456 If you want to have 2
24457 \begin_inset space ~
24460 columns for the whole document, it is recommended to use the
24462 Two-column document
24465 For all other cases use this feature.
24468 \begin_layout Standard
24469 To use multiple text columns in your document, you have to load the module
24476 Document\SpecialChar menuseparator
24477 Settings\SpecialChar menuseparator
24480 ) and must have the \SpecialChar LaTeX
24482 \begin_inset Flex Code
24485 \begin_layout Plain Layout
24494 \begin_layout Standard
24495 Footnotes within multiple columns will be placed at the bottom of the page
24496 and not under each column.
24497 Within the different columns you can use everything, with the limitation
24498 that for floats you need to use the float option
24505 \begin_layout Subsection
24509 \begin_layout Standard
24510 If you want to have 2
24511 \begin_inset space ~
24514 columns in your text, insert a multicolumn inset via the menu
24516 Insert\SpecialChar menuseparator
24518 \begin_inset space ~
24521 Insets\SpecialChar menuseparator
24523 \begin_inset space ~
24528 where the columns should start.
24529 Write all text that should be printed in 2
24530 \begin_inset space ~
24533 columns into this inset.
24536 \begin_layout Standard
24537 Here is an example:
24540 \begin_layout Standard
24542 \begin_inset Flex Multiple Columns
24545 \begin_layout Plain Layout
24550 The Adventure of the Empty House
24553 \begin_inset Newline newline
24556 by Sir Arthur Conan Doyle
24559 \begin_layout Plain Layout
24562 It was in the spring of the year 1894 that all London was interested, and
24563 the fashionable world dismayed, by the murder of the Honourable Ronald
24564 Adair under most unusual and inexplicable circumstances.
24565 The public has already learned those particulars of the crime which came
24566 out in the police investigation, but a good deal was suppressed upon that
24567 occasion, since the case for the prosecution was so overwhelmingly strong
24568 that it was not necessary to bring forward all the facts.
24569 Only now, at the end of nearly ten years, am I allowed to supply those
24570 missing links which make up the whole of that remarkable chain.
24571 The crime was of interest in itself, but that interest was as nothing to
24572 me compared to the inconceivable sequel, which afforded me the greatest
24573 shock and surprise of any event in my adventurous life.
24574 Even now, after this long interval, I find myself thrilling as I think
24575 of it, and feeling once more that sudden flood of joy, amazement, and increduli
24576 ty which utterly submerged my mind.
24577 Let me say to that public, which has shown some interest in those glimpses
24578 which I have occasionally given them of the thoughts and actions of a very
24579 remarkable man, that they are not to blame me if I have not shared my knowledge
24580 with them, for I should have considered it my first duty to do so, had
24581 I not been barred by a positive prohibition from his own lips, which was
24582 only withdrawn upon the third of last month.
24590 \begin_layout Standard
24591 To get 3 or more columns, set the cursor into the multicolumn inset and
24594 Insert\SpecialChar menuseparator
24596 \begin_inset space ~
24600 \begin_inset space ~
24606 The number of the desired columns is written into that inset (for 3
24607 \begin_inset space ~
24611 \begin_inset Quotes eld
24615 \begin_inset Quotes erd
24619 \begin_inset Newline newline
24622 Here is an example with 3
24623 \begin_inset space ~
24629 \begin_layout Standard
24630 \begin_inset Flex Multiple Columns
24633 \begin_layout Plain Layout
24636 \begin_inset Argument 1
24639 \begin_layout Plain Layout
24646 It can be imagined that my close intimacy with Sherlock Holmes had interested
24647 me deeply in crime, and that after his disappearance I never failed to
24648 read with care the various problems which came before the public.
24649 And I even attempted, more than once, for my own private satisfaction,
24650 to employ his methods in their solution, though with indifferent success.
24651 There was none, however, which appealed to me like this tragedy of Ronald
24653 As I read the evidence at the inquest, which led up to a verdict of willful
24654 murder against some person or persons unknown, I realized more clearly
24655 than I had ever done the loss which the community had sustained by the
24656 death of Sherlock Holmes.
24657 There were points about this strange business which would, I was sure,
24658 have specially appealed to him, and the efforts of the police would have
24659 been supplemented, or more probably anticipated, by the trained observation
24660 and the alert mind of the first criminal agent in Europe.
24661 All day, as I drove upon my round, I turned over the case in my mind and
24662 found no explanation which appeared to me to be adequate.
24663 At the risk of telling a twice-told tale, I will recapitulate the facts
24664 as they were known to the public at the conclusion of the inquest.
24672 \begin_layout Standard
24673 You can have up to 10
24674 \begin_inset space ~
24677 columns if you want to, but that might not be very pleasant for the readers
24681 \begin_layout Standard
24682 \begin_inset Newpage newpage
24688 \begin_layout Subsection
24689 Columns inside Columns
24692 \begin_layout Standard
24693 You can also have columns inside columns:
24696 \begin_layout Standard
24697 \begin_inset Flex Multiple Columns
24700 \begin_layout Plain Layout
24703 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
24704 at that time governor of one of the Australian colonies.
24705 Adair's mother had returned from Australia to undergo the operation for
24706 cataract, and she, her son Ronald, and her daughter Hilda were living together
24710 \begin_layout Plain Layout
24711 \begin_inset Flex Multiple Columns
24714 \begin_layout Plain Layout
24717 The youth moved in the best society
24718 \begin_inset space ~
24721 – had, so far as was known, no enemies and no particular vices.
24722 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
24723 had been broken off by mutual consent some months before, and there was
24724 no sign that it had left any very profound feeling behind it.
24725 For the rest {sic} the man's life moved in a narrow and conventional circle,
24726 for his habits were quiet and his nature unemotional.
24727 Yet it was upon this easy-going young aristocrat that death came, in most
24728 strange and unexpected form, between the hours of ten and eleven-twenty
24729 on the night of March 30, 1894.
24737 \begin_layout Plain Layout
24740 Ronald Adair was fond of cards
24741 \begin_inset space ~
24744 – playing continually, but never for such stakes as would hurt him.
24745 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
24746 It was shown that, after dinner on the day of his death, he had played
24747 a rubber of whist at the latter club.
24748 He had also played there in the afternoon.
24753 The evidence of those who had played with him
24754 \begin_inset space ~
24758 Murray, Sir John Hardy, and Colonel Moran
24759 \begin_inset space ~
24762 – showed that the game was whist, and that there was a fairly equal fall
24764 Adair might have lost five pounds, but not more.
24765 His fortune was a considerable one, and such a loss could not in any way
24767 He had played nearly every day at one club or other, but he was a cautious
24768 player, and usually rose a winner.
24769 It came out in evidence that, in partnership with Colonel Moran, he had
24770 actually won as much as four hundred and twenty pounds in a sitting, some
24771 weeks before, from Godfrey Milner and Lord Balmoral.
24772 So much for his recent history as it came out at the inquest.
24780 \begin_layout Subsection
24784 \begin_layout Standard
24785 The examples in this section show some more special features of multiple
24789 \begin_layout Standard
24790 For more features of multiple columns, have a look at the
24791 \begin_inset CommandInset href
24793 name "documentation"
24794 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
24799 of the \SpecialChar LaTeX
24801 \begin_inset Flex Code
24804 \begin_layout Plain Layout
24813 \begin_layout Subsubsection
24817 \begin_layout Standard
24818 To add a preface text for multiple columns, set the cursor into the multicolumn
24819 inset and use the menu
24821 Insert\SpecialChar menuseparator
24825 Write your preface text into that inset.
24826 \begin_inset Newline newline
24829 This is an example with some preface text:
24832 \begin_layout Standard
24833 \begin_inset VSpace bigskip
24839 \begin_layout Standard
24840 \begin_inset Flex Multiple Columns
24843 \begin_layout Plain Layout
24844 \begin_inset Argument 2
24847 \begin_layout Plain Layout
24848 And the story continues and continues and continues and continues\SpecialChar ldots
24856 On the evening of the crime, he returned from the club exactly at ten.
24857 His mother and sister were out spending the evening with a relation.
24858 The servant deposed that she heard him enter the front room on the second
24859 floor, generally used as his sitting-room.
24860 She had lit a fire there, and as it smoked she had opened the window.
24861 No sound was heard from the room until eleven-twenty, the hour of the return
24862 of Lady Maynooth and her daughter.
24863 Desiring to say good-night, she attempted to enter her son's room.
24864 The door was locked on the inside, and no answer could be got to their
24865 cries and knocking.
24866 Help was obtained, and the door forced.
24867 The unfortunate young man was found lying near the table.
24868 His head had been horribly mutilated by an expanding revolver bullet, but
24869 no weapon of any sort was to be found in the room.
24877 \begin_layout Standard
24878 You can also use a section heading as the preface if you use a section command
24879 as \SpecialChar TeX
24881 For example the command
24884 \begin_layout LyX-Code
24887 subsection{subsection title}
24890 \begin_layout Standard
24891 creates a subsection.
24892 In this example the preface is a subsubsection:
24895 \begin_layout Standard
24896 \begin_inset Flex Multiple Columns
24899 \begin_layout Plain Layout
24900 \begin_inset Argument 2
24903 \begin_layout Plain Layout
24907 \begin_layout Plain Layout
24916 This is a subsubsection heading as a preface
24920 \begin_layout Plain Layout
24934 A minute examination of the circumstances served only to make the case more
24936 In the first place, no reason could be given why the young man should have
24937 fastened the door upon the inside.
24938 There was the possibility that the murderer had done this, and had afterwards
24939 escaped by the window.
24940 The drop was at least twenty feet, however, and a bed of crocuses in full
24942 Neither the flowers nor the earth showed any sign of having been disturbed,
24943 nor were there any marks upon the narrow strip of grass which separated
24944 the house from the road.
24945 Apparently, therefore, it was the young man himself who had fastened the
24947 But how did he come by his death? No one could have climbed up to the window
24948 without leaving traces.
24949 Suppose a man had fired through the window, he would indeed be a remarkable
24950 shot who could with a revolver inflict so deadly a wound.
24951 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
24952 a hundred yards of the house.
24953 No one had heard a shot.
24961 \begin_layout Standard
24962 If there is less vertical space than 6
24963 \begin_inset space ~
24966 text lines is left on the page at the beginning of the multiple columns,
24967 a page break will be inserted before the multiple columns.
24968 Depending on the number of lines of the preface text, you might want to
24970 This is done by setting the cursor into the mulitcolumn inset behind the
24971 preface (if there is any) and using the menu
24973 Insert\SpecialChar menuseparator
24975 \begin_inset space ~
24979 \begin_inset space ~
24983 \begin_inset space ~
24989 Insert into that inset the amount of space like e.
24990 \begin_inset space \thinspace{}
24994 \begin_inset space \space{}
24998 \begin_inset Quotes eld
25002 \begin_inset Quotes erd
25006 \begin_inset Newline newline
25009 In this example the space is set to 7
25010 \begin_inset space ~
25013 text lines by using
25014 \begin_inset Flex Code
25017 \begin_layout Plain Layout
25026 \begin_inset Flex Code
25029 \begin_layout Plain Layout
25037 needs to be inserted as \SpecialChar TeX
25041 \begin_layout Standard
25042 \begin_inset Flex Multiple Columns
25045 \begin_layout Plain Layout
25046 \begin_inset Argument 3
25049 \begin_layout Plain Layout
25054 \begin_layout Plain Layout
25070 On the evening of the crime, he returned from the club exactly at ten.
25071 His mother and sister were out spending the evening with a relation.
25072 The servant deposed that she heard him enter the front room on the second
25073 floor, generally used as his sitting-room.
25074 She had lit a fire there, and as it smoked she had opened the window.
25075 No sound was heard from the room until eleven-twenty, the hour of the return
25076 of Lady Maynooth and her daughter.
25077 Desiring to say good-night, she attempted to enter her son's room.
25078 The door was locked on the inside, and no answer could be got to their
25079 cries and knocking.
25080 Help was obtained, and the door forced.
25081 The unfortunate young man was found lying near the table.
25082 His head had been horribly mutilated by an expanding revolver bullet, but
25083 no weapon of any sort was to be found in the room.
25091 \begin_layout Subsubsection
25095 \begin_layout Standard
25096 The amount of space before and after multiple columns can be changed by
25097 changing the length
25098 \begin_inset Flex Code
25101 \begin_layout Plain Layout
25110 For example the command
25113 \begin_layout LyX-Code
25121 \begin_layout Standard
25122 in \SpecialChar TeX
25123 Code changes its value to 3
25124 \begin_inset space \thinspace{}
25128 The change must be made before the multiple columns' start.
25129 The predefined value is 13
25130 \begin_inset space \thinspace{}
25136 \begin_layout Standard
25138 \begin_inset Flex Code
25141 \begin_layout Plain Layout
25150 \begin_inset space \thinspace{}
25156 \begin_layout Standard
25160 \begin_layout Plain Layout
25166 multicolsep}{2.5cm}
25174 \begin_layout Standard
25175 \begin_inset Flex Multiple Columns
25178 \begin_layout Plain Layout
25181 All day I turned these facts over in my mind, endeavouring to hit upon some
25182 theory which could reconcile them all, and to find that line of least resistanc
25183 e which my poor friend had declared to be the starting-point of every investigat
25185 I confess that I made little progress.
25186 In the evening I strolled across the Park, and found myself about six o'clock
25187 at the Oxford Street end of Park Lane.
25188 A group of loafers upon the pavements, all staring up at a particular window,
25189 directed me to the house which I had come to see.
25190 A tall, thin man with coloured glasses, whom I strongly suspected of being
25191 a plain-clothes detective, was pointing out some theory of his own, while
25192 the others crowded round to listen to what he said.
25193 I got as near him as I could, but his observations seemed to me to be absurd,
25194 so I withdrew again in some disgust.
25195 As I did so I struck against an elderly, deformed man, who had been behind
25196 me, and I knocked down several books which he was carrying.
25204 \begin_layout Standard
25205 \begin_inset Note Greyedout
25208 \begin_layout Plain Layout
25213 The values you set with
25214 \begin_inset Flex Code
25217 \begin_layout Plain Layout
25225 will be used for all following multiple columns until you change them again.
25233 \begin_layout Standard
25237 \begin_layout Plain Layout
25249 \begin_inset Note Note
25252 \begin_layout Plain Layout
25253 go back to the default
25261 \begin_layout Standard
25262 \begin_inset Newpage newpage
25268 \begin_layout Subsubsection
25272 \begin_layout Standard
25273 A column break can be forced by inserting the command
25274 \begin_inset Flex Code
25277 \begin_layout Plain Layout
25285 as \SpecialChar TeX
25286 Code to that position in the text where the column should be broken.
25287 Note that this leads in most cases to whitespace in the text.
25288 \begin_inset Newline newline
25291 Here is an example:
25294 \begin_layout Standard
25295 \begin_inset Flex Multiple Columns
25298 \begin_layout Plain Layout
25301 \begin_inset Quotes eld
25304 You're surprised to see me, sir,
25305 \begin_inset Quotes erd
25308 said he, in a strange, croaking voice.
25311 \begin_layout Plain Layout
25314 I acknowledged that I was.
25317 \begin_layout Plain Layout
25320 \begin_inset Quotes eld
25323 Well, I've a conscience, sir, and when I chanced to see you go into this
25324 house, as I came hobbling after you, I thought to myself, I'll just step
25325 in and see that kind gentleman, and tell him that if I was a bit gruff
25326 in my manner there was not any harm meant, and that I am much obliged to
25327 him for picking up my books.
25328 \begin_inset Quotes erd
25334 \begin_layout Plain Layout
25337 \begin_inset Quotes eld
25340 You make too much of a trifle,
25341 \begin_inset Quotes erd
25346 \begin_inset Quotes eld
25349 May I ask how you knew who I was?
25350 \begin_inset Quotes erd
25353 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
25357 \begin_layout Plain Layout
25369 \begin_layout Plain Layout
25372 \begin_inset Quotes eld
25375 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25376 you'll find my little bookshop at the corner of Church Street, and very
25377 happy to see you, I am sure.
25378 Maybe you collect yourself, sir.
25382 \begin_inset space ~
25396 \begin_inset space ~
25399 – a bargain, every one of them.
25400 With five volumes you could just fill that gap on that second shelf.
25401 It looks untidy, does it not, sir?
25402 \begin_inset Quotes erd
25413 \begin_layout Subsubsection
25417 \begin_layout Standard
25418 The width of the columns is automatically calculated, but you can modify
25419 the space between the columns.
25420 This is done by changing the length
25421 \begin_inset Flex Code
25424 \begin_layout Plain Layout
25433 Its predefined value is 10
25434 \begin_inset space \thinspace{}
25438 Here is an example where
25439 \begin_inset Flex Code
25442 \begin_layout Plain Layout
25451 \begin_inset space \thinspace{}
25457 \begin_layout Standard
25461 \begin_layout Plain Layout
25475 \begin_layout Standard
25476 \begin_inset Flex Multiple Columns
25479 \begin_layout Plain Layout
25482 My observations of No.
25483 \begin_inset space \space{}
25486 427 Park Lane did little to clear up the problem in which I was interested.
25487 The house was separated from the street by a low wall and railing, the
25488 whole not more than five feet high.
25489 It was perfectly easy, therefore, for anyone to get into the garden, but
25490 the window was entirely inaccessible, since there was no water pipe or
25491 anything which could help the most active man to climb it.
25492 More puzzled than ever, I retraced my steps to Kensington.
25493 I had not been in my study five minutes when the maid entered to say that
25494 a person desired to see me.
25495 To my astonishment it was none other than my strange old book collector,
25496 his sharp, wizened face peering out from a frame of white hair, and his
25497 precious volumes, a dozen of them at least, wedged under his right arm.
25505 \begin_layout Standard
25509 \begin_layout Plain Layout
25521 \begin_inset Note Note
25524 \begin_layout Plain Layout
25525 go back to the default
25533 \begin_layout Subsubsection
25537 \begin_layout Standard
25538 Between the columns a rule with a width of the length
25539 \begin_inset Flex Code
25542 \begin_layout Plain Layout
25551 If this rule width is set to 0
25552 \begin_inset space \thinspace{}
25555 pt (this is the default), the rule is suppressed.
25556 In the following example the rule is 2
25557 \begin_inset space \thinspace{}
25563 \begin_layout Standard
25567 \begin_layout Plain Layout
25573 columnseprule}{2pt}
25581 \begin_layout Standard
25582 \begin_inset Flex Multiple Columns
25585 \begin_layout Plain Layout
25588 \begin_inset Quotes eld
25591 You're surprised to see me, sir,
25592 \begin_inset Quotes erd
25595 said he, in a strange, croaking voice.
25598 \begin_layout Plain Layout
25601 I acknowledged that I was.
25604 \begin_layout Plain Layout
25607 \begin_inset Quotes eld
25610 Well, I've a conscience, sir, and when I chanced to see you go into this
25611 house, as I came hobbling after you, I thought to myself, I'll just step
25612 in and see that kind gentleman, and tell him that if I was a bit gruff
25613 in my manner there was not any harm meant, and that I am much obliged to
25614 him for picking up my books.
25615 \begin_inset Quotes erd
25621 \begin_layout Plain Layout
25624 \begin_inset Quotes eld
25627 You make too much of a trifle,
25628 \begin_inset Quotes erd
25633 \begin_inset Quotes eld
25636 May I ask how you knew who I was?
25637 \begin_inset Quotes erd
25643 \begin_layout Plain Layout
25646 \begin_inset Quotes eld
25649 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25650 you'll find my little bookshop at the corner of Church Street, and very
25651 happy to see you, I am sure.
25652 Maybe you collect yourself, sir.
25656 \begin_inset space ~
25670 \begin_inset space ~
25673 – a bargain, every one of them.
25674 With five volumes you could just fill that gap on that second shelf.
25675 It looks untidy, does it not, sir?
25676 \begin_inset Quotes erd
25687 \begin_layout Standard
25688 \begin_inset VSpace defskip
25694 \begin_layout Standard
25695 The rule can be colored by redefining the command
25696 \begin_inset Flex Code
25699 \begin_layout Plain Layout
25708 This is done by inserting the command
25711 \begin_layout LyX-Code
25716 columnseprulecolor}{
25721 \begin_layout Standard
25722 as \SpecialChar TeX
25723 Code before the multicolumn inset.
25725 \begin_inset Flex Code
25728 \begin_layout Plain Layout
25734 in this command by a color of your choice.
25735 You can use all pre- and self-defined colors.
25743 \begin_inset space ~
25748 for more information about pre- and self-defined colors.
25749 To go back to the default color insert the command
25752 \begin_layout LyX-Code
25757 columnseprulecolor}{
25762 \begin_layout Standard
25763 Here is the example with a cyan rule and 1
25764 \begin_inset space \thinspace{}
25767 cm column separation:
25770 \begin_layout Standard
25774 \begin_layout Plain Layout
25783 \begin_layout Plain Layout
25789 columnseprulecolor}{
25799 \begin_layout Standard
25800 \begin_inset Flex Multiple Columns
25803 \begin_layout Plain Layout
25806 \begin_inset Quotes eld
25809 You're surprised to see me, sir,
25810 \begin_inset Quotes erd
25813 said he, in a strange, croaking voice.
25816 \begin_layout Plain Layout
25819 I acknowledged that I was.
25822 \begin_layout Plain Layout
25825 \begin_inset Quotes eld
25828 Well, I've a conscience, sir, and when I chanced to see you go into this
25829 house, as I came hobbling after you, I thought to myself, I'll just step
25830 in and see that kind gentleman, and tell him that if I was a bit gruff
25831 in my manner there was not any harm meant, and that I am much obliged to
25832 him for picking up my books.
25833 \begin_inset Quotes erd
25839 \begin_layout Plain Layout
25842 \begin_inset Quotes eld
25845 You make too much of a trifle,
25846 \begin_inset Quotes erd
25851 \begin_inset Quotes eld
25854 May I ask how you knew who I was?
25855 \begin_inset Quotes erd
25861 \begin_layout Plain Layout
25864 \begin_inset Quotes eld
25867 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25868 you'll find my little bookshop at the corner of Church Street, and very
25869 happy to see you, I am sure.
25870 Maybe you collect yourself, sir.
25874 \begin_inset space ~
25888 \begin_inset space ~
25891 – a bargain, every one of them.
25892 With five volumes you could just fill that gap on that second shelf.
25893 It looks untidy, does it not, sir?
25894 \begin_inset Quotes erd
25905 \begin_layout Standard
25909 \begin_layout Plain Layout
25915 columnseprule}{0pt}
25918 \begin_layout Plain Layout
25924 columnseprulecolor}{
25932 \begin_inset Note Note
25935 \begin_layout Plain Layout
25936 go back to the default
25944 \begin_layout Section
25945 Non-standard Paragraph Shapes
25948 \begin_layout Standard
25951 as well as any other text processor uses by default rectangular paragraphs.
25952 For special cases like for example posters, invitation cards or poems you
25953 can modify the paragraph shape to one of your choice.
25954 This can be done by using the \SpecialChar LaTeX
25956 \begin_inset Flex Code
25959 \begin_layout Plain Layout
25965 which is loaded by using in the document settings the module
25967 Custom paragraph shapes
25972 \begin_layout Subsection
25976 \begin_layout Standard
25981 provides the following shapes:
25984 \begin_layout Standard
25985 \begin_inset Tabular
25986 <lyxtabular version="3" rows="13" columns="3">
25987 <features booktabs="true" islongtable="true" longtabularalignment="center">
25988 <column alignment="left" valignment="middle" width="16col%">
25989 <column alignment="left" valignment="middle" width="40col%">
25990 <column alignment="left" valignment="middle" width="35col%">
25991 <row endhead="true">
25992 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25995 \begin_layout Plain Layout
26004 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26007 \begin_layout Plain Layout
26016 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26019 \begin_layout Plain Layout
26029 <row interlinespace="default">
26030 <cell alignment="left" valignment="top" usebox="none">
26033 \begin_layout Plain Layout
26041 <cell alignment="left" valignment="top" usebox="none">
26044 \begin_layout Plain Layout
26047 Circle with circular hole (in the size of a CD/DVD)
26052 <cell alignment="left" valignment="top" usebox="none">
26055 \begin_layout Plain Layout
26058 Cannot be scaled, take care there is not too much text
26064 <row interlinespace="default">
26065 <cell alignment="left" valignment="top" usebox="none">
26068 \begin_layout Plain Layout
26076 <cell alignment="left" valignment="top" usebox="none">
26079 \begin_layout Plain Layout
26087 <cell alignment="left" valignment="top" usebox="none">
26090 \begin_layout Plain Layout
26093 Fragile, calculation might fail
26099 <row interlinespace="default">
26100 <cell alignment="left" valignment="top" usebox="none">
26103 \begin_layout Plain Layout
26111 <cell alignment="left" valignment="top" usebox="none">
26114 \begin_layout Plain Layout
26117 Rhomboid (symbolizing a
26118 \begin_inset Quotes eld
26122 \begin_inset Quotes erd
26130 <cell alignment="left" valignment="top" usebox="none">
26133 \begin_layout Plain Layout
26142 <row interlinespace="default">
26143 <cell alignment="left" valignment="top" usebox="none">
26146 \begin_layout Plain Layout
26154 <cell alignment="left" valignment="top" usebox="none">
26157 \begin_layout Plain Layout
26165 <cell alignment="left" valignment="top" usebox="none">
26168 \begin_layout Plain Layout
26177 <row interlinespace="default">
26178 <cell alignment="left" valignment="top" usebox="none">
26181 \begin_layout Plain Layout
26189 <cell alignment="left" valignment="top" usebox="none">
26192 \begin_layout Plain Layout
26200 <cell alignment="left" valignment="top" usebox="none">
26203 \begin_layout Plain Layout
26212 <row interlinespace="default">
26213 <cell alignment="left" valignment="top" usebox="none">
26216 \begin_layout Plain Layout
26224 <cell alignment="left" valignment="top" usebox="none">
26227 \begin_layout Plain Layout
26230 Nut for bolt (hexagon with circular hole)
26235 <cell alignment="left" valignment="top" usebox="none">
26238 \begin_layout Plain Layout
26247 <row interlinespace="default">
26248 <cell alignment="left" valignment="top" usebox="none">
26251 \begin_layout Plain Layout
26259 <cell alignment="left" valignment="top" usebox="none">
26262 \begin_layout Plain Layout
26270 <cell alignment="left" valignment="top" usebox="none">
26273 \begin_layout Plain Layout
26282 <row interlinespace="default">
26283 <cell alignment="left" valignment="top" usebox="none">
26286 \begin_layout Plain Layout
26294 <cell alignment="left" valignment="top" usebox="none">
26297 \begin_layout Plain Layout
26305 <cell alignment="left" valignment="top" usebox="none">
26308 \begin_layout Plain Layout
26317 <row interlinespace="default">
26318 <cell alignment="left" valignment="top" usebox="none">
26321 \begin_layout Plain Layout
26329 <cell alignment="left" valignment="top" usebox="none">
26332 \begin_layout Plain Layout
26340 <cell alignment="left" valignment="top" usebox="none">
26343 \begin_layout Plain Layout
26352 <row interlinespace="default">
26353 <cell alignment="left" valignment="top" usebox="none">
26356 \begin_layout Plain Layout
26364 <cell alignment="left" valignment="top" usebox="none">
26367 \begin_layout Plain Layout
26370 Normal/reversed rain drop
26375 <cell alignment="left" valignment="top" usebox="none">
26378 \begin_layout Plain Layout
26381 Fragile, calculation might fail
26387 <row interlinespace="default">
26388 <cell alignment="left" valignment="top" usebox="none">
26391 \begin_layout Plain Layout
26400 <cell alignment="left" valignment="top" usebox="none">
26403 \begin_layout Plain Layout
26406 The \SpecialChar TeX
26412 <cell alignment="left" valignment="top" usebox="none">
26415 \begin_layout Plain Layout
26424 <row interlinespace="default">
26425 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
26428 \begin_layout Plain Layout
26432 \begin_inset Newline newline
26440 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
26443 \begin_layout Plain Layout
26446 Triangles in different orientations
26451 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
26454 \begin_layout Plain Layout
26470 \begin_layout Standard
26471 To use a shape for your paragraph, simply select it in \SpecialChar LyX
26473 for environments in the toolbar.
26476 \begin_layout Standard
26477 \begin_inset Newpage newpage
26483 \begin_layout Standard
26484 Here is an example paragraph in the shape of a nut:
26487 \begin_layout Standard
26488 \begin_inset VSpace bigskip
26497 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26498 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26500 At vero eos et accusam et justo duo dolores et ea rebum.
26501 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26503 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26504 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26508 \begin_layout Standard
26509 \begin_inset VSpace bigskip
26515 \begin_layout Standard
26516 \begin_inset Note Greyedout
26519 \begin_layout Plain Layout
26528 paragraphs cannot run over a page break.
26536 \begin_layout Standard
26537 \begin_inset VSpace bigskip
26543 \begin_layout Standard
26545 \begin_inset Flex Code
26548 \begin_layout Plain Layout
26554 takes care that the shape will always be preserved, no matter how much
26555 text is in the paragraph.
26556 Therefore the paragraph size changes with the amount of contained text.
26557 This can lead to paragraph sizes exceeding the page margins.
26558 To demonstrate the size scaling, here is the same example paragraph but
26559 with twice as much text:
26562 \begin_layout Standard
26563 \begin_inset Newpage newpage
26572 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26573 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26575 At vero eos et accusam et justo duo dolores et ea rebum.
26576 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26578 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26579 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26581 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26582 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26584 At vero eos et accusam et justo duo dolores et ea rebum.
26585 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26587 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26588 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26592 \begin_layout Standard
26593 \begin_inset VSpace bigskip
26599 \begin_layout Standard
26600 An exception is the shape
26605 It cannot be scaled because it must fit the size of a CD/DVD.
26606 Therefore the amount of text that fits into the shape is limited.
26607 \begin_inset Newline newline
26618 shape are fragile, meaning that the calculation of their size can fail,
26619 depending on the amount of text.
26620 You will then get the \SpecialChar LaTeX
26622 \begin_inset Quotes eld
26625 Arithmetic overflow
26626 \begin_inset Quotes erd
26630 In this case one can try to remove or add some text; if nothing works one
26631 has to use another shape.
26634 \begin_layout Standard
26635 \begin_inset VSpace bigskip
26641 \begin_layout Standard
26642 For shapes with tips you will maybe see that \SpecialChar LaTeX
26643 's hyphenation routine fails
26644 for text in the tips.
26645 Therefore it is often necessary to add hyphenation points
26650 arg "specialchar-insert hyphenation"
26655 ) to the corresponding text parts.
26658 \begin_layout Standard
26659 \begin_inset VSpace bigskip
26665 \begin_layout Standard
26666 Shapepar paragraphs are either always centered or placed on the page so
26667 that their left border touches the left page margin.
26668 You can therefore not use the paragraph dialog to align such paragraphs.
26669 A solution is to put the paragraph into a minipage or parbox and align
26671 The problem is hereby to find the right width for the box.
26672 Because if it is too wide and you center the box, the paragraph is not
26673 centered too because it sticks at the left side of the box.
26674 So you might have to play a bit with the width until it fits.
26675 Here are two heart-shaped paragraphs, the first one is not aligned, the
26676 second one is right-aligned:
26679 \begin_layout Standard
26680 \begin_inset Newpage newpage
26686 \begin_layout Heart
26690 Lo\SpecialChar softhyphen
26691 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26692 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26694 At vero eos et accusam et justo duo dolores et ea rebum.
26695 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26699 \begin_layout Standard
26700 \begin_inset VSpace bigskip
26706 \begin_layout Standard
26709 \begin_inset Box Frameless
26719 height_special "totalheight"
26724 backgroundcolor "none"
26727 \begin_layout Heart
26731 Lo\SpecialChar softhyphen
26732 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26733 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26735 At vero eos et accusam et justo duo dolores et ea rebum.
26736 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26745 \begin_layout Subsection
26749 \begin_layout Standard
26750 You can define any shape you want.
26751 Doing this manually is a lot of work because every coordinate must be specified.
26752 But there is a way to let the computer calculate the coordinates:
26755 \begin_layout Enumerate
26756 Install the program
26757 \begin_inset CommandInset href
26760 target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
26768 \begin_layout Enumerate
26775 TeX/LaTeX\SpecialChar menuseparator
26776 Settings\SpecialChar menuseparator
26779 and select the font size you are using in your document.
26780 For example this document uses the size 12
26781 \begin_inset space \thinspace{}
26787 \begin_layout Enumerate
26791 \begin_layout Enumerate
26794 TeX/LaTeX\SpecialChar menuseparator
26797 to export the shape to coordinates.
26798 In the appearing dialog use either the outline of your shape for the coordinate
26799 s or the path itself.
26803 \begin_layout Plain Layout
26804 For more information see
26805 \begin_inset CommandInset href
26807 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
26820 \begin_layout Standard
26821 The coordinates are written into a \SpecialChar TeX
26823 To use it for your \SpecialChar LyX
26827 \begin_layout Enumerate
26828 Place the cursor before the first character of your paragraph (or into a
26832 \begin_layout Enumerate
26833 Open in \SpecialChar LyX
26836 Insert\SpecialChar menuseparator
26837 File\SpecialChar menuseparator
26839 \begin_inset space ~
26844 , select the file and use
26853 \begin_layout Standard
26854 \begin_inset VSpace defskip
26860 \begin_layout Standard
26861 \begin_inset Note Greyedout
26864 \begin_layout Plain Layout
26869 : The changed shape only applies to the current paragraph; everything is
26870 reset to normal for the next paragraph.
26871 Therefore the shape definition file must be input into every paragraph
26872 with the desired shape.
26880 \begin_layout Standard
26881 \begin_inset VSpace bigskip
26887 \begin_layout Standard
26888 Here is an example:
26891 \begin_layout Standard
26892 \begin_inset VSpace bigskip
26898 \begin_layout Standard
26899 \begin_inset CommandInset include
26901 filename "SpecialParagraphShape.tex"
26908 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26909 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26911 At vero eos et accusam et justo duo dolores et ea rebum.
26912 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26914 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26915 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26919 \begin_layout Standard
26920 \begin_inset VSpace bigskip
26926 \begin_layout Standard
26931 to draw complexer shapes in
26935 you can draw the shape in a program of your choice and import the resulting
26941 Then you only need to draw a line or spline along the outline of the image.
26944 \begin_layout Standard
26945 \begin_inset VSpace bigskip
26951 \begin_layout Standard
26954 Custom paragraph shapes
26956 also provides the two commands
26964 which can be used to define custom shapes coordinate by coordinate.
26968 \begin_layout Plain Layout
26969 These commands are internally used for all shapes described here.
26974 For information how these styles are used and about further customization
26975 possibilities, have a look at the
26976 \begin_inset CommandInset href
26978 name "documentation"
26979 target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
26985 \begin_inset Flex Code
26988 \begin_layout Plain Layout