1 #LyX 2.3 created this file. For more info see http://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 false
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
53 \font_sf_scale 100 100
54 \font_tt_scale 100 100
56 \use_dash_ligatures true
58 \default_output_format pdf2
60 \bibtex_command default
61 \index_command default
65 \pdf_title "LyX's Additional Features manual"
66 \pdf_author "LyX Team"
67 \pdf_subject "LyX's additional features documentation"
68 \pdf_keywords "LyX, Documentation, Additional"
70 \pdf_bookmarksnumbered true
71 \pdf_bookmarksopen false
72 \pdf_bookmarksopenlevel 1
77 \pdf_pdfusetitle false
78 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
81 \use_package amsmath 1
82 \use_package amssymb 1
85 \use_package mathdots 1
86 \use_package mathtools 0
88 \use_package stackrel 0
89 \use_package stmaryrd 0
90 \use_package undertilde 0
92 \cite_engine_type default
96 \paperorientation portrait
101 \notefontcolor #0000ff
108 \paragraph_separation indent
109 \paragraph_indentation default
111 \math_indentation default
112 \math_numbering_side default
113 \quotes_style english
117 \paperpagestyle headings
118 \tracking_changes true
119 \output_changes false
123 \author -712698321 "Jürgen Spitzmüller"
129 Additional \SpecialChar LyX
133 \begin_layout Subtitle
138 by the \SpecialChar LyX
143 \begin_layout Plain Layout
145 Principal maintainer of this file is
150 If you have comments or error corrections, please send them to the \SpecialChar LyX
153 \begin_inset Flex Code
156 \begin_layout Plain Layout
158 <lyx-docs@lists.lyx.org>
171 \begin_layout Standard
172 \begin_inset CommandInset toc
173 LatexCommand tableofcontents
180 \begin_layout Chapter
184 \begin_layout Standard
185 This manual is essentially Part II of the
187 User's Guide\SpecialChar endofsentence
190 The reason for separating the two documents is simple: the
194 is already quite lengthy, and it contains information on all of the basic
195 features one needs to know in order to prepare most documents.
196 However, the \SpecialChar LyX
197 Team has worked to make \SpecialChar LyX
198 extensible through various configuration
199 files and external packages.
200 That means that if you want to support the Fizzwizzle \SpecialChar LaTeX
202 create a layout file (or module) for it without having to alter \SpecialChar LyX
204 We've already had contributions of several new features this way, and some
205 of them are documented here.
206 There are also some more `advanced' features, such as how to control the
207 presentation of bibliographies and how to work with multi-part documents,
208 that are not covered in the
212 and are discussed here.
215 \begin_layout Standard
216 This manual also documents some special features, like fax support, version
217 control, and SGML support, which require additional software to work properly.
218 There is also a chapter on \SpecialChar LyX
220 And lastly, there's a chapter of \SpecialChar LaTeX
221 tools and tips, things you can use to
222 spruce up your documents by directly using the powerful features of \SpecialChar LaTeX
224 After all, \SpecialChar LyX
229 only WYSIWYM and will only ever interface to some, not all, \SpecialChar LaTeX
233 \begin_layout Standard
234 If you haven't read the
238 yet, you are definitely in the wrong manual.
243 is the first place to go, since it describes the notation and format of
245 You should also be thoroughly familiar with the
249 and all of the basic features of \SpecialChar LyX
250 before attempting to read this one.
253 \begin_layout Standard
254 Since many of the topics in this manual depend heavily on \SpecialChar LyX
256 with \SpecialChar LaTeX
257 , this first chapter covers the inner workings of \SpecialChar LyX
260 to generate exactly the \SpecialChar LaTeX
262 It is obviously for more seasoned \SpecialChar LyX
266 \begin_layout Chapter
268 and \SpecialChar LaTeX
272 \begin_layout Section
274 Uses \SpecialChar LaTeX
278 \begin_layout Standard
279 This chapter is for both \SpecialChar TeX
280 -nicians and the \SpecialChar LaTeX
282 In it, we'll explain how \SpecialChar LyX
283 and \SpecialChar LaTeX
284 work together to produce printable output.
285 This is the only place in any of the manuals where we assume you know something
286 about \SpecialChar LaTeX
290 \begin_layout Standard
291 At one time, \SpecialChar LyX
293 \begin_inset Quotes eld
296 WYSIWYM frontend to \SpecialChar LaTeX
298 \begin_inset Quotes erd
301 but that's no longer true.
302 There are frontends to \SpecialChar LaTeX
307 \begin_layout Plain Layout
308 Some familar ones are \SpecialChar TeX
309 maker and kile, on Linux, and \SpecialChar TeX
311 There are also the \SpecialChar LaTeX
312 modes for vi and emacs, of course.
317 These are basically text editors with the ability to run \SpecialChar LaTeX
319 errors in the file you're editing.
320 Although \SpecialChar LyX
329 run \SpecialChar LaTeX
330 , and it also indicates errors in the file, it also does much, much
332 For one thing, you don't need to know \SpecialChar LaTeX
333 to use \SpecialChar LyX
336 has added its own extensions to \SpecialChar LaTeX
338 Try the following sometime: select
339 \begin_inset Flex Noun
342 \begin_layout Plain Layout
343 Export\SpecialChar menuseparator
350 \begin_inset Flex Noun
353 \begin_layout Plain Layout
360 \begin_inset Flex Noun
363 \begin_layout Plain Layout
364 View\SpecialChar menuseparator
374 ), then look at the preamble of the resulting
375 \begin_inset Flex Code
378 \begin_layout Plain Layout
385 You'll notice a variety of new macros defined specifically by \SpecialChar LyX
387 These macros are defined automatically, according to the features you use
391 \begin_layout Standard
392 There are several commands that automatically invoke \SpecialChar LaTeX
397 \begin_layout Itemize
398 \begin_inset Flex Noun
401 \begin_layout Plain Layout
402 Document\SpecialChar menuseparator
411 \begin_layout Itemize
412 \begin_inset Flex Noun
415 \begin_layout Plain Layout
416 Document\SpecialChar menuseparator
425 \begin_layout Standard
426 They will only invoke \SpecialChar LaTeX
427 if the file has changed since the last time \SpecialChar LaTeX
433 \begin_layout Standard
434 When \SpecialChar LyX
435 runs \SpecialChar LaTeX
436 on the file you're editing, it performs these steps:
439 \begin_layout Enumerate
440 Convert the document to \SpecialChar LaTeX
441 and save to a file with the extension
442 \begin_inset Flex Code
445 \begin_layout Plain Layout
452 \begin_inset Flex Code
455 \begin_layout Plain Layout
464 \begin_layout Enumerate
465 Run \SpecialChar LaTeX
467 \begin_inset Flex Code
470 \begin_layout Plain Layout
476 file (maybe several times), and run any other commands (such as
477 \begin_inset Flex Code
480 \begin_layout Plain Layout
487 \begin_inset Flex Code
490 \begin_layout Plain Layout
496 ) needed to compile the \SpecialChar LaTeX
500 \begin_layout Enumerate
501 If there are any errors, show the error log.
504 \begin_layout Standard
505 If you have run \SpecialChar LaTeX
507 \begin_inset Flex Noun
510 \begin_layout Plain Layout
511 View\SpecialChar menuseparator
518 then runs a DVI viewer to display the DVI-file.
520 \begin_inset Flex Noun
523 \begin_layout Plain Layout
524 View\SpecialChar menuseparator
531 performs further steps:
534 \begin_layout Itemize
536 \begin_inset Flex Code
539 \begin_layout Plain Layout
545 to convert the DVI file to PostScript.
548 \begin_layout Itemize
549 Run a PostScript viewer, such as
550 \begin_inset Flex Code
553 \begin_layout Plain Layout
559 , to display the PostScript file.
562 \begin_layout Standard
564 does similar things when viewing, or exporting, other formats.
567 \begin_layout Section
568 Translating \SpecialChar LaTeX
569 files into \SpecialChar LyX
573 \begin_layout Standard
574 You can import a \SpecialChar LaTeX
575 file into \SpecialChar LyX
577 \begin_inset Flex Noun
580 \begin_layout Plain Layout
581 File\SpecialChar menuseparator
582 Import\SpecialChar menuseparator
588 command in \SpecialChar LyX
590 This will call a program named
591 \begin_inset Flex Code
594 \begin_layout Plain Layout
600 which will create a file
601 \begin_inset Flex Code
604 \begin_layout Plain Layout
611 \begin_inset Flex Code
614 \begin_layout Plain Layout
622 will then open that file.
626 \begin_layout Plain Layout
627 \begin_inset Flex Code
630 \begin_layout Plain Layout
636 can also be run from the command line, of course.
644 \begin_layout Standard
645 \begin_inset Flex Code
648 \begin_layout Plain Layout
654 will translate most legal \SpecialChar LaTeX
655 , but not everything.
656 It will put things it doesn't understand into \SpecialChar TeX
657 code, so after translating
659 \begin_inset Flex Code
662 \begin_layout Plain Layout
668 , you can look for \SpecialChar TeX
669 code and hand-edit it until it looks right.
672 \begin_layout Standard
673 If you don't know what \SpecialChar TeX
674 code is, read the next section.
677 \begin_layout Section
678 \begin_inset CommandInset label
680 name "sec:Inserting-TeX-Code"
684 Inserting \SpecialChar TeX
685 Code into \SpecialChar LyX
689 \begin_layout Standard
690 Anything you can do in \SpecialChar LaTeX
691 you can do in \SpecialChar LyX
692 , for a very simple reason: You can
693 always insert \SpecialChar TeX
694 code into any \SpecialChar LyX
697 cannot, and will never be able to, display every possible \SpecialChar LaTeX
699 If ever you need to insert \SpecialChar LaTeX
700 commands into your \SpecialChar LyX
701 document, you can use the
703 \begin_inset Flex Code
706 \begin_layout Plain Layout
713 box, which you can insert into your document with
714 \begin_inset Flex Noun
717 \begin_layout Plain Layout
718 Insert\SpecialChar menuseparator
728 or the keyboard shortcut
737 \begin_layout Standard
738 Here's an example of inserting \SpecialChar LaTeX
739 commands in a \SpecialChar LyX
741 The code looks like this:
744 \begin_layout LyX-Code
748 \begin_inset Newline newline
754 \begin_inset Newline newline
757 This is an example of a minipage environment.
759 \begin_inset Newline newline
762 can put nearly everything in it, even (non-floating)
763 \begin_inset Newline newline
768 \begin_inset Newline newline
774 \begin_inset Newline newline
778 \begin_inset Newline newline
784 \begin_inset Newline newline
790 \begin_inset Newline newline
796 \begin_inset Newline newline
801 \begin_inset Newline newline
807 \begin_inset Newline newline
813 \begin_inset Newline newline
819 \begin_inset Newline newline
827 \begin_layout LyX-Code
831 \begin_layout Standard
833 \begin_inset Flex Code
836 \begin_layout Plain Layout
843 box containing this text is directly after this paragraph.
844 Those of you reading the manual in \SpecialChar LyX
845 will only see the \SpecialChar TeX
847 Those reading a printed version of the manuals will see the actual results:
848 \begin_inset VSpace bigskip
854 \begin_layout Standard
858 \begin_layout Plain Layout
865 \begin_layout Plain Layout
872 \begin_layout Plain Layout
874 This is an example of a minipage environment.
875 You can put nearly everything in it, even (non-floating) figures and tables.
879 \begin_layout Plain Layout
886 \begin_layout Plain Layout
891 \begin_layout Plain Layout
898 \begin_layout Plain Layout
905 \begin_layout Plain Layout
912 \begin_layout Plain Layout
918 \begin_layout Plain Layout
925 \begin_layout Plain Layout
932 \begin_layout Plain Layout
939 \begin_layout Plain Layout
949 \begin_inset VSpace bigskip
955 \begin_layout Standard
956 In addition to using \SpecialChar TeX
957 code, you can also create a separate file containing
958 some complex \SpecialChar LaTeX
959 structure and then use
960 \begin_inset Flex Noun
963 \begin_layout Plain Layout
964 Insert\SpecialChar menuseparator
974 to include your file (you should select the type
975 \begin_inset Flex Code
978 \begin_layout Plain Layout
985 We recommend that you only do this if you have a
986 \begin_inset Flex Code
989 \begin_layout Plain Layout
1000 Otherwise, you'll have a big job tracking down \SpecialChar LaTeX
1004 \begin_layout Standard
1005 There are a few last points to emphasize:
1008 \begin_layout Itemize
1014 check if your \SpecialChar LaTeX
1018 \begin_layout Itemize
1019 Beware of reinventing the wheel.
1022 \begin_layout Standard
1023 On that last point, \SpecialChar LyX
1024 does have quite a few features tucked into it, and
1026 Be sure to check the manuals to make sure that \SpecialChar LyX
1027 doesn't have such-and-such
1028 feature before you decide you have to do it by hand.
1029 Moreover, there are numerous \SpecialChar LaTeX
1030 packages out there to do all sorts of things,
1031 from labels to envelopes to fancy multipage tables.
1033 \begin_inset CommandInset href
1036 target "http://www.ctan.org/"
1044 \begin_layout Standard
1045 If you do need to do some wild and fancy things within your document, be
1046 sure to check out a good \SpecialChar LaTeX
1047 book for assistance.
1048 There are a number of them listed in the bibliography of the
1055 \begin_layout Section
1057 and the \SpecialChar LaTeX
1061 \begin_layout Subsection
1062 About the \SpecialChar LaTeX
1066 \begin_layout Standard
1067 If you already know \SpecialChar LaTeX
1068 , there is no need to explain here what the preamble
1070 If you don't, the following will give you some ideas—we recommend again
1071 that you consult a \SpecialChar LaTeX
1072 book for further information.
1073 In any case, you should read the points below, because they explain what
1074 you can do and what you don't need to do in the \SpecialChar LaTeX
1075 preamble of a \SpecialChar LyX
1079 \begin_layout Standard
1080 The \SpecialChar LaTeX
1081 preamble comes at the very beginning of a document,
1089 \begin_layout Itemize
1090 Declare the document class.
1092 \begin_inset Newline newline
1096 already does this for you.
1097 If you're a seasoned \SpecialChar LaTeX
1098 -nician, and you have a custom document class you
1099 want to use, check out the
1101 Customization Manual
1103 for information on how to make \SpecialChar LyX
1107 \begin_layout Itemize
1108 Declare the usage of packages.
1110 \begin_inset Newline newline
1114 packages provide special commands, which are only available within a document
1115 when the package has been declared in the preamble.
1116 In addition to providing special commands, the inclusion of a package can
1117 change the document.
1118 For example, the package
1119 \begin_inset Flex Code
1122 \begin_layout Plain Layout
1128 forces all paragraphs to be indented.
1129 There are other packages for labels, envelopes, margins, etc.
1133 \begin_layout Itemize
1134 Set counters, variables, lengths and widths.
1136 \begin_inset Newline newline
1139 There are several \SpecialChar LaTeX
1140 counters and variables that
1144 be set globally from within the preamble in order to have the desired effect.
1145 (There are variables that you can set and reset inside the document, too.)
1146 Margins are a good example of something that must be set in the preamble.
1147 Another example is the label format for lists.
1148 You can actually set these just about anywhere, but it's best to do it
1149 just once, inside the preamble.
1152 \begin_layout Itemize
1153 Declare user defined commands (with
1154 \begin_inset Flex Code
1157 \begin_layout Plain Layout
1166 \begin_inset Flex Code
1169 \begin_layout Plain Layout
1178 \begin_inset Newline newline
1181 These are abbreviations for \SpecialChar LaTeX
1182 commands which appear very often inside a document.
1183 Although the preamble is a good place to declare such commands, they
1187 be declared anywhere (before they are used for the first time, of course).
1188 This can be useful if there is a lot of raw \SpecialChar LaTeX
1189 code in your document, which
1190 normally should not be the case.
1193 \begin_layout Standard
1195 adds its own set of definitions to the preamble of the
1196 \begin_inset Flex Code
1199 \begin_layout Plain Layout
1206 This makes \SpecialChar LaTeX
1207 files generated by \SpecialChar LyX
1211 \begin_layout Subsection
1212 Changing the Preamble
1215 \begin_layout Standard
1216 The commands which \SpecialChar LyX
1217 adds to the preamble of a \SpecialChar LaTeX
1218 file are fixed; you can't
1219 change them without patching \SpecialChar LyX
1221 You can, however, add your own stuff to the preamble by selecting
1222 \begin_inset Flex Noun
1225 \begin_layout Plain Layout
1228 \begin_inset space ~
1237 \begin_inset Flex Noun
1240 \begin_layout Plain Layout
1241 Document\SpecialChar menuseparator
1249 adds anything in the
1250 \begin_inset Flex Noun
1253 \begin_layout Plain Layout
1259 dialog to its own built-in preamble.
1260 Before adding your own declarations in the preamble, you should make sure
1261 that \SpecialChar LyX
1262 doesn't already support what you want to do.
1263 (Remember what we said about reinventing the wheel?) Also,
1265 make sure your preamble code is correct
1269 doesn't check it for you.
1270 If there is an error, you're likely to get an error like
1271 \begin_inset Quotes eld
1275 \begin_inset Flex Code
1278 \begin_layout Plain Layout
1287 \begin_inset Quotes erd
1291 If you see this error, check your preamble.
1294 \begin_layout Subsection
1298 \begin_layout Standard
1299 Here are some examples of what you can add to a preamble, and what they
1303 \begin_layout Subsubsection
1307 \begin_layout Standard
1308 There are two variables under \SpecialChar LaTeX
1309 that control page position:
1310 \begin_inset Flex Code
1313 \begin_layout Plain Layout
1322 \begin_inset Flex Code
1325 \begin_layout Plain Layout
1334 Their names should be self-explanatory.
1335 These variables are useful if you think for a moment about computer labels.
1336 Sometimes, the size of a print medium and the area of the medium that you
1337 can actually print on aren't the same.
1339 \begin_inset Flex Code
1342 \begin_layout Plain Layout
1351 \begin_inset Flex Code
1354 \begin_layout Plain Layout
1365 \begin_layout Standard
1366 The default values for
1367 \begin_inset Flex Code
1370 \begin_layout Plain Layout
1379 \begin_inset Flex Code
1382 \begin_layout Plain Layout
1391 \begin_inset space \thinspace{}
1395 \begin_inset space \thinspace{}
1399 \begin_inset space \space{}
1402 the page isn't shifted.
1403 Unfortunately, some DVI drivers always seem to shift the page.
1404 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1405 If you're using \SpecialChar LyX
1406 on a system that you don't personally maintain, and your
1407 sysadmin is a doofus,
1408 \begin_inset Flex Code
1411 \begin_layout Plain Layout
1420 \begin_inset Flex Code
1423 \begin_layout Plain Layout
1432 Suppose your left and top margins are always 0.5
1433 \begin_inset space \thinspace{}
1437 You can add this to the preamble:
1440 \begin_layout LyX-Code
1448 \begin_layout LyX-Code
1456 \begin_layout Standard
1457 and your margins should now be correct.
1460 \begin_layout Subsubsection
1464 \begin_layout Standard
1465 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1466 There's a rather nice package, available at your nearest CTAN archive,
1467 for printing sheets of labels:
1468 \begin_inset Flex Code
1471 \begin_layout Plain Layout
1478 Now, your system may not have this package installed by default.
1479 We leave that up to you to check.
1480 You'll also want to read the documentation for it; we're not going to do
1482 Since this is an example, however, we'll give you an example of how you
1486 \begin_layout Standard
1487 First, make sure you're using the
1488 \begin_inset Flex Code
1491 \begin_layout Plain Layout
1498 Next, you need to put the following in your preamble:
1501 \begin_layout LyX-Code
1507 \begin_layout LyX-Code
1513 \begin_layout LyX-Code
1519 \begin_layout LyX-Code
1525 \begin_layout LyX-Code
1531 \begin_layout LyX-Code
1537 \begin_layout LyX-Code
1543 \begin_layout Standard
1544 This sets things up for Avery label sheets, stock #5360.
1545 You're now ready to print labels, but you'll need to insert \SpecialChar LaTeX
1548 \begin_inset Flex Code
1551 \begin_layout Plain Layout
1560 \begin_inset Flex Code
1563 \begin_layout Plain Layout
1571 around each label text.
1572 This and other special features of
1573 \begin_inset Flex Code
1576 \begin_layout Plain Layout
1582 are explained in its documentation.
1585 \begin_layout Standard
1586 Someday, someone may write a \SpecialChar LyX
1587 layout file to support this package directly.
1588 Maybe that someone is you.
1591 \begin_layout Subsubsection
1592 Example #3: Paragraph Indentation
1595 \begin_layout Standard
1596 Americans are trained to indent the first line of
1601 As with all of their other weird quirks, most Americans will whine and
1602 moan until they can have their way and indent the first line of all paragraphs.
1611 \begin_layout Standard
1612 Of course, this behavior isn't standard typography.
1613 In books, you typically only indent the first line of a paragraph
1617 it follows another one.
1618 The idea behind indenting the first line of a paragraph is to distinguish
1619 neighboring paragraphs from one another.
1620 If there is no previous paragraph—for example, if it follows a figure or
1621 is the first paragraph in a section—then there is no need for indentation.
1625 \begin_layout Standard
1626 If you're a typical American (we're still joking!), though, you don't care
1627 about such esoteric things; you want your indentation! Add this to the
1631 \begin_layout LyX-Code
1634 usepackage{indentfirst}
1637 \begin_layout Standard
1638 If your \SpecialChar TeX
1639 distribution isn't braindead, you'll have this package, and all
1640 of your paragraphs will get the indentation the Founding Fathers intended
1644 \begin_layout Subsubsection
1645 Example #4: This Document
1648 \begin_layout Standard
1649 You can also check out the preamble of this document to get an idea of some
1650 of the advanced things you can do.
1653 \begin_layout Section
1655 and \SpecialChar LaTeX
1659 \begin_layout Standard
1660 When \SpecialChar LyX
1661 calls \SpecialChar LaTeX
1662 , it tells \SpecialChar LaTeX
1663 to blithely ignore any errors and keep going.
1664 It then uses the logfile from the \SpecialChar LaTeX
1665 run to do a post-mortem.
1666 After analyzing the logfile, \SpecialChar LyX
1667 displays a dialog listing the errors.
1668 Clicking on any one of them will take you to the position in your \SpecialChar LyX
1670 where the error occurred.
1674 \begin_layout Plain Layout
1676 Analyzing the logfile is a tough job, and \SpecialChar LyX
1677 doesn't always go to the right
1679 There are also cases where \SpecialChar LaTeX
1680 reports the error on one line, but the actual
1682 This is not unlike forgetting a closing brace in a program: You'll get
1683 an error, but only later.
1691 \begin_layout Standard
1692 Some folks also like to look at the log file directly: It is available from
1694 \begin_inset Flex Noun
1697 \begin_layout Plain Layout
1698 Document\SpecialChar menuseparator
1700 \begin_inset space ~
1709 There are some fairly common error messages and warnings.
1710 We'll cover those here.
1711 You should look at a good \SpecialChar LaTeX
1712 book for a complete listing.
1715 \begin_layout Itemize
1716 \begin_inset Flex Code
1719 \begin_layout Plain Layout
1726 \begin_inset Newline newline
1729 Anything beginning with these words is a warning message for the purpose
1731 \begin_inset Quotes eld
1735 \begin_inset Quotes erd
1738 the \SpecialChar LaTeX
1740 You'll get messages like this if you added or changed cross-references
1741 or bibliography entries, in which case, \SpecialChar LaTeX
1742 is trying to tell you that you
1743 need to make another run.
1744 You can by-and-large ignore these.
1747 \begin_layout Itemize
1748 \begin_inset Flex Code
1751 \begin_layout Plain Layout
1758 \begin_inset Newline newline
1761 Another warning message, this time about fonts which \SpecialChar LaTeX
1763 The rest of the message will often say something about a replacement font
1764 that \SpecialChar LaTeX
1766 You can safely ignore these, too.
1769 \begin_layout Itemize
1770 \begin_inset Flex Code
1773 \begin_layout Plain Layout
1782 \begin_inset Newline newline
1791 They are warnings about lines that were too long and run past the right
1793 Almost always, this is unnoticeable in the final output.
1794 (It can be just a point or two.) Or, only one or two characters extend past
1797 seems to generate at least one of these messages for just about any document
1799 \begin_inset Newline newline
1802 You can ignore these messages.
1803 Your eyes will tell you if there's a problem with something that's too
1804 wide; just look at the output.
1808 \begin_layout Plain Layout
1809 You can also enable the `draft' option in
1810 \begin_inset Flex Noun
1813 \begin_layout Plain Layout
1814 Document\SpecialChar menuseparator
1820 , and then \SpecialChar LaTeX
1821 will draw a black box in the margin of lines that are overfull.
1829 \begin_layout Itemize
1830 \begin_inset Flex Code
1833 \begin_layout Plain Layout
1842 \begin_inset Newline newline
1845 Not quite as common as its cousin.
1847 seems to like to print lines that are a bit too wide as opposed to ones
1848 that are a bit too narrow.
1849 We have no idea why.
1852 \begin_layout Itemize
1853 \begin_inset Flex Code
1856 \begin_layout Plain Layout
1865 \begin_inset Flex Code
1868 \begin_layout Plain Layout
1877 \begin_inset Newline newline
1880 Warnings about troubles breaking the page.
1881 Once again, just look at the output.
1882 Your eyes will tell you where something has gone wrong.
1885 \begin_layout Itemize
1886 \begin_inset Flex Code
1889 \begin_layout Plain Layout
1891 \begin_inset Quotes els
1895 \begin_inset Quotes ers
1904 \begin_inset Newline newline
1908 \begin_inset Quotes eld
1912 \begin_inset Quotes erd
1915 isn't installed on this system.
1916 This usually appears because some package your document needs isn't installed.
1917 If you didn't touch the preamble or didn't use the
1918 \begin_inset Flex Code
1921 \begin_layout Plain Layout
1929 command, then one of the packages \SpecialChar LyX
1930 tried to load is missing.
1932 \begin_inset Flex Noun
1935 \begin_layout Plain Layout
1936 Help\SpecialChar menuseparator
1943 to get a list of packages that \SpecialChar LyX
1945 This file is updated whenever you reconfigure \SpecialChar LyX
1947 \begin_inset Flex Noun
1950 \begin_layout Plain Layout
1951 Tools\SpecialChar menuseparator
1957 ) and tells you which packages have been detected and what they do.
1958 \begin_inset Newline newline
1962 \begin_inset Flex Code
1965 \begin_layout Plain Layout
1973 command and the package in question isn't installed, then you'll need to
1974 install it yourself.
1977 \begin_layout Itemize
1978 \begin_inset Flex Code
1981 \begin_layout Plain Layout
1982 LaTeX Error: Unknown option
1988 \begin_inset Newline newline
1991 Error messages beginning with this are trying to tell you that you specified
1992 a bad or undefined option to a package.
1993 Check the package's documentation.
1996 \begin_layout Itemize
1997 \begin_inset Flex Code
2000 \begin_layout Plain Layout
2001 Undefined control sequence
2007 \begin_inset Newline newline
2010 If you've inserted \SpecialChar LaTeX
2011 code into your document, but made a typo, you'll get
2013 You may have forgotten to load a package.
2014 In any case, this error message usually means that you used an undefined
2019 \begin_layout Standard
2020 There are other error and warning messages.
2021 Some are self-explanatory.
2022 These are usually \SpecialChar LaTeX
2024 Others are downright cryptic.
2025 These are usually \SpecialChar TeX
2026 error messages, and we really have
2030 what they mean or how to decipher them.
2034 \begin_layout Standard
2035 There's a general sequence you should follow if you get error messages:
2038 \begin_layout Enumerate
2039 Look at the \SpecialChar LaTeX
2040 code you inserted for typos.
2043 \begin_layout Enumerate
2044 If there are no typos, check that you used the command(s) correctly.
2047 \begin_layout Enumerate
2048 If you get a bunch of error boxes piled up at the very top of the document—and
2049 especially if you see a
2050 \begin_inset Quotes eld
2054 \begin_inset Flex Code
2057 \begin_layout Plain Layout
2066 \begin_inset Quotes erd
2069 error—it means that there are errors in the preamble.
2070 Start debugging your preamble.
2073 \begin_layout Enumerate
2074 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2076 document, the first suspect is your \SpecialChar LaTeX
2077 distribution itself.
2078 Check for missing packages and install them.
2081 \begin_layout Enumerate
2082 Okay, so there are no missing packages.
2083 Did you use any of the fine-tuning options in \SpecialChar LyX
2084 ? Specifically, did you
2088 any of them, like trying to manually insert lots of
2089 \begin_inset Flex Code
2092 \begin_layout Plain Layout
2094 \begin_inset space ~
2103 \begin_inset Flex Code
2106 \begin_layout Plain Layout
2113 \begin_inset Flex Code
2116 \begin_layout Plain Layout
2122 ? Did you try to kludge something together with these instead of using the
2123 appropriate paragraph environment?
2126 \begin_layout Enumerate
2127 All right, you didn't use any of the fine-tuning options, you played by
2129 Did you try to pull a fancy maneuver? Did you do something funky inside
2130 a table or an equation, like inserting a graphic into a table cell?
2133 \begin_layout Enumerate
2134 Do you have long sections of text where \SpecialChar LaTeX
2135 cannot find a place to break a
2136 line? By default, \SpecialChar LaTeX
2137 is rather strict about how much extra inter-word spacing
2138 it will add in order to break a line.
2139 Preferably, you should rework the paragraph to avoid the problem.
2142 \begin_layout Enumerate
2143 Did you go overboard with the nesting? \SpecialChar LyX
2144 (currently) doesn't check to make
2145 sure you're in the limits for nesting environments.
2146 If you nested a bunch of environments to the
2147 \begin_inset Formula $17^{\mathrm{th}}$
2150 level, that's the problem.
2151 (The limit in \SpecialChar LaTeX
2155 \begin_layout Enumerate
2156 Okay, you didn't get any error messages, but your output looks awful.
2157 If you have a table or figure that's too wide or long for the page, you
2162 \begin_layout Enumerate
2163 rescale the figure so it fits.
2166 \begin_layout Enumerate
2167 trim down the table so it fits.
2171 \begin_layout Enumerate
2172 If something else is wrong with the output, and you didn't try to pull anything
2173 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2176 \begin_layout Standard
2177 If all this doesn't help—well, then
2181 you might have found a bug in \SpecialChar LyX
2186 \begin_layout Chapter
2190 \begin_layout Section
2191 Customizing Bibliographies with Bib\SpecialChar TeX
2195 \begin_layout Standard
2196 The most basic information about how to use Bib\SpecialChar TeX
2201 with \SpecialChar LyX
2202 is contained in the section
2204 Bibliography databases
2211 The following subsections explain special bibliography features supported
2216 \begin_layout Subsection
2217 Alternative Citation Styles
2220 \begin_layout Standard
2221 Standard Bib\SpecialChar TeX
2223 \begin_inset space \thinspace{}
2227 \begin_inset space \space{}
2231 \begin_inset Quotes eld
2235 \begin_inset Quotes erd
2238 ) to refer to a cited work.
2239 However, in many scientific disciplines, other citation styles are in use.
2240 The most common one is the author-year style (e.
2241 \begin_inset space \thinspace{}
2245 \begin_inset space \space{}
2249 \begin_inset Quotes eld
2253 \begin_inset Quotes erd
2258 supports three packages that provide this style,
2259 \begin_inset Flex Code
2262 \begin_layout Plain Layout
2269 \begin_inset Flex Code
2272 \begin_layout Plain Layout
2279 \begin_inset Flex Code
2282 \begin_layout Plain Layout
2289 Each of these packages has their pros and cons, which cannot be listed
2291 If you only want to have simple author-year (or author-numerical) style,
2292 or if you want to use one of the countless style files for
2293 \begin_inset Flex Code
2296 \begin_layout Plain Layout
2302 , then the established
2303 \begin_inset Flex Code
2306 \begin_layout Plain Layout
2312 package is probably your choice.
2313 If you look for specific citation styles common in law studies, you might
2315 \begin_inset Flex Code
2318 \begin_layout Plain Layout
2325 If you want to have full control over the formatting or look for advanced
2326 features such as ibidem, footnote citations, full title citations, advanced
2327 date formats (such as 400 BC) or full localization to other languages than
2328 English, you should definitely consider
2329 \begin_inset Flex Code
2332 \begin_layout Plain Layout
2338 , which exceeds all other packages in terms of features, but is also quite
2339 heavy and more resource-hungry.
2342 \begin_layout Standard
2343 The handling of these packages in \SpecialChar LyX
2344 is basically the same.
2346 \begin_inset Flex Noun
2349 \begin_layout Plain Layout
2350 Document\SpecialChar menuseparator
2357 \begin_inset Flex Noun
2360 \begin_layout Plain Layout
2367 \begin_inset Flex Noun
2370 \begin_layout Plain Layout
2377 \begin_inset Flex Noun
2380 \begin_layout Plain Layout
2387 \begin_inset Flex Noun
2390 \begin_layout Plain Layout
2391 Biblatex (Natbib mode)
2397 \begin_inset Flex Noun
2400 \begin_layout Plain Layout
2407 \begin_inset Flex Noun
2410 \begin_layout Plain Layout
2417 \begin_inset space ~
2420 6.5.3 in the User's Guide for more information on these choices).
2421 With all these packages, you will get some extra features in the citation
2422 dialog and you can select the style of the reference (
2423 \begin_inset Quotes eld
2427 \begin_inset Quotes erd
2431 \begin_inset Quotes eld
2435 \begin_inset Quotes erd
2439 \begin_inset Quotes eld
2443 \begin_inset Quotes erd
2447 \begin_inset Quotes eld
2451 \begin_inset Quotes erd
2455 Note that either package needs specifically designed style files.
2456 They all ship their own, but there are lots of additional style files,
2457 and there is even an interactive style file builder
2461 \begin_layout Plain Layout
2463 \begin_inset Flex URL
2466 \begin_layout Plain Layout
2468 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2479 \begin_inset Flex Code
2482 \begin_layout Plain Layout
2491 \begin_layout Subsection
2492 Subdivided Bibliographies
2495 \begin_layout Standard
2496 Sometimes you might need to divide your bibliography into several sections.
2497 If you are for instance a historian, the possibility to separate sources
2498 and scientific works is most likely a
2499 \begin_inset Quotes eld
2503 \begin_inset Quotes erd
2507 Unfortunately, Bib\SpecialChar TeX
2508 itself does not allow you to do this.
2509 But with the help of some \SpecialChar LaTeX
2510 packages, Bib\SpecialChar TeX
2511 can be extended to fit your needs.
2514 \begin_layout Standard
2516 provides native support for one of these packages,
2524 \begin_layout Plain Layout
2526 \begin_inset Flex URL
2529 \begin_layout Plain Layout
2531 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2541 The advantage of this package (compared to other packages such as
2545 ) is that you don't need to define new citation commands.
2546 Instead, you need to prepare different bibliographic databases which include
2547 the entries for the different sections of the bibliography.
2548 For example: If you want to divide your bibliography into the sections
2550 \begin_inset Quotes eld
2554 \begin_inset Quotes erd
2558 \begin_inset Quotes eld
2562 \begin_inset Quotes erd
2565 , you first need to create two bibliographic databases, e.
2566 \begin_inset space \thinspace{}
2570 \begin_inset space \space{}
2574 \begin_inset Flex Code
2577 \begin_layout Plain Layout
2584 \begin_inset Flex Code
2587 \begin_layout Plain Layout
2597 \begin_layout Standard
2599 \begin_inset Flex Noun
2602 \begin_layout Plain Layout
2603 Document\SpecialChar menuseparator
2610 \begin_inset Flex Noun
2613 \begin_layout Plain Layout
2620 \begin_inset Flex Noun
2623 \begin_layout Plain Layout
2624 Subdivided bibliography
2630 Now you can insert multiple Bib\SpecialChar TeX
2631 bibliographies, one for each section of
2633 Returning to our example: Insert the Bib\SpecialChar TeX
2635 \begin_inset Flex Code
2638 \begin_layout Plain Layout
2644 and a second one for the database
2645 \begin_inset Flex Code
2648 \begin_layout Plain Layout
2655 You are free to use the same or different styles for each section.
2656 Additionally, you can choose if the bibliography section should contain
2658 \begin_inset Quotes eld
2661 all cited references
2662 \begin_inset Quotes erd
2665 of the specified database(s) (which is the default),
2666 \begin_inset Quotes eld
2669 all uncited references
2670 \begin_inset Quotes erd
2674 \begin_inset Quotes eld
2678 \begin_inset Quotes erd
2682 This might be useful if you would like to separate your bibliography into
2684 \begin_inset Quotes eld
2688 \begin_inset Quotes erd
2692 \begin_inset Quotes eld
2696 \begin_inset Quotes erd
2700 \begin_inset Quotes eld
2704 \begin_inset Quotes erd
2708 The titles for the sections can be added as ordinary sections or subsections.
2710 \begin_inset Flex Code
2713 \begin_layout Plain Layout
2719 removes the bibliography title, you have to manually re-add that, too (as
2720 a chapter* or section*, for instance).
2723 \begin_layout Standard
2728 , the procedure is a bit different.
2737 , the aforementioned
2738 \begin_inset Flex Noun
2741 \begin_layout Plain Layout
2742 Subdivided bibliography
2747 option is disabled if you use
2756 provides its own means to generate subdivided bibliographies.
2757 You can either add keywords to bibliography entries via the
2758 \begin_inset Flex Code
2761 \begin_layout Plain Layout
2767 entry option and then filter bibliography sections by keyword (by adding
2769 \begin_inset Flex Code
2772 \begin_layout Plain Layout
2779 \begin_inset Flex Noun
2782 \begin_layout Plain Layout
2788 field of the dialog that opens if you right-click on the
2789 \begin_inset Flex Noun
2792 \begin_layout Plain Layout
2793 Biblatex Generated Bibliography
2798 button), or you can filter by entry types (such as
2807 \begin_inset space \thinspace{}
2812 \begin_inset Flex Code
2815 \begin_layout Plain Layout
2822 \begin_inset Flex Code
2825 \begin_layout Plain Layout
2832 \begin_inset Flex Noun
2835 \begin_layout Plain Layout
2841 field, or you can create so-called
2842 \begin_inset Quotes eld
2845 Bibliography Categories
2846 \begin_inset Quotes erd
2849 to which you can assign individual entries.
2850 Please refer to the Biblatex manual, section
2852 Subdivided Bibliographies
2857 \begin_layout Subsection
2858 Multiple Bibliographies
2861 \begin_layout Standard
2862 Multiple bibliographies, e.
2863 \begin_inset space \thinspace{}
2867 \begin_inset space \space{}
2870 a bibliography for each part, chapter, section, subsection or child (sub-documen
2871 t) of the document, are also supported by \SpecialChar LyX
2873 In order to enable it, go to
2874 \begin_inset Flex Noun
2877 \begin_layout Plain Layout
2878 Document\SpecialChar menuseparator
2879 Settings\SpecialChar menuseparator
2885 and select the relevant unit (e.
2886 \begin_inset space \thinspace{}
2890 \begin_inset Quotes eld
2894 \begin_inset Quotes erd
2898 \begin_inset Flex Noun
2901 \begin_layout Plain Layout
2902 Multiple Bibliographies
2908 Then add a Bib(la)\SpecialChar TeX
2909 bibliography to each unit (e.
2910 \begin_inset space \thinspace{}
2913 g., section) of your document.
2914 In the output, a separate bibliography, containing only the references
2915 done in the current unit is generated.
2918 \begin_layout Standard
2919 If you use Bib\SpecialChar TeX
2921 \begin_inset Flex Code
2924 \begin_layout Plain Layout
2931 \change_deleted -712698321 1501067466
2933 \change_inserted -712698321 1501067466
2937 \begin_inset Flex Code
2940 \begin_layout Plain Layout
2946 package is used to create multiple bibliographies.
2947 The former package is used if you select
2948 \begin_inset Quotes eld
2952 \begin_inset Quotes erd
2960 \begin_inset Flex Noun
2963 \begin_layout Plain Layout
2964 Sectioned Bibliography
2971 \begin_inset Flex Code
2974 \begin_layout Plain Layout
2984 \begin_layout Plain Layout
2985 An alternative approach, if you are willing to use some
2986 \begin_inset Flex Noun
2989 \begin_layout Plain Layout
2997 \begin_inset space ~
3001 \begin_inset CommandInset ref
3003 reference "sec:Inserting-TeX-Code"
3008 \begin_inset Flex Code
3011 \begin_layout Plain Layout
3023 \begin_inset Flex Code
3026 \begin_layout Plain Layout
3032 is used, \SpecialChar LyX
3033 encloses the specified units in
3034 \begin_inset Flex Code
3037 \begin_layout Plain Layout
3044 \begin_inset Flex Code
3047 \begin_layout Plain Layout
3056 \begin_inset Flex Code
3059 \begin_layout Plain Layout
3067 in order to create the units.
3068 Note that this approach has some limitations.
3069 First, every citation reference has to be inside some
3070 \begin_inset Flex Code
3073 \begin_layout Plain Layout
3080 So citations outside a defined unit (e.
3081 \begin_inset space \thinspace{}
3084 g., before the first section if you use
3085 \begin_inset Quotes eld
3089 \begin_inset Quotes erd
3093 \begin_inset Quotes eld
3097 \begin_inset Quotes erd
3101 You can also create your own units by entering
3102 \begin_inset Flex Code
3105 \begin_layout Plain Layout
3114 \begin_inset Flex Code
3117 \begin_layout Plain Layout
3126 code (for instance to work around the mentioned limitation).
3128 \begin_inset Flex Code
3131 \begin_layout Plain Layout
3138 A second limitation is that
3139 \begin_inset Flex Code
3142 \begin_layout Plain Layout
3148 always processes all references of a bibliography database, even if they
3150 This can result in odd labels (e.
3151 \begin_inset space \thinspace{}
3156 \begin_inset Quotes eld
3160 \begin_inset Quotes erd
3163 if two works of this author from 2014 are in the database, even if only
3167 \begin_layout Standard
3173 \begin_inset Flex Code
3176 \begin_layout Plain Layout
3182 option is used instead.
3183 If you need specific units, you can start them with the \SpecialChar TeX
3185 \begin_inset Flex Code
3188 \begin_layout Plain Layout
3197 \begin_inset Flex Code
3200 \begin_layout Plain Layout
3209 If you also want to control the end of the unit, use the environment
3210 \begin_inset Flex Code
3213 \begin_layout Plain Layout
3223 \begin_inset Flex Code
3226 \begin_layout Plain Layout
3236 \begin_inset Flex Code
3239 \begin_layout Plain Layout
3246 In addition to the individual bibliography of the current unit,
3250 also provides an easy way to output all bibliographies, subsequently, at
3252 \begin_inset space \thinspace{}
3255 g., at the end of the document).
3257 \begin_inset Quotes eld
3261 \begin_inset Quotes erd
3264 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve
3270 manual for more information on this topic.
3273 \begin_layout Section
3277 \begin_layout Subsection
3281 \begin_layout Standard
3282 When you are working on a large file with many sections, it is often convenient
3283 to break up the document into several files, or perhaps you have something
3284 where a table may change from time to time, but the preceding text does
3286 In these cases, you should seriously consider using multipart documents.
3287 For example, scientific papers often have five major sections: the introduction
3288 , observations, results, discussion, and conclusion.
3289 Each of these could be its own separate \SpecialChar LyX
3291 \begin_inset Quotes eld
3295 \begin_inset Quotes erd
3298 file which contains the title, authors, abstract, references, etc., plus
3299 the five included files.
3300 It is important to note that each of these files is a full \SpecialChar LyX
3302 can be formatted and printed on its own, as well as included in a master
3304 Each of these files must have the same document class, however—don't attempt
3305 to mix book classes with article classes.
3306 You may also include \SpecialChar LaTeX
3307 files; however, these files must not have their own
3309 \begin_inset space \thinspace{}
3313 \begin_inset space \space{}
3316 everything up to and including the
3317 \begin_inset Flex Code
3320 \begin_layout Plain Layout
3329 \begin_inset Flex Code
3332 \begin_layout Plain Layout
3340 line must be deleted) or else errors will be generated when you try to
3344 \begin_layout Standard
3346 allows you to include files quite easily with
3347 \begin_inset Flex Noun
3350 \begin_layout Plain Layout
3351 Insert\SpecialChar menuseparator
3353 \change_deleted -712698321 1501147443
3355 \change_inserted -712698321 1501147443
3359 \begin_inset space ~
3368 When you click on this selection a small box is inserted into the file
3369 at the current cursor location.
3370 Clicking on the box raises a dialog which allows you to select the file
3371 to be included, and the method of its inclusion.
3375 \begin_layout Standard
3376 The file selection box should by now be obvious.
3377 The three inclusion methods are
3378 \begin_inset Quotes eld
3382 \begin_inset Quotes erd
3386 \begin_inset Quotes eld
3390 \begin_inset Quotes erd
3394 \begin_inset Quotes eld
3398 \begin_inset Quotes erd
3402 The difference between
3403 \begin_inset Quotes eld
3407 \begin_inset Quotes erd
3411 \begin_inset Quotes eld
3415 \begin_inset Quotes erd
3418 is really only meaningful to \SpecialChar LaTeX
3419 perts, but the practical difference is that
3421 \begin_inset Quotes eld
3425 \begin_inset Quotes erd
3428 are typeset beginning on a new page, while files that are
3429 \begin_inset Quotes eld
3433 \begin_inset Quotes erd
3436 are typeset starting on the current page.
3439 \begin_layout Standard
3440 Generally, the master file is converted into a full \SpecialChar LaTeX
3441 file before typesetting,
3442 while the included files are converted to \SpecialChar LaTeX
3443 files that do not have all the
3444 preamble information.
3447 \begin_layout Standard
3449 \begin_inset Quotes eld
3453 \begin_inset Quotes erd
3456 included file allows you to include a file typeset exactly as it appears
3458 \begin_inset space \thinspace{}
3462 \begin_inset space \space{}
3466 \begin_inset Flex Code
3469 \begin_layout Plain Layout
3475 mode, with the characters set in a fixed-width typewriter font.
3476 Normally, spaces in this file are invisible, though two consecutive spaces
3477 are conserved, unlike \SpecialChar LyX
3478 's normal treatment of spaces.
3479 However, setting the
3480 \begin_inset Flex Noun
3483 \begin_layout Plain Layout
3485 \begin_inset space ~
3489 \begin_inset space ~
3493 \begin_inset space ~
3501 checkbox typesets a mark to unambiguously define the presence of a space.
3505 \begin_layout Subsection
3506 Cross-References Between Files
3509 \begin_layout Standard
3510 \begin_inset Box Shadowbox
3520 height_special "totalheight"
3525 backgroundcolor "none"
3528 \begin_layout Plain Layout
3529 This section is somewhat out of date.
3530 Need to describe default master documents and how children are opened when
3540 \begin_layout Standard
3541 It is possible to set up cross-references between the different files.
3542 First, open all the files in question: let's call them A and B in a two
3543 file example, where B is included in A.
3544 Let's say you insert a label in A, then want to reference it in B.
3545 Open the cross-reference dialog whilst in document B, and you can select
3547 \begin_inset Quotes eld
3551 \begin_inset Quotes erd
3557 \begin_layout Subsection
3558 Bibliography Lists in all Subdocuments
3561 \begin_layout Standard
3562 \begin_inset Box Frameless
3572 height_special "totalheight"
3577 backgroundcolor "none"
3580 \begin_layout Plain Layout
3581 This section also needs updating.
3582 There is now material about this on the wiki, and it could be copied here.
3590 \begin_layout Standard
3591 Copy the bibliography list with all entries to all subdocuments and transform
3593 This way \SpecialChar LyX
3595 \begin_inset Flex Code
3598 \begin_layout Plain Layout
3604 -files and you can easily insert references without making the bibliography
3608 \begin_layout Standard
3609 As the bibliography list is in a comment, \SpecialChar LaTeX
3610 won't use it and the references
3611 will look like this: [?], instead of like this: [1].
3612 One solution is to use the \SpecialChar LaTeX
3614 \begin_inset Flex Code
3617 \begin_layout Plain Layout
3623 that will only include comments by processing the files separately.
3624 To do this, add in the \SpecialChar LaTeX
3625 preamble of every subdocument the following:
3628 \begin_layout LyX-Code
3634 \begin_layout LyX-Code
3637 includecomment{comment}
3640 \begin_layout Standard
3642 \begin_inset Flex URL
3645 \begin_layout Plain Layout
3647 http://wiki.lyx.org/FAQ/Unsorted#toc31
3655 \begin_layout Section
3660 \begin_layout Standard
3661 Users sometimes need to be able to
3662 \begin_inset Quotes eld
3666 \begin_inset Quotes erd
3670 file together with all the images (and other files) on which it depends,
3671 either for sending to a publisher or for sharing with a co-author.
3673 2.0 includes a Python script (
3674 \begin_inset Flex Code
3677 \begin_layout Plain Layout
3683 ) that automates this process.
3684 To use it, you must have either the
3685 \begin_inset Flex Code
3688 \begin_layout Plain Layout
3695 \begin_inset Flex Code
3698 \begin_layout Plain Layout
3704 python modules installed on your system.
3705 By default, the script prefers the
3706 \begin_inset Flex Code
3709 \begin_layout Plain Layout
3716 \begin_inset Flex Code
3719 \begin_layout Plain Layout
3725 format on Unix-like systems and the
3726 \begin_inset Flex Code
3729 \begin_layout Plain Layout
3738 \begin_layout Standard
3740 's configuration process will set the script up to export a `\SpecialChar LyX
3742 and this format will then be available under
3743 \begin_inset Flex Code
3746 \begin_layout Plain Layout
3747 File\SpecialChar menuseparator
3756 \begin_layout Standard
3757 Independently of the platform, the generation of a particular archive format
3758 can be forced by adding either the
3759 \begin_inset Flex Code
3762 \begin_layout Plain Layout
3769 \begin_inset Flex Code
3772 \begin_layout Plain Layout
3779 \begin_inset Flex Code
3782 \begin_layout Plain Layout
3789 \begin_inset Flex Code
3792 \begin_layout Plain Layout
3798 format) switch to the
3799 \begin_inset Flex Code
3802 \begin_layout Plain Layout
3804 \SpecialChar menuseparator
3812 \begin_inset Flex Code
3815 \begin_layout Plain Layout
3816 Tools\SpecialChar menuseparator
3817 Preferences\SpecialChar menuseparator
3818 File Handling\SpecialChar menuseparator
3825 (Make sure you add the switch after the script name, not before it.)
3828 \begin_layout Section
3829 Fancy Headers and Footers
3832 \begin_layout Standard
3833 The default page layout is rather plain; for an
3834 \begin_inset Flex Code
3837 \begin_layout Plain Layout
3843 document class, all you get is a centered page number at the bottom of
3845 This document uses KOMA-script's book class, so it appears to be a bit
3847 But to really put on a show, you need to set the document page style to
3849 \begin_inset Quotes eld
3853 \begin_inset Quotes erd
3856 , as mentioned in the
3861 This section describes the \SpecialChar LaTeX
3862 code you need to insert in your \SpecialChar LaTeX
3864 order to get the desired effects.
3867 \begin_layout Standard
3868 For more information on fancy headers, see the
3869 \begin_inset Flex Code
3872 \begin_layout Plain Layout
3878 package documentation.
3880 \begin_inset Flex URL
3883 \begin_layout Plain Layout
3885 http://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
3893 \begin_layout Standard
3894 The page header is divided into three fields, not surprisingly labeled
3895 \begin_inset Quotes eld
3899 \begin_inset Quotes erd
3903 \begin_inset Quotes eld
3907 \begin_inset Quotes erd
3911 \begin_inset Quotes eld
3915 \begin_inset Quotes erd
3919 The footer is also divided into these three fields.
3920 The \SpecialChar LaTeX
3921 commands to set these fields in the simplest manner are
3922 \begin_inset Flex Code
3925 \begin_layout Plain Layout
3934 \begin_inset Flex Code
3937 \begin_layout Plain Layout
3946 \begin_inset Flex Code
3949 \begin_layout Plain Layout
3958 \begin_inset Flex Code
3961 \begin_layout Plain Layout
3970 Suppose you wish to put your name in the upper left hand corner of each
3972 Simply insert the following command in the preamble:
3975 \begin_layout Standard
3984 \begin_layout Standard
3985 You will now see your name in the upper left.
3986 If a field has a default entry that you would like to get rid of (often
3987 the page number appears in the central footer) simply include a command
3988 with a blank argument, e.
3989 \begin_inset space \thinspace{}
3995 \begin_layout Standard
4003 \begin_layout Standard
4004 Let's get really fancy: lets put the section number with the word
4005 \begin_inset Quotes eld
4009 \begin_inset Quotes erd
4013 \begin_inset space \thinspace{}
4017 \begin_inset space \space{}
4020 Section 3) in the upper left, the page number (e.
4021 \begin_inset space \thinspace{}
4025 \begin_inset space \space{}
4028 Page 4) in the upper right, your name in the lower left, and the date in
4030 The following commands should now appear in the preamble:
4033 \begin_layout Standard
4043 \begin_layout Standard
4051 \begin_layout Standard
4061 \begin_layout Standard
4070 \begin_layout Standard
4078 \begin_layout Standard
4088 \begin_layout Standard
4090 \begin_inset Flex Code
4093 \begin_layout Plain Layout
4102 \begin_inset Flex Code
4105 \begin_layout Plain Layout
4113 access \SpecialChar LaTeX
4114 's section and page counters, and so print out the current section
4117 \begin_inset Flex Code
4120 \begin_layout Plain Layout
4128 simply prints out today's date.
4131 \begin_layout Standard
4132 The thicknesses of the horizontal rules drawn beneath the header and above
4133 the footer can also be modified.
4134 If you don't want one of the rules, set its thickness to 0.
4135 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
4141 \begin_inset Flex Code
4144 \begin_layout Plain Layout
4149 headrulewidth}{0.4pt}
4155 \begin_inset Flex Code
4158 \begin_layout Plain Layout
4163 footrulewidth}{0.4pt}
4168 to set the thicknesses.
4171 \begin_layout Standard
4172 You can switch the header/footer settings on and off for individual pages
4174 \begin_inset Flex Code
4177 \begin_layout Plain Layout
4180 thispagestyle{empty}
4186 \begin_inset Flex Code
4189 \begin_layout Plain Layout
4192 thispagestyle{plain}
4198 \begin_inset Flex Code
4201 \begin_layout Plain Layout
4204 thispagestyle{fancy}
4210 Simply insert them in the text on the page you want changed and mark them
4213 In fact, title pages are marked as plain by default, while following pages
4214 are marked fancy when using the global fancy setting.
4217 \begin_layout Standard
4218 As a final example, it is possible to include an image in the header or
4220 Suppose you want to put a company logo in the upper lefthand corner.
4221 You might try something like
4224 \begin_layout Standard
4233 includegraphics{logo.eps}}}
4236 \begin_layout Standard
4238 (you may need to preface this with
4239 \begin_inset Flex Code
4242 \begin_layout Plain Layout
4246 usepackage{graphics}
4251 if you don't include graphics elsewhere in your document).
4254 \begin_layout Section
4255 Itemize Bullet Selection
4256 \begin_inset CommandInset label
4265 \begin_layout Standard
4271 \begin_layout Subsection
4275 \begin_layout Standard
4277 provides 216 bullet shapes that can be accessed from a simple dialog.
4278 Using this dialog you can easily specify what bullet shape to use at each
4279 level of an itemized list.
4280 These settings are document-wide so you won't be able to specify different
4281 sets of bullets for different paragraphs.
4285 \begin_layout Plain Layout
4286 Well, actually you can but you'll have to do it by hand.
4294 \begin_layout Subsection
4298 \begin_layout Standard
4299 Open the dialog by selecting the
4300 \begin_inset Flex Noun
4303 \begin_layout Plain Layout
4304 Document\SpecialChar menuseparator
4310 menu item and then select the
4311 \begin_inset Flex Noun
4314 \begin_layout Plain Layout
4323 \begin_layout Standard
4324 The dialog provides you with a table of bullet shapes.
4325 A column of buttons on the left of the table provides access to the six
4326 different panels of bullet shapes.
4327 The row of buttons across the top is used to select which bullet depth
4329 A text entry under the table shows the currently selected bullet shape's
4331 equivalent and this can be edited if desired.
4332 If you do modify the text you will also need to specify any needed packages
4333 in the \SpecialChar LaTeX
4337 \begin_layout Standard
4338 The six panels are divided up by the packages they require.
4339 The following table shows the mappings from button name to \SpecialChar LaTeX
4343 \begin_layout Standard
4345 \begin_inset Tabular
4346 <lyxtabular version="3" rows="7" columns="2">
4347 <features tabularvalignment="middle">
4348 <column alignment="center" valignment="top" width="0pt">
4349 <column alignment="center" valignment="top" width="0pt">
4351 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4354 \begin_layout Plain Layout
4369 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4372 \begin_layout Plain Layout
4389 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4392 \begin_layout Plain Layout
4407 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4410 \begin_layout Plain Layout
4419 base \SpecialChar LaTeX
4427 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4430 \begin_layout Plain Layout
4445 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4448 \begin_layout Plain Layout
4465 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4468 \begin_layout Plain Layout
4483 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4486 \begin_layout Plain Layout
4503 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4506 \begin_layout Plain Layout
4521 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4524 \begin_layout Plain Layout
4541 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4544 \begin_layout Plain Layout
4559 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4562 \begin_layout Plain Layout
4579 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4582 \begin_layout Plain Layout
4597 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4600 \begin_layout Plain Layout
4623 \begin_layout Standard
4625 doesn't stop you using bullets from packages you don't have.
4626 If you get errors from \SpecialChar LaTeX
4627 when you try to view or print the file, then it
4628 is likely you are missing a package.
4632 \begin_layout Plain Layout
4634 doesn't restrict your use since you may be editing locally and exporting
4643 \begin_layout Subsection
4647 \begin_layout Standard
4648 Select which bullet depth you want to change then select the bullet shape
4650 Any changes will not be visible in \SpecialChar LyX
4651 , but are visible when viewing the document.
4654 \begin_layout Standard
4655 You can reset a bullet shape to the default simply by clicking your right
4656 mouse button on the appropriate bullet depth button.
4660 \begin_layout Plain Layout
4665 want to have multiple sets of paragraphs with different sets of bullets
4666 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
4668 The bullet selection dialog can help though because it provides you with
4669 the \SpecialChar LaTeX
4670 code for a wide range of bullet shapes.
4671 To make your own custom paragraphs you have the following options:
4674 \begin_layout Plain Layout
4678 \begin_layout Plain Layout
4694 \begin_layout Plain Layout
4698 \begin_layout Plain Layout
4720 \begin_layout Itemize
4721 Use the \SpecialChar LaTeX
4723 \begin_inset Flex Code
4726 \begin_layout Plain Layout
4734 to specify a new bullet shape for a given depth.
4735 You'll also need to save the current bullet shape so you can restore it
4737 In this itemized list the following \SpecialChar LaTeX
4738 code was used to change the bullet
4739 used for the first depth.
4743 \begin_layout LyX-Code
4753 \begin_layout LyX-Code
4770 \begin_layout Itemize
4771 Note that the itemize depth is specified in Roman numerals as part of the
4781 \begin_layout Itemize
4783 \change_deleted -712698321 1501149643
4787 \begin_layout Plain Layout
4789 \change_deleted -712698321 1501149634
4800 \change_deleted -712698321 1501149636
4809 \change_inserted -712698321 1501149643
4811 \begin_inset Argument item:1
4814 \begin_layout Plain Layout
4816 \change_inserted -712698321 1501149643
4820 \begin_layout Plain Layout
4822 \change_inserted -712698321 1501149643
4844 Specify each individual entry by starting each item with the bullet shape
4846 \change_deleted -712698321 1501149707
4848 \change_inserted -712698321 1501149740
4850 \begin_inset Quotes eld
4854 \begin_inset Quotes erd
4859 Insert\SpecialChar menuseparator
4865 \begin_inset Flex Noun
4868 \begin_layout Plain Layout
4876 For example, this item was started with
4877 \begin_inset Flex Code
4880 \begin_layout Plain Layout
4882 \change_deleted -712698321 1501149692
4892 \change_deleted -712698321 1501149693
4903 \begin_layout Plain Layout
4907 \begin_layout Plain Layout
4923 \begin_layout Plain Layout
4924 You'll also need to revert the labelitem back to its previous setting for
4925 the global bullet shape settings to remain in effect.
4926 The way used here was:
4929 \begin_layout LyX-Code
4944 \begin_layout Chapter
4946 and the World Wide Web
4949 \begin_layout Standard
4951 has long supported the export of documents to various web-friendly formats,
4954 \change_inserted -712698321 1501076595
4957 on 2.0, however, HTML export was always accomplished by the use of external
4962 \begin_layout Plain Layout
4963 For details on the use of external converters with \SpecialChar LyX
4968 section of the Customization manual.
4973 These fall into two large groups: there are converters that use \SpecialChar LaTeX
4975 intermediate format, such as
4976 \begin_inset Flex Code
4979 \begin_layout Plain Layout
4986 \begin_inset Flex Code
4989 \begin_layout Plain Layout
4996 \begin_inset Flex Code
4999 \begin_layout Plain Layout
5005 , relying upon \SpecialChar LyX
5006 to produce the \SpecialChar LaTeX
5007 ; and there is a converter that works directly
5010 \begin_inset Flex Code
5013 \begin_layout Plain Layout
5021 All of these have different advantages and disadvantages.
5025 \begin_layout Standard
5026 The \SpecialChar LaTeX
5027 -based converters have the advantage that, in principle, they know everythin
5028 g about the exported document that \SpecialChar LaTeX
5030 Such converters do not care, for example, if a certain block of code was
5031 produced by \SpecialChar LyX
5032 or was Evil Red Text.
5033 These converters know about
5034 \begin_inset Flex Code
5037 \begin_layout Plain Layout
5043 files, counters, and references, and can often make use of the
5044 \begin_inset Flex Code
5047 \begin_layout Plain Layout
5053 files generated by Bib\SpecialChar TeX
5055 On the other hand, \SpecialChar LaTeX
5056 is a very hard language to parse—it is sometimes said
5057 that only \SpecialChar TeX
5058 itself understands \SpecialChar TeX
5059 —and \SpecialChar LaTeX
5060 -based converters will often choke on
5061 what seem to be quite simple constructs; complex ones can throw them completely
5062 , and as of this writing, for example, the
5066 manual will not export with
5067 \begin_inset Flex Code
5070 \begin_layout Plain Layout
5076 , though the others will.
5077 The other issue concerns how math is handled.
5078 These converters typically convert the formulae into little pictures that
5079 are then linked from the HTML document.
5080 Since these are actually generated by \SpecialChar LaTeX
5081 , they are accurate.
5082 But they do not scale well, and just getting them to look as if they are
5083 actually meant to be in your document—so that the font sizes seem to be
5084 roughly the same—can be a challenge.
5087 \begin_layout Standard
5089 \begin_inset Flex Code
5092 \begin_layout Plain Layout
5100 \begin_inset CommandInset href
5102 name "http://elyxer.nongnu.org/"
5103 target "http://elyxer.nongnu.org/"
5108 ) solves some of these problems.
5109 In particular, the formulae it produces scale perfectly, since it renders
5110 math using a combination of HTML and CSS rather than converting the formulae
5112 But even moderately complex formula are rendered less well than with
5113 \begin_inset Flex Code
5116 \begin_layout Plain Layout
5122 ; this reflects the limitations of HTML.
5126 \begin_layout Plain Layout
5128 \begin_inset Flex Code
5131 \begin_layout Plain Layout
5138 can also use jsMath and MathJax for equations, but this setting is only
5139 available globally and requires one to have access to a server that runs
5145 More importantly (as of version 1.1.1, at least),
5146 \begin_inset Flex Code
5149 \begin_layout Plain Layout
5156 has limited support for math macros and no support for user-defined paragraph
5157 or character styles.
5158 These limitations make
5159 \begin_inset Flex Code
5162 \begin_layout Plain Layout
5169 unsuitable for many of the documents \SpecialChar LyX
5171 In principle, of course, these problems could be solved, but the \SpecialChar LyX
5173 have decided to follow a different path and have made \SpecialChar LyX
5175 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
5176 , DocBook, and plaintext.
5179 \begin_layout Standard
5180 As of this writing, XHTML output remains under development and should probably
5182 \begin_inset Quotes eld
5186 \begin_inset Quotes erd
5193 \begin_layout Plain Layout
5195 \begin_inset Flex Code
5198 \begin_layout Plain Layout
5200 \change_inserted -712698321 1501078933
5208 , which can be found in the \SpecialChar LyX
5210 \begin_inset CommandInset href
5212 name "accessed online"
5213 target "http://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
5218 , usually contains up-to-date information about the state of XHTML output.
5219 See also the list of XHTML bugs on
5220 \begin_inset CommandInset href
5222 name "the bug tracker"
5223 target "http://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"
5233 Still, the developers have chosen this approach because it has several
5234 potential advantages over the other two.
5237 \begin_layout Standard
5238 These advantages are primarily due to the fact that the XHTML output routines,
5239 since they are part of \SpecialChar LyX
5240 , know everything \SpecialChar LyX
5241 knows about the document being
5246 \begin_layout Plain Layout
5247 Another advantage is that, since these routines are internal to \SpecialChar LyX
5249 immune to changes in \SpecialChar LyX
5250 's file format, or to changes in the semantics of
5256 So they know about the table of contents (as displayed in the outline),
5257 about the counters associated with different paragraph styles, and about
5258 user-defined styles.
5259 The XHTML output routines know what \SpecialChar LyX
5260 knows about internationalization,
5261 too, so they will output
5262 \begin_inset Quotes eld
5266 \begin_inset Quotes erd
5270 \begin_inset Quotes eld
5278 \begin_inset Quotes erd
5281 , depending upon the language in effect at the time.
5285 \begin_layout Standard
5286 Quite generally, the output routines know what \SpecialChar LyX
5287 knows about document layout,
5288 that is, about how the document is to be rendered on screen.
5289 We use this information when we output the document as XHTML.
5290 In particular, \SpecialChar LyX
5295 generates CSS style information corresponding to the layout information
5296 it uses to render the document on screen: if section headings are supposed
5297 to be sans-serif and bold as seen in \SpecialChar LyX
5298 , then (by default) they will be sans-seri
5299 f and bold when viewed in a web browser, too.
5300 And this is true not just for pre-defined styles, like Section, but for
5301 any style, including user-defined styles.
5302 Indeed, the XHTML output routines make no distinction between user-defined
5303 paragraph and character styles and \SpecialChar LyX
5304 's own pre-defined styles: in each case,
5305 everything \SpecialChar LyX
5306 knows about the styles is contained in the layout files.
5307 And much the same is true as regards pre-defined textual insets, such as
5308 footnotes, and various custom insets.
5312 \begin_layout Standard
5313 The result is that XHTML output can be customized and extended in exactly
5314 the same way \SpecialChar LaTeX
5315 output can be customized and extended: through layout files
5317 See chapter five of the
5321 manual for the details.
5324 \begin_layout Standard
5325 The remainder of this chapter contains more detailed information on XHTML
5326 output, its limitations, and ways to work around those limitations.
5329 \begin_layout Section
5330 Math Output in XHTML
5333 \begin_layout Standard
5335 offers four choices for how math is rendered.
5336 These have various advantages and disadvantages:
5339 \begin_layout Itemize
5341 \begin_inset Newline newline
5344 MathML is a dialect of XML designed specifically for mathematics on the
5345 web, and it typically renders very well in browsers that support it.
5346 The disadvantage is that not all browsers support MathML, and support is
5347 not complete even in the Gecko-based browsers, such as Firefox.
5348 \begin_inset Newline newline
5352 is unable to render a formula as MathML—for example, if the formula
5354 \begin_inset Flex Code
5357 \begin_layout Plain Layout
5363 package or ERT—then it will instead output the formula as an image.
5367 \begin_layout Itemize
5369 \begin_inset Newline newline
5373 \begin_inset Flex Code
5376 \begin_layout Plain Layout
5382 outputs math as HTML, styled by CSS.
5386 \begin_layout Plain Layout
5388 has borrowed some of the CSS for its HTML output from
5389 \begin_inset Flex Code
5392 \begin_layout Plain Layout
5403 For simple formulae, this can work quite well, though with more complicated
5404 formulae it tends to break down.
5405 Still, this method has the advantage that it is very widely supported and
5406 so it may be appropriate for documents that contain only a little, fairly
5408 \begin_inset Newline newline
5411 If Lyx is unable to render a formula as HTML—for example, if the formula
5413 \begin_inset Flex Code
5416 \begin_layout Plain Layout
5422 package or ERT—then it will instead output the formula as an image.
5426 \begin_layout Itemize
5428 \begin_inset Newline newline
5432 \begin_inset Flex Code
5435 \begin_layout Plain Layout
5442 will output formulae as images, the very same images, in fact, that are
5443 used for instant preview.
5447 \begin_layout Plain Layout
5448 Instant preview does
5452 have to be on for images to be output, however.
5457 The advantage to this method is that the images are simply generated by
5459 , so they are very accurate.
5460 The disadvantage, as mentioned earlier, is that these are bitmapped images,
5461 so they do not scale terribly well, and one cannot copy them, etc.
5463 \change_deleted -712698321 1501075981
5464 (As of this writing, there are also problems about equation numbering.
5466 \begin_inset CommandInset href
5469 target "http://www.lyx.org/trac/ticket/6894"
5477 \begin_inset Newline newline
5480 The size of the images can be controlled by setting the
5481 \begin_inset Quotes eld
5485 \begin_inset Quotes erd
5489 \begin_inset Flex Noun
5492 \begin_layout Plain Layout
5493 Document\SpecialChar menuseparator
5494 Settings\SpecialChar menuseparator
5496 \change_deleted -712698321 1501076136
5498 \change_inserted -712698321 1501076137
5510 \begin_layout Plain Layout
5511 For those who want to know, this controls the resolution of the image in
5512 dots per inch and is based upon a default of 75 dpi.
5518 \begin_inset Newline newline
5522 for some reason fails to create an image for a formula (e.g., if a required
5524 package is not installed), then it will fall back to outputing the raw
5529 \begin_layout Itemize
5532 \begin_inset Newline newline
5535 Finally, \SpecialChar LyX
5536 will happily output math as \SpecialChar LaTeX
5538 As well as being the output of last resort, this method can be used with
5540 \begin_inset CommandInset href
5543 target "http://www.math.union.edu/~dpvc/jsMath/"
5548 , which uses JavaScript to render \SpecialChar LaTeX
5549 embedded in HTML documents.
5551 wraps the \SpecialChar LaTeX
5553 \begin_inset Flex Code
5556 \begin_layout Plain Layout
5562 (for inline formulas) or
5563 \begin_inset Flex Code
5566 \begin_layout Plain Layout
5572 (for displayed formulas) with
5573 \begin_inset Flex Code
5576 \begin_layout Plain Layout
5582 , as is required for jsMath.
5585 \begin_layout Standard
5586 One of these output methods must be selected under
5587 \begin_inset Flex Noun
5590 \begin_layout Plain Layout
5591 Document\SpecialChar menuseparator
5592 Settings\SpecialChar menuseparator
5594 \change_deleted -712698321 1501076586
5596 \change_inserted -712698321 1501076587
5605 By default, \SpecialChar LyX
5607 This is a document-wide setting, therefore.
5610 \begin_layout Standard
5611 Eventually, \SpecialChar LyX
5612 will offer the user the option to select an alternate output
5613 method for a particular inset, say, one that isn't being rendered very
5618 \begin_layout Plain Layout
5619 That said, since \SpecialChar LyX
5620 falls back to images if the inset contains ERT, then one
5621 can force output as an image by putting some harmless ERT into the math,
5623 \begin_inset Formula $a=b\relax$
5634 \begin_layout Section
5635 Bibliography and Citations
5638 \begin_layout Standard
5639 XHTML output fully supports bibliographies and citations.
5643 \begin_layout Standard
5644 Citation labels are generated by the same machinery that generates \SpecialChar LyX
5646 labels, so the labels will look in the output much as they do in \SpecialChar LyX
5649 If you are using numerical citations, then \SpecialChar LyX
5650 will output numerical labels,
5651 such as [1] or [17], rather than simply showing the citation key in square
5652 brackets, as it does on-screen.
5653 If you are using author-year citations, then \SpecialChar LyX
5654 will add lowercase letters
5655 to the years, just as Bib\SpecialChar TeX
5656 does, if it finds more than one citation for
5657 a given author-year combination.
5658 The labels will be printed with the bibliography entries.
5659 Note that there is, at present, no way to customize the appearance of the
5660 labels, for example, to choose between square brackets and parentheses.
5663 \begin_layout Standard
5664 Bibliography output is handled by the same machinery that handles the presentati
5665 on of reference information in the citation dialog, so you will see in the
5666 XHTML output pretty much what you would see if you were to look at a given
5667 entry in the citation dialog.
5668 The formatting can be customized in your layout file or, preferably, in
5674 manual for the details.
5677 \begin_layout Standard
5678 The main defect at present is that cross-referenced information is printed
5679 with every entry with which it is associated.
5680 So you can see things like this:
5685 \begin_inset Quotes eld
5688 Context and Logical Form
5689 \begin_inset Quotes erd
5694 Language in Context: Selected Essays
5696 (Oxford: Oxford University Press, 2007), pp.
5702 \begin_inset Quotes eld
5705 Semantics in Context
5706 \begin_inset Quotes erd
5711 Language in Context: Selected Essays
5713 (Oxford: Oxford University Press, 2007), pp.
5717 \begin_layout Standard
5718 This should be fixed before long.
5721 \begin_layout Standard
5722 There is no support at present for sectioned bibliographies.
5723 If you have multiple bibliographies, then \SpecialChar LyX
5724 will print the same bibliography
5728 \begin_layout Section
5732 \begin_layout Standard
5734 will happily export indexes as XHTML, but with certain limitations at the
5738 \begin_layout Standard
5739 Index export will be most reliable when you do not attempt to use the fancy
5740 constructs that are described in the section on indexes in the
5748 \begin_layout Plain Layout
5749 The main issue here is that \SpecialChar LyX
5750 itself does not really handle these.
5751 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
5757 We'll describe how they are handled using the subsection headings from
5761 \begin_layout Itemize
5762 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
5763 makes an effort to support these,
5764 but the entries must be separated by
5765 \begin_inset Quotes eld
5769 \begin_inset Quotes erd
5772 , that is, there must be spaces around the exclamation point.
5773 This is because it is otherwise too difficult to check for escaped exclamation
5774 points, ones in math, and so forth.
5777 \begin_layout Itemize
5778 Page Ranges: There is no support at all for page ranges, since these make
5779 no sense with XHMTL.
5780 Instead, you will just get two index entries, one at either end.
5783 \begin_layout Itemize
5784 Cross-referencing: There is no support for cross-referencing.
5786 finds an entry containing the
5787 \begin_inset Quotes eld
5790 |see\SpecialChar ldots
5792 \begin_inset Quotes erd
5795 construct, it is just dropped, and the rest is treated as an ordinary index
5799 \begin_layout Itemize
5800 Index Entry Order: \SpecialChar LyX
5801 does support attempts to fix the sorting order.
5802 It will take what is before the first `@' it finds and use that for sorting,
5803 taking what follows the first `@' to be the actual entry.
5804 At present, \SpecialChar LyX
5805 does not check for escaped `@', so do not try to index email
5809 \begin_layout Itemize
5810 Index Entry Layout: You can format entries by using the text style dialog,
5811 or by using any other method available within \SpecialChar LyX
5813 There is no support for constructs like:
5814 \begin_inset Quotes eld
5818 \begin_inset Quotes erd
5822 Indeed, if \SpecialChar LyX
5823 finds a pipe symbol, `|', in an entry, it will delete it and
5824 everything that follows it.
5827 \begin_layout Itemize
5828 Multiple Indexes: There is no support for multiple indexes.
5829 Rather, all index entries will be printed as one large index.
5830 To avoid our printing several versions of the index, we print only the
5831 main index, so make sure you have one.
5834 \begin_layout Section
5835 Nomenclature and Glossary
5838 \begin_layout Standard
5839 There is at present no support for glossaries.
5840 Adding it would be fairly trivial, and welcome.
5843 \begin_layout Chapter
5844 The \SpecialChar LyX
5848 \begin_layout Section
5852 \begin_layout Standard
5853 The `\SpecialChar LyX
5854 server' allows other programs to talk to \SpecialChar LyX
5855 , invoke \SpecialChar LyX
5856 commands, and retrieve
5857 information about the \SpecialChar LyX
5859 This is only intended for advanced users, but they should find it useful.
5860 It is by writing to the \SpecialChar LyX
5861 server, for example, that bibliography managers,
5862 such as JabRef, are able to
5863 \begin_inset Quotes eld
5867 \begin_inset Quotes erd
5870 citations to \SpecialChar LyX
5874 \begin_layout Section
5875 Starting the \SpecialChar LyX
5879 \begin_layout Standard
5880 The \SpecialChar LyX
5881 server works through the use of a pair of named pipes.
5882 These are usually located in
5883 \begin_inset Flex Code
5886 \begin_layout Plain Layout
5892 , (except on Windows, where
5896 named pipes are special objects located in
5897 \begin_inset Flex Code
5900 \begin_layout Plain Layout
5912 ) and have the names
5913 \begin_inset Quotes eld
5917 \begin_inset Flex Code
5920 \begin_layout Plain Layout
5927 \begin_inset Quotes erd
5931 \begin_inset Quotes eld
5935 \begin_inset Flex Code
5938 \begin_layout Plain Layout
5945 \begin_inset Quotes erd
5949 External programs write into
5950 \begin_inset Flex Code
5953 \begin_layout Plain Layout
5959 and read back data from
5960 \begin_inset Flex Code
5963 \begin_layout Plain Layout
5970 The stem of the pipe names can be defined in the
5971 \begin_inset Flex Noun
5974 \begin_layout Plain Layout
5975 Tools\SpecialChar menuseparator
5982 \begin_inset Flex Code
5985 \begin_layout Plain Layout
5986 "/home/myhome/lyxpipe"
5992 \begin_inset Flex Code
5995 \begin_layout Plain Layout
6009 on Windows (where any working path instead of lyxpipe can be used, for
6011 \begin_inset Flex Code
6014 \begin_layout Plain Layout
6037 configure this manually in order for the server to start.
6040 \begin_layout Standard
6043 \begin_inset Flex Code
6046 \begin_layout Plain Layout
6053 \begin_inset Flex Code
6056 \begin_layout Plain Layout
6062 ' to create the pipes.
6063 If one of the pipes already exists, \SpecialChar LyX
6064 will assume that another \SpecialChar LyX
6066 is already running and will not start the server.
6067 On POSIX (Unix like) systems, if for some other reason, an unused
6068 \begin_inset Quotes eld
6072 \begin_inset Quotes erd
6075 pipe is left in existence when \SpecialChar LyX
6076 closes, then \SpecialChar LyX
6077 will try to delete it.
6078 If this fails for some reason, you will need to delete the pipes manually
6079 and then restart \SpecialChar LyX
6081 On Windows, pipes are deleted by the OS on program termination or crash,
6083 \begin_inset Quotes eld
6087 \begin_inset Quotes erd
6090 pipes should not be possible.
6093 \begin_layout Standard
6094 To have several \SpecialChar LyX
6095 processes with servers at the same time, you have to use
6096 different configurations, perhaps by using separate user directories, each
6098 \begin_inset Flex Code
6101 \begin_layout Plain Layout
6107 file, for each process.
6110 \begin_layout Standard
6111 If you are developing a client program, you might find it useful to enable
6112 debugging information from the \SpecialChar LyX
6114 Do this by starting \SpecialChar LyX
6116 \begin_inset Flex Code
6119 \begin_layout Plain Layout
6128 \begin_layout Standard
6129 You can find a complete example client written in C++ in the source distribution
6131 \begin_inset Flex Code
6134 \begin_layout Plain Layout
6135 development/lyxserver/server_monitor.cpp
6143 \begin_layout Standard
6144 Another useful tool is the command-line based client found in
6145 \begin_inset Flex Code
6148 \begin_layout Plain Layout
6149 src/client/lyxclient
6157 \begin_layout Section
6158 Normal communication
6161 \begin_layout Standard
6162 To issue a \SpecialChar LyX
6163 call, the client writes a line of ASCII text into the input
6165 This line has the following format:
6182 \begin_layout Description
6183 clientname is a name that the client can choose arbitrarily.
6184 Its only use is that \SpecialChar LyX
6185 will echo it if it sends an answer—so a client can
6186 dispatch results from different requesters.
6189 \begin_layout Description
6190 function is the function you want \SpecialChar LyX
6192 It is the same as the commands you'd use in the minibuffer.
6195 \begin_layout Description
6196 argument is an optional argument which is meaningful only to some functions
6198 \begin_inset Quotes eld
6202 \begin_inset Quotes erd
6205 LFUN will insert the argument as text at the cursor position).
6208 \begin_layout Standard
6209 The answer from \SpecialChar LyX
6210 will arrive in the output pipe and be of the form
6227 \begin_layout Standard
6236 are just echoed from the command request, while
6240 is more or less useful information filled according to how the command
6241 execution worked out.
6242 Some commands, such as
6243 \begin_inset Quotes eld
6247 \begin_inset Quotes erd
6250 , will return information about the internal state of \SpecialChar LyX
6252 return an empty data-response.
6253 This means that the command execution went fine.
6256 \begin_layout Standard
6257 In case of errors, the response from \SpecialChar LyX
6275 \begin_layout Standard
6280 should contain an explanation of why the command failed.
6283 \begin_layout Standard
6287 \begin_layout LyX-Code
6288 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
6289 \begin_inset Newline newline
6292 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
6293 \begin_inset Newline newline
6296 read a <~/.lyxpipe.out
6297 \begin_inset Newline newline
6303 \begin_layout Subsection
6304 AppleScript (Mac OS X)
6307 \begin_layout Standard
6308 Since \SpecialChar LyX
6309 2.1, \SpecialChar LyX
6310 supports basic interactions with AppleScript for normal communicatio
6311 n through the command run.
6312 This command takes a direct argument (the
6316 to perform) and an optional argument.
6317 It either returns the output of the function or triggers an error with
6318 the error message and code.
6321 \begin_layout Standard
6325 \begin_layout LyX-Code
6326 tell application "\SpecialChar LyX
6330 \begin_layout LyX-Code
6334 \begin_layout LyX-Code
6335 -- Stores the current file name into f
6338 \begin_layout LyX-Code
6339 set f to (run "server-get-filename" with argument "")
6342 \begin_layout LyX-Code
6343 on error the error_message number the error_number
6346 \begin_layout LyX-Code
6347 display dialog "Error: " & the error_number & ".
6351 \begin_layout LyX-Code
6352 & the error_message buttons {"OK"} default button 1
6355 \begin_layout LyX-Code
6359 \begin_layout LyX-Code
6363 \begin_layout Section
6367 \begin_layout Standard
6369 can notify clients of events going on asynchronously.
6370 Currently it will only do this if the user binds a key sequence with the
6372 \begin_inset Quotes eld
6376 \begin_inset Quotes erd
6380 The format of the string \SpecialChar LyX
6381 sends is as follows:
6385 \begin_inset Flex Code
6388 \begin_layout Plain Layout
6399 \begin_layout Standard
6404 is the printed representation of the key sequence that was actually typed
6408 \begin_layout Standard
6409 This mechanism can be used to extend \SpecialChar LyX
6410 's command set and implement macros.
6411 Bind some key sequence to
6412 \begin_inset Quotes eld
6416 \begin_inset Quotes erd
6420 Then start a client that listens on the output pipe, dispatches the command
6421 according to the sequence, and starts a function that may use \SpecialChar LyX
6424 requests to issue a command or a series of commands to \SpecialChar LyX
6428 \begin_layout Section
6429 The simple \SpecialChar LyX
6433 \begin_layout Standard
6435 implements a simple protocol that can be used for session management.
6436 All messages are of the form
6449 \begin_layout Standard
6455 \begin_inset Quotes eld
6459 \begin_inset Quotes erd
6463 \begin_inset Quotes eld
6467 \begin_inset Quotes erd
6472 \begin_inset Quotes eld
6476 \begin_inset Quotes erd
6479 is received from a client, \SpecialChar LyX
6480 will report back to inform the client that
6481 it's listening to it's messages, while
6482 \begin_inset Quotes eld
6486 \begin_inset Quotes erd
6489 sent from \SpecialChar LyX
6490 will inform clients that \SpecialChar LyX
6494 \begin_layout Section
6495 Reverse DVI/PDF search
6498 \begin_layout Standard
6499 Some DVI/PDF viewers
6503 \begin_layout Plain Layout
6504 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
6505 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
6514 facility (also called
6519 This means that you can tell \SpecialChar LyX
6520 to put the cursor to a specific line in the
6521 document by clicking at the respective position in the DVI/PDF output.
6522 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
6524 This is done via the \SpecialChar LyX
6525 server either by using the named pipe (
6529 ), or the UNIX domain socket (
6533 ) that \SpecialChar LyX
6534 creates in its temporary directory (this is the way the
6535 \begin_inset Flex Code
6538 \begin_layout Plain Layout
6544 program communicates with \SpecialChar LyX
6546 In some cases, you need a helper script that mediates between the viewer
6547 and \SpecialChar LyX
6548 , in others, the viewer can communicate with \SpecialChar LyX
6550 This depends on the selected viewer and on your operating system.
6551 The same applies to the way viewers need to be configured and the way the
6552 reverse search is actually performed.
6553 In what follows, we will thus describe how to setup reverse search for
6555 Before we turn to this, though, we will explain what needs to be done generally
6556 to enable reverse search in the DVI/PDF output.
6559 \begin_layout Subsection
6561 \begin_inset CommandInset label
6563 name "subsec:rev-search"
6570 \begin_layout Standard
6571 In most cases \SpecialChar LyX
6572 will do the work for you by
6573 \change_inserted -712698321 1500975045
6574 pressing the following button in the toolbar:
6577 arg "buffer-toggle-output-sync"
6581 Alternatively, you can also enable the feature by checking
6583 Synchronize with Output
6586 \begin_inset Flex Noun
6589 \begin_layout Plain Layout
6591 \change_inserted -712698321 1500975071
6592 Document\SpecialChar menuseparator
6593 Settings\SpecialChar menuseparator
6600 \change_deleted -712698321 1500974764
6602 \begin_inset Flex Noun
6605 \begin_layout Plain Layout
6606 Synchronize with Output
6612 \begin_inset Flex Noun
6615 \begin_layout Plain Layout
6616 Document\SpecialChar menuseparator
6617 Settings\SpecialChar menuseparator
6626 In such a case \SpecialChar LyX
6627 will automatically insert the necessary Sync\SpecialChar TeX
6629 PDF) or load the srcltx package (for DVI) respectively.
6630 This option can be easily reached also on
6631 \begin_inset Flex Code
6634 \begin_layout Plain Layout
6643 \begin_layout Standard
6644 If you need a different setting, you can select or input a custom macro
6645 from the drop down box just below
6646 \begin_inset Flex Noun
6649 \begin_layout Plain Layout
6650 Document\SpecialChar menuseparator
6651 Settings\SpecialChar menuseparator
6652 Output\SpecialChar menuseparator
6653 Synchronize with Output
6661 \begin_layout Standard
6662 Note that the method
6663 \begin_inset Flex Code
6666 \begin_layout Plain Layout
6674 enables gzip compression.
6675 If your viewer does not support it, you should instead use
6676 \begin_inset Flex Code
6679 \begin_layout Plain Layout
6690 \begin_layout Standard
6691 Please also note that including the
6692 \begin_inset Flex Code
6695 \begin_layout Plain Layout
6702 \begin_inset Flex Code
6705 \begin_layout Plain Layout
6711 sometimes has an undesired impact on the typesetting.
6712 Thus, you should switch output synchronization off for the final typesetting
6714 \begin_inset Flex Code
6717 \begin_layout Plain Layout
6724 \begin_inset Flex Code
6727 \begin_layout Plain Layout
6737 \begin_layout Standard
6738 In case you need some more special settings that are not covered by the
6739 automatic settings, read the next section about how to set up output synchroniz
6741 If the automatic setup suits your needs, you can readily jump to section
6742 \begin_inset space ~
6746 \begin_inset CommandInset ref
6748 reference "subsec:configuring-viewers"
6752 , where the necessary configuration steps in your viewer – needed both with
6753 the automatic and the manual setup – are described.
6756 \begin_layout Subsection
6760 \begin_layout Standard
6762 provides several different methods for reverse search.
6763 Some are built-in in the
6764 \begin_inset Flex Code
6767 \begin_layout Plain Layout
6773 program, some are provided by external packages.
6774 Your choice depends on whether your \SpecialChar LaTeX
6775 distribution already provides a given
6776 method (the built-in methods are rather new) and whether your viewer can
6778 The available methods are described in the following.
6781 \begin_layout Subsubsection*
6782 Built-in DVI-search via src-specials (DVI only)
6785 \begin_layout Standard
6786 This method provides the DVI file with the necessary information for reverse
6788 It is available in \SpecialChar LaTeX
6789 since quite some time (any somewhat recent \SpecialChar LaTeX
6791 should include it), and it works reliably.
6792 To enable it, change the
6793 \begin_inset Flex Noun
6796 \begin_layout Plain Layout
6807 \begin_inset Flex Noun
6810 \begin_layout Plain Layout
6821 \begin_inset Flex Noun
6824 \begin_layout Plain Layout
6825 Preferences\SpecialChar menuseparator
6826 File Handling\SpecialChar menuseparator
6833 \begin_inset Flex Code
6836 \begin_layout Plain Layout
6837 latex -src-specials $$i
6843 If this doesn't work, check if your \SpecialChar TeX
6844 engine needs different options (the
6845 syntax might differ in some distributions).
6848 \begin_layout Subsubsection*
6849 External Packages (PDFSync and scrltx)
6852 \begin_layout Standard
6861 provide reverse search facility for PDF output (via pdflatex) and DVI output,
6863 In order to enable it, load the packages in the \SpecialChar LyX
6867 \begin_layout Itemize
6868 \begin_inset Flex Code
6871 \begin_layout Plain Layout
6879 for reverse PDF search,
6882 \begin_layout Itemize
6883 \begin_inset Flex Code
6886 \begin_layout Plain Layout
6889 usepackage[active]{srcltx}
6894 for reverse DVI search.
6897 \begin_layout Standard
6898 If you want to be able to perform both DVI and PDF reverse searches, you
6899 can also insert in the preamble the following lines
6902 \begin_layout LyX-Code
6906 \begin_inset Newline newline
6912 \begin_inset Newline newline
6918 \begin_inset Newline newline
6924 \begin_inset Newline newline
6929 usepackage[active]{srcltx}
6930 \begin_inset Newline newline
6938 \begin_layout Standard
6939 This way, you can preview the file as either DVI or PDF (pdflatex) and the
6940 right package will be used.
6943 \begin_layout Standard
6944 Note that PDFSync might affect the output layout of your document.
6945 It is therefore advised to disable PDFsync for final documents.
6948 \begin_layout Subsubsection*
6949 Built-in reverse search via Sync\SpecialChar TeX
6953 \begin_layout Standard
6955 \begin_inset Flex Code
6958 \begin_layout Plain Layout
6964 have built-in support for both PDF and DVI reverse search.
6967 Sync\SpecialChar TeX
6970 facility is basically the result of the integration of the PDFSync package
6971 to the pdftex program and its merge with the
6976 You need at least \SpecialChar TeX
6977 Live 2008 or a recent Mik\SpecialChar TeX
6978 distribution in order to use
6983 \begin_layout Plain Layout
6984 For some reason, Mik\SpecialChar TeX
6985 does not understand/obey the command \SpecialChar LyX
6987 the preamble when you check the "Enable Forward/Reverse Search" button
6988 in the toolbar and does not generate the necessary info.
6991 \begin_layout Plain Layout
6992 The generation of the required info can be forced by changing the converter
6994 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
6995 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
6996 the -synctex=1 switch).
7001 Also note that only a few PDF viewers (
7002 \change_inserted -712698321 1500977288
7005 Okular and Qpdfview on Unix, Skim on the Mac, SumatraPDF on Windows
7006 \change_inserted -712698321 1500977299
7007 ; see the next section for details
7009 ) already provide Sync\SpecialChar TeX
7013 \begin_layout Standard
7014 To enable Sync\SpecialChar TeX
7015 for DVI output, change the
7016 \begin_inset Flex Noun
7019 \begin_layout Plain Layout
7030 \begin_inset Flex Noun
7033 \begin_layout Plain Layout
7044 \begin_inset Flex Noun
7047 \begin_layout Plain Layout
7048 Preferences\SpecialChar menuseparator
7049 File Handling\SpecialChar menuseparator
7056 \begin_inset Flex Code
7059 \begin_layout Plain Layout
7060 latex -synctex=1 $$i
7065 , and for PDF output, change the
7066 \begin_inset Flex Noun
7069 \begin_layout Plain Layout
7074 (pdflatex) -> PDF (pdflatex)
7080 \change_deleted -712698321 1500977453
7084 \begin_inset Flex Code
7087 \begin_layout Plain Layout
7088 pdflatex -synctex=1 $$i
7095 \change_inserted -712698321 1500977740
7096 Should your viewer not be considered in the following description, or in
7097 case of missing success, please
7098 \change_deleted -712698321 1500977741
7100 \change_inserted -712698321 1500977744
7103 heck the documentation of your viewer whether the viewer needs to be configured
7104 for the use with Sync\SpecialChar TeX
7109 \begin_layout Plain Layout
7110 Note that the option
7111 \begin_inset Flex Code
7114 \begin_layout Plain Layout
7120 option enables gzip compression.
7121 If your viewer does not support it, you should instead use
7122 \begin_inset Flex Code
7125 \begin_layout Plain Layout
7139 \begin_layout Subsection
7140 Configuring and using specific viewers
7141 \begin_inset CommandInset label
7143 name "subsec:configuring-viewers"
7150 \begin_layout Subsubsection*
7151 Xdvi (all platforms)
7154 \begin_layout Standard
7156 \begin_inset Flex Code
7159 \begin_layout Plain Layout
7165 , you don't need to do anything else for performing a reverse DVI search,
7167 already provides the necessary hooks for automatically using the
7168 \begin_inset Flex Code
7171 \begin_layout Plain Layout
7178 Just setup your document as described above (reverse search is triggered
7179 by Ctrl-click or Alt-click on Mac OSX, respectively).
7182 \begin_layout Standard
7183 However, if for whatever reason you want to use the named pipe instead of
7184 the socket for communicating with \SpecialChar LyX
7185 , simply change the DVI viewer in
7186 \begin_inset Flex Noun
7189 \begin_layout Plain Layout
7190 Preferences\SpecialChar menuseparator
7191 File Handling\SpecialChar menuseparator
7201 \begin_layout Plain Layout
7202 On Mac OSX you have to use
7203 \begin_inset Flex Code
7206 \begin_layout Plain Layout
7207 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
7218 \begin_inset Flex Code
7221 \begin_layout Plain Layout
7222 xdvi -editor "lyxeditor.sh %f %l"
7228 \begin_inset Flex Code
7231 \begin_layout Plain Layout
7237 is a suitable script.
7238 For example, a minimal shell script is the following one:
7241 \begin_layout LyX-Code
7243 \begin_inset Newline newline
7246 LYXPIPE="/path/to/lyxpipe"
7247 \begin_inset Newline newline
7250 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
7251 \begin_inset Newline newline
7254 echo "$COMMAND" > "${LYXPIPE}".in || exit
7255 \begin_inset Newline newline
7258 read TMP < "${LYXPIPE}".out || exit
7261 \begin_layout Standard
7263 \begin_inset Flex Code
7266 \begin_layout Plain Layout
7272 is the LyXServer pipe path specified in
7273 \begin_inset Flex Noun
7276 \begin_layout Plain Layout
7277 Preferences\SpecialChar menuseparator
7287 \begin_layout Plain Layout
7289 \begin_inset Flex Code
7292 \begin_layout Plain Layout
7298 folder of a source distribution you can find a
7299 \begin_inset Flex Code
7302 \begin_layout Plain Layout
7308 script which is able to locate the
7312 based on your preferences.
7320 \begin_layout Subsubsection*
7324 \begin_layout Standard
7326 \begin_inset Flex Code
7329 \begin_layout Plain Layout
7330 /Applications/MacDviX_Folder/calleditor.script
7335 , add the following lines:
7338 \begin_layout LyX-Code
7339 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
7340 \begin_inset Newline newline
7346 \begin_layout Standard
7347 Modify the lines accordingly if you install \SpecialChar LyX
7348 somewhere else than in the
7349 Applications folder.
7352 \begin_layout Standard
7353 Reverse search is triggered by Alt-click (OPTION-click).
7356 \begin_layout Subsubsection*
7360 \begin_layout Standard
7362 \begin_inset Flex Code
7365 \begin_layout Plain Layout
7366 open -a Skim.app $$i
7371 to the viewer setting in
7372 \begin_inset Flex Noun
7375 \begin_layout Plain Layout
7376 Preferences\SpecialChar menuseparator
7377 File Handling\SpecialChar menuseparator
7378 File formats\SpecialChar menuseparator
7385 \begin_inset Flex Noun
7388 \begin_layout Plain Layout
7389 Skim\SpecialChar menuseparator
7390 Preferences\SpecialChar menuseparator
7397 \begin_inset Flex Noun
7400 \begin_layout Plain Layout
7406 preset and enter command
7407 \begin_inset Flex Noun
7410 \begin_layout Plain Layout
7411 /Applications/\SpecialChar LyX
7412 .app/Contents/MacOS/lyxeditor
7420 \begin_layout Standard
7421 Reverse search is triggered by COMMAND-SHIFT-click
7424 \begin_layout Subsubsection*
7428 \begin_layout Standard
7429 Reverse search with evince does not work out of the box, but it can be achieved
7430 by means of some third party helper scripts.
7432 \begin_inset CommandInset href
7434 target "http://wiki.lyx.org/LyX/SyncTeX"
7442 \begin_layout Subsubsection*
7446 \begin_layout Standard
7448 \begin_inset Flex Noun
7451 \begin_layout Plain Layout
7452 Settings\SpecialChar menuseparator
7453 Configure Okular\SpecialChar menuseparator
7460 \change_inserted -712698321 1500981642
7462 \change_deleted -712698321 1500981641
7466 \change_deleted -712698321 1500981634
7468 \begin_inset Quotes eld
7472 \change_inserted -712698321 1500981635
7476 \begin_inset Quotes erd
7480 \change_inserted -712698321 1500981659
7482 This inserts the appropriate
7483 \change_deleted -712698321 1500981663
7487 \change_inserted -712698321 1500981665
7491 \begin_inset Flex Code
7494 \begin_layout Plain Layout
7501 \change_inserted -712698321 1500981668
7507 \begin_layout Standard
7508 Reverse search is triggered by SHIFT-click.
7511 \begin_layout Subsubsection*
7515 \begin_layout Standard
7516 Qpdfview supports Sync\SpecialChar TeX
7517 since version 0.3.5.
7519 \begin_inset Flex Noun
7522 \begin_layout Plain Layout
7523 Edit\SpecialChar menuseparator
7524 Settings\SpecialChar menuseparator
7530 , click on the input field of the
7531 \begin_inset Quotes eld
7535 \begin_inset Quotes erd
7538 item and add the command
7539 \begin_inset Flex Code
7542 \begin_layout Plain Layout
7551 \begin_layout Standard
7552 Reverse search is triggered by double-click or, in more recent versions,
7556 \begin_layout Subsubsection*
7560 \begin_layout Standard
7561 Launch yap, choose its
7562 \begin_inset Flex Noun
7565 \begin_layout Plain Layout
7566 View\SpecialChar menuseparator
7573 \begin_inset Quotes eld
7577 \begin_inset Quotes erd
7582 \begin_inset Quotes eld
7585 New\SpecialChar ldots
7587 \begin_inset Quotes erd
7590 button and, in the window that opens, enter
7591 \begin_inset Quotes eld
7596 \begin_inset Quotes erd
7599 (or any other name you like) in the
7600 \begin_inset Quotes eld
7604 \begin_inset Quotes erd
7608 Now click on the button labeled
7609 \begin_inset Quotes eld
7614 \begin_inset Quotes erd
7617 to open a file dialog and navigate to the directory containing the batch
7619 \begin_inset Flex Code
7622 \begin_layout Plain Layout
7630 \begin_inset Flex Code
7633 \begin_layout Plain Layout
7639 and then specify the program arguments as
7640 \begin_inset Flex Code
7643 \begin_layout Plain Layout
7651 \begin_inset Flex Code
7654 \begin_layout Plain Layout
7660 wrapper is used for communicating with \SpecialChar LyX
7668 \begin_layout LyX-Code
7670 \begin_inset Newline newline
7673 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
7682 \begin_inset Newline newline
7696 \begin_layout Standard
7697 Make sure that the \SpecialChar LyX
7698 Server pipe path you specified in \SpecialChar LyX
7700 \begin_inset Flex Code
7703 \begin_layout Plain Layout
7717 , otherwise change the
7718 \begin_inset Flex Code
7721 \begin_layout Plain Layout
7727 wrapper accordingly.
7730 \begin_layout Standard
7731 In yap, reverse search is triggered by double-click.
7734 \begin_layout Subsubsection*
7735 SumatraPDF (Windows)
7738 \begin_layout Standard
7739 In order to use SumatraPDF for inverse search, enter
7740 \begin_inset Flex Code
7743 \begin_layout Plain Layout
7744 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
7749 in the viewer setting in
7750 \begin_inset Flex Noun
7753 \begin_layout Plain Layout
7754 Preferences\SpecialChar menuseparator
7755 File Handling\SpecialChar menuseparator
7756 File formats\SpecialChar menuseparator
7763 \begin_inset Flex Code
7766 \begin_layout Plain Layout
7772 is the previous wrapper.
7773 If SumatraPDF.exe is not in your command PATH, use its full file name.
7776 \begin_layout Standard
7777 Reverse search is triggered by double-click.
7780 \begin_layout Subsubsection*
7784 \begin_layout Standard
7785 First of all, make sure that yap is your default DVI viewer in the Windows
7786 environment, then launch it, choose its
7787 \begin_inset Flex Noun
7790 \begin_layout Plain Layout
7791 View\SpecialChar menuseparator
7798 \begin_inset Quotes eld
7802 \begin_inset Quotes erd
7807 \begin_inset Quotes eld
7810 New\SpecialChar ldots
7812 \begin_inset Quotes erd
7815 button and, in the window that opens, enter
7816 \begin_inset Quotes eld
7821 \begin_inset Quotes erd
7824 (or any other name you like) in the
7825 \begin_inset Quotes eld
7829 \begin_inset Quotes erd
7833 Now click on the button labeled
7834 \begin_inset Quotes eld
7839 \begin_inset Quotes erd
7842 to open a file dialog and navigate to the directory containing the
7843 \begin_inset Flex Code
7846 \begin_layout Plain Layout
7852 program (which is installed by default on Cygwin along with the \SpecialChar LyX
7855 \begin_inset Flex Code
7858 \begin_layout Plain Layout
7864 and then specify the program arguments as
7865 \begin_inset Flex Code
7868 \begin_layout Plain Layout
7875 In this way, you will be using the
7879 for communicating with \SpecialChar LyX
7881 If, for whatever reason, you want to use the
7886 \begin_inset Flex Code
7889 \begin_layout Plain Layout
7895 option and be sure to specify the \SpecialChar LyX
7896 Server pipe path in the \SpecialChar LyX
7900 \begin_layout Standard
7901 In yap, reverse search is triggered by double-click.
7904 \begin_layout Subsubsection*
7908 \begin_layout Standard
7909 In order to use SumatraPDF for inverse search, enter
7910 \begin_inset Flex Code
7913 \begin_layout Plain Layout
7914 SumatraPDF -inverse-search "lyxeditor -g %f %l"
7919 in the viewer setting in
7920 \begin_inset Flex Noun
7923 \begin_layout Plain Layout
7924 Preferences\SpecialChar menuseparator
7925 File Handling\SpecialChar menuseparator
7926 File formats\SpecialChar menuseparator
7933 If SumatraPDF.exe is not in your command PATH, use its full posix path.
7935 \begin_inset Flex Code
7938 \begin_layout Plain Layout
7944 enables communication via the
7950 \begin_inset Flex Code
7953 \begin_layout Plain Layout
7959 option if you want to use the
7963 , and be sure to specify the \SpecialChar LyX
7964 Server pipe path in the \SpecialChar LyX
7968 \begin_layout Standard
7969 Reverse search is triggered by double-click.
7972 \begin_layout Section
7976 \begin_layout Standard
7977 Forward search is, as the name implies, in a sense the
7978 \begin_inset Quotes eld
7982 \begin_inset Quotes erd
7986 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
7988 If forward search is set up (as described in what follows), you can put
7989 the cursor anywhere in your \SpecialChar LyX
7991 \begin_inset Flex Noun
7994 \begin_layout Plain Layout
7995 Navigate\SpecialChar menuseparator
8002 \begin_inset Flex Noun
8005 \begin_layout Plain Layout
8011 in the context menu via right mouse click), and then the viewer will jump
8012 to that position as well.
8013 This implies, of course, that your viewer supports this function.
8016 \begin_layout Standard
8017 To make forward search possible, you first need to provide the generated
8018 output PDF/DVI file with additional information about the \SpecialChar TeX
8020 This can be done via the methods described in the section
8021 \begin_inset CommandInset ref
8023 reference "subsec:rev-search"
8030 \begin_layout Standard
8031 Additionally, you need to configure \SpecialChar LyX
8032 for using your viewers in
8033 \begin_inset Flex Noun
8036 \begin_layout Plain Layout
8037 Tools\SpecialChar menuseparator
8038 Preferences\SpecialChar menuseparator
8039 Output\SpecialChar menuseparator
8046 We provide a range of tested configurations for some viewers, which you
8047 can select from the drop down list.
8048 If none of these configurations suits you, you have to find out and enter
8049 a suitable configuration yourself.
8050 The definition syntax uses the following placeholders:
8053 \begin_layout Itemize
8055 \begin_inset Flex Code
8058 \begin_layout Plain Layout
8067 \begin_layout Itemize
8069 \begin_inset Flex Code
8072 \begin_layout Plain Layout
8078 : name of the (temporary) exported .tex file (without path)
8081 \begin_layout Itemize
8083 \begin_inset Flex Code
8086 \begin_layout Plain Layout
8092 : name of the (temporary) exported .tex file (including path)
8095 \begin_layout Itemize
8097 \begin_inset Flex Code
8100 \begin_layout Plain Layout
8106 : name of the exported output file (either dvi or pdf, depending on which
8107 one exists in the temporary directory)
8110 \begin_layout Standard
8111 Note that only some of the viewers provide full and usable forward search
8112 functionality out of the box, among them yap, xdvi, okular
8116 \begin_layout Plain Layout
8117 You might want to set
8118 \begin_inset Flex Code
8121 \begin_layout Plain Layout
8128 \begin_inset Flex Noun
8131 \begin_layout Plain Layout
8132 Tools\SpecialChar menuseparator
8133 Preferences\SpecialChar menuseparator
8134 File Handling\SpecialChar menuseparator
8136 \begin_inset space ~
8149 , qpdfview, and SumatraPDF
8153 \begin_layout Plain Layout
8154 SumatraPDF can also use DDE commands through the external program CMCDDE
8156 \begin_inset CommandInset href
8158 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
8169 Others, such as evince
8173 \begin_layout Plain Layout
8174 Forward search with evince can be achieved by means of third party helper
8177 \begin_inset CommandInset href
8179 target "http://wiki.lyx.org/LyX/SyncTeX"
8189 , require some extra tools in order to use forward search.
8190 While many of the widespread PDF viewers (most notably Adobe Reader) do
8191 not support forward search at all, some other viewers – e.
8192 \begin_inset space \thinspace{}
8196 xpdf – allow at least to reload the document and jump to a specific page
8197 of the file, so you can at least navigate
8198 \begin_inset Quotes eld
8202 \begin_inset Quotes erd
8206 This latter functionality is provided by an external call of synctex (see
8207 the predefined example configurations).
8211 \begin_layout Standard
8212 Forward search works both with DVI and PDF output.
8214 simply checks which preview format you have used before (i.
8215 \begin_inset space \thinspace{}
8218 e., which format is already there in the temporary directory) and chooses
8219 the appropriate configuration for the respective format.
8222 \begin_layout Chapter
8223 Special Document Classes
8226 \begin_layout Section
8230 \begin_layout Standard
8236 \begin_layout Subsection
8240 \begin_layout Standard
8241 This section describes how \SpecialChar LyX
8242 can be used to write articles for submission
8243 to the scientific journal
8245 Astronomy and Astrophysics
8248 \begin_inset Flex URL
8251 \begin_layout Plain Layout
8253 http://www.edpsciences.fr/aa/
8258 ) using Version 5.01 of the document class
8263 This package can be downloaded from the ftp site
8266 \begin_layout Standard
8267 \begin_inset VSpace medskip
8273 \begin_layout Standard
8275 \begin_inset Flex URL
8278 \begin_layout Plain Layout
8280 ftp://ftp.edpsciences.org/pub/aa/readme.html
8288 \begin_layout Standard
8289 \begin_inset VSpace medskip
8295 \begin_layout Standard
8296 A manual comes together with that package, and this text is not meant to
8297 replace the original manual but is merely a short guide in how to realize
8298 the correct form of your paper.
8302 \begin_layout Standard
8303 Please note that the publisher of the journal was changed from Springer
8304 to EDP Sciences starting January 1, 2001.
8305 That change involved also some slight changes to the style files, namely
8306 the removal of the thesaurus command.
8307 The \SpecialChar LyX
8308 class aa supports the newest version of these style files, V 5.01.
8309 If you have an older version installed, please upgrade.
8310 For compatibility, the old (version 4) layout has been kept as
8315 Please refer to the comments in
8318 Dir/layouts/aapaper.layout
8323 \begin_layout Subsection
8327 \begin_layout Standard
8328 It is recommended you start from the example template distributed with \SpecialChar LyX
8330 If you are not using a template, note the following settings:
8333 \begin_layout Itemize
8340 Document\SpecialChar menuseparator
8343 dialog (OK, that one was obvious).
8346 \begin_layout Itemize
8347 Don't change the option
8350 \begin_inset space ~
8360 The whole layout is done by the macros, you shouldn't change anything.
8363 \begin_layout Subsection
8367 \begin_layout Standard
8368 First thing to enter is the header information.
8369 It consists of seven entries, of which some are optional.
8373 \begin_layout Itemize
8381 \begin_layout Itemize
8389 \begin_layout Itemize
8397 \begin_layout Itemize
8405 \begin_layout Itemize
8410 : [optional] if more than one author: whom to contact for offprint requests.
8413 \begin_layout Itemize
8418 : [optional] mail address for contacts.
8421 \begin_layout Itemize
8429 Received: <date>; Accepted <date>
8432 \begin_layout Standard
8433 There is no need to issue the
8439 command, this is done automatically by \SpecialChar LyX
8440 when the header is finished.
8441 Although the order of the single header entries doesn't matter it is advised
8442 to keep the above sequence, just to get the best optics and meets the layout
8443 of the real document.
8446 \begin_layout Standard
8447 If you want to place footnotes in the header block, e.
8448 \begin_inset space \thinspace{}
8452 \begin_inset space \space{}
8455 to state your present address, just use the standard footnote via the menu
8458 Insert\SpecialChar menuseparator
8463 will automagically use the term
8470 \change_inserted -712698321 1501150851
8474 \begin_layout Standard
8476 \change_inserted -712698321 1501150892
8479 Edit\SpecialChar menuseparator
8482 , you'll find two insets which are relevant for the titling:
8485 \begin_layout Itemize
8487 \change_inserted -712698321 1501150936
8494 to mark corresponding author\SpecialChar breakableslash
8496 The institutes are numbered sequentially as they appear in the
8500 field, so you have to put a marker to each author.
8503 \begin_layout Itemize
8505 \change_inserted -712698321 1501150947
8510 to supply an email address for fast contact.
8515 \begin_layout Standard
8516 In addition to these topics, the macros use
8517 \change_deleted -712698321 1501150958
8519 \change_inserted -712698321 1501150961
8522 additional \SpecialChar LaTeX
8524 \change_deleted -712698321 1501150963
8528 \change_deleted -712698321 1501150967
8530 \change_inserted -712698321 1501150967
8533 no counterpart in \SpecialChar LyX
8537 \begin_layout Itemize
8544 to separate different names for more than one author and institute, respectivel
8548 \begin_layout Itemize
8550 \change_deleted -712698321 1501150911
8557 to mark corresponding author/institute pairs.
8558 The institutes are numbered sequentially as they appear in the
8562 field, so you have to put a marker to each author.
8565 \begin_layout Itemize
8567 \change_deleted -712698321 1501150911
8574 to supply an email address for fast contact.
8579 \begin_layout Standard
8581 \change_deleted -712698321 1501150972
8583 \change_inserted -712698321 1501150972
8586 he appropriate command has to be entered in \SpecialChar LyX
8587 and marked as \SpecialChar LaTeX
8593 \begin_layout Subsection
8597 \begin_layout Standard
8598 The abstract should immediately follow the header block.
8599 With version 5 the abstract environment was changed to a command, and there
8600 is now a resctriction to only one paragraph.
8601 In addition, it should contain an entry with the keywords.
8603 \change_deleted -712698321 1501151111
8604 not yet implemented for \SpecialChar LyX
8605 , therefore you have to enter the \SpecialChar LaTeX
8612 by hand and mark it as \SpecialChar LaTeX
8614 \change_inserted -712698321 1501151122
8615 done via the paragraph style
8622 Refer to the example paper.
8625 \begin_layout Subsection
8626 Supported environments
8629 \begin_layout Standard
8630 The A&A paper layout supports the following environments for structuring
8634 \begin_layout Itemize
8640 \begin_layout Itemize
8646 \begin_layout Itemize
8652 \begin_layout Itemize
8658 \begin_layout Itemize
8664 \begin_layout Itemize
8670 \begin_layout Itemize
8676 \begin_layout Itemize
8682 \begin_layout Itemize
8688 \begin_layout Itemize
8694 \begin_layout Itemize
8700 \begin_layout Itemize
8707 \begin_layout Subsection
8708 Commands not supported by \SpecialChar LyX
8712 \begin_layout Standard
8713 Some commands are not yet supported by the
8717 layout for \SpecialChar LyX
8719 Some have already been mentioned.
8720 For the sake of completeness, they are listed all together here:
8723 \begin_layout Itemize
8731 \begin_layout Itemize
8733 \change_deleted -712698321 1501151229
8743 \begin_layout Itemize
8745 \change_deleted -712698321 1501151308
8755 \begin_layout Itemize
8763 \begin_layout Itemize
8765 \change_deleted -712698321 1501151231
8773 \begin_layout Itemize
8775 \change_deleted -712698321 1501151231
8785 \begin_layout Itemize
8793 \begin_layout Itemize
8801 \begin_layout Standard
8802 If you want to use any of these commands, you have to enter them yourself.
8805 Do not forget to mark them as \SpecialChar LaTeX
8809 \begin_layout Subsection
8810 Figure and Table Floats
8813 \begin_layout Standard
8815 provides support for the necessary float environments
8817 figure, figure*, table
8823 , therefore we won't tell much about it here.
8827 \begin_inset space ~
8833 Just remember that tables should be left-aligned.
8834 For that, select the table and change the alignment in
8836 Edit\SpecialChar menuseparator
8838 \begin_inset space ~
8844 \begin_layout Standard
8845 There is only one special thing: the figures with caption besides the figure.
8846 To create such a figure, you have to do the following:
8849 \begin_layout Enumerate
8850 Create a wide figure float:
8852 Insert\SpecialChar menuseparator
8853 Float\SpecialChar menuseparator
8856 , then right click in the figure and select
8859 \begin_inset space ~
8867 \begin_layout Enumerate
8868 Enter your caption text.
8871 \begin_layout Enumerate
8876 to move the cursor above the caption.
8879 \begin_layout Enumerate
8883 \begin_layout Enumerate
8884 Position the cursor behind the figure and insert a horizontal fill:
8886 Insert\SpecialChar menuseparator
8888 \begin_inset space ~
8891 Character\SpecialChar menuseparator
8893 \begin_inset space ~
8901 \begin_layout Enumerate
8902 Switch to \SpecialChar LaTeX
8906 \begin_inset space ~
8914 \begin_layout Enumerate
8924 Do not close the brace!
8927 \begin_layout Enumerate
8928 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
8933 \begin_inset space ~
8945 \begin_layout Standard
8946 Also, refer to the figures in the example paper.
8949 \begin_layout Subsection
8953 \begin_layout Standard
8954 For submission, the paper has to be formated in a special double-spacing
8956 For this purpose, you have to give the option
8960 to the documentclass.
8961 This must be done using the
8962 \change_deleted -712698321 1501151486
8964 \change_inserted -712698321 1501151487
8967 class options field in the
8969 Document\SpecialChar menuseparator
8973 Just enter the string
8980 \begin_layout Subsection
8984 \begin_layout Standard
8989 directory contains an example paper written with \SpecialChar LyX
8991 It is the example paper from the original macro package, translated to
8994 Use it for inspiration, and compare the original \SpecialChar LaTeX
8995 code with \SpecialChar LyX
8999 \begin_layout Section
9004 \begin_layout Standard
9010 \begin_layout Subsection
9014 \begin_layout Standard
9016 is a set of macros produced by the American Astronomical Society to
9017 facilitate electronic manuscript submission to the three journals they
9018 publish: the Astrophysical Journal (including the Letters and Supplement),
9019 the Astronomical Journal, and the Publications of the Astronomical Society
9022 has proven to be an excellent tool for generating these documents, especially
9023 given its equation, citation, and figure handling capabilities.
9025 requires version 5.0 (or higher) of these macros; preferably
9026 \change_deleted -712698321 1501152764
9028 \change_inserted -712698321 1501152766
9031 , which is the version described here, or higher.
9032 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
9033 2.09 and are fundamentally
9034 incompatible with \SpecialChar LyX
9036 The AAS\SpecialChar TeX
9037 package may be downloaded from the AAS\SpecialChar TeX
9041 \begin_layout Standard
9042 \begin_inset VSpace medskip
9048 \begin_layout Standard
9050 \begin_inset Flex URL
9053 \begin_layout Plain Layout
9055 https://aas.org/aastex/aastex-downloads
9063 \begin_layout Standard
9064 \begin_inset VSpace medskip
9070 \begin_layout Standard
9071 A complete user guide is contained in that package and you should familiarize
9072 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
9075 will not reduce the need to figure out all the AAS\SpecialChar TeX
9076 commands, it will only
9077 reduce the drudgery of typing everything in.
9078 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
9080 completely to the requirements of the journal to which you are submitting
9084 \begin_layout Subsection
9085 Starting a New Paper
9088 \begin_layout Standard
9089 I strongly suggest that you start with the AAS\SpecialChar TeX
9093 File\SpecialChar menuseparator
9100 , enter the new file name, then choose the
9103 \change_inserted -712698321 1501152130
9109 This will show the most common fields found in a manuscript.
9110 Simply overwrite the existing text (including the brackets,
9114 ) with the correct information.
9115 Many of the AAS\SpecialChar TeX
9116 commands and environments can be implemented directly in
9119 \change_deleted -712698321 1501152213
9132 , which should stick out like a sore thumb if you actually just opened the
9136 For commands such as these, the \SpecialChar LaTeX
9137 code must be entered directly and marked
9139 Such commands are referred to as \SpecialChar TeX
9140 code, or Evil Red Text.
9141 I tried to minimize the amount of \SpecialChar TeX
9142 code needed in an AAS\SpecialChar TeX
9144 \change_deleted -712698321 1501152220
9145 , but there is still a bit more required than any of us would like
9150 \begin_layout Subsection
9151 Finishing Your Paper
9154 \begin_layout Standard
9155 When the paper is finished to your satisfaction and previews/prints correctly,
9157 \begin_inset Quotes eld
9161 \begin_inset Quotes erd
9164 actions which need to be done before you submit it to the journals.
9168 \begin_layout Enumerate
9169 Export your paper as a \SpecialChar LaTeX
9172 File\SpecialChar menuseparator
9173 Export\SpecialChar menuseparator
9181 \begin_layout Enumerate
9186 file with your favorite text editor
9190 \begin_layout Enumerate
9191 remove the comment lines before the
9200 \begin_layout Enumerate
9205 usepackage...{fontenc}
9207 line if it appears (usually just after
9222 \begin_layout Enumerate
9223 remove everything between (and including) the
9235 commands, except for any commands you specifically put into the \SpecialChar LaTeX
9237 (which should appear immediately after the
9238 \begin_inset Quotes eld
9241 User specified \SpecialChar LaTeX
9243 \begin_inset Quotes erd
9254 \begin_layout Enumerate
9255 Run the resulting file through \SpecialChar LaTeX
9256 to make sure it still processes correctly.
9259 \begin_layout Enumerate
9260 Reread the journal requirements to make sure your filenames and formats
9264 \begin_layout Enumerate
9268 \begin_layout Subsection
9269 Comments On Specific Commands
9272 \begin_layout Standard
9273 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
9280 ) gives a good description of each.
9281 Thus it's probably easiest for me to go down the list as found in the guide
9282 and offer comments where necessary.
9283 So let's begin \SpecialChar ldots
9287 \begin_layout Subsubsection
9288 Things that work as expected
9291 \begin_layout Standard
9292 Because they work as you might expect, I simply list them and the section
9393 begin{thebibliography}
9401 (2.13.2), all the cite commands and their variations (2.13.2), the generic
9402 graphicx figure commands (2.14.1),
9426 (2.15.4, amongst other places),
9453 \begin_layout Standard
9454 The following style options also work correctly:
9475 Simply put them in the
9481 Layout\SpecialChar menuseparator
9487 \begin_layout Subsubsection
9488 Things that work, but require more comment
9491 \begin_layout Standard
9492 The following items work, but require a little more discussion:
9495 \begin_layout Itemize
9496 These items are reserved for use by the journal editors, but you can put
9497 them into the \SpecialChar LaTeX
9498 preamble if you feel compelled to do so:
9531 \begin_layout Itemize
9532 These items may be placed in the \SpecialChar LaTeX
9533 preamble, and are included as blanks in
9555 \begin_layout Itemize
9562 (2.3) – can only be used
9563 \begin_inset Quotes eld
9567 \begin_inset Quotes erd
9570 , not in the middle of a paragraph.
9571 Use \SpecialChar TeX
9572 code if you need to embed it.
9575 \begin_layout Itemize
9582 (2.3) – will have extra {} after it.
9583 This should not cause an error.
9586 \begin_layout Itemize
9593 (2.6) – can only be used
9594 \begin_inset Quotes eld
9598 \begin_inset Quotes erd
9601 , not in the middle of a paragraph.
9602 Use \SpecialChar TeX
9603 code if you need to embed it.
9606 \begin_layout Itemize
9613 (2.8) – can't insert a cross-reference tag, you must type the tag name by
9617 \begin_layout Itemize
9631 \begin_layout Itemize
9638 (2.9) – will have extra {} after it.
9639 This should not cause an error.
9642 \begin_layout Itemize
9649 (2.11) – will have extra {} after it.
9650 This should not cause an error.
9653 \begin_layout Itemize
9660 (2.14.2) – you can insert an optional filename argument by placing the cursor
9661 at the beginning of the text and selecting
9663 Insert\SpecialChar menuseparator
9668 \begin_inset Quotes eld
9672 \begin_inset Quotes erd
9675 inserts an optional argument of the type needed by
9682 Hopefully it will be renamed someday.
9685 \begin_layout Itemize
9698 for the catalog ID optional parameter
9701 \begin_layout Itemize
9714 for the catalog ID optional parameter
9717 \begin_layout Subsubsection
9718 Things not implemented, use \SpecialChar TeX
9722 \begin_layout Standard
9724 \change_deleted -712698321 1501152401
9749 setcounter{equation}
9751 (2.12), Journal name abbreviations (2.13.4),
9787 (2.15.4, insert it as the first element in the lefthand cell after where
9789 Don't use any of \SpecialChar LyX
9790 's rules in the table),
9802 (2.15.5), much of Misc (2.17, except
9853 \begin_layout Subsubsection
9854 Things that cannot be implemented
9857 \begin_layout Standard
9859 at least in any meaningful sort of way, so I suggest ignoring them.
9860 They are the references environment (2.13.3), and the deluxetable environment
9862 If you really, really need to use deluxetable, I suggest editing it in
9863 a separate file with a text editor, then using
9865 Insert\SpecialChar menuseparator
9867 \begin_inset space ~
9872 to include it in your \SpecialChar LyX
9878 file to see an example of this.
9881 \begin_layout Subsection
9882 FAQs, Tips, Tricks, and Other Ruminations
9885 \begin_layout Subsubsection
9886 Getting \SpecialChar LyX
9887 and AAS\SpecialChar TeX
9891 \begin_layout Standard
9892 It can be a bit tricky to get \SpecialChar LyX
9893 to recognize a new layout and document class.
9894 When all else fails, do this:
9897 \begin_layout Enumerate
9898 Make certain that \SpecialChar LaTeX
9899 can find AAS\SpecialChar TeX
9901 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
9903 directory completely unrelated to \SpecialChar LaTeX
9904 or AAS\SpecialChar TeX
9905 and run \SpecialChar LaTeX
9913 \begin_layout Enumerate
9918 appears in \SpecialChar LyX
9926 \begin_layout Enumerate
9929 Tools\SpecialChar menuseparator
9933 , then restart \SpecialChar LyX
9937 \begin_layout Enumerate
9938 Open a regular new file, not from a template.
9939 Does AAS\SpecialChar TeX
9940 appear in the class list in
9942 Document\SpecialChar menuseparator
9948 \begin_layout Standard
9949 If you get a warning from an existing AAS\SpecialChar TeX
9950 document about not being able
9951 to find the AAS\SpecialChar TeX
9952 layout or a message about
9953 \begin_inset Quotes eld
9956 You should not mix title layouts with normal ones
9957 \begin_inset Quotes erd
9960 , things haven't been installed correctly.
9963 \begin_layout Subsubsection
9965 error processing a table
9968 \begin_layout Standard
9970 , by default, attempts to center the table caption/title.
9971 This seems to produce a bad interaction in AAS\SpecialChar TeX
9972 so you should click somewhere
9973 in the caption/title, then select
9975 Edit\SpecialChar menuseparator
9977 \begin_inset space ~
9991 This took care of it for me.
9994 \begin_layout Subsubsection
9998 \begin_layout Standard
9999 A couple of things: 1) I have noticed some funny spacing in the reference
10000 entries in the text.
10001 When you enter the bibliography item data, make sure their is
10005 space between the last author and the parenthesis setting off the year;
10009 \begin_inset space \thinspace{}
10013 \begin_inset space \space{}
10027 2) Entering the references at all is not obvious.
10028 The easiest thing is to start typing your first reference at the end of
10029 the document, then mark it as type
10034 That will put a small gray box in front of what you just typed.
10035 Click on the box to fill in the rest of the information.
10036 For new references, go to the end of an existing reference and press return.
10037 That will create a new line with its own box, etc.
10040 \begin_layout Subsubsection
10041 Including EPS files
10044 \begin_layout Standard
10045 Even though AAS\SpecialChar TeX
10046 provides its own figure commands (
10052 , for example), I much prefer \SpecialChar LaTeX
10053 's standard figure commands (with the default
10062 \begin_inset space ~
10065 commands as \SpecialChar TeX
10066 code into a Figure Float box if you desire, but I never have
10067 much luck getting the layout right.
10068 With the standard graphics, \SpecialChar LyX
10073 usepackage{graphicx}
10075 command into the \SpecialChar LaTeX
10076 preamble and handle the figures in the standard \SpecialChar LaTeX2e
10078 interspersing the figures in the text.
10079 I believe ApJ accepts figures exactly this way now; AJ might still use
10081 \begin_inset Quotes eld
10084 stack everything at the end
10085 \begin_inset Quotes erd
10091 \begin_layout Subsubsection
10092 Things I could have done, but didn't
10095 \begin_layout Standard
10097 \begin_inset Quotes eld
10101 \begin_inset Quotes erd
10104 things I could have implemented, but chose not to.
10105 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
10107 even though it is double-spaced in the paper manuscript.
10108 Also, I chose not to make separate layouts for the preprint and preprint2
10110 Since I assume you will spend most of your time in the plain manuscript
10111 mode anyway, I decided not to chew up more disk space with this.
10115 \begin_layout Subsection
10119 \begin_layout Standard
10120 Your mileage may vary.
10121 I've now had papers published by both ApJ and AJ that have had 98% of the
10122 effort done in \SpecialChar LyX
10123 ; the last 2% was the \SpecialChar LaTeX
10124 post-processing and a few cleanups.
10125 I have had no trouble with the submission process, and I'm sure the journals
10126 were never aware that there might be a difference.
10127 So, go forth and publish!
10130 \begin_layout Section
10131 AMS \SpecialChar LaTeX
10135 \begin_layout Standard
10145 \begin_layout Standard
10146 \begin_inset VSpace bigskip
10152 \begin_layout Standard
10154 The AMS \SpecialChar LaTeX
10155 layouts are set up to conform to suggested styles for mathematical
10156 papers to be submitted to American Mathematical Society publications.
10157 The layouts are not tailored to a specific journal, but easily can be.
10158 You should refer to the AMS documentation for specific instructions for
10159 each journal (usually it will entail only changing a single line in the
10162 That documentation is available on the Web at
10163 \begin_inset Flex URL
10166 \begin_layout Plain Layout
10174 \begin_inset Flex URL
10177 \begin_layout Plain Layout
10179 ftp://ftp.ams.org/pub/tex/amslatex/
10185 These layouts are appropriate, and useful, for any mathematical writing.
10189 \begin_layout Standard
10190 There are two basic AMS \SpecialChar LaTeX
10194 \begin_layout Itemize
10195 amsart: The standard AMS article format.
10198 \begin_layout Itemize
10199 amsbook: the standard AMS book (really, monograph) format.
10203 \begin_layout Standard
10204 The layouts themselves contain only the minimum necessary to use the AMS
10206 They do not, in particular, contain any of the `theorem' environments used
10207 for setting theorems, lemmas, and the like.
10208 These are contained, instead, in the
10209 \begin_inset Flex Code
10212 \begin_layout Plain Layout
10218 module, which is loaded by default when you select one of the AMS classes.
10219 (It can also be used with other classes and can be removed, if you would
10220 rather use something else.) Less commonly used environments are in the
10221 \begin_inset Flex Code
10224 \begin_layout Plain Layout
10225 Theorems (AMS-Extended)
10230 module, which must be loaded manually.
10233 \begin_layout Standard
10234 By default, theorems and the like are numbered consecutively throughout
10235 the document, but this may be modified by loading the module
10236 \begin_inset Flex Code
10239 \begin_layout Plain Layout
10240 Theorems (Order by Section)
10245 or, if you are using
10246 \begin_inset Flex Code
10249 \begin_layout Plain Layout
10256 \begin_inset Flex Code
10259 \begin_layout Plain Layout
10260 Theorems (Order by Chapter)
10266 These will number the results as
10267 \begin_inset Formula $n.m$
10270 , where the first number refers to the section (or chapter) and the second
10271 refers to the total number of results so far in that section (or chapter).
10272 Many environments are also available unnumbered.
10273 These are indicated by an asterisk at the end.
10274 If you happen to want
10278 unnumbered results, the module
10279 \begin_inset Flex Code
10282 \begin_layout Plain Layout
10288 provides that option.
10291 \begin_layout Standard
10292 Note that these modules do not
10296 to be used with the AMS classes.
10297 It is perfectly possible to use the
10298 \begin_inset Flex Code
10301 \begin_layout Plain Layout
10307 module, and the others mentioned, with other classes, such as
10308 \begin_inset Flex Code
10311 \begin_layout Plain Layout
10318 \begin_inset Flex Code
10321 \begin_layout Plain Layout
10328 \begin_inset Flex Code
10331 \begin_layout Plain Layout
10340 \begin_layout Subsection
10341 What these layouts provide
10344 \begin_layout Standard
10345 There is a long list of included environments provided by these layouts.
10346 In AMS-\SpecialChar LaTeX
10347 , there is, in fact, an opportunity to define an unlimited variety
10348 of `theorem' environments.
10349 However, the AMS recommends the environments that are available in \SpecialChar LyX
10354 \begin_layout Standard
10355 The following environments—as well as the standard environments, such as
10357 \begin_inset Flex Noun
10360 \begin_layout Plain Layout
10367 \begin_inset Flex Noun
10370 \begin_layout Plain Layout
10377 \begin_inset Flex Noun
10380 \begin_layout Plain Layout
10387 \begin_inset Flex Noun
10390 \begin_layout Plain Layout
10397 \begin_inset Flex Noun
10400 \begin_layout Plain Layout
10407 \begin_inset Flex Code
10410 \begin_layout Plain Layout
10417 \begin_inset Flex Code
10420 \begin_layout Plain Layout
10429 \begin_layout Description
10430 Address This should be the author's permanent address.
10433 \begin_layout Description
10435 \begin_inset space ~
10438 Address This should be the author's temporary address at the time of submission,
10439 if different from the Address.
10442 \begin_layout Description
10443 Email Author's e-mail address
10446 \begin_layout Description
10447 URL Author's Web address, if desired.
10450 \begin_layout Description
10451 Keywords Key words or phrases used to identify specific topics discussed
10455 \begin_layout Description
10456 Subjectclass These refer to the AMS Subject Classifications, published and
10459 Mathematical Reviews
10462 These are also available online at the AMS cites listed above.
10465 \begin_layout Description
10469 \begin_layout Description
10473 \begin_layout Description
10477 \begin_layout Standard
10478 The following environments are provided by both the
10479 \begin_inset Flex Code
10482 \begin_layout Plain Layout
10489 \begin_inset Flex Code
10492 \begin_layout Plain Layout
10498 modules, in the latter case in both starred (unnumbered) and unstarred
10499 (numbered) versions.
10500 These same environments are provided only in the starred versions by the
10502 \begin_inset Flex Code
10505 \begin_layout Plain Layout
10514 \begin_layout Theorem
10515 This is typically used for the statements of major results.
10519 \begin_layout Corollary*
10520 This is used for statements which follow fairly directly from previous statement
10522 Again, these can be major results.
10526 \begin_layout Lemma
10527 These are smaller results needed to prove other statements.
10530 \begin_layout Proposition
10531 These are less major results which (hopefully) add to the general theory
10535 \begin_layout Conjecture
10536 These are statements provided without justification, which the author does
10537 not know how to prove, but which seem to be true (to the author, at least).
10540 \begin_layout Definition*
10541 Guess what this is for.
10542 The font is different for this environment than for the previous ones.
10546 \begin_layout Example*
10547 Used for examples illustrating proven results.
10550 \begin_layout Problem
10551 It's not really known what this is for.
10552 You should figure it out.
10555 \begin_layout Exercise*
10556 Write a description for this one.
10559 \begin_layout Remark
10560 This environment is also a type of theorem, usually a lesser sort of observation.
10563 \begin_layout Claim*
10564 Often used in the course of giving a proof of a larger result.
10568 Generally, these are used to break up long arguments, using specific instances
10574 The numbering scheme for cases is on its own, not together with other numbered
10579 \begin_layout Proof
10580 At the end of this environment, a QED symbol (usually a square, but it can
10581 vary with different styles) is placed.
10582 If you want to have other environments within this one—for example, Case
10583 environments—and have the QED symbol appear only after them, then the other
10584 environments need to be nested within the proof environment.
10587 Nesting Environments
10593 for information on nesting.
10596 \begin_layout Standard
10597 And these environments are provided by
10598 \begin_inset Flex Code
10601 \begin_layout Plain Layout
10602 Theorems (AMS-Extended)
10610 \begin_layout Criterion*
10611 A required condition.
10614 \begin_layout Algorithm*
10615 A general procedure to be used.
10618 \begin_layout Axiom*
10619 This is a property or statement taken as true within the system being discussed.
10622 \begin_layout Condition*
10623 Sometimes used to state a condition assumed within the present context of
10627 \begin_layout Note*
10628 Similar to a Remark.
10631 \begin_layout Notation*
10632 Used for the explanation of, yes, notation.
10635 \begin_layout Summary
10636 Do we really need to tell you?
10639 \begin_layout Acknowledgement*
10643 \begin_layout Conclusion*
10644 Sometimes used at the end of a long train of argument.
10648 Used in a way similar to Proposition, though perhaps lower on the scale.
10651 \begin_layout Standard
10652 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
10655 They need to be available on your system in order to use these environments.
10658 \begin_layout Section
10666 \begin_layout Standard
10672 \begin_layout Subsection
10676 \begin_layout Standard
10677 These are the layout files for some of the journals of the American Geophysical
10679 It is assumed that you have both the AGU's own class files and AGUplus
10680 installed (everything to be found at
10681 \begin_inset Flex URL
10684 \begin_layout Plain Layout
10686 http://publications.agu.org/files/2013/08/AGU-LaTeX.zip
10694 \begin_layout Subsection
10698 \begin_layout Standard
10708 They are still called this in the \SpecialChar LyX
10709 GUI, though their \SpecialChar LaTeX
10722 \begin_layout Standard
10723 Newly defined styles are
10760 These are mostly manuscript attributes and defined in the AGU class documentati
10764 \begin_layout Standard
10765 I suspect this is still badly incomplete.
10768 \begin_layout Subsection
10772 \begin_layout Standard
10789 \begin_layout Subsection
10793 \begin_layout Itemize
10796 Journal of Geophysical Research
10805 \begin_layout Standard
10806 Add your own, it isn't so hard! Look at the
10817 \begin_layout Subsection
10818 Bugs and things to remember
10821 \begin_layout Standard
10822 In order to use the new layouts, you must remember to do the following for
10826 \begin_layout Enumerate
10832 This can be done in the
10834 Layout\SpecialChar menuseparator
10839 Document\SpecialChar menuseparator
10843 (AGU articles are always in English, right? So
10847 choose a language.)
10850 \begin_layout Enumerate
10855 into the document's
10860 (Yes, this is a bug.)
10863 \begin_layout Enumerate
10864 Make sure you use the
10868 bibliography style, by entering
10872 into the second field of the Bib\SpecialChar TeX
10874 None of the standard styles will do.
10877 \begin_layout Section
10881 \begin_layout Standard
10887 \begin_layout Subsection
10891 \begin_layout Standard
10892 Broadway is for writing plays.
10893 The format is more decorative than Hollywood, and much less standardized.
10894 This format should be suitable for workshops.
10897 \begin_layout Subsection
10901 \begin_layout Standard
10902 The same as in Hollywood.
10905 \begin_layout Subsection
10909 \begin_layout Standard
10914 names as labels then cross-reference the label to insert the name.
10915 The cross-reference dialog will show the current cast of characters.
10918 \begin_layout Subsection
10919 Paper size and Margins
10922 \begin_layout Standard
10923 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
10926 \begin_layout Subsection
10930 \begin_layout Standard
10931 The following environments are available.
10932 You can use broadway.bind to get the bind keys shown at the right.
10935 \begin_layout Itemize
10939 \begin_inset Newline newline
10944 You should not have to use this, but it is here for anything that does not
10948 \begin_layout Itemize
10952 \begin_inset space \hfill{}
10956 \begin_inset Newline newline
10961 Used to describe stage setting and the action.
10962 First use of speaker names in all CAPs.
10965 \begin_layout Itemize
10969 \begin_inset space \hfill{}
10973 \begin_inset Newline newline
10978 Automatically numbered.
10979 On screen it will be arabic, but will print as Roman.
10982 \begin_layout Itemize
10986 \begin_inset space \hfill{}
10990 \begin_inset Newline newline
11000 It is just centered text.
11003 \begin_layout Itemize
11007 \begin_inset space \hfill{}
11011 \begin_inset Newline newline
11016 Not automatically numbered.
11017 You supply the number.
11018 This is because I couldn't figure out how.
11021 \begin_layout Itemize
11025 \begin_inset space \hfill{}
11029 \begin_inset Newline newline
11034 A special case of Narrative to describe the setting and action as the curtain
11038 \begin_layout Itemize
11042 \begin_inset space \hfill{}
11046 \begin_inset Newline newline
11051 The speaker's (actor's) title, centered in all CAPS.
11054 \begin_layout Itemize
11058 \begin_inset space \hfill{}
11062 \begin_inset Newline newline
11067 Instructions to the speaker.
11068 The parentheses are automatically inserted.
11069 The ( will appear on screen, but both will be in the printed play.
11070 This environment is only used within
11077 \begin_layout Itemize
11081 \begin_inset space \hfill{}
11085 \begin_inset Newline newline
11090 What the Speaker says.
11093 \begin_layout Itemize
11097 \begin_inset space \hfill{}
11101 \begin_inset Newline newline
11106 The curtain comes down.
11109 \begin_layout Itemize
11113 \begin_inset space \hfill{}
11119 \begin_layout Itemize
11123 \begin_inset space \hfill{}
11129 \begin_layout Itemize
11133 \begin_inset space \hfill{}
11139 \begin_layout Standard
11143 \begin_layout Section
11147 \begin_layout Standard
11152 can be used to type letters according to German conventions.
11153 A template file is included in
11155 .../lyx/share/templates
11157 for you to use as a starting point.
11160 \begin_layout Section
11168 \begin_layout Standard
11174 \begin_layout Subsection
11178 \begin_layout Standard
11179 This is the layout file for the European Geophysical Society journals.
11184 can be downloaded from the web site of the EGS under
11185 \begin_inset Flex URL
11188 \begin_layout Plain Layout
11198 \begin_layout Subsection
11202 \begin_layout Standard
11205 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
11213 The current layout file is unfortunately very unmodular and would benefit
11214 from using the various
11221 \begin_layout Section
11225 \begin_layout Standard
11226 See the \SpecialChar LyX
11232 It contains all infos you need.
11235 \begin_layout Section
11238 Foil\SpecialChar TeX
11242 \begin_inset CommandInset label
11251 \begin_layout Standard
11257 \begin_layout Subsection
11261 \begin_layout Standard
11262 This section describes how to use \SpecialChar LyX
11263 to make slides for overhead projectors.
11264 There are two document classes that can do this: the default slides class
11267 Foil\SpecialChar TeX
11271 This section documents the latter.
11274 \begin_layout Standard
11275 I'm going to say this again, nice and clear, so that there's no misunderstanding
11279 \begin_layout Standard
11280 \begin_inset VSpace bigskip
11286 \begin_layout Standard
11290 This section documents the class
11291 \begin_inset Quotes eld
11299 \begin_inset Quotes erd
11307 \begin_layout Standard
11308 \begin_inset VSpace bigskip
11314 \begin_layout Standard
11315 If you're looking for the documentation for
11316 \begin_inset Quotes eld
11324 \begin_inset Quotes erd
11327 , check out section
11328 \begin_inset space ~
11332 \begin_inset CommandInset ref
11334 reference "sec:slitex"
11339 If your machine doesn't have the
11347 installed, you'll probably have to use the default
11351 class, which isn't quite as good as
11356 \begin_layout Standard
11361 class is designed for use with version
11362 \begin_inset space ~
11370 class file which is now an integral part of \SpecialChar LaTeX2e
11374 \begin_layout Subsection
11378 \begin_layout Standard
11379 Obviously, to use this document class, you need to select
11390 \begin_inset space ~
11396 There are some settings in the
11399 \begin_inset space ~
11404 dialog that you should know about that are specific to this class:
11407 \begin_layout Itemize
11408 Don't change the options
11419 \begin_inset space ~
11425 They're ignored by the
11432 \begin_layout Itemize
11433 The default font size is 20
11434 \begin_inset space \thinspace{}
11437 pt with the other options being 17
11438 \begin_inset space \thinspace{}
11442 \begin_inset space \thinspace{}
11446 \begin_inset space \thinspace{}
11452 \begin_layout Itemize
11453 The default font is
11461 but all math equations are still typeset in the usual roman font.
11464 \begin_layout Itemize
11467 Foil\SpecialChar TeX
11470 supports A4 and Letter paper sizes as well as a special size for working
11472 \begin_inset space \thinspace{}
11476 It doesn't support A5, B5, legal or executive paper sizes.
11479 \begin_layout Itemize
11480 Don't bother changing the
11484 settings because they are ignored anyway.
11485 All floats appear where they are defined in the text.
11488 \begin_layout Itemize
11493 setting behaves a bit differently for this class.
11496 Foil\SpecialChar TeX
11499 provides extensive footer and header capabilities including a user-defined
11502 \begin_inset space ~
11506 \begin_inset CommandInset ref
11508 reference "sec:foilfoot"
11513 The title page is treated differently to all other pages in the document
11522 has the logo centered at the bottom of the page (if one is defined).
11523 The possible page style choices and what they do are as follows:
11527 \begin_layout Labeling
11528 \labelwidthstring MMMMMMM
11535 The final output contains no page numbers, or other headers or footers
11536 (except footnotes of course).
11540 \begin_layout Labeling
11541 \labelwidthstring MMMMMMM
11548 The final output contains page numbers centered at the bottom of the page.
11549 No other headings or footers (other than footnotes).
11552 \begin_layout Labeling
11553 \labelwidthstring MMMMMMM
11558 Page numbers in lower right corner.
11559 Additional headers and footers are also shown.
11560 This is also the default.
11563 \begin_layout Labeling
11564 \labelwidthstring MMMMMMM
11569 Gives you access to the
11573 package although its use with
11575 Foil\SpecialChar TeX
11578 is discouraged by the writer of the
11580 Foil\SpecialChar TeX
11583 package because of some potential page layout clashes.
11587 \begin_layout Subsubsection
11591 \begin_layout Standard
11592 The following options may be used in the extra class options in the
11594 Document\SpecialChar menuseparator
11600 \begin_layout Labeling
11601 \labelwidthstring MMMMMMx
11606 This sets up the page layout for 7.33
11607 \begin_inset space \thinspace{}
11611 \begin_inset space \thinspace{}
11614 in paper, which is about the same aspect ratio as a 35
11615 \begin_inset space \thinspace{}
11618 mm slide, making it a bit easier to work with this medium.
11621 \begin_layout Labeling
11622 \labelwidthstring MMMMMMx
11627 Places a rule across the page below the header on every page except the
11631 \begin_layout Labeling
11632 \labelwidthstring MMMMMMx
11637 Places a rule across the page above the footer on every page except the
11641 \begin_layout Labeling
11642 \labelwidthstring MMMMMMx
11647 This is automatically set each time you create a new
11654 Foil\SpecialChar TeX
11657 to use the dvips driver to rotate those pages that are set as landscape
11661 \begin_layout Labeling
11662 \labelwidthstring MMMMMMx
11667 Simply changes the page dimensions to those of a landscape page but doesn't
11669 Thus if you use this option you need to use an external program to rotate
11670 each page or feed your paper through your printer as landscape.
11671 Note that this option effectively reverses the roles of the
11679 environments (don't worry these are described in the next section).
11682 \begin_layout Labeling
11683 \labelwidthstring MMMMMMx
11688 Equation numbers on the left.
11691 \begin_layout Labeling
11692 \labelwidthstring MMMMMMx
11697 Flush-left equations.
11700 \begin_layout Subsection
11701 Supported Environments
11704 \begin_layout Standard
11705 Most of the environments commonly supported in other classes are also supported
11711 There are several additional environments provided by
11713 Foil\SpecialChar TeX
11716 as well as a couple added by \SpecialChar LyX
11718 The following environments are shared with other classes:
11721 \begin_layout Standard
11722 \begin_inset Flex Multiple Columns
11725 \begin_layout Itemize
11731 \begin_layout Itemize
11737 \begin_layout Itemize
11743 \begin_layout Itemize
11749 \begin_layout Itemize
11755 \begin_layout Itemize
11762 \begin_layout Itemize
11768 \begin_layout Itemize
11774 \begin_layout Itemize
11780 \begin_layout Itemize
11784 \change_deleted -712698321 1501158884
11788 \begin_layout Itemize
11794 \begin_layout Itemize
11800 \begin_layout Itemize
11806 \begin_layout Itemize
11812 \begin_layout Itemize
11818 \begin_layout Itemize
11824 \begin_layout Itemize
11826 \change_deleted -712698321 1501158888
11834 \begin_layout Itemize
11836 \change_deleted -712698321 1501158891
11849 \begin_layout Standard
11850 That is, all the major environments apart from the sectioning environments.
11851 Since foils are essentially self-contained sections, with a title and body,
11854 Foil\SpecialChar TeX
11857 provides specific commands for starting new foils and these are:
11860 \begin_layout Itemize
11866 \begin_layout Itemize
11872 \begin_layout Standard
11874 also provides slightly modified versions of these two environments called:
11877 \begin_layout Itemize
11883 \begin_layout Itemize
11886 ShortRotatefoilhead
11889 \begin_layout Standard
11890 and the differences will be explained in the next section.
11893 \begin_layout Standard
11894 Since foils are often used in presenting ideas or new theorems and such
11897 Foil\SpecialChar TeX
11900 also provides a comprehensive box of goodies for presenting them:
11903 \begin_layout Standard
11904 \begin_inset Flex Multiple Columns
11907 \begin_layout Itemize
11913 \begin_layout Itemize
11919 \begin_layout Itemize
11925 \begin_layout Itemize
11931 \begin_layout Itemize
11937 \begin_layout Itemize
11943 \begin_layout Itemize
11949 \begin_layout Itemize
11955 \begin_layout Itemize
11961 \begin_layout Itemize
11967 \begin_layout Itemize
11978 \begin_layout Standard
11979 The starred versions are unnumbered while the unstarred versions are numbered.
11980 There are also two list environments added by \SpecialChar LyX
11984 \begin_layout Itemize
11990 \begin_layout Itemize
11996 \begin_layout Standard
11999 Foil\SpecialChar TeX
12002 provides some powerful header and footer capabilities that are best set
12003 in the preamble although they may be set at any point in a document.
12004 If you want to change these settings in your document the best place to
12005 do so is at the very top of a foil, i.
12006 \begin_inset space \thinspace{}
12012 \begin_inset space \space{}
12017 straight after the foilhead.
12020 \begin_layout Standard
12021 For this purpose, the following command styles are provided [
12028 \begin_layout Standard
12029 \begin_inset Flex Multiple Columns
12032 \begin_layout Itemize
12036 \begin_inset space ~
12042 \begin_layout Itemize
12048 \begin_layout Itemize
12052 \begin_inset space ~
12058 \begin_layout Itemize
12062 \begin_inset space ~
12068 \begin_layout Itemize
12072 \begin_inset space ~
12079 \begin_layout Plain Layout
12080 \begin_inset space ~
12092 \begin_layout Standard
12093 There are also a few commands provided by
12095 Foil\SpecialChar TeX
12098 that aren't directly supported by \SpecialChar LyX
12099 but I'll tell you what they do and how
12100 to use them in section
12101 \begin_inset space ~
12105 \begin_inset CommandInset ref
12107 reference "sec:unsuppfoils"
12114 \begin_layout Subsection
12115 Building a Set of Foils
12118 \begin_layout Standard
12119 This section will give a simple introduction to using the different environments
12120 to build a set of foils.
12121 If you want to see an example set of foils, take a look at the
12125 file you find in \SpecialChar LyX
12133 \begin_layout Subsubsection
12134 Give It a Title Page
12137 \begin_layout Standard
12138 Unlike other classes that provide
12158 creates the title on a page of its own.
12159 If you leave out the
12163 environment \SpecialChar LaTeX
12164 will substitute the current date (every time you regenerate
12168 \begin_layout Subsubsection
12172 \begin_layout Standard
12173 As I mentioned earlier, there are four ways of starting a new foil.
12174 For portrait foils you should use
12183 The difference between these two environments is the amount of space between
12184 the title of the foil (the foilhead) and the body of the foil.
12187 \begin_layout Standard
12188 Landscape foils are generated using the
12194 ShortRotatefoilhead
12197 Again the only difference is the spacing between foilhead and body.
12198 Both of the short versions have 0.5
12199 \begin_inset space ~
12202 inches less separation between the foilhead and the body.
12206 \begin_layout Standard
12207 One problem with the support for landscape foils is the requirement that
12208 you have to use the
12212 driver to generate the PostScript output otherwise the foils won't be rotated.
12213 It is possible to get landscape foils even if you haven't got the
12217 driver provided you can feed your foils sideways through your printer ;-)
12220 \begin_layout Subsubsection
12221 Theorems, Lemmas, Proofs and more
12224 \begin_layout Standard
12226 \change_deleted -712698321 1501160146
12227 Due to a small bug in \SpecialChar LyX
12229 \change_inserted -712698321 1501160146
12232 ou can't have two of the same type of these environments directly following
12235 \change_inserted -712698321 1501160182
12236 If you use a normal paragraph break,
12237 \change_deleted -712698321 1501160188
12238 They must be separated by something.
12241 , you will just be extending the previous environment as if you had merged
12242 the two environments together.
12244 \change_deleted -712698321 1501160194
12245 So, how do you get around this problem? The simplest option is to insert
12246 some text between the two environments or add a
12251 environment between the two with just a
12252 \begin_inset Quotes eld
12260 \begin_inset Quotes erd
12264 This will force \SpecialChar LyX
12265 to produce two separate environments and hence the correct
12268 An example is provided in the example file included with the \SpecialChar LyX
12270 Remember, this problem only occurs if you are trying to place two of the
12271 same type of theorem-like environments one directly after the other.
12273 \change_inserted -712698321 1501160255
12274 Rather than that, you need to insert a so-called separator.
12275 Please refer to the section entitled
12288 \begin_layout Subsubsection
12292 \begin_layout Standard
12293 You get all the commonly supported list styles found in other classes as
12294 well as two new ones.
12295 I'll only describe the new ones here.
12296 If you want to find out more about the other list environments check out
12302 If you intend to use itemized lists you might also want to read about the
12306 \begin_inset space ~
12310 \begin_inset space ~
12315 dialog described above in section
12316 \begin_inset space ~
12320 \begin_inset CommandInset ref
12322 reference "sec:bullet"
12329 \begin_layout Standard
12330 The two new list styles,
12338 , are designed to make it easier for you to create lists of do's and don'ts
12339 or right and wrong by providing dedicated environments that use a tick
12340 or a cross as the label of the list.
12341 These lists are in fact dedicated variants of the
12346 They do however require that you have the
12350 packages installed.
12353 \begin_layout Subsubsection
12357 \begin_layout Standard
12360 Foil\SpecialChar TeX
12363 redefines the floating tables and figures so that they appear exactly where
12364 they are in the text rather than pushing them to the top of the page or
12365 to some user specified location.
12366 In fact if you change the float placement settings they are simply ignored.
12369 \begin_layout Subsubsection
12370 Page Headers and Footers
12371 \begin_inset CommandInset label
12373 name "sec:foilfoot"
12380 \begin_layout Standard
12384 \begin_inset space ~
12393 are two commands used to control the left-footer text string.
12394 The first is meant to allow you to include a graphic logo on your foils
12396 \begin_inset Quotes eld
12401 Foil\SpecialChar TeX
12405 \begin_inset Quotes erd
12409 While the second is meant to provide a classification for the audience,
12413 \begin_inset space \thinspace{}
12419 \begin_inset space \space{}
12423 It is empty by default.
12426 \begin_layout Standard
12427 The remaining page corners can be filled by
12430 \begin_inset space ~
12435 (which defaults to page numbers),
12438 \begin_inset space ~
12446 \begin_inset space ~
12454 \begin_layout Subsection
12457 Foil\SpecialChar TeX
12461 \begin_inset CommandInset label
12463 name "sec:unsuppfoils"
12470 \begin_layout Standard
12471 All the commands mentioned below need to be set in a
12481 within another environment.
12484 \begin_layout Subsubsection
12488 \begin_layout Standard
12489 All lengths are adjusted using the
12512 should be replaced by the name given to the length you want to change and
12517 is the length value.
12518 All lengths should be specified in units of length such as inches (
12530 ) or relative to some document or font-based length such as
12540 \begin_layout Standard
12541 It's possible to change the spacing between a foilhead and the body of the
12542 foil by adjusting the length specified by
12549 For example, to make
12554 \begin_inset space \space{}
12557 in closer to their bodies put the following in the preamble:
12563 foilheadskip}{-0.5in}
12566 \begin_layout Standard
12567 The spacings around floats can be adjusted by setting these lengths:
12570 \begin_layout Labeling
12571 \labelwidthstring MMMMMMMMMMM
12578 Separation between the text and the top of the float
12581 \begin_layout Labeling
12582 \labelwidthstring MMMMMMMMMMM
12589 Separation between the float and the caption
12592 \begin_layout Labeling
12593 \labelwidthstring MMMMMMMMMMM
12600 Separation between the caption and the following text
12603 \begin_layout Labeling
12604 \labelwidthstring MMMMMMMMMMM
12611 You can make the captions narrower than the surrounding text by adjusting
12613 Best done relative to
12622 \begin_layout Standard
12623 There are also several title page related lengths that you may find useful
12624 if you have a long title or several authors:
12627 \begin_layout Labeling
12628 \labelwidthstring MMMMMMMMMMM
12635 Separation from headers to
12640 \begin_layout Labeling
12641 \labelwidthstring MMMMMMMMMMM
12659 \begin_layout Labeling
12660 \labelwidthstring MMMMMMMMMMM
12674 \begin_layout Labeling
12675 \labelwidthstring MMMMMMMMMMM
12691 \begin_layout Labeling
12692 \labelwidthstring MMMMMMMMMMM
12708 \begin_layout Standard
12709 The last length related command affects all the list environments.
12720 a list environment then all the vertical spacing between the list items
12722 Note that this is a command not a length so it doesn't require
12728 like the stuff mentioned above.
12731 \begin_layout Subsubsection
12732 Headers and Footers
12735 \begin_layout Standard
12748 commands control whether the logo in the
12752 definition appear on a given page.
12759 in the preamble then none of the foils will have the logo on them.
12760 If you don't want the logo on a particular page place the
12766 directly after the foilhead of that page and the
12772 directly after the next foilhead.
12775 \begin_layout Standard
12776 If you decide to use the
12780 page style setting in the
12783 \begin_inset space ~
12788 dialog you should probably add
12798 to your preamble so headers and footers on landscape pages are correctly
12799 placed when rotated.
12800 This is due to some clashes between the page layouts provided by the
12811 \begin_layout Section
12812 Hollywood (Hollywood spec scripts)
12815 \begin_layout Standard
12821 \begin_layout Subsection
12825 \begin_layout Standard
12826 Getting the format of a Hollywood script right is a
12827 \begin_inset Quotes eld
12831 \begin_inset Quotes erd
12834 It is designed to make the readers focus on content and to be easy and
12835 familiar for the actors to read.
12836 Each page of a script should be one minute of film.
12837 Nothing goes in a script that you cannot see or hear on screen.
12838 The courier 12 pt font should be used throughout.
12842 \begin_layout Subsection
12846 \begin_layout Standard
12847 Speakers' lines should NEVER break in mid-sentence.
12848 If a speaker's lines continue over a page break, repeat the
12852 title followed by (Cont'd).
12855 \begin_layout Subsection
12859 \begin_layout Standard
12864 names as labels then cross-reference the label to insert the name.
12865 The cross-reference dialog will show the current cast of characters.
12866 You can use this to insert the speaker name in narratives also.
12869 \begin_layout Subsection
12870 Paper size and Margins
12873 \begin_layout Standard
12874 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12877 \begin_layout Subsection
12881 \begin_layout Standard
12882 The following environments are available.
12883 You can use hollywood.bind to get the bind keys shown at the right.
12886 \begin_layout Itemize
12890 \begin_inset Newline newline
12895 Used where nothing else works.
12899 \begin_layout Itemize
12905 \begin_inset space \hfill{}
12913 \begin_inset Newline newline
12916 Usually followed by something like
12917 \begin_inset Quotes eld
12920 on Sally waking up.
12921 \begin_inset Quotes erd
12927 \begin_layout Itemize
12931 \begin_inset space \hfill{}
12935 \begin_inset Newline newline
12940 Introduces a new INTERIOR camera set-up.
12941 Always followed by DAY or NIGHT, or something similar to define the lighting
12943 Everthing on this line in CAPS.
12946 \begin_layout Itemize
12950 \begin_inset space \hfill{}
12954 \begin_inset Newline newline
12959 Introduces a new EXTERIOR camera set-up.
12960 Everthing on this line in CAPS.
12963 \begin_layout Itemize
12967 \begin_inset space \hfill{}
12971 \begin_inset Newline newline
12976 The character speaking.
12979 \begin_layout Itemize
12983 \begin_inset space \hfill{}
12987 \begin_inset Newline newline
12992 Instructions to the speaker.
12993 The () are automatically inserted
12994 \change_deleted -712698321 1501161286
12995 , but only the ( will show in \SpecialChar LyX
12997 Both will be printed
13002 \begin_layout Itemize
13006 \begin_inset space \hfill{}
13010 \begin_inset Newline newline
13022 \begin_layout Itemize
13026 \begin_inset space \hfill{}
13030 \begin_inset Newline newline
13035 Camera movement instruction.
13037 \begin_inset space \thinspace{}
13041 \begin_inset space \space{}
13047 \begin_layout Itemize
13051 \begin_inset space \hfill{}
13057 \begin_layout Itemize
13061 \begin_inset space \hfill{}
13067 \begin_layout Itemize
13071 \begin_inset space \hfill{}
13077 \begin_layout Itemize
13081 \begin_inset space \hfill{}
13087 \begin_layout Subsection
13091 \begin_layout Itemize
13095 \begin_layout Itemize
13099 \begin_layout Itemize
13101 \begin_inset space \thinspace{}
13108 \begin_layout Itemize
13113 \begin_layout Itemize
13114 PAN — camera movement
13117 \begin_layout Itemize
13118 INSERT — cut to close-up of
13121 \begin_layout Section
13125 \begin_layout Standard
13128 Panayotis Papasotiriou
13131 \begin_layout Subsection
13135 \begin_layout Standard
13136 The ijmpc package is a set of macros that facilitates electronic manuscript
13139 International Journal of Modern Physics C
13142 Similarly, the ijmpd package is for creating manuscripts to be submitted
13145 International Journal of Modern Physics D
13148 Both journals are published by World Scientific.
13149 The corresponding document classes are named
13158 These files, together with instructions for the authors, can be downloaded
13160 \begin_inset Flex URL
13163 \begin_layout Plain Layout
13165 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
13171 \begin_inset Flex URL
13174 \begin_layout Plain Layout
13176 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
13182 Both packages are modified versions of the standard
13183 \begin_inset Quotes eld
13187 \begin_inset Quotes erd
13190 package, and they are almost (but not exactly) identical.
13191 Most of their features are supported by \SpecialChar LyX
13193 I have used \SpecialChar LyX
13194 successfully to write articles submitted to both journals
13195 without any problem.
13198 \begin_layout Subsection
13202 \begin_layout Standard
13203 As usual, the easiest way to write a paper is to start with a template.
13206 File\SpecialChar menuseparator
13222 This will give an (almost) empty document that includes the most common
13223 fields found in a manuscript.
13224 Simply overwrite the existing text (including the brackets,
13229 You should keep in mind the following remarks.
13232 \begin_layout Enumerate
13234 won't let you change the font size and the page style of the document,
13235 because such modifications are not allowed by both packages.
13238 \begin_layout Enumerate
13239 The language of the document should not be changed.
13240 Before previewing your paper, be sure that the babel package is not used.
13241 To do this, click on
13242 \change_inserted -712698321 1501082726
13246 arg "dialog-show document"
13252 \change_deleted -712698321 1501082743
13257 \SpecialChar menuseparator
13259 \change_deleted -712698321 1501082747
13261 \change_inserted -712698321 1501082748
13267 \change_deleted -712698321 1501082762
13276 checkbox in the language settings, and click on
13284 , if you wish to make this change permanent)
13285 \change_inserted -712698321 1501082770
13287 \begin_inset Quotes eld
13291 \begin_inset Quotes erd
13303 \begin_layout Enumerate
13305 \begin_inset Quotes eld
13309 \begin_inset Quotes erd
13312 style must be used to define keywords.
13315 \begin_layout Enumerate
13316 The ijmpc package provides a style named
13317 \begin_inset Quotes eld
13320 Classification Codes
13321 \begin_inset Quotes erd
13324 , which can be used to define classification codes, such as PACS numbers.
13325 Note that this facility is not supported by the ijmpd package.
13328 \begin_layout Enumerate
13329 Several new environments are available:
13330 \begin_inset Quotes eld
13334 \begin_inset Quotes erd
13338 \begin_inset Quotes eld
13342 \begin_inset Quotes erd
13346 \begin_inset Quotes eld
13350 \begin_inset Quotes erd
13354 \begin_inset Quotes eld
13358 \begin_inset Quotes erd
13362 \begin_inset Quotes eld
13366 \begin_inset Quotes erd
13370 \begin_inset Quotes eld
13374 \begin_inset Quotes erd
13378 \begin_inset Quotes eld
13382 \begin_inset Quotes erd
13386 \begin_inset Quotes eld
13390 \begin_inset Quotes erd
13394 \begin_inset Quotes eld
13398 \begin_inset Quotes erd
13402 \begin_inset Quotes eld
13406 \begin_inset Quotes erd
13410 \begin_inset Quotes eld
13414 \begin_inset Quotes erd
13418 \begin_inset Quotes eld
13422 \begin_inset Quotes erd
13426 \begin_inset Quotes eld
13430 \begin_inset Quotes erd
13434 \begin_inset Quotes eld
13438 \begin_inset Quotes erd
13442 Their use is more or less obvious.
13444 supports all these environments; it will use the proper label, text style,
13445 and numbering scheme for each of them.
13448 \begin_layout Enumerate
13449 Both packages use basic citations; the natbib package should not be used.
13450 In \SpecialChar LyX
13451 , citation references are shown as usual; in the output, citations are
13452 shown as superscripts.
13453 If you want to use a citation as normal text, you should use the
13458 \begin_inset space \thinspace{}
13462 \begin_inset space \space{}
13466 \begin_inset Quotes eld
13470 \begin_inset space \space{}
13480 \begin_inset Quotes erd
13486 \begin_layout Enumerate
13488 \begin_inset Quotes eld
13492 \begin_inset Quotes erd
13495 section in both packages.
13496 To put acknowledgments, just use the
13497 \begin_inset Quotes eld
13501 \begin_inset Quotes erd
13507 \begin_layout Enumerate
13508 Appendices may be added to the paper,
13512 the Acknowledgments and
13518 provides a special environment, called
13519 \begin_inset Quotes eld
13523 \begin_inset Quotes erd
13526 which marks the beginning of the appendices.
13527 This environment should be left blank; it just sends a \SpecialChar LaTeX
13528 command, but nothing
13530 In \SpecialChar LyX
13532 \begin_inset Quotes eld
13536 \begin_inset Quotes erd
13539 is printed with blue letters, as a signal that all sections after that
13540 point are appendices.
13541 To write an appendix, use the
13542 \begin_inset Quotes eld
13546 \begin_inset Quotes erd
13551 will number each appendix with capital letters, as required by both journals.
13553 \begin_inset Quotes eld
13557 \begin_inset Quotes erd
13564 be present before the first appendix; if not, all appendices will be numbered
13565 as normal sections in the output.
13568 \begin_layout Enumerate
13569 The ijmpc and the ijmpd packages use the
13573 command to implement table captions.
13574 As a result, a table created by \SpecialChar LyX
13575 is printed correctly, but its caption
13577 However, you can use some \SpecialChar TeX
13578 code to overcome this problem, so that captions
13579 are printed as expected.
13580 To do so, create a float table as usual, remove the caption, and replace
13581 it with the \SpecialChar TeX
13592 (sic); you must also the \SpecialChar TeX
13597 immediately after the tabular material.
13598 Study the example table included in the template files to see how this
13599 trick is implemented.
13600 Alternatively, If you need table captions, you should implement the whole
13605 file, then include this file to the \SpecialChar LyX
13608 Insert\SpecialChar menuseparator
13609 File\SpecialChar menuseparator
13611 \begin_inset space ~
13617 Details on how to create a table float can be found in the files
13625 , included in the corresponding packages.
13628 \begin_layout Subsection
13629 Preparing a paper for submission
13632 \begin_layout Standard
13633 Before you submit your paper you must export the \SpecialChar LyX
13634 document as a \SpecialChar LaTeX
13637 File\SpecialChar menuseparator
13638 Export\SpecialChar menuseparator
13646 \begin_layout Plain Layout
13647 Actually you have the choice between \SpecialChar LaTeX
13648 (plain) and pdflatex.
13649 If you intend to use pdflatex to prepare the paper, you should use the
13650 pdflatex option so that included graphics are converted to PDF format,
13651 ready for use by pdflatex.
13656 , then make the following changes to the resulting
13663 \begin_layout Enumerate
13664 Remove the comment lines before the
13673 \begin_layout Enumerate
13674 Remove everything between (and including) the
13686 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13690 \begin_layout Standard
13695 file should be saved and processed through \SpecialChar LaTeX
13696 as many times as necessary.
13697 You may also want to check the resulting
13704 \begin_layout Subsection
13706 \change_deleted -712698321 1501082212
13707 Use of \SpecialChar TeX
13711 \begin_layout Standard
13713 \change_deleted -712698321 1501082212
13714 The use of \SpecialChar TeX
13715 code is reduced to two commands, which must be placed at the
13716 top of the document.
13717 If you started writing your paper by using the
13725 template, the \SpecialChar TeX
13726 code needed is already in its place; you usually don't need
13728 You may only modify the first \SpecialChar TeX
13729 code to specify the information printed
13730 to the top of odd and even pages (authors' names and short paper's title,
13732 This \SpecialChar TeX
13733 code must have the form
13737 markboth{Authors' Names}{Short Paper's Title}
13744 \begin_layout Section
13748 \begin_layout Standard
13754 \begin_layout Subsection
13758 \begin_layout Standard
13759 The iopart package provides a document class to create electronic manuscript
13760 submission to the journals published by the Institute of Physics.
13761 Instructions for the authors how to create a paper using the iopart class
13762 can be downloaded together with the iopart package from the site
13763 \begin_inset Flex URL
13766 \begin_layout Plain Layout
13768 ftp://ftp.iop.org/pub/journals/latex2e
13776 \begin_layout Subsection
13780 \begin_layout Standard
13781 The easiest way to write a paper is to start with the
13782 \change_deleted -712698321 1501162201
13784 \change_inserted -712698321 1501162202
13792 \change_deleted -712698321 1501162208
13793 in \SpecialChar LyX
13794 's examples files folder
13795 \change_inserted -712698321 1501162222
13798 File\SpecialChar menuseparator
13799 New From Template\SpecialChar ldots
13801 \change_deleted -712698321 1501162219
13808 \change_deleted -712698321 1501162234
13809 Open this file, save it under a new name, and start writing.
13813 \change_deleted -712698321 1501162238
13815 \change_inserted -712698321 1501162239
13818 explains how to use the special text environments.
13819 Here are the most important advices:
13822 \begin_layout Itemize
13823 To be able to compile your document to a PDF, PS, or DVI, ensure that the
13825 \change_deleted -712698321 1501162254
13828 Use AMS math package
13830 in the document settings under
13835 \change_inserted -712698321 1501162277
13836 no AMS packages are loaded in
13838 Document\SpecialChar menuseparator
13839 Settings\SpecialChar menuseparator
13847 \begin_layout Itemize
13850 The title environment defines the kind of your paper.
13851 So use one of the following environments for the title:
13855 \begin_layout Itemize
13864 \begin_layout Itemize
13873 \begin_layout Itemize
13879 for a Topical review
13882 \begin_layout Itemize
13891 \begin_layout Itemize
13900 \begin_layout Itemize
13906 for a Paper (same as Title)
13909 \begin_layout Itemize
13915 for a Preliminary communication
13918 \begin_layout Itemize
13924 for a Rapid communication
13927 \begin_layout Itemize
13933 for a Letter to the editor
13937 \begin_layout Itemize
13940 All title environments except of
13944 can have an optional short title.
13947 \begin_layout Itemize
13948 There is a general title environment
13952 which is not directly supported by
13953 \change_deleted -712698321 1501162663
13958 This can be used as \SpecialChar TeX
13959 code when your document doesn't fit into one of the
13963 \begin_layout Standard
13964 For more informations like hints for special table and formula formatting,
13965 look at the IOP author guidelines.
13968 \begin_layout Section
13972 \begin_layout Standard
13975 Panayotis Papasotiriou
13978 \begin_layout Subsection
13982 \begin_layout Standard
13983 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
13984 that facilitates electronic manuscript submission to the journals they
13986 Most known of them (at least in my domain of interest) are
13988 Astrophysics and Space Science
13994 , but there are many others (see a complete list at
13995 \begin_inset Flex URL
13998 \begin_layout Plain Layout
14000 http://www.wkap.nl/jrnllist.htm/JRNLHOME
14006 The Kluwer package may be downloaded from the site
14007 \begin_inset Flex URL
14010 \begin_layout Plain Layout
14012 http://www.wkap.nl/kaphtml.htm/STYLEFILES
14018 A complete user guide is contained in that package (but it can also be
14019 downloaded separately).
14022 \begin_layout Standard
14024 supports many features of the package but not everything.
14025 However, the \SpecialChar TeX
14026 code needed is reduced to some
14027 \begin_inset Quotes eld
14031 \begin_inset Quotes erd
14034 commands of the package (see
14035 \begin_inset space ~
14039 \begin_inset CommandInset ref
14041 reference "subsec:kluwer_peculiarities"
14046 I have recently used \SpecialChar LyX
14047 to write an article submitted to the
14049 Astrophysics and Space Science
14051 without any problem.
14054 \begin_layout Subsection
14058 \begin_layout Standard
14059 The easiest way to write a paper is to start with the Kluwer template file.
14062 File\SpecialChar menuseparator
14074 This will give an (almost) empty document that includes the most common
14075 fields found in a manuscript and a short description of their use.
14076 As in most templates, simply overwrite the existing text (including the
14081 ) with the correct information.
14084 \begin_layout Subsection
14085 Preparing a paper for submission
14088 \begin_layout Standard
14089 As in the AAS\SpecialChar TeX
14090 package, before you submit your paper to a journal you must
14092 \begin_inset Quotes eld
14096 \begin_inset Quotes erd
14102 \begin_layout Enumerate
14103 Export your paper as a \SpecialChar LaTeX
14105 To do this, click on
14107 File\SpecialChar menuseparator
14108 Export\SpecialChar menuseparator
14116 \begin_layout Enumerate
14121 file with a text editor and make the following changes
14125 \begin_layout Enumerate
14126 remove the comment lines before the
14135 \begin_layout Enumerate
14136 remove everything between (and including) the
14148 commands, except for any commands you specifically put into the \SpecialChar LaTeX
14152 \begin_layout Standard
14161 \begin_layout Enumerate
14166 file through \SpecialChar LaTeX
14167 as many times as necessary (usually up to three).
14170 \begin_layout Enumerate
14176 \begin_inset space \thinspace{}
14180 \begin_inset space \space{}
14187 , and check if everything is OK (it should, if you didn't make any mistake).
14190 \begin_layout Subsection
14191 \begin_inset Quotes eld
14195 \begin_inset Quotes erd
14198 of the Kluwer package
14199 \begin_inset CommandInset label
14201 name "subsec:kluwer_peculiarities"
14208 \begin_layout Standard
14209 The Kluwer package has the following
14210 \begin_inset Quotes eld
14214 \begin_inset Quotes erd
14220 \begin_layout Enumerate
14221 It is possible to write multiple articles in the same \SpecialChar LaTeX
14226 \begin_layout Plain Layout
14227 I can't imagine any good reason to do this.
14233 Each article must be included in the environment
14234 \begin_inset Quotes eld
14238 \begin_inset Quotes erd
14242 Unfortunately, this environment cannot be omitted, even if you write just
14244 Therefore, each article starts with the command
14250 and, obviously, ends with the command
14257 Although this can be implemented in \SpecialChar LyX
14258 , I didn't included it, since it looks
14259 ugly and can confuse the novice user.
14260 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
14263 \begin_inset Quotes eld
14268 \begin_inset Quotes erd
14274 \begin_layout Enumerate
14275 Information given at the beginning of the article (i.
14276 \begin_inset space \thinspace{}
14280 \begin_inset space \space{}
14283 title, subtitle, author, institution, running title, running author, abstract
14284 and keywords) must be included in an environment called
14285 \begin_inset Quotes eld
14289 \begin_inset Quotes erd
14293 This is not implemented in \SpecialChar LyX
14294 , so you must enter title, subtitle etc.
14295 \begin_inset space ~
14298 between two \SpecialChar TeX
14314 \begin_layout Enumerate
14315 According to the user manual, the label of each bibliography item must be
14339 \begin_layout Standard
14344 template takes care of all these
14345 \begin_inset Quotes eld
14349 \begin_inset Quotes erd
14353 If you start a new paper using this template you don't need to do anything
14358 \begin_layout Enumerate
14359 don't delete the \SpecialChar TeX
14360 code included in the template, and
14363 \begin_layout Enumerate
14364 copy the example bibliography item included in the template and modify it
14365 as necessary to enter new bibliography items.
14368 \begin_layout Section
14372 \begin_layout Standard
14378 \begin_layout Subsection
14382 \begin_layout Standard
14383 The \SpecialChar LyX
14386 article (koma-script)
14390 report (koma-script)
14408 correspond to the \SpecialChar LaTeX
14426 \begin_inset space ~
14429 of the Koma-Script family.
14430 They are replacements for the standard document classes
14446 , resp., and fit better to European typography conventions in a number of
14450 \begin_layout Itemize
14451 Standard character size is 11pt in
14453 article (koma-script)
14457 report (koma-script)
14465 letter (koma-script)
14470 \begin_layout Itemize
14471 Headings, labels of the description environment, and a number of elements
14474 letter (koma-script)
14476 document class are set in a bold sans serif font.
14480 \begin_layout Plain Layout
14481 There is a big difference between the bold sans serif old cm fonts and new
14482 ec fonts, especially in the appearance of headings.
14483 In comparison, the ec bold sans serif fonts look a bit thin.
14484 Here the \SpecialChar LaTeX
14493 helps to produce the
14494 \begin_inset Quotes eld
14498 \begin_inset Quotes erd
14501 appearance when using the ec fonts.
14506 The numbering of chapter headings is made in the same way as the numbering
14507 of section headings, that is without the extra line
14508 \begin_inset Quotes eld
14511 Chapter\SpecialChar ldots
14513 \begin_inset Quotes erd
14517 In addition, the appearance of the headings can be modified by using a
14518 number of options (in \SpecialChar LyX
14519 to be entered in the field
14522 \begin_inset space ~
14529 Layout\SpecialChar menuseparator
14536 \begin_layout Itemize
14537 The main means in the Koma-Script document classes to design the type area
14546 (in \SpecialChar LyX
14547 to be entered in the extra class options field in the dialog
14549 Document\SpecialChar menuseparator
14553 They make a clearer modification of page margins possible as do the options
14556 Document\SpecialChar menuseparator
14563 \begin_layout Itemize
14564 The \SpecialChar LaTeX
14565 document classes of the Koma-Script family define a number of additional
14567 Those part of it which makes sense in \SpecialChar LyX
14568 is implemented in corresponding
14572 \begin_layout Standard
14573 Detailed descriptions of the \SpecialChar LaTeX
14574 document classes of the Koma-Script family
14575 can be found in the Koma-Script documentation
14586 \begin_layout Subsection
14587 article (koma-script), report (koma-script), and book (koma-script)
14590 \begin_layout Standard
14591 The document classes
14593 article (koma-script)
14597 report (koma-script)
14607 are implemented in the layout files
14620 They contain all the paragraph types of the corresponding standard document
14633 , resp., partly modified, with the exception of the \SpecialChar LyX
14638 -type, which is replaced by the new
14642 -type having the same functionality.
14647 -Type there is a number of new paragraph types added.
14654 letter (koma-script)
14659 \begin_layout Itemize
14668 : are equivalents to
14676 , resp., additionally inserting an entry in the table of contents.
14685 are not contained in
14687 article (koma-script)
14692 \begin_layout Itemize
14701 : behave exactly as
14709 , resp., additionally clearing running heads.
14714 is not contained in
14716 article (koma-script)
14722 \begin_layout Plain Layout
14735 report (koma-script)
14737 , but since this is identical to
14741 , is has not been implemented in \SpecialChar LyX
14750 \begin_layout Itemize
14755 : generates a heading directly above the following paragraph in the standard
14756 character size without affecting the structure of the document.
14759 \begin_layout Itemize
14768 are special captions which respect the different space settings needed
14769 for captions placed above or below an element (if you follow strict typographic
14770 rules, you might want to place table captions always above the table).
14771 You can also use the class option
14775 , which will switch
14788 You need at least Koma-Script version 2.8q to use this.
14791 \begin_layout Itemize
14796 : can be used to set a bonmot, e.
14797 \begin_inset space \thinspace{}
14801 \begin_inset space \space{}
14804 at the beginning of a chapter.
14805 If you use the optional argument (
14807 Insert\SpecialChar menuseparator
14809 \change_deleted -712698321 1501163301
14811 \begin_inset space ~
14815 \change_inserted -712698321 1501163306
14817 \begin_inset space ~
14824 ), you can insert the dictum's author there.
14825 Dictum and author are separated by a line.
14826 You need at least Koma-Script version 2.8q to use this.
14831 is not contained in
14833 article (koma-script)
14838 \begin_layout Standard
14839 The following types, together with the standard types
14851 , form the title area of the document.
14852 They must be entered ahead of the first
14853 \begin_inset Quotes eld
14857 \begin_inset Quotes erd
14864 \begin_layout Plain Layout
14865 The corresponding \SpecialChar LaTeX
14866 commands must appear before the
14877 When such a type is used more than once, the latter usage overwrites the
14878 former one, that means, for every type only the latest usage is valid.
14879 The order of the different types however has, like
14891 , no effect on the appearance of the produced document.
14894 \begin_layout Itemize
14899 : produces a centered paragraph above the ordinary title (
14911 ) for the subject of the document.
14914 \begin_layout Itemize
14919 : produces a centered paragraph below the ordinary title (
14931 ) for the publishers' name.
14934 \begin_layout Itemize
14941 report (koma-script)
14947 produces a centered paragraph on its own page behind the title page, or
14950 article (koma-script)
14952 produces a centered paragraph below the ordinary title (
14968 ) for a dedication.
14971 \begin_layout Itemize
14976 : produces a left aligned paragraph above the ordinary title (
14992 ) for a document`s head.
14995 \begin_layout Itemize
15000 : produces in a double-sided print in
15002 report (koma-script)
15008 a left-aligned paragraph at the top of the title page`s back or has no
15009 effect in a single-sided print or in
15011 article (koma-script)
15016 \begin_layout Itemize
15021 : produces in a double-sided print in
15023 report (koma-script)
15029 a left-aligned paragraph at the bottom of the title page`s back or has
15030 no effect in a single-sided print or in
15032 article (koma-script)
15037 \begin_layout Itemize
15042 : produces a special
15043 \begin_inset Quotes eld
15047 \begin_inset Quotes erd
15050 page ahead of the actual document containing a paragraph without special
15054 \begin_layout Standard
15055 The layout files for the document classes
15057 article (koma-script)
15061 report (koma-script)
15067 do include the file
15072 This is thought of as a place to define your own types.
15077 in your personal layout directory and edit the file!
15080 \begin_layout Subsection
15081 letter (koma-script)
15084 \begin_layout Description
15086 \change_inserted -712698321 1501163945
15087 Note: This section discusses the obsolete
15089 KOMA-Script-Letter (v.
15090 \begin_inset space ~
15095 , which is not even included anymore in recent KOMA releases.
15096 Please refer to the next section for the current KOMA-Script-Letter class
15098 \begin_inset space ~
15104 \begin_layout Standard
15108 letter (koma-script)
15110 is implemented in the layout file
15115 It contains all the paragraph types of the corresponding standard document
15120 , partly modified, with the exception of the \SpecialChar LyX
15134 type, which is replaced by the new
15139 In addition, it contains, in contrast to the standard document class, the
15158 Furthermore, there are a number of new letter specific types.
15161 \begin_layout Standard
15162 The appearance of the letter produced by this document class can be controlled
15163 by a number of \SpecialChar LaTeX
15164 commands, which you can put in the \SpecialChar LaTeX
15169 \begin_layout Plain Layout
15170 For example, the standard appearance of the letter`s heading, consisting
15171 of name and address, is quite self-willed.
15173 \begin_inset Quotes eld
15177 \begin_inset Quotes erd
15180 heading is produced by the following \SpecialChar LaTeX
15181 commands in the preamble:
15184 \begin_layout LyX-Code
15194 \begin_layout LyX-Code
15210 \begin_layout LyX-Code
15220 \begin_layout LyX-Code
15240 A detailed German description of such \SpecialChar LaTeX
15241 commands can be found in the Koma-Script
15247 With it, the letter's author can produce his personal letter layout.
15250 \begin_layout Standard
15259 define the beginning of the letter and must be used in every letter.
15260 To emphasize them in the \SpecialChar LyX
15261 document class, they are marked with the letter
15271 \begin_inset space ~
15274 in the left margin.
15275 It is possible to write any number of letters in one file.
15280 type produces a new letter using the same addressee and a
15284 type produces a new addressee.
15301 are ordinary paragraph types and can also be used several times in one
15302 and the same letter.
15305 \begin_layout Itemize
15310 : produces a paragraph for the addressee and implicitly defines the beginning
15314 \begin_layout Itemize
15319 : produces a paragraph for the form of address and implicitly produces a
15323 \begin_layout Itemize
15328 : produces a paragraph for a close.
15331 \begin_layout Itemize
15336 : produces a paragraph for a postscript.
15339 \begin_layout Itemize
15344 : produces a paragraph for a distribution list.
15347 \begin_layout Itemize
15352 : produces a paragraph for enclosures.
15355 \begin_layout Standard
15396 are input types provided with a label to enter information, which will
15397 be processed by the document class.
15401 \begin_layout Plain Layout
15402 It could be seen as a matter of inconsequence, that the types
15410 described above are not such input types as well.
15411 Because of the special meaning of those types, however, I have implemented
15412 them as ordinary paragraph types with a one letter mark in the left margin.
15413 Moreover, it would affect my feeling of symmetry, if the
15421 type had such a serious different appearance.
15426 The types must be used ahead of the corresponding
15433 \begin_layout Standard
15434 An implementation of these types in a WYSIWYG fashion does not seem to make
15435 sense, because the real appearance of the produced letter does not only
15436 depend on the usage of the particular type, but also on other factors.
15437 For example, a signature entered in the
15441 type will in the standard behavior appear in the produced letter only,
15442 when in the same letter also a
15447 The entered value of the
15451 type will in the standard behavior not appear in the produced letter at
15453 The possibility to design the letter`s heading freely is already indicated
15454 in a footnote above.
15457 \begin_layout Standard
15458 The input types can also be used as empty paragraphs.
15459 This makes sense e.
15460 \begin_inset space \thinspace{}
15464 \begin_inset space \space{}
15476 type is not used at all, in the standard behavior the value of the
15480 type is used as signature, whereas if an empty
15484 type is used, no signature value is defined.
15487 \begin_layout Standard
15488 By using the input types it is possible to write a letter template, containing
15489 filled input types with your personal dates (name, address, etc.) and empty
15490 input types for other dates you want to enter.
15493 \begin_layout Itemize
15498 : sender's name, in the standard behavior appears as a centered paragraph
15499 in small caps in the letter`s heading.
15502 \begin_layout Itemize
15507 : sender's signature, in the standard behavior appears below the
15516 type is used, the value of the
15520 type appears instead.
15523 \begin_layout Itemize
15528 : sender's address, in the standard behavior appears in a centered paragraph
15529 in the letter`s heading below the sender's name.
15532 \begin_layout Itemize
15537 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
15548 \begin_layout Itemize
15553 : place of the letter`s making.
15556 \begin_layout Itemize
15561 : date of the letter`s making.
15570 , in the standard behavior, produce the place and the date in a right-aligned
15571 line below the addressee's field.
15576 type is used, neither place nor date appear, independent of the value of
15586 type is used, the date of the letter `s production is used.
15589 \begin_layout Itemize
15594 : sender`s back address, in the standard behavior appears above the addressee's
15595 field in a small sans serif font.
15598 \begin_layout Itemize
15603 : special mail information, in the standard behavior appears underlined
15604 above the addressee's field below the back address.
15607 \begin_layout Itemize
15612 : additional information, in the standard behavior appears on right side
15613 below the addressee`s field.
15616 \begin_layout Itemize
15621 : the letter's title, in the standard behavior appears in a big, bold, sans
15622 serif font above the subject.
15625 \begin_layout Itemize
15630 : the letter's subject, in the standard behavior appears in a bold font
15638 \begin_layout Standard
15659 produce a business letter like line above the
15663 line containing the fields
15664 \begin_inset Quotes eld
15668 \begin_inset Quotes erd
15672 \begin_inset Quotes eld
15676 \begin_inset Quotes erd
15680 \begin_inset Quotes eld
15684 \begin_inset Quotes erd
15688 \begin_inset Quotes eld
15692 \begin_inset Quotes erd
15696 \begin_inset Quotes eld
15700 \begin_inset Quotes erd
15704 \begin_inset Quotes eld
15708 \begin_inset Quotes erd
15712 For the date field, the value of the
15718 \begin_inset Quotes eld
15721 business letter types
15722 \begin_inset Quotes erd
15725 is used, the value of the
15729 type however does not appear, but only the \SpecialChar LaTeX
15737 The ordinary output of place and date in a right-aligned line below the
15738 addressee`s field is suppressed.
15739 The types are implemented as input types provided with a label and must
15740 be used ahead of the corresponding
15747 \begin_layout Itemize
15755 \begin_layout Itemize
15763 \begin_layout Itemize
15771 \begin_layout Itemize
15779 \begin_layout Itemize
15787 \begin_layout Subsection
15788 The new letter class: letter (koma-script v.2)
15791 \begin_layout Standard
15797 \begin_layout Standard
15798 \begin_inset VSpace medskip
15804 \begin_layout Standard
15806 Koma-Script version 2.8 has introduced a new letter class
15810 which supersedes the now unsupported
15815 It has — on the \SpecialChar LaTeX
15816 side — a completely new interface and is not compatible
15817 with the old class.
15818 Therefore, \SpecialChar LyX
15819 supports both, though it is recommended you use the new class.
15822 \begin_layout Standard
15823 This class covers the same functionality as
15825 letter (koma-script),
15828 The basic items are
15832 (receiver's address, same as
15836 in the old layout),
15849 will start a new letter (i.
15850 \begin_inset space \thinspace{}
15854 \begin_inset space \space{}
15857 you can write several letters per document).
15858 New elements are sender's
15874 and the possibility to use a
15880 Insert\SpecialChar menuseparator
15886 \begin_layout Standard
15887 The biggest improvement is, though, that the letter's layout is configurable
15888 to meet almost any needs.
15889 This can be done via the preamble or with a special style file (Letter
15890 Class Option, extension
15894 ), that will be read in as a class option.
15898 \begin_layout Plain Layout
15899 The KOMA package comes with some default
15904 There is, for instance, a
15908 file that follows german typesetting rules, or a
15912 that provides the default layout of the old
15917 The latter can be loaded with the class option
15923 Layout\SpecialChar menuseparator
15924 Document\SpecialChar menuseparator
15936 template that is included in \SpecialChar LyX
15938 A detailed description is to be found in the Koma-Script documentation
15946 \begin_layout Subsection
15950 \begin_layout Standard
15951 Visualizing the Koma-Script document classes in \SpecialChar LyX
15952 , the \SpecialChar LyX
15953 internals cause some
15957 \begin_layout Itemize
15958 The chapter number of a
15962 type appears on a line of its own above the chapter heading instead of
15963 appearing in the same line ahead of it.
15964 The cause for that is the \SpecialChar LyX
15965 internal behavior for the labeltype
15969 in the layout file.
15972 \begin_layout Itemize
15973 The headings of the types
15981 are only put in the
15982 \begin_inset Quotes eld
15986 \begin_inset Quotes erd
15990 table of contents, but not in the \SpecialChar LyX
15991 table of contents (
15993 Document\SpecialChar menuseparator
15995 \begin_inset space ~
15999 \begin_inset space ~
16007 \begin_layout Itemize
16008 The paragraphs in a
16012 document class appear in a skip separation mode, not indented.
16013 This is the standard behavior, no special \SpecialChar LaTeX
16014 commands are needed for that.
16017 Document\SpecialChar menuseparator
16020 dialog the corresponding radio button indicates
16029 value always has the effect that extra \SpecialChar LaTeX
16030 commands are inserted in the document
16031 to produce the gap, which is not what is wanted in this case.
16034 \begin_layout Section
16038 \begin_layout Standard
16044 \begin_layout Subsection
16048 \begin_layout Standard
16049 Memoir is a very powerful and constantly evolving class.
16050 It has been designed with regard to fictional and non-fictional literature.
16051 Its aim is to let the user have maximum control over the typesetting of
16053 Memoir is based on the standard book class, but it can also emulate the
16054 article class (see below).
16057 \begin_layout Standard
16058 Peter Wilson, the developer of Memoir, is known as the author of lots of
16059 useful packages in the \SpecialChar LaTeX
16061 Most of them have been merged with Memoir.
16062 Therefore, it is much easier to layout the table of contents, appendices,
16063 chapter designs and such.
16065 , though, does not support all of these goodies natively.
16066 Some of them might be added to forthcoming releases
16070 \begin_layout Plain Layout
16071 You are invited to send suggestions to
16072 \begin_inset Flex URL
16075 \begin_layout Plain Layout
16077 lyx-devel@lists.lyx.org
16087 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
16089 Of course you can still use all features with the help of some native \SpecialChar LaTeX
16091 commands (\SpecialChar TeX
16096 \begin_layout Plain Layout
16101 \begin_layout Plain Layout
16111 \begin_inset space ~
16115 \begin_inset CommandInset ref
16117 reference "sec:Inserting-TeX-Code"
16127 In this section, we can only list those features that are natively supported
16128 by \SpecialChar LyX
16130 For detailed descriptions (and for the rest of features) we recommend you
16131 have a look at the detailed manual of the Memoir class
16135 \begin_layout Plain Layout
16140 \begin_layout Plain Layout
16150 \begin_inset Flex URL
16153 \begin_layout Plain Layout
16155 CTAN:/macros/latex/memoir/memman.pdf
16165 , which is not only a user guide for the class, but also both a comprehensive
16166 description on good typesetting and a superb example for good typesetting
16170 \begin_layout Subsection
16171 Basic features and restrictions
16174 \begin_layout Standard
16175 Memoir supports basically all features of the standard book classes.
16176 There are, however, some differences, as follows:
16179 \begin_layout Description
16181 \begin_inset space ~
16184 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
16187 \begin_layout Description
16189 \begin_inset space ~
16192 style: The fancy page style is not supported, due to a command clash between
16193 Memoir and the fancyhdr package (they both define a command with the same
16194 name, which confuses \SpecialChar LaTeX
16196 Instead, Memoir comes with a number of its own page styles (see
16197 \change_deleted -712698321 1501165256
16200 Layout\SpecialChar menuseparator
16203 Document\SpecialChar menuseparator
16205 \change_inserted -712698321 1501165264
16206 Settings\SpecialChar menuseparator
16210 \begin_inset space ~
16216 If you want to use these for the chapter pages, you have to use the command
16223 in the main text or in preamble (e.
16224 \begin_inset space \thinspace{}
16228 \begin_inset space \space{}
16235 chapterstyle{companion}
16240 \begin_layout Description
16241 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
16242 optional argument in the standard classes.
16243 With this, you can specify an alternative version of the title for the
16244 table of contents and the headers (for instance, if the title is too long).
16245 In \SpecialChar LyX
16246 , you can do this via
16248 Insert\SpecialChar menuseparator
16250 \begin_inset space ~
16255 at the beginning of a chapter/section.
16256 Memoir features a second optional argument and thus separates the table
16257 of contents from the header.
16258 You can define three variants of a title with this: one for the main text,
16259 one for the table of contents, and one for the headers.
16261 \change_deleted -712698321 1501165686
16262 Simply insert two optional arguments if you need this feature, the first
16263 one containing the short title for the Table of Contents, the second one
16264 containing an alternative short title for the headers
16265 \change_inserted -712698321 1501165708
16267 makes these available in form of specific
16280 \begin_layout Description
16281 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
16282 of contents, the list of figures and the list of table start a new page
16284 Memoir does not follow this route.
16285 You have to insert a page break yourself, if you want to have one.
16288 \begin_layout Description
16289 Titlepage: For some unknown reason, Memoir uses pagination on the title
16290 page (in the standard classes, title pages are
16291 \begin_inset Quotes eld
16295 \begin_inset Quotes erd
16299 If you want an empty title page, type
16303 aliaspagestyle{title}{empty}
16308 \begin_layout Description
16309 Article: With the class option
16314 \change_deleted -712698321 1501165976
16317 Layout\SpecialChar menuseparator
16320 Document\SpecialChar menuseparator
16322 \change_inserted -712698321 1501165986
16323 Settings\SpecialChar menuseparator
16324 Class Settings\SpecialChar menuseparator
16326 \change_deleted -712698321 1501165988
16328 \change_inserted -712698321 1501165989
16332 \begin_inset space ~
16337 ), you can emulate article style.
16338 That is, counters (footnotes, figures, tables etc.) will not be reset on
16339 new chapters, chapters don't start a new page (but are—in contrary to
16340 \begin_inset Quotes eld
16344 \begin_inset Quotes erd
16347 article classes—still allowed), parts, though, use their own page, as in
16351 \begin_layout Description
16352 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
16353 font commands, which have been used in the old \SpecialChar LaTeX
16355 \begin_inset space \thinspace{}
16359 \begin_inset space \space{}
16375 It produces an error and stops \SpecialChar LaTeX
16376 whenever such a command appears.
16381 reallows the commands and spits out warnings instead (which does at least
16382 not stop \SpecialChar LaTeX
16384 Since a lot of packages and particularly Bib\SpecialChar TeX
16385 style files are still using
16386 those commands, we have decided to use this option by default.
16389 \begin_layout Subsection
16393 \begin_layout Standard
16394 We will only describe the features supported by \SpecialChar LyX
16395 (which is not much currently).
16396 Please consult the Memoir manual
16400 \begin_layout Plain Layout
16405 \begin_layout Plain Layout
16415 \begin_inset Flex URL
16418 \begin_layout Plain Layout
16420 CTAN:/macros/latex/memoir/memman.pdf
16433 \begin_layout Description
16434 Abstract: You may wonder why an abstract is an extra feature.
16435 Well, it is in book class.
16436 Usually books don't have abstracts.
16437 Memoir, however, has.
16438 You can use it wherever and how often you like.
16441 \begin_layout Description
16442 Chapterprecis: You may know this older typesetting style: The contents of
16443 a chapter are summarized below the title and also in the table of contents
16445 \begin_inset space \thinspace{}
16449 \begin_inset space \space{}
16454 Our hero arrives in Troia; he loses some friends; he finds others
16457 Chapterprecis does exactly this.
16458 It is therefore only sensible below a chapter.
16461 \begin_layout Description
16462 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
16463 The epigraph environment provides an elegant way of typesetting such a
16465 The motto itself (text) and its
16466 \change_inserted -712698321 1501166968
16469 author (source) are divided by a short line.
16471 \change_deleted -712698321 1501166972
16472 Unfortunately, we have to fool \SpecialChar LyX
16473 a bit here again, since the environment
16474 needs two arguments (text and source).
16475 In this case, we have to use curly brackets (in \SpecialChar TeX
16476 mode) between the two
16487 <author of the slogan>
16488 \change_inserted -712698321 1501166996
16491 The author (source) can be inserted via
16493 Insert\SpecialChar menuseparator
16502 \begin_layout Description
16503 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
16504 complex figurative poems).
16506 can only support a few of them.
16507 One is poemtitle, which is a centered title for poems, which will also
16508 be added to the table of contents (verse is the standard environment for
16510 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
16512 because they have to be nested inside regular verse environments, which
16513 is not possible with \SpecialChar LyX
16517 \begin_layout Description
16518 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
16521 \begin_layout Section
16522 Article (mwart), book (mwbk) and report (mwrep)
16523 \begin_inset Argument status
16526 \begin_layout Plain Layout
16539 \begin_layout Standard
16545 \begin_layout Standard
16546 The \SpecialChar LyX
16563 correspond to the \SpecialChar LaTeX
16577 They are replacements for the standard document classes
16589 , resp., and fit better to Polish typography conventions in a number of points.
16593 \begin_layout Standard
16597 \begin_layout Itemize
16598 Unnumbered titles (with star, e.
16599 \begin_inset space \thinspace{}
16603 \begin_inset space \space{}
16610 ) are added into table of contents,
16613 \begin_layout Itemize
16614 Additional page styles:
16618 \begin_layout Description
16619 uheadings header with separated lines,
16622 \begin_layout Description
16623 myheadings custom header, contents headers via commands:
16638 \begin_layout Description
16639 myuheadings custom header with separated lines,
16642 \begin_layout Description
16643 outer page number is placed on outer side of page
16647 \begin_layout Itemize
16652 \begin_layout Description
16653 rmheadings serif titles — default,
16656 \begin_layout Description
16657 sfheadings sansserif titles,
16660 \begin_layout Description
16661 authortitle on title page first placed is author next title — default,
16664 \begin_layout Description
16665 titleauthor on title page first placed is title next author,
16668 \begin_layout Description
16669 withmarginpar reserve place on page for margins.
16673 \begin_layout Section
16677 \begin_layout Standard
16682 provides an alternative to the standard
16687 It provides similar functionality, but you might prefer this layout with
16688 sans serif sections, headings, and more.
16691 \begin_layout Section
16692 Rev\SpecialChar TeX
16696 \begin_layout Standard
16702 \begin_layout Standard
16703 \begin_inset VSpace bigskip
16709 \begin_layout Standard
16714 \begin_inset space ~
16719 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
16721 \begin_inset Formula $\beta$
16724 release of May, 1999) class.
16727 \begin_layout Standard
16733 textclass, which works with Rev\SpecialChar TeX
16735 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
16737 That means that it doesn't interact very well with \SpecialChar LyX
16738 , which requires \SpecialChar LaTeX2e
16740 it has been kludged to work.
16741 Since Rev\SpecialChar TeX
16742 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
16747 Rev\SpecialChar TeX
16749 \begin_inset space ~
16754 textclass should also be pretty easy to use.
16757 \begin_layout Standard
16758 These documents are supposed to be used in
16762 to the Rev\SpecialChar TeX
16763 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
16765 and assume you'll know what to put in the preamble if necessary.
16768 \begin_layout Subsection
16772 \begin_layout Standard
16773 All you need to do is install Rev\SpecialChar TeX
16774 4, as described in the package's README
16776 The package can be found at The Rev\SpecialChar TeX
16778 \begin_inset Flex URL
16781 \begin_layout Plain Layout
16783 http://publish.aps.org/revtex4/
16789 Install it somewhere that \SpecialChar LaTeX
16791 Test it by trying to \SpecialChar LaTeX
16792 a short Rev\SpecialChar TeX
16793 4 document in some random directory (i.
16794 \begin_inset space \thinspace{}
16798 \begin_inset space \space{}
16801 not the directory where you installed the class file.) Then, if you reconfigure
16803 , it will find the class file and let you use the Rev\SpecialChar TeX
16807 \begin_layout Standard
16808 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
16817 \begin_inset space ~
16822 template, found in the templates directory.
16825 \begin_layout Subsection
16829 \begin_layout Standard
16830 Optional arguments to
16837 \begin_inset Quotes eld
16841 \begin_inset Quotes erd
16845 \begin_inset Quotes eld
16849 \begin_inset Quotes erd
16855 \begin_inset space ~
16863 \begin_inset space ~
16869 Remember that in Rev\SpecialChar TeX
16870 , at least one optional argument is required!
16873 \begin_layout Standard
16874 Other preamble matter, like
16881 \begin_inset space ~
16888 \begin_inset space ~
16893 dialog, also as usual.
16896 \begin_layout Subsection
16900 \begin_layout Standard
16901 The layouts basically correspond to the commands in Rev\SpecialChar TeX
16903 For example, the Email layout corresponds to
16910 Note that (at least as of Rev\SpecialChar TeX
16919 layouts are exactly equivalent, so you shouldn't need to use both.
16923 \begin_layout Plain Layout
16924 In case you're curious, both were included so that
16928 would be able to translate both
16948 \begin_layout Subsection
16952 \begin_layout Standard
16953 There are a couple of important unique aspects of Rev\SpecialChar TeX
16954 4 which might cause
16955 bugs that will be even more confusing in \SpecialChar LyX
16959 \begin_layout Standard
16960 In Rev\SpecialChar TeX
16978 The \SpecialChar LyX
16979 equivalent is that there is a separate Thanks layout.
16984 write footnotes in the
16988 layout, or weird things may happen.
16989 See the Rev\SpecialChar TeX
16990 4 documentation for more details.
16993 \begin_layout Standard
16997 \begin_inset space ~
17005 \begin_inset space ~
17014 layouts must be placed
17022 layout and the corresponding
17039 , the \SpecialChar LaTeX
17043 \begin_layout Subsection
17045 \change_deleted -712698321 1501168252
17049 \begin_layout Standard
17051 \change_deleted -712698321 1501168252
17052 The main problem with this layout is that you can't use the optional arguments
17053 to layouts like Email and Title.
17054 (The problem is not unique to this layout; you can't use optional arguments
17055 to the Section layouts either.) This means that after you export that file
17056 to \SpecialChar LaTeX
17057 (which you'll need to do eventually to send it in to APS), you'll need
17058 to edit the \SpecialChar LaTeX
17059 file with a text editor to add the optional arguments to set,
17061 \begin_inset space \thinspace{}
17065 \begin_inset space \space{}
17068 the running title for the page headers.
17069 Lacking these layouts makes the
17075 (and the equivalent
17081 ) useless, so the corresponding layouts don't exist, and will have to be
17086 \begin_layout Plain Layout
17091 actually, \SpecialChar LyX
17092 1.3.0 supports some forms of optional arguments, but this layout
17093 has not been updated yet to take advantage of it.
17103 \begin_layout Section
17104 Springer Journals (
17111 \begin_layout Standard
17117 \begin_layout Subsection
17121 \begin_layout Standard
17122 These are the layout files for some of the journal formats used by Springer
17123 Verlag and listed on
17124 \begin_inset Flex URL
17127 \begin_layout Plain Layout
17129 http://www.springer.de/author/tex/help-journals.html
17134 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
17136 It is a modular system: the things common to all journals are implemented
17141 , which journal-specific layout files (such as, e.
17142 \begin_inset space \thinspace{}
17146 \begin_inset space \space{}
17153 for Journal of Geodesy) can include.
17156 \begin_layout Standard
17157 This means that implementing support for any other Springer journal on this
17158 list is as simple as writing your own
17166 file following the outline given in
17174 \begin_layout Standard
17175 It is reasonably well tested only for the Journal of Geodesy.
17184 come with the standard \SpecialChar LyX
17186 Install the relevant class file (downloaded from Springer) in a proper
17187 directory, reconfigure \SpecialChar LaTeX
17188 (in the te\SpecialChar TeX
17193 , as root if necessary — doesn't \SpecialChar LyX
17194 take care of this?), reconfigure \SpecialChar LyX
17199 \begin_layout Subsection
17203 \begin_layout Standard
17204 A large number of theorem-like styles —
17216 \begin_layout Standard
17219 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
17220 _Title, Author_Running, Institute,
17221 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
17224 See the Springer class file documentation for details.
17227 \begin_layout Subsection
17231 \begin_layout Itemize
17243 \begin_layout Itemize
17246 Probability Theory and Related Fields
17252 — Jean-Marc Lasgouttes
17255 \begin_layout Standard
17256 Add your own, it isn't so hard!
17259 \begin_layout Subsection
17263 \begin_layout Standard
17264 These files are partly based on the older
17268 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
17270 file from Springer.
17275 layout, are now defunct.
17276 Jean-Marc Lasgouttes helped out big in making me find my way around the
17278 layout file mechanism.
17281 \begin_layout Subsection
17285 \begin_layout Standard
17287 But probably less than in the old hacked-\SpecialChar LaTeX
17295 \begin_layout Standard
17297 \change_deleted -712698321 1501168901
17299 \begin_inset space \thinspace{}
17302 g.: does not display the number for theorem-like layouts, just #.
17307 \begin_layout Section
17310 Sli\SpecialChar TeX
17314 \begin_inset CommandInset label
17323 \begin_layout Standard
17331 \begin_layout Subsection
17335 \begin_layout Standard
17336 This section describes how to use \SpecialChar LyX
17337 to make slides for overhead projectors.
17338 There are two document classes that can do this: the default slides class
17341 Foil\SpecialChar TeX
17345 This section documents the former.
17348 \begin_layout Standard
17349 I'm going to say this again, nice and clear, so that there's no misunderstanding
17353 \begin_layout Standard
17354 \begin_inset VSpace bigskip
17360 \begin_layout Standard
17364 This section documents the class
17365 \begin_inset Quotes eld
17373 \begin_inset Quotes erd
17381 \begin_layout Standard
17382 \begin_inset VSpace bigskip
17388 \begin_layout Standard
17389 If you're looking for the documentation for
17390 \begin_inset Quotes eld
17395 slides (Foil\SpecialChar TeX
17399 \begin_inset Quotes erd
17402 , check out section
17403 \begin_inset space ~
17407 \begin_inset CommandInset ref
17409 reference "sec:foiltex"
17419 \begin_inset Quotes eld
17424 slides (Foil\SpecialChar TeX
17428 \begin_inset Quotes erd
17431 ] is actually somewhat better than the default
17439 \begin_layout Plain Layout
17441 or so I've been told repeatedly by its advocates.
17442 Having never used it, I have no idea if this claim is true or not.
17447 which this section documents.
17450 \begin_layout Standard
17451 This class is the \SpecialChar LaTeX2e
17452 improvement of the old
17454 Sli\SpecialChar TeX
17458 Every \SpecialChar LaTeX2e
17459 distribution includes this class [which I'll just refer to as
17460 \begin_inset Quotes eld
17468 \begin_inset Quotes erd
17471 from now on], so you're bound to have it.
17472 As I noted earlier, there are other classes, such as
17476 , which also produce slides for overhead projectors and do a better job
17478 However, there are some things which
17482 can do which the others can't, such as generate overlays.
17483 Read on to learn more!
17486 \begin_layout Subsection
17488 \begin_inset CommandInset label
17490 name "sec:slidesetup"
17497 \begin_layout Standard
17498 Obviously, to use this document class, you need to select
17499 \begin_inset Quotes eld
17507 \begin_inset Quotes erd
17510 from the class list in the
17512 Document\SpecialChar menuseparator
17516 There are some other special things you should know about this class:
17519 \begin_layout Itemize
17520 Don't bother changing the options
17525 They're not supported by the
17532 \begin_layout Itemize
17536 \begin_inset space ~
17541 behaves a bit differently for this class.
17542 The possible choices and what they do are as follows:
17546 \begin_layout Description
17551 The final output contains page numbers in the lower right corner.
17554 \begin_layout Description
17563 , but also prints out any time markers you've put in.
17564 This is the default.
17567 \begin_layout Description
17572 The final output contains no page numbers, time markers, or alignment markers.
17576 \begin_layout Itemize
17581 class has an extra option:
17587 \begin_inset Quotes eld
17595 \begin_inset Quotes erd
17598 in the extra class options.
17602 \begin_layout Standard
17603 Using this options allows you to add time markers to
17609 \begin_inset space ~
17613 \begin_inset CommandInset ref
17615 reference "sec:slideNote"
17623 \begin_layout Standard
17624 You can also use the template file
17625 \begin_inset Quotes eld
17633 \begin_inset Quotes erd
17636 to automatically set up a document to use the
17642 File\SpecialChar menuseparator
17644 \begin_inset space ~
17648 \begin_inset space ~
17653 to open your new document].
17654 The template file also contains some examples of the special paragraph
17655 environments used by this class.
17656 I'll describe those next.
17659 \begin_layout Subsection
17660 Paragraph Environments
17663 \begin_layout Subsubsection
17664 Supported Environments
17667 \begin_layout Standard
17668 The first thing you'll notice when you start up a new
17672 document is the font size and type: it's the equivalent of the size
17673 \begin_inset Quotes eld
17681 \begin_inset Quotes erd
17687 \begin_inset space ~
17693 This is also what's used in the output.
17695 \begin_inset Quotes eld
17699 \begin_inset Quotes erd
17702 to remind you that this is a slide.
17703 Your final slides will use a larger font; ergo, you'll have less space.
17704 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
17707 \begin_layout Standard
17708 The next thing that becomes obvious is the changes to the paragraph environment
17709 pull-down box [at the far-left end of the toolbar].
17710 Most of the paragraph environments you're used to seeing are missing.
17711 There are also five new ones.
17716 class itself only supports certain paragraph environments:
17719 \begin_layout Itemize
17725 \begin_layout Itemize
17731 \begin_layout Itemize
17737 \begin_layout Itemize
17743 \begin_layout Itemize
17749 \begin_layout Itemize
17755 \begin_layout Itemize
17761 \begin_layout Itemize
17767 \begin_layout Itemize
17773 \begin_layout Itemize
17780 \begin_layout Itemize
17782 \change_deleted -712698321 1501169265
17790 \begin_layout Standard
17791 All of the other standard environments, including the section-heading environmen
17792 ts, aren't used in the
17799 \begin_layout Standard
17800 On the other hand, you'll notice the following new environments:
17803 \begin_layout Itemize
17809 \begin_layout Itemize
17815 \begin_layout Itemize
17821 \begin_layout Itemize
17827 \begin_layout Itemize
17833 \begin_layout Standard
17834 These five are kind of quirky, due to a
17835 \begin_inset Quotes eld
17839 \begin_inset Quotes erd
17842 in \SpecialChar LyX
17844 You see, \SpecialChar LyX
17845 doesn't permit you to nest any other paragraph environment into
17846 an empty environment.
17847 Now, that's fine and dandy, but it means that you wouldn't be able to start
17848 a slide with anything except plain text.
17849 To deal with this, I've performed a little
17850 \begin_inset Quotes eld
17855 \begin_inset Quotes erd
17861 \begin_layout Subsubsection
17862 Quirks of the New Environments
17863 \begin_inset CommandInset label
17865 name "sec:slideQuirk"
17872 \begin_layout Standard
17873 All five of the new paragraph environments are somewhat quirky due to inherent
17874 limitiations in the current version of \SpecialChar LyX
17876 As I just mentioned, \SpecialChar LyX
17877 forbids environments that begin with another environment.
17878 To get around this, the
17882 environment isn't a paragraph environment as described in the
17890 \begin_layout Standard
17891 You should consider
17904 \begin_inset Quotes eld
17907 pseudo-environments.
17908 \begin_inset Quotes erd
17911 They look like a section heading or a
17912 \begin_inset Quotes eld
17920 \begin_inset Quotes erd
17923 but really begin a [and, if necessary, end the previous] paragraph environment.
17933 \begin_inset Quotes eld
17937 \begin_inset Quotes erd
17940 These two perform some action.
17943 \begin_layout Standard
17944 A common feature of all five environments,
17964 , is a rather long-ish label.
17965 The text following this label — ordinarily the contents of the paragraph
17966 environment — is utterly irrelevant for
17988 completely ignores it.
17989 In fact, you can leave these five environments completely empty.
17993 \begin_layout Standard
17998 to put any text after the rather long-ish label, you might want to.
17999 This could be a short description of the contents of the
18004 In that case, enter your descriptive comment and hit
18008 as you normally would.
18011 \begin_layout Standard
18012 If, on the other hand, you don't want to enter any descriptive text, you'll
18013 hit another \SpecialChar LyX
18016 , like nature, abhors a vacuum, and will not let you start a new paragraph
18017 environment until you put something in the old one.
18021 \begin_layout Itemize
18022 Start entering the text that will
18050 \begin_layout Itemize
18051 Now move to the beginning of that paragraph.
18055 \begin_layout Itemize
18064 \begin_layout Itemize
18065 Finally, change this new, empty paragraph to a
18089 \begin_layout Standard
18090 Some future version of \SpecialChar LyX
18091 will, hopefully, resolve this quirkiness\SpecialChar ldots
18095 \begin_layout Subsection
18096 Making a Presentation with
18109 \begin_layout Subsubsection
18117 \begin_layout Standard
18118 If you're expecting this section to teach you how to actually make a presentatio
18119 n, you'll be sorely disappointed.
18120 Naturally, I'll describe all of the ways the
18124 class can assist you in preparing the materials for a presentation.
18125 Filling in the contents, however, is up to you.
18130 the \SpecialChar LyX
18134 \begin_layout Standard
18139 environment [in the manner described in section
18140 \begin_inset space ~
18144 \begin_inset CommandInset ref
18146 reference "sec:slideQuirk"
18150 ] tells \SpecialChar LyX
18151 to begin a new slide [duh].
18152 The label for this environment/
18153 \begin_inset Quotes erd
18157 \begin_inset Quotes erd
18161 \begin_inset Quotes eld
18165 \begin_inset Quotes erd
18168 in cool blue, followed by the label,
18169 \begin_inset Quotes eld
18173 \begin_inset Quotes erd
18177 Any text or paragraph environments that follow this one go on the new slide.
18181 \begin_layout Standard
18182 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
18184 (this can be specified in the
18189 In fact, you'll want to, once you finish entering the contents of one slide.
18190 If you've entered more text than can physically fit on a slide, the extra
18191 overflows onto a new slide.
18192 I don't recommend doing this, however, since the overflow slide won't have
18193 any page number on it.
18194 Furthermore, it may interfere with any
18198 you've made to accompany the oversized
18205 \begin_layout Standard
18214 environments work the same way as the
18219 They both create an
18220 \begin_inset Quotes eld
18224 \begin_inset Quotes erd
18227 followed by a label [
18228 \begin_inset Quotes eld
18232 \begin_inset Quotes erd
18236 \begin_inset Quotes eld
18240 \begin_inset Quotes erd
18244 The color is a stunning magenta instead of blue, and the
18245 \begin_inset Quotes eld
18249 \begin_inset Quotes erd
18252 will look different, in style and in length.
18253 The label fonts of all three also differ from one another.
18256 \begin_layout Standard
18261 , if the contents of a
18269 exceed the physical size of a slide or sheet of paper, the extra will overflow
18271 Again, you should avoid this.
18272 It defeats the whole purpose of
18283 \begin_layout Subsubsection
18293 \begin_layout Standard
18298 is a slide that sits atop another slide.
18299 Perhaps you wish to discuss a figure on the main
18303 before displaying the text associated with it.
18304 One way to accomplish this is tape a flap of dark paper over the part of
18309 you want to display later.
18310 This method fails, however, if you wish to overlap one graph with another,
18312 You would then have to fumble while speaking to align the two separate,
18317 s to align the two graphs.
18322 environment in both cases makes life much easier.
18325 \begin_layout Standard
18330 receives the page number of its
18331 \begin_inset Quotes eld
18335 \begin_inset Quotes erd
18343 \begin_inset Quotes eld
18351 \begin_inset Quotes erd
18358 \begin_layout Plain Layout
18359 Presumably, mutliple
18364 \begin_inset Quotes eld
18372 \begin_inset Quotes erd
18376 \begin_inset Quotes eld
18384 \begin_inset Quotes erd
18388 \begin_inset Quotes eld
18396 \begin_inset Quotes erd
18400 \begin_inset space ~
18403 appended to the page number of the parent
18413 Clearly, you want the contents of both the
18421 to each fit on a single physical slide! You should probably consider an
18427 \begin_inset Quotes eld
18431 \begin_inset Quotes erd
18439 Indeed, the \SpecialChar LyX
18444 class provides a visual cue for this: the label at the start of an
18448 is shorter than that at the start of a
18453 Lastly, when you generate printable output, you'll find alignment markers
18454 in all four corners of both the
18458 page and its parent
18463 These will assist you in lining up the two physical slides.
18466 \begin_layout Standard
18467 The major problem in overlaying two slides is aligning the contents of the
18468 two transparencies.
18469 How much space should you leave for that graph on the second slide? Worse
18470 still, what if you want a graph and a sentence on second slide, but there
18471 is text on the main transparency that goes in between them? You could try
18472 and insert vertical space of the right size.
18473 The better way is to use
18484 \begin_layout Standard
18485 As their names imply,
18493 are two command-like paragraph environments that make all subsequent text
18494 invisible and visible, respectively.
18496 \begin_inset space ~
18500 \begin_inset CommandInset ref
18502 reference "sec:slideQuirk"
18506 that you don't place anything
18510 these two environments, however.
18515 , it inserts a centered, sky-blue label into the page reading
18516 \begin_inset Quotes eld
18519 <Invisible Text Follows>
18520 \begin_inset Quotes erd
18524 For paragraphs following this label, the parts of the
18532 ; it doesn't matter which] where they would be contain instead blank space.
18536 \begin_layout Standard
18541 , the corresponding centered label is
18542 \begin_inset Quotes eld
18545 <Visible Text Follows>
18546 \begin_inset Quotes erd
18550 Paragraphs following this label behave normally.
18551 Note that the beginning of a new
18563 automatically shuts off an
18568 It's therefore not necessary to use
18579 \begin_layout Standard
18580 By now, it should be obvious how to create overlay transparencies using
18581 the proper combination of
18600 \begin_layout Enumerate
18605 , including everything that will appear on it, whether on the main slide
18613 \begin_layout Enumerate
18614 Before each figure or paragraph that will appear only on the
18623 If necessary, insert a
18627 environment after the
18634 \begin_layout Enumerate
18639 immediately following the
18646 \begin_layout Enumerate
18647 Copy the contents of this
18658 \begin_layout Enumerate
18663 , change all of the
18674 \begin_layout Standard
18676 You've just made an
18683 \begin_layout Standard
18684 There's one problem with the way I've designed the \SpecialChar LyX
18689 class: you can't make text in the middle of a paragraph invisible, nor
18690 make text in the middle of an invisible paragraph visible again.
18691 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
18696 \begin_layout Plain Layout
18697 The commands of interest are:
18700 \begin_layout Itemize
18705 invisible \SpecialChar ldots
18709 \begin_layout Itemize
18714 visible \SpecialChar ldots
18718 \begin_layout Plain Layout
18720 and need to be marked as \SpecialChar TeX
18723 \begin_inset Quotes eld
18727 \begin_inset Quotes erd
18730 you wish to change goes in between the brackets [and after the
18743 If you don't know how to mark text as \SpecialChar TeX
18744 , see the appropriate section of
18757 \begin_layout Subsubsection
18767 \begin_inset CommandInset label
18769 name "sec:slideNote"
18776 \begin_layout Standard
18785 is associated with a
18786 \begin_inset Quotes eld
18790 \begin_inset Quotes erd
18798 Here, too, the \SpecialChar LyX
18803 class provides visual cues.
18808 is shorter than that of a
18812 [yet longer than that of an
18816 ] and, like the label of an
18820 is shockingly magenta.
18821 Additionally, the printed
18825 has the page number of its
18826 \begin_inset Quotes eld
18830 \begin_inset Quotes erd
18838 \begin_inset Quotes eld
18846 \begin_inset Quotes erd
18850 \begin_inset Quotes eld
18858 \begin_inset Quotes erd
18862 \begin_inset Quotes eld
18870 \begin_inset Quotes erd
18874 You can have multiple
18878 s associated with a single
18890 , you'll probably want to break up long
18894 s so that they fit on a single sheet of paper.
18897 \begin_layout Standard
18902 is obvious: it contains anything additional you might want to say about
18908 It could also be used as a sheet of reminders for a particular
18913 In the case of the latter, you might want to make use of time markers.
18914 Currently, the \SpecialChar LyX
18920 \begin_inset Quotes eld
18924 \begin_inset Quotes erd
18927 support for time markers, a
18929 Sli\SpecialChar TeX
18933 So, you'll have to resort to using the \SpecialChar LaTeX
18937 \begin_layout Standard
18938 To use time markers, you'll need to specify the extra class option
18939 \begin_inset Quotes eld
18947 \begin_inset Quotes erd
18951 \begin_inset space ~
18955 \begin_inset CommandInset ref
18957 reference "sec:slidesetup"
18962 This option turns on timing marks, which will appear in the lower-left-hand
18968 To set what appears in the time marker, you use the \SpecialChar LaTeX
18970 \begin_inset Quotes eld
18980 \begin_inset Quotes erd
18984 \begin_inset Quotes eld
18994 \begin_inset Quotes erd
18998 The arguments of both commands are time measured in seconds.
19000 \begin_inset Quotes eld
19010 \begin_inset Quotes erd
19013 sets the time marker to a given time.
19015 \begin_inset Quotes eld
19025 \begin_inset Quotes erd
19028 increments the time marker by the specified amount.
19029 Using time markers and
19033 s in this fashion, you can remind yourself how much time to spend on a particula
19041 \begin_layout Standard
19042 There's one last feature to describe.
19043 Clearly, you'd like to print out all of your
19051 s on transparencies while printing all of your
19068 with which it is associated.
19069 What's a person to do?
19072 \begin_layout Standard
19073 Luckily, there are two \SpecialChar LaTeX
19074 commands that allow you to select what to print
19076 Both must be placed into the preamble of your document.
19078 \begin_inset Quotes eld
19090 \begin_inset Quotes erd
19093 will cause the output to contain only the
19102 Correspondingly, the command
19103 \begin_inset Quotes eld
19115 \begin_inset Quotes erd
19118 prevents the output of anything but
19123 I'd advise placing both commands in the preamble and initially comment
19125 You can then preview your entire presentation as you write.
19126 When you're done writing, you can then uncomment one of the two to select
19127 what you want to print.
19128 I like to uncomment
19129 \begin_inset Quotes eld
19141 \begin_inset Quotes erd
19144 , print to a file with
19145 \begin_inset Quotes eld
19153 \begin_inset Quotes erd
19156 in its name, comment it back out, then uncomment
19157 \begin_inset Quotes eld
19169 \begin_inset Quotes erd
19173 \begin_inset Quotes eld
19181 \begin_inset Quotes erd
19185 I can then send either file to a printer, loading transparencies or plain
19186 paper as appropriate.
19189 \begin_layout Standard
19190 You can also provide other arguments to the
19191 \begin_inset Quotes eld
19201 \begin_inset Quotes erd
19205 \begin_inset Quotes eld
19215 \begin_inset Quotes erd
19219 See a good \SpecialChar LaTeX
19223 \begin_layout Subsection
19228 Class Template File
19231 \begin_layout Standard
19232 I have also provided a template file,
19233 \begin_inset Quotes eld
19241 \begin_inset Quotes erd
19249 To use it, begin your new presentation with
19251 File\SpecialChar menuseparator
19253 \begin_inset space ~
19257 \begin_inset space ~
19263 Your new \SpecialChar LyX
19264 presentation file will contain an example
19285 additionally contain an example of the use of
19294 Lastly, the preamble will contain:
19297 \begin_layout LyX-Code
19298 % Uncomment to print out only slides and overlays
19301 \begin_layout LyX-Code
19305 \begin_layout LyX-Code
19311 \begin_inset Newline newline
19317 \begin_layout LyX-Code
19318 % Uncomment to print out only notes
19321 \begin_layout LyX-Code
19325 \begin_layout LyX-Code
19333 \begin_layout Standard
19334 One final thing: I created this class to support the \SpecialChar LaTeX2e
19336 \begin_inset Quotes eld
19341 Sli\SpecialChar TeX
19345 \begin_inset Quotes erd
19348 class, one of the built-in \SpecialChar LaTeX2e
19350 Neither I nor the rest of the \SpecialChar LyX
19351 Team endorse or oppose the use of this built-in
19353 It's here if you want it or need it.
19354 There exist other \SpecialChar LaTeX2e
19355 classes for creating presentations, such as the
19360 \begin_inset space ~
19364 \begin_inset CommandInset ref
19366 reference "sec:foiltex"
19371 \begin_inset Quotes eld
19379 \begin_inset Quotes erd
19382 package [present on some \SpecialChar TeX
19384 The latter is not yet supported under \SpecialChar LyX
19389 \begin_layout Plain Layout
19390 Perhaps you can take on the task\SpecialChar ldots
19396 I know nothing about these other classes.
19397 Try them out to see what sort of alternative they provide.
19400 \begin_layout Chapter
19402 Features needing Extra Software
19405 \begin_layout Section
19406 Checking \SpecialChar TeX
19410 \begin_layout Standard
19416 \begin_layout Subsection
19420 \begin_layout Standard
19429 \begin_layout Plain Layout
19434 is not yet available when you are using the \SpecialChar LaTeX
19435 distribution MiK\SpecialChar TeX
19441 , you'll find in the
19448 \begin_inset space ~
19459 \begin_inset Newline newline
19463 \begin_inset CommandInset href
19465 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
19473 \begin_layout Standard
19476 Chk\SpecialChar TeX
19479 package is a program that was written by
19480 \begin_inset Flex Noun
19483 \begin_layout Plain Layout
19485 \begin_inset space ~
19493 in frustration because some constructs in \SpecialChar LaTeX
19494 are sometimes non-intuitive,
19495 and easy to forget.
19496 The program runs over your \SpecialChar LaTeX
19497 file, checks the integrity of the file, and
19498 flags some common errors.
19499 In other technical words, it is
19503 for \SpecialChar LaTeX
19507 \begin_layout Standard
19508 Well, what is a syntax checker doing in \SpecialChar LyX
19509 which is supposed to produce correct
19511 anyways? The answer is simple: Just as
19515 not only checks the
19519 of C programs, but also does
19523 checks for type-errors,
19525 Chk\SpecialChar TeX
19528 catches some common
19532 errors, in addition to the syntactical ones.
19535 Chk\SpecialChar TeX
19538 is capable of detecting several common errors, such as
19541 \begin_layout Itemize
19542 Ellipsis detection:
19543 \begin_inset Newline newline
19546 Use \SpecialChar ldots
19550 \begin_layout Itemize
19551 No space in front of/after parenthesis:
19552 \begin_inset Newline newline
19558 \begin_layout Itemize
19559 Enforcement of normal space after common abbreviations:
19560 \begin_inset Newline newline
19564 \begin_inset space \thinspace{}
19568 \begin_inset space \space{}
19571 is too wide spacing.
19574 \begin_layout Itemize
19575 Enforcement of end-of-sentence space when the last sentence ends with a
19577 \begin_inset Newline newline
19581 And this is wrong spacing.
19584 \begin_layout Itemize
19585 Space in front of labels and similar commands:
19586 \begin_inset Newline newline
19589 The label should stick right up to the text to avoid falling to a wrong
19592 \begin_inset CommandInset label
19602 \begin_layout Plain Layout
19603 This footnote is in danger of falling off to a wrong page
19608 The label is separated too much.
19611 \begin_layout Itemize
19612 Space in front of references, instead of hard spaces:
19613 \begin_inset Newline newline
19616 If you have bad luck, the text will break right between the referenced text
19617 and reference number, and that's a pity.
19619 \begin_inset CommandInset ref
19621 reference "sec:chktex"
19628 \begin_layout Itemize
19630 \begin_inset Quotes eld
19634 \begin_inset Quotes erd
19638 \begin_inset Formula $\times$
19642 \begin_inset Newline newline
19645 2x2 looks cheap compared to
19646 \begin_inset Formula $2\times2$
19652 \begin_layout Standard
19653 and more \SpecialChar ldots
19654 It is an invaluable tool when you are
19655 \begin_inset Quotes eld
19659 \begin_inset Quotes erd
19662 your document before printing, and you should run it right after the obligatory
19663 spelling check, and before you go fine tuning the typesetting.
19666 \begin_layout Subsection
19670 \begin_layout Standard
19671 If you have the program installed, usage is as simple as choosing
19673 Tools\SpecialChar menuseparator
19675 \begin_inset space ~
19681 This will make \SpecialChar LyX
19682 generate a \SpecialChar LaTeX
19683 file of your document, start
19685 Chk\SpecialChar TeX
19688 to check it, and then make \SpecialChar LyX
19690 \begin_inset Quotes eld
19694 \begin_inset Quotes erd
19697 with the warnings from
19699 Chk\SpecialChar TeX
19702 , if there were any.
19703 The warnings will be placed close to the point of the mistake, and you
19704 can quickly find them by using the
19706 Navigate\SpecialChar menuseparator
19709 menu item, or the shortcut key
19718 Open the error boxes by clicking on them with the mouse, or use the shortcut
19727 bindings, or the corresponding
19736 Read the warning and correct the mistake, if it is a mistake.
19737 If you have trouble understanding what the warning is about, you can safely
19739 Remember that there is a hidden layer between the document on screen and
19740 the technical details in invoking
19742 Chk\SpecialChar TeX
19745 , and this gap can make some warnings seem arcane or just plain silly.
19748 \begin_layout Standard
19749 This document is an excellent testing bed for the feature, and it should
19750 provide quite a few warnings for you to fiddle with.
19751 Since computers are only so smart, expect most of the warnings to be false
19755 \begin_layout Subsection
19756 How to fine tune it
19759 \begin_layout Standard
19760 Sometimes, you'll find that
19762 Chk\SpecialChar TeX
19765 makes more noise than suits your mood.
19766 Then you can choose not to use it, wait until your mood changes, or try
19769 Chk\SpecialChar TeX
19772 to get better along with you.
19775 \begin_layout Standard
19778 Chk\SpecialChar TeX
19785 very configurable and extensible, you should not expect to solve all problems
19788 Chk\SpecialChar TeX
19791 in \SpecialChar LyX
19793 Since \SpecialChar LyX
19794 has to generate a somewhat special \SpecialChar LaTeX
19795 file to be able to match the
19796 line numbers from the
19798 Chk\SpecialChar TeX
19805 \begin_layout Plain Layout
19806 You can inspect the specific output from
19812 Document\SpecialChar menuseparator
19815 \begin_inset space ~
19829 to the internal document structure, some of the warnings will not appear
19831 There are two things you can do about this:
19834 \begin_layout Itemize
19837 Chk\SpecialChar TeX
19840 invocation command line in
19841 \begin_inset Flex Noun
19844 \begin_layout Plain Layout
19845 Tools\SpecialChar menuseparator
19846 Preferences\SpecialChar menuseparator
19847 Output\SpecialChar menuseparator
19848 LaTeX\SpecialChar menuseparator
19856 Chk\SpecialChar TeX
19859 installation configuration file (usually with the file
19864 See below to learn what warnings can be enabled and disabled on the command
19868 \begin_layout Itemize
19869 Export your document as a raw \SpecialChar LaTeX
19872 File\SpecialChar menuseparator
19873 Export\SpecialChar menuseparator
19882 Invoked in this way, it can be a hassle to find the corresponding place
19883 in the document inside \SpecialChar LyX
19884 , but with a little patience, you should be able
19888 \begin_layout Standard
19889 Here follows the warning messages that can be enabled and disabled in
19898 to disable a warning, and
19902 to enable a warning.
19903 The emphasized entries are disabled by default, because the default is
19906 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
19911 \begin_layout Standard
19912 Notice that you should only use the options that enable and disable warnings,
19913 because \SpecialChar LyX
19914 relies on some of the other command line parameters to be set
19915 in a specific way to have a chance to communicate with
19922 \begin_layout Enumerate
19926 Command terminated with space.
19929 \begin_layout Enumerate
19932 Non-breaking space (
19933 \begin_inset Quotes eld
19941 \begin_inset Quotes erd
19944 ) should have been used.
19947 \begin_layout Enumerate
19951 You should enclose the previous parenthesis with
19952 \begin_inset Quotes eld
19960 \begin_inset Quotes erd
19966 \begin_layout Enumerate
19969 Italic correction (
19970 \begin_inset Quotes eld
19980 \begin_inset Quotes erd
19983 ) found in non-italic buffer.
19986 \begin_layout Enumerate
19989 Italic correction (
19990 \begin_inset Quotes eld
20000 \begin_inset Quotes erd
20003 ) found more than once.
20006 \begin_layout Enumerate
20010 No italic correction (
20011 \begin_inset Quotes eld
20021 \begin_inset Quotes erd
20027 \begin_layout Enumerate
20031 \begin_inset Quotes eld
20039 \begin_inset Quotes erd
20043 \begin_inset Quotes eld
20051 \begin_inset Quotes erd
20057 \begin_layout Enumerate
20060 Wrong length of dash may have been used.
20063 \begin_layout Enumerate
20067 \begin_inset Quotes eld
20075 \begin_inset Quotes erd
20079 \begin_inset Quotes eld
20087 \begin_inset Quotes erd
20093 \begin_layout Enumerate
20097 \begin_inset Quotes eld
20105 \begin_inset Quotes erd
20111 \begin_layout Enumerate
20115 \begin_inset Quotes eld
20123 \begin_inset Quotes erd
20126 to achieve an ellipsis.
20129 \begin_layout Enumerate
20132 Inter-word spacing (
20133 \begin_inset Quotes eld
20143 \begin_inset Quotes eld
20146 ) should perhaps be used.
20149 \begin_layout Enumerate
20152 Inter-sentence spacing (
20153 \begin_inset Quotes eld
20163 \begin_inset Quotes erd
20166 ) should perhaps be used.
20169 \begin_layout Enumerate
20172 Could not find argument for command.
20175 \begin_layout Enumerate
20179 \begin_inset Quotes eld
20187 \begin_inset Quotes erd
20193 \begin_layout Enumerate
20196 Math mode still on at end of \SpecialChar LaTeX
20200 \begin_layout Enumerate
20204 \begin_inset Quotes eld
20212 \begin_inset Quotes erd
20215 doesn't match the number of
20216 \begin_inset Quotes eld
20224 \begin_inset Quotes erd
20230 \begin_layout Enumerate
20233 You should use either
20236 \begin_inset Quotes eld
20244 \begin_inset Quotes erd
20249 as an alternative to
20250 \begin_inset Quotes eld
20258 \begin_inset Quotes erd
20264 \begin_layout Enumerate
20271 " (ASCII 39) instead of "
20278 \begin_layout Enumerate
20281 User-specified pattern found.
20284 \begin_layout Enumerate
20287 This command might not be intended.
20290 \begin_layout Enumerate
20297 \begin_layout Enumerate
20315 \begin_layout Enumerate
20318 Delete this space to maintain correct page references.
20321 \begin_layout Enumerate
20325 You might wish to put this between a pair of
20326 \begin_inset Quotes eld
20334 \begin_inset Quotes erd
20340 \begin_layout Enumerate
20343 You ought to remove spaces in front of punctuation.
20346 \begin_layout Enumerate
20349 Could not execute \SpecialChar LaTeX
20353 \begin_layout Enumerate
20362 in front of small punctuation.
20365 \begin_layout Enumerate
20373 may look prettier here.
20376 \begin_layout Enumerate
20380 Multiple spaces detected in output.
20383 \begin_layout Enumerate
20386 This text may be ignored.
20389 \begin_layout Enumerate
20395 \begin_inset Quotes eld
20400 to begin quotation, not
20407 \begin_layout Enumerate
20414 to end quotation, not
20417 \begin_inset Quotes eld
20425 \begin_layout Enumerate
20431 \begin_layout Enumerate
20434 You should perhaps use
20435 \begin_inset Quotes eld
20443 \begin_inset Quotes erd
20449 \begin_layout Enumerate
20452 You should put a space in front of/after parenthesis.
20455 \begin_layout Enumerate
20458 You should avoid spaces in front of/after parenthesis.
20461 \begin_layout Enumerate
20465 You should not use punctuation in front of/after quotes.
20468 \begin_layout Enumerate
20471 Double space found.
20474 \begin_layout Enumerate
20477 You should put punctuation outside inner/inside display math mode.
20480 \begin_layout Enumerate
20483 You ought to not use primitive \SpecialChar TeX
20484 in \SpecialChar LaTeX
20488 \begin_layout Enumerate
20491 You should remove spaces in front of
20492 \begin_inset Quotes eld
20500 \begin_inset Quotes erd
20506 \begin_layout Enumerate
20509 \begin_inset Quotes eld
20517 \begin_inset Quotes erd
20520 is normally not followed by
20521 \begin_inset Quotes eld
20529 \begin_inset Quotes erd
20535 \begin_layout Standard
20536 In later versions of \SpecialChar LyX
20537 , we hope to provide a more complete interface to this
20538 tool (and it's smaller cousin
20542 ) to exploit the full power of it.
20543 But it's not exactly useless as it is now: go try it on one of your existing
20544 documents of a certain length and be surprised.
20547 \begin_layout Section
20548 Version Control in \SpecialChar LyX
20552 \begin_layout Standard
20555 Lars Gullik Bjønnes
20562 \begin_layout Subsection
20566 \begin_layout Standard
20568 supports some of the most basic RCS/CVS/SVN/GIT commands.
20569 If you need something a bit more sophisticated you will have to do that
20570 manually in a terminal.
20573 \begin_layout Standard
20574 Also note that CVS support is not as good as subversion support so we advise
20576 A good place to start learning Subversion is SVN Book
20580 \begin_layout Plain Layout
20581 \begin_inset CommandInset href
20583 target "http://svnbook.red-bean.com/"
20594 In the case of RCS you should read
20595 \begin_inset Quotes eld
20599 \begin_inset Quotes erd
20602 (a man file, read it with
20607 This file describes all the basic features of RCS.
20608 You should especially notice the comment about a RCS directory, and the
20609 notion of a master RCS file (the file ending in
20616 \begin_layout Standard
20617 Before you begin to use the version control features in \SpecialChar LyX
20619 familiar with RCS/CVS/SVN/GIT usage.
20620 The implementation in \SpecialChar LyX
20621 assumes a recent version of the GNU RCS or CVS/SVN
20622 package — no guarantees are made for older versions.
20623 Most of the log messages are not currently displayed after operations —
20624 you can check them in the Messages pane if unsure.
20625 Regular users of version control will appreciate VC toolbar, which can
20628 View\SpecialChar menuseparator
20629 Toolbars\SpecialChar menuseparator
20631 \begin_inset space ~
20639 \begin_layout Standard
20640 For introducing your own external commands consult vc-command in the manual
20641 of \SpecialChar LyX
20645 \begin_layout Standard
20646 It is strongly recommended to store documents in uncompressed format if
20647 using version control (uncheck
20649 Document\SpecialChar menuseparator
20652 if it is checked): Uncompressed LyX documents are text files and therefore
20653 for merging two different versions by version control systems.
20654 Compressed LyX documents are binary files, which cannot be merged by version
20658 \begin_layout Subsection
20659 RCS commands in \SpecialChar LyX
20663 \begin_layout Standard
20664 The following sections describe the RCS commands supported by \SpecialChar LyX
20666 You can find them in the
20668 File\SpecialChar menuseparator
20670 \begin_inset space ~
20677 was tested against RCS 5.7/5.8.
20680 \begin_layout Subsubsection
20686 \begin_layout Standard
20687 If your document is not under revision control, this is the only item shown
20689 And if it is under revision control, the
20693 item is not visible.
20697 \begin_layout Standard
20698 This command registers your document with RCS (unless you are under the
20699 directory managed by CVS)\SpecialChar endofsentence
20700 You are asked interactively to supply an initial
20701 description of the document.
20702 The document is now set in Read-Only mode and you have to
20705 \begin_inset space ~
20709 \begin_inset space ~
20713 \begin_inset space ~
20718 , before making any changes to it.
20719 A document under revision control has a
20720 \begin_inset Quotes eld
20723 [RCS:<version> <locker>]
20724 \begin_inset Quotes erd
20727 item tagged to the filename in the minibuffer.
20730 \begin_layout Standard
20731 RCS command that is run:
20733 ci -q -u -i -t-"<initial description>" <file-name>
20736 \begin_layout Standard
20741 to understand the switches.
20745 \begin_layout Subsubsection
20751 \begin_layout Standard
20752 When you are finished editing a file, you check in your changes.
20753 When you do this, you are asked for a description of the changes.
20754 This is stored in the history log.
20755 The version number is bumped, your changes are applied to the master RCS
20756 file, the document is unlocked and set to Read-Only mode.
20759 \begin_layout Standard
20762 ci -q -u -m"<description>" <file-name>
20765 \begin_layout Subsubsection
20771 \begin_layout Standard
20772 By doing this you lock the document so that only you can edit it.
20773 This will also make the document Read-Write only for you.
20774 You will usually continue editing for a while and when you are finished
20775 you check in your changes.
20776 The status line is changed to reflect that you have locked the file.
20779 \begin_layout Standard
20782 co -q -l <file-name>
20785 \begin_layout Subsubsection
20788 Revert To Repository Version
20791 \begin_layout Standard
20792 This will discard all changes made to the document since the last check
20794 You get a warning before changes are discarded.
20797 \begin_layout Standard
20800 co -f -u<version> <file-name>
20803 \begin_layout Subsubsection
20809 \begin_layout Standard
20810 This will create a copy of the current document.
20811 Since RCS does not support copy operations natively, the version history
20812 is not preserved, and the copy is added as a new file.
20813 It requires a clean document without any changes since the last checkin.
20814 You are asked for a file name and a description of the copy operation.
20815 After that the copy is created, both locally and in the repository.
20816 If the parent directories of the copied and original document differ, all
20817 relative paths of included files of the copy are adjusted (like in
20819 File\SpecialChar menuseparator
20824 Finally, the copy is loaded instead of the original document.
20827 \begin_layout Labeling
20828 \labelwidthstring 00.00.0000
20830 \begin_inset space ~
20834 \begin_inset space ~
20838 \begin_inset Newline newline
20842 \begin_inset Flex Code
20845 \begin_layout Plain Layout
20848 \begin_inset Quotes eld
20852 \begin_inset Quotes erd
20861 \begin_inset Flex Code
20864 \begin_layout Plain Layout
20867 \begin_inset Quotes eld
20871 \begin_inset Quotes erd
20880 \begin_inset Newline newline
20884 \begin_inset Flex Code
20887 \begin_layout Plain Layout
20891 \begin_inset Quotes eld
20895 \begin_inset Quotes erd
20906 \begin_layout Subsubsection
20912 \begin_layout Standard
20913 This makes as if the last check in never happened.
20914 No changes are made to the document loaded into \SpecialChar LyX
20915 , but the last version
20916 is removed from the master RCS file.
20919 \begin_layout Standard
20922 rcs -o<version> <file-name>
20925 \begin_layout Subsubsection
20931 \begin_layout Standard
20932 This shows the complete history of the RCS document.
20937 is shown in a browser.
20945 \begin_layout Subsubsection
20949 \begin_layout Standard
20951 supports RCS version number, author name, date and time of last commit.
20952 All those are extracted from
20954 rlog -r <file-name>
20958 \begin_inset CommandInset ref
20960 reference "subsec:VCS-Revision-Information"
20967 \begin_layout Subsection
20968 CVS commands in \SpecialChar LyX
20972 \begin_layout Standard
20973 A subset of CVS operations is supported by \SpecialChar LyX
20975 You can find the commands in the
20977 File\SpecialChar menuseparator
20979 \begin_inset space ~
20985 The version control system SVN is more powerful, so please use it instead
20986 of CVS if possible.
20989 \begin_layout Subsubsection
20995 \begin_layout Standard
20996 If you start from scratch with CVS you have to create your repository and
20997 checkout the working copy with external tools.
20998 If you're using a client-server setup you may need to login before doing
20999 the first repository checkout.
21002 \begin_layout Standard
21003 If your documents are under revision control and others are using the same
21004 repository problems arise when different changes to the same document at
21005 the same location happen.
21006 Standard CVS repositories don't operate with a file locking mechanism.
21007 This may be surprising, but conflicts only occur if people disagree on
21008 the proper content of the same part of a document.
21009 So, if co-workers are used to communicate regularly, these conflicts occur
21011 If they don't communicate they have a fundamental problem anyway.
21012 Nevertheless some people like to work with so called
21013 \begin_inset Quotes eld
21017 \begin_inset Quotes erd
21021 If they do so the working copy of all files is readonly when checked out
21022 first and the user starts editing after using a special command to make
21023 the working copy writable.
21024 When the changes are checked in the working copy returns to readonly state.
21025 With \SpecialChar LyX
21026 one has to edit the
21027 \begin_inset Flex Code
21030 \begin_layout Plain Layout
21036 file and add the line
21037 \begin_inset Flex Code
21040 \begin_layout Plain Layout
21046 to work with reserved checkouts.
21047 The benefit is the possibility to see who is using a writable copy of some
21049 It's not guaranteed only one user makes a copy writable.
21052 \begin_layout Standard
21054 tries to guess if you're using reserved or non-reserved checkouts.
21055 If your working copy is readonly or it is writable and an additional copy
21056 of your document exists in the CVS/Base sub-directory a reserved otherwise
21057 a non-reserved checkout is assumed.
21058 When a reserved checkout is detected you have to use
21059 \begin_inset Flex Noun
21062 \begin_layout Plain Layout
21068 to make your working copy writable if it's readonly.
21070 \begin_inset Flex Noun
21073 \begin_layout Plain Layout
21079 operation is possible and that makes your working copy readonly again after
21080 transferring your changes to the repository.
21083 \begin_layout Standard
21084 More information about CVS can be found here
21085 \begin_inset Flex URL
21088 \begin_layout Plain Layout
21090 http://www.nongnu.org/cvs
21096 \begin_inset Flex URL
21099 \begin_layout Plain Layout
21101 http://ximbiot.com/cvs
21109 \begin_layout Standard
21114 to understand the sub-commands and the switches mentioned below.
21117 \begin_layout Subsubsection
21123 \begin_layout Standard
21124 If your document is not under revision control, this is the only item shown
21126 And if it is under revision control, the
21130 item is not visible.
21134 \begin_layout Standard
21135 This command registers in CVS your document
21136 \begin_inset Flex Strong
21139 \begin_layout Plain Layout
21147 in the case you have already the documents directory under CVS control
21153 This means you have to create or checkout the archive by yourself using
21155 (In case you forget that step \SpecialChar LyX
21156 registers the document with RCS.)
21159 \begin_layout Standard
21160 Then you are asked interactively to supply an initial description of the
21162 Don't forget that registered file is not yet checked in.
21165 \begin_layout Standard
21166 CVS command that is run:
21168 cvs -q add -m"<entered message>" "<file-name>"
21171 \begin_layout Standard
21176 above and for all other CVS commands is an abbreviation for
21177 \begin_inset Quotes eld
21180 change the current working directory to file location and use the file name
21181 without path component as argument
21182 \begin_inset Quotes erd
21188 \begin_layout Subsubsection
21194 \begin_layout Standard
21195 When you are finished editing a file, you commit your changes.
21196 When you do this and you had changed the document, you are asked for a
21197 description of the changes.
21198 After that changes are written to the repository.
21199 In case you didn't change the document and a reserved checkout is detected
21200 the reservation made on
21201 \begin_inset Flex Noun
21204 \begin_layout Plain Layout
21213 \begin_layout Labeling
21214 \labelwidthstring 00.00.0000
21216 \begin_inset space ~
21220 \begin_inset space ~
21224 \begin_inset Newline newline
21228 \begin_inset Flex Code
21231 \begin_layout Plain Layout
21234 -q commit -m"<description>" "<file-name>"
21240 \begin_inset Newline newline
21244 \begin_inset Flex Code
21247 \begin_layout Plain Layout
21258 \begin_layout Subsubsection
21264 \begin_layout Standard
21265 When you are sharing a repository with others, you may have to incorporate
21266 their changes into your working copy.
21269 \begin_layout Standard
21272 cvs -q update "<file-name>"
21275 \begin_layout Standard
21276 If a readonly checkout is detected the working copy is made writable and
21280 \begin_layout Standard
21283 cvs -q edit "<file-name>"
21286 \begin_layout Subsubsection
21289 Revert To Repository Version
21292 \begin_layout Standard
21293 This will discard all changes made to the document since the last check
21295 You get a warning before changes are discarded.
21296 Firstly the file is deleted, secondly CVS update command is run.
21299 \begin_layout Standard
21302 cvs -q update "<file-name>"
21305 \begin_layout Standard
21306 If a reserved checkout is detected and the working copy has no changes only
21307 the reservation is undone.
21310 \begin_layout Standard
21313 cvs -q unedit "<file-name>"
21316 \begin_layout Subsubsection
21322 \begin_layout Standard
21323 This will create a copy of the current document.
21324 Since CVS does not support copy operations natively, the version history
21325 is not preserved, and the copy is added as a new file.
21326 It requires a clean document without any changes since the last checkin.
21327 You are asked for a file name and a description of the copy operation.
21328 After that the copy is created, both locally and in the repository.
21329 If the parent directories of the copied and original document differ, all
21330 relative paths of included files of the copy are adjusted (like in
21332 File\SpecialChar menuseparator
21337 Finally, the copy is loaded instead of the original document.
21340 \begin_layout Labeling
21341 \labelwidthstring 00.00.0000
21343 \begin_inset space ~
21347 \begin_inset space ~
21351 \begin_inset Newline newline
21355 \begin_inset Flex Code
21358 \begin_layout Plain Layout
21361 \begin_inset Quotes eld
21365 \begin_inset Quotes erd
21374 \begin_inset Flex Code
21377 \begin_layout Plain Layout
21380 \begin_inset Quotes eld
21384 \begin_inset Quotes erd
21393 \begin_inset Newline newline
21397 \begin_inset Flex Code
21400 \begin_layout Plain Layout
21404 \begin_inset Quotes eld
21408 \begin_inset Quotes erd
21419 \begin_layout Subsubsection
21425 \begin_layout Standard
21426 This will rename the current document.
21427 Since CVS does not support rename operations natively, the version history
21428 is not preserved, the renamed document is added as a new file, and the
21429 original document is deleted.
21430 It requires a clean document without any changes since the last checkin.
21431 You are asked for a file name and a description of the rename operation.
21432 After that the document is renamed, both locally and in the repository.
21433 If the parent directories of the new and old file names differ, all relative
21434 paths of included files are adjusted (like in
21436 File\SpecialChar menuseparator
21441 Finally, the document is reloaded using the new name.
21444 \begin_layout Labeling
21445 \labelwidthstring 00.00.0000
21447 \begin_inset space ~
21451 \begin_inset space ~
21455 \begin_inset Newline newline
21459 \begin_inset Flex Code
21462 \begin_layout Plain Layout
21465 \begin_inset Quotes eld
21469 \begin_inset Quotes erd
21478 \begin_inset Flex Code
21481 \begin_layout Plain Layout
21484 \begin_inset Quotes eld
21488 \begin_inset Quotes erd
21497 \begin_inset Newline newline
21501 \begin_inset Flex Code
21504 \begin_layout Plain Layout
21508 \begin_inset Quotes eld
21512 \begin_inset Quotes erd
21521 \begin_inset Newline newline
21525 \begin_inset Flex Code
21528 \begin_layout Plain Layout
21532 \begin_inset Quotes eld
21536 \begin_inset Quotes erd
21547 \begin_layout Subsubsection
21548 Update of the local directory checkout from repository
21551 \begin_layout Standard
21552 Once your documents gets more complex, containing sub-documents and pictures,
21554 \begin_inset Flex Code
21557 \begin_layout Plain Layout
21563 files and so on using version control becomes more complicated.
21565 supports updating the whole tree in which resides the document.
21566 This become especially useful once you cooperate with people which neither
21567 have detailed knowledge about CVS usage nor they have ambition to commit
21568 additional material to the repository.
21569 You have to organize the files structure so that all external files are
21570 in the same directory or subdirectories of the document.
21571 It's good practice anyway to store multipart documents in an extra directory.
21574 \begin_layout Standard
21576 \begin_inset Flex Code
21579 \begin_layout Plain Layout
21580 Update local directory from repository
21585 command updates the whole directory.
21586 If local changes are detected user is warned before update starts.
21587 In case of merge conflicts both versions of the conflicting document parts
21588 are placed in the final document.
21589 You have to review and correct the result of the merge.
21590 You'll find the conflicts enclosed in pairs of
21591 \begin_inset Flex Code
21594 \begin_layout Plain Layout
21601 \begin_inset Flex Code
21604 \begin_layout Plain Layout
21611 \begin_inset Flex Code
21614 \begin_layout Plain Layout
21621 The first part is your version as before the update operation with the
21622 document name prepended.
21623 The second one is the repository version with the version number after
21625 \begin_inset Flex Code
21628 \begin_layout Plain Layout
21637 \begin_layout Labeling
21638 \labelwidthstring 00.00.0000
21640 \begin_inset space ~
21644 \begin_inset space ~
21648 \begin_inset Newline newline
21652 \begin_inset Flex Code
21655 \begin_layout Plain Layout
21663 (Ask if changes are detected.)
21664 \begin_inset Newline newline
21668 \begin_inset Flex Code
21671 \begin_layout Plain Layout
21672 cd $path; cvs -q update
21682 \begin_layout Standard
21684 \begin_inset Flex Code
21687 \begin_layout Plain Layout
21693 stands for the path to the document.
21696 \begin_layout Subsubsection
21702 \begin_layout Standard
21703 This shows the complete history of the CVS document.
21706 cvs log "<file-name>"
21708 is shown in a browser.
21711 \begin_layout Subsubsection
21715 \begin_layout Standard
21717 supports CVS version number, author name, date and time of last commit.
21718 All those are extracted from
21720 cvs log -r <file-name>
21724 \begin_inset CommandInset ref
21726 reference "subsec:VCS-Revision-Information"
21733 \begin_layout Subsection
21734 SVN commands in \SpecialChar LyX
21738 \begin_layout Standard
21739 SVN is now partially supported by \SpecialChar LyX
21741 You can find the commands in the
21743 File\SpecialChar menuseparator
21745 \begin_inset space ~
21751 Please note that if you use password protected access to repository via
21752 ssh, you will be asked in terminal window.
21754 was tested against SVN 1.5, 1.6, 1.7 and 1.8
21758 \begin_layout Plain Layout
21759 Most of the commands will work with 1.4 too, see
21760 \begin_inset CommandInset ref
21762 reference "subsec:SVN-Repo-Update"
21767 There seems to be currently unresolved permissions problem under SVN 1.8
21768 with reverting changes when file is locked.
21776 \begin_layout Subsubsection
21782 \begin_layout Standard
21783 If your document is not under revision control, this is the only item shown
21785 And if it is under revision control, the
21789 item is not visible.
21792 \begin_layout Standard
21793 This command registers in SVN your document ONLY in case you have already
21794 the documents directory under SVN control (in particular
21799 This means you have to checkout the archive by yourself.
21802 \begin_layout Standard
21803 Then you are asked interactively to supply an initial description of the
21805 Don't forget that registered file is not yet commited.
21808 \begin_layout Standard
21809 SVN command that is run:
21812 \begin_inset Quotes eld
21816 \begin_inset Quotes erd
21822 \begin_layout Standard
21827 to understand the switches.
21830 \begin_layout Subsubsection
21836 \begin_layout Standard
21837 When you are finished editing a file, you commit your changes.
21838 When you do this, you are asked for a description of the changes.
21839 After that changes are commited.
21842 \begin_layout Standard
21847 \begin_layout Plain Layout
21848 In case locking is not enabled.
21850 \begin_inset CommandInset ref
21852 reference "subsec:SVN-File-Locking"
21863 svn commit -q -m"<description>" <file-name>
21866 \begin_layout Subsubsection
21872 \begin_layout Standard
21873 Updates the changes of this file from the repository.
21874 Be sure you understand SVN merging and conflicts resolving before using
21875 this function, because all conflicts has to be resolved manually by you!
21878 \begin_layout Standard
21883 \begin_layout Plain Layout
21891 svn update --non-interactive
21892 \begin_inset Quotes eld
21896 \begin_inset Quotes erd
21902 \begin_layout Subsubsection
21905 Revert To Repository Version
21908 \begin_layout Standard
21909 This will discard all changes made to the document since the last check
21911 You get a warning before changes are discarded.
21914 \begin_layout Standard
21918 \begin_inset Quotes eld
21922 \begin_inset Quotes erd
21928 \begin_layout Subsubsection
21934 \begin_layout Standard
21935 This will create a copy of the current document including the version history.
21936 It requires a clean document without any changes since the last checkin.
21937 You are asked for a file name and a description of the copy operation.
21938 After that the copy is created, both locally and in the repository.
21939 If the parent directories of the copied and original document differ, all
21940 relative paths of included files of the copy are adjusted (like in
21942 File\SpecialChar menuseparator
21947 Finally, the copy is loaded instead of the original document.
21950 \begin_layout Labeling
21951 \labelwidthstring 00.00.0000
21953 \begin_inset space ~
21957 \begin_inset space ~
21961 \begin_inset Newline newline
21965 \begin_inset Flex Code
21968 \begin_layout Plain Layout
21972 \begin_inset Quotes eld
21976 \begin_inset Quotes erd
21980 \begin_inset Quotes eld
21984 \begin_inset Quotes erd
21993 \begin_inset Newline newline
21997 \begin_inset Flex Code
22000 \begin_layout Plain Layout
22009 \begin_layout Subsubsection
22015 \begin_layout Standard
22016 This will rename the current document including the version history.
22017 It requires a clean document without any changes since the last checkin.
22018 You are asked for a file name and a description of the rename operation.
22019 After that the document is renamed, both locally and in the repository.
22020 If the parent directories of the new and old file names differ, all relative
22021 paths of included files are adjusted (like in
22023 File\SpecialChar menuseparator
22028 Finally, the document is reloaded using the new name.
22031 \begin_layout Labeling
22032 \labelwidthstring 00.00.0000
22034 \begin_inset space ~
22038 \begin_inset space ~
22042 \begin_inset Newline newline
22046 \begin_inset Flex Code
22049 \begin_layout Plain Layout
22053 \begin_inset Quotes eld
22057 \begin_inset Quotes erd
22061 \begin_inset Quotes eld
22065 \begin_inset Quotes erd
22074 \begin_inset Newline newline
22078 \begin_inset Flex Code
22081 \begin_layout Plain Layout
22090 \begin_layout Subsubsection
22091 \begin_inset CommandInset label
22093 name "subsec:SVN-Repo-Update"
22097 Update of the local directory checkout from repository
22101 \begin_layout Plain Layout
22102 Note that this command will work only with subversion
22103 \begin_inset Formula $\geqq1.5$
22114 \begin_layout Standard
22115 All the commands above have one shortcomming - they deal with the current
22117 Once your document contains pictures, includes external
22118 \begin_inset Flex Code
22121 \begin_layout Plain Layout
22127 files and so on administration becomes more complicated.
22129 now supports updating the whole tree in which resides the document
22133 \begin_layout Plain Layout
22134 One need to organize the files structure so that all external files are
22135 in the same directory or subdirectories of the document.
22142 This become especially useful once you cooperate with people which neither
22143 know about subversion management nor they have ambition to commit additional
22144 material to the repository.
22148 \begin_layout Standard
22149 \begin_inset Flex Code
22152 \begin_layout Plain Layout
22153 Update local directory from repository
22158 command updates the whole directory and in case of merge conflicts local
22159 version of the files are left, so no unintended data loss occurs.
22160 If local changes are detected user is warned before update starts.
22163 \begin_layout Labeling
22164 \labelwidthstring 00.00.0000
22166 \begin_inset space ~
22170 \begin_inset space ~
22174 \begin_inset Newline newline
22178 \begin_inset Flex Code
22181 \begin_layout Plain Layout
22187 (Ask if changes are detected.)
22188 \begin_inset Newline newline
22192 \begin_inset Flex Code
22195 \begin_layout Plain Layout
22196 svn update –accept mine-full $path
22204 \begin_layout Standard
22206 \begin_inset Flex Code
22209 \begin_layout Plain Layout
22215 stands for the path to the document.
22218 \begin_layout Subsubsection
22224 \begin_layout Standard
22225 This shows the complete history of the SVN document.
22229 \begin_inset Quotes eld
22233 \begin_inset Quotes erd
22238 is shown in a browser.
22241 \begin_layout Subsubsection
22243 \begin_inset CommandInset label
22245 name "subsec:SVN-File-Locking"
22252 \begin_layout Standard
22253 The file exchange through various revision control systems brings the problem
22254 of merge conflicts in case two different users try to edit the same (parts
22256 When such a conflict happens it needs manual resolving and one reasonable
22257 alternative is to provide some kind of locking mechanism, which guarantees
22258 that only one user is allowed to edit file at the given time.
22261 \begin_layout Standard
22262 SVN has two such mechanisms to provide mutual exclusivity for file access
22263 - locks and automatic setting of write permissions (see sec.
22265 \begin_inset CommandInset ref
22267 reference "subsec:Automatical-Locking-Property"
22272 \begin_inset Flex Code
22275 \begin_layout Plain Layout
22285 \begin_layout Plain Layout
22286 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
22292 If this property is detected for a given document \SpecialChar LyX
22293 starts to use SVN locks
22294 for document editing automatically and the whole check-in/out mechanism
22295 switches to the same regimen as for RCS.
22296 This in particular means there are two different modes of file use in \SpecialChar LyX
22300 \begin_layout Itemize
22302 The loaded file is in the read-only mode.
22303 For editing on needs to check-out.
22308 consists of updating from the repository and gaining write lock.
22309 If the lock is not possible to obtain, we remain in unlocked state.
22312 \begin_layout Itemize
22314 The loaded file is in the 'normal' edit mode.
22315 No other user is allowed to edit the file.
22320 consists of commiting changes and releasing write-lock.
22321 If no changes have been made to the document, no commit will be produced
22325 \begin_layout Plain Layout
22326 Don't be puzzled by the fact that you will be asked for commit message anyway.
22331 and only the write-lock will be released.
22334 \begin_layout Standard
22338 \begin_layout Labeling
22339 \labelwidthstring 00.00.0000
22342 svn commit -q -m"<description>" "<file-name>"
22343 \begin_inset Newline newline
22346 svn unlock "<file-name>"
22349 \begin_layout Labeling
22350 \labelwidthstring 00.00.0000
22353 svn update "<file-name>"
22354 \begin_inset Newline newline
22357 svn lock "<file-name>"
22360 \begin_layout Subsubsection
22363 \begin_inset CommandInset label
22365 name "subsec:Automatical-Locking-Property"
22371 Automatic Locking Property
22374 \begin_layout Standard
22375 The above mentioned automatic setting of write permissions of the .lyx file
22378 File\SpecialChar menuseparator
22380 \begin_inset space ~
22383 Control\SpecialChar menuseparator
22384 Toggle locking property
22387 This command is active only when the file is not locked on the svn server
22389 you need to check-out before proceeding).
22392 \begin_layout Labeling
22393 \labelwidthstring 00.00.0000
22395 \begin_inset space ~
22401 \begin_layout Labeling
22402 \labelwidthstring 00.00.0000
22405 svn propset svn:needs-lock ON "<file-name>"
22408 \begin_layout Labeling
22409 \labelwidthstring 00.00.0000
22412 svn propdel svn:needs-lock "<file-name>"
22415 \begin_layout Subsubsection
22416 \begin_inset CommandInset label
22418 name "subsec:VCS-Revision-Information"
22422 Revision Information in Documents
22425 \begin_layout Standard
22426 There are more possibilities how to activate revision information in our
22430 \begin_layout Itemize
22436 \begin_layout Itemize
22437 tree revision information (
22438 \begin_inset Flex Code
22441 \begin_layout Plain Layout
22448 The result is the output of the
22449 \begin_inset Flex Code
22452 \begin_layout Plain Layout
22458 command, the following table gives you an idea, how to read the results.
22461 \begin_layout Standard
22463 \begin_inset Tabular
22464 <lyxtabular version="3" rows="6" columns="2">
22465 <features tabularvalignment="middle">
22466 <column alignment="center" valignment="top">
22467 <column alignment="center" valignment="top">
22469 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
22472 \begin_layout Plain Layout
22478 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
22481 \begin_layout Plain Layout
22489 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22492 \begin_layout Plain Layout
22498 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22501 \begin_layout Plain Layout
22502 mixed revision working copy
22509 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22512 \begin_layout Plain Layout
22518 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22521 \begin_layout Plain Layout
22522 modified working copy
22529 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22532 \begin_layout Plain Layout
22538 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22541 \begin_layout Plain Layout
22542 switched working copy
22549 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22552 \begin_layout Plain Layout
22558 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22561 \begin_layout Plain Layout
22562 partial working copy, from a sparse checkout
22569 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
22572 \begin_layout Plain Layout
22578 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
22581 \begin_layout Plain Layout
22582 mixed revision, modified, switched working copy
22595 \begin_layout Itemize
22596 file revision information.
22597 The result comes from parsing the output of
22598 \begin_inset Flex Code
22601 \begin_layout Plain Layout
22603 \begin_inset space ~
22607 \begin_inset space ~
22611 \begin_inset space ~
22620 Supported flags are:
22624 \begin_layout Itemize
22625 version number of the last commit (
22626 \begin_inset Flex Code
22629 \begin_layout Plain Layout
22638 \begin_layout Itemize
22639 author of the last commit (
22640 \begin_inset Flex Code
22643 \begin_layout Plain Layout
22652 \begin_layout Itemize
22653 date of the last commit (
22654 \begin_inset Flex Code
22657 \begin_layout Plain Layout
22666 \begin_layout Itemize
22667 time of the last commit (
22668 \begin_inset Flex Code
22671 \begin_layout Plain Layout
22681 \begin_layout Standard
22682 You can obtain this info via InsetInfo (e.g.
22684 \begin_inset Flex Code
22687 \begin_layout Plain Layout
22688 info-insert buffer vcs-date
22694 The information will be available only when you have the file stored under
22695 svn managment (i.e.
22697 \begin_inset Flex Code
22700 \begin_layout Plain Layout
22706 directory is available with your document).
22710 \begin_layout Itemize
22711 Another—a hacking one—possibility is to use svn keywords
22715 \begin_layout Plain Layout
22716 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
22722 In short – you set file keywords property (e.g.
22725 svn propset svn:keywords 'Rev' file.lyx
22727 ) and then paste keyword \SpecialChar TeX
22732 \begin_layout Plain Layout
22733 This is an easy way how to ensure that \SpecialChar LyX
22734 won't break the line in the middle
22740 tag in your document (e.g.
22745 \begin_layout Plain Layout
22753 This way svn client will automatically substitute revision number (e.g.
22758 \begin_layout Plain Layout
22765 ) after each update and commit.
22766 There are more problems with this approach.
22767 Firstly, the '$' character is used in \SpecialChar TeX
22768 world for math equations, so any
22769 occurence of math formula
22770 \begin_inset Formula $Rev$
22774 \begin_inset Formula $Rev:59$
22777 in your \SpecialChar LyX
22779 Similarly for other keywords like Id, Date, Author, etc.
22780 Secondly svn output is dependent on your locales, so its very easy that
22781 svn would produce some problematic strings once Date is used.
22782 Thirdly you get the whole 'Rev: 59' string in your document instead of
22784 Until subversion implements user's custom keywords it will be hard to use
22785 this approach reliably or let \SpecialChar LyX
22786 to support it directly.
22789 \begin_layout Subsection
22790 SVN and Windows Environment
22793 \begin_layout Quote
22794 My inclination is to say that if the user cannot figure out the command
22795 line operations on their own fairly quickly, they would be well advised
22796 to use TortoiseSVN.
22802 \begin_layout Subsubsection
22806 \begin_layout Standard
22807 In addition to installing \SpecialChar LyX
22808 , and having access to a Subversion repository,
22809 the user will need to install the Subversion client program.
22810 A Windows installer for the client program is available from
22811 \begin_inset CommandInset href
22814 target "http://www.collab.net/nonav/downloads/subversion/"
22820 The user may also want to install
22821 \begin_inset CommandInset href
22824 target "http://tortoisesvn.tigris.org/"
22829 , which integrates Subversion operations into the context (rightclick) menu
22830 of Windows Explorer.
22831 Operations done outside \SpecialChar LyX
22832 will typically be more convenient using the Explorer
22834 Note that TortoiseSVN is not a replacement for the client program, which
22835 is what \SpecialChar LyX
22839 \begin_layout Subsubsection
22840 Bringing a document under Subversion control
22843 \begin_layout Standard
22844 Before a \SpecialChar LyX
22845 document can be brought under version control in Subversion, its
22846 parent directory needs to be under version control.
22847 If the document is being added to a project already in the repository,
22848 this is accomplished by checking the project out to the directory where
22849 the new document will be placed.
22850 If the project itself is not yet under version control (for instance, if
22851 this document starts a new project), the directory must be imported into
22853 This is done outside \SpecialChar LyX
22855 Both import and checkout are easily accomplished from the Explorer context
22856 menu using TortoiseSVN, or alternatively can be done using the command
22857 line client at a DOS prompt.
22858 The procedure for importing the project using TortoiseSVN is described
22859 below, assuming an existing repository and a new project being started
22867 For information on using the Subversion client program, run
22874 \begin_layout Enumerate
22881 in Windows Explorer, right click it, and select
22883 TortoiseSVN\SpecialChar menuseparator
22887 If necessary, adjust the URL for the repository, then click OK.
22890 \begin_layout Enumerate
22891 Right click the level of the repository under which you want to place the
22892 new project folder (typically the top level) and click
22896 Supply a name for the project folder and click OK.
22897 Add a message for the log file if desired, then click OK again.
22898 The new project folder should appear in the repository.
22899 Finally, click OK again to exit the repository browser.
22902 \begin_layout Enumerate
22903 Once again right click
22909 , this time selecting SVN Checkout\SpecialChar ldots
22910 Select the URL of the project folder
22911 you just created in the repository, and set the checkout directory to
22919 You will be warned about a non-empty folder; click OK to proceed.
22920 You should now have a
22931 \begin_layout Enumerate
22932 Create or open your document in \SpecialChar LyX
22935 File\SpecialChar menuseparator
22937 \begin_inset space ~
22940 Control\SpecialChar menuseparator
22944 Add a log message and click OK to commit the document to version control.
22947 \begin_layout Standard
22948 From this point onward, you should have full functionality in the
22950 File\SpecialChar menuseparator
22952 \begin_inset space ~
22958 You also have the option of checking the document in and out, viewing its
22960 using the TortoiseSVN context menu in Windows Explorer or the Subversion
22961 client program from a command prompt.
22964 \begin_layout Subsubsection
22965 SSH tunnel used with SVN under Windows
22968 \begin_layout Standard
22969 Compared with Linux setting up an svn client to communicate over ssh under
22970 Windows is a rather troublesome task.
22971 We will at least offer some hints how to setup the client side but prior
22972 knowledge about ssh and the Windows command line is needed, also be prepared
22973 for a great deal of frustration\SpecialChar ldots
22977 \begin_layout Enumerate
22978 Get an svn client for windows, as described in the previous sections.
22979 When it is a fresh install run some svn command (e.g.
22981 \begin_inset Flex Code
22984 \begin_layout Plain Layout
22990 ) to create config files, which you will need to change later on.
22993 \begin_layout Enumerate
22994 Choose an ssh client for Windows.
22995 There are several possibilities, we will use the one from Putty tools
22999 \begin_layout Plain Layout
23000 \begin_inset Flex URL
23003 \begin_layout Plain Layout
23005 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
23016 You will need to set the connection up so that the client doesn't ask for
23017 any password from you.
23018 To keep things easy we will use only keys without any additional password
23023 \begin_layout Enumerate
23025 \begin_inset Flex Code
23028 \begin_layout Plain Layout
23035 Save your private .ppk key file and put the public one on the server side.
23036 If the SVN server runs on Linux, note that the format of the public key
23037 is not compatible with Linux openssh and you will need to direcly copy-paste
23040 Public key for pasting into OpenSSH authorized_keys file
23042 :” edit field into the server's
23043 \begin_inset Flex Code
23046 \begin_layout Plain Layout
23047 ~/.ssh/authorized_keys
23053 \begin_inset Flex Code
23056 \begin_layout Plain Layout
23065 \begin_layout Enumerate
23067 \begin_inset Flex Code
23070 \begin_layout Plain Layout
23077 In the SVN config file
23081 \begin_layout Plain Layout
23082 Exact path depends on Windows version, usually somewhere around
23083 \begin_inset Flex Code
23086 \begin_layout Plain Layout
23089 Documents and Settings
23103 \begin_inset Flex Code
23106 \begin_layout Plain Layout
23121 , section [tunnels], setup ssh command, e.g.
23123 \begin_inset Flex Code
23126 \begin_layout Plain Layout
23127 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
23136 \begin_layout Plain Layout
23137 It will usually take a lot of time to get exact command right and it depends
23139 For example do not have some remote server saved as a default session in
23141 If things fail, try to connect via plink without SVN first.
23150 \begin_layout Enumerate
23151 Checkout the SVN archive, e.
23152 \begin_inset space \thinspace{}
23156 \begin_inset Newline newline
23160 \begin_inset Flex Code
23163 \begin_layout Plain Layout
23164 svn co svn+ssh://user@server/repository_path
23172 \begin_layout Subsubsection
23173 End-of-Line Conversions
23176 \begin_layout Standard
23177 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
23179 use different line endings inside the .lyx files.
23180 This is not a problem as far as \SpecialChar LyX
23181 functionality is concerned, but the commit
23182 diffs will be huge and merge-conflicts prone.
23183 Fortunately SVN itself knows
23187 \begin_layout Plain Layout
23188 \begin_inset Flex URL
23191 \begin_layout Plain Layout
23193 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
23203 how to deal with CR/LF problems when switching .lyx files to the
23204 \begin_inset Flex Code
23207 \begin_layout Plain Layout
23217 \begin_layout Plain Layout
23219 \begin_inset Flex Code
23222 \begin_layout Plain Layout
23223 svn propset svn:eol-style native FILE_NAME
23236 \begin_layout Subsection
23237 GIT commands in \SpecialChar LyX
23241 \begin_layout Standard
23242 A minimal subset of GIT commands is now supported by \SpecialChar LyX
23244 You can find the commands in the
23246 File\SpecialChar menuseparator
23248 \begin_inset space ~
23254 Please note that if you use password protected access to repository via
23255 ssh, you will be asked in terminal window.
23257 was tested against GIT 1.7.
23261 \begin_layout Plain Layout
23262 Windows users please note that you need to ensure that git is on the path.
23263 This can be set from within \SpecialChar LyX
23266 Tools\SpecialChar menuseparator
23267 Preferences\SpecialChar menuseparator
23268 Paths\SpecialChar menuseparator
23279 \begin_layout Standard
23280 One big difference of GIT and the other supported version control systems
23281 is the distributed nature of GIT: With traditional version control systems
23282 there is one central server which hosts the repository.
23283 Users commit their changes to the server, and get updates made by other
23285 With GIT, users commit to a local repository.
23286 The local repository can be synchronized with one or more remote repositories
23288 \begin_inset Flex Code
23291 \begin_layout Plain Layout
23298 \begin_inset Flex Code
23301 \begin_layout Plain Layout
23309 does not interact in any way with remote GIT repositories.
23310 It works exclusively with the local repository in a very similar way as
23311 with a central CVS or SVN repository.
23312 If you use remote GIT repositories you need to do the
23313 \begin_inset Flex Code
23316 \begin_layout Plain Layout
23323 \begin_inset Flex Code
23326 \begin_layout Plain Layout
23332 operations with your favourite GIT client.
23335 \begin_layout Subsubsection
23341 \begin_layout Standard
23342 If your document is not under revision control, this is the only item shown
23344 And if it is under revision control, the
23348 item is not visible.
23351 \begin_layout Standard
23352 This command registers in GIT your document ONLY in case you have already
23353 the documents directory under GIT control (in particular
23358 This means you have to checkout the archive by yourself.
23361 \begin_layout Standard
23362 Then you are asked interactively to supply an initial description of the
23364 Don't forget that registered file is not yet commited.
23367 \begin_layout Standard
23368 GIT command that is run:
23371 \begin_inset Quotes eld
23375 \begin_inset Quotes erd
23381 \begin_layout Standard
23386 to understand the switches.
23389 \begin_layout Subsubsection
23395 \begin_layout Standard
23396 When you are finished editing a file, you commit your changes.
23397 When you do this, you are asked for a description of the changes.
23398 After that changes are commited.
23401 \begin_layout Standard
23404 git commit -q -m"<description>" <file-name>
23407 \begin_layout Subsubsection
23410 Revert To Repository Version
23413 \begin_layout Standard
23414 This will discard all changes made to the document since the last check
23416 You get a warning before changes are discarded.
23419 \begin_layout Standard
23423 \begin_inset Quotes eld
23427 \begin_inset Quotes erd
23433 \begin_layout Subsubsection
23439 \begin_layout Standard
23440 This will rename the current document including the version history.
23441 It requires a clean document without any changes since the last checkin.
23442 You are asked for a file name and a description of the rename operation.
23443 After that the document is renamed, both locally and in the repository.
23444 If the parent directories of the new and old file names differ, all relative
23445 paths of included files are adjusted (like in
23447 File\SpecialChar menuseparator
23452 Finally, the document is reloaded using the new name.
23455 \begin_layout Labeling
23456 \labelwidthstring 00.00.0000
23458 \begin_inset space ~
23462 \begin_inset space ~
23466 \begin_inset Newline newline
23470 \begin_inset Flex Code
23473 \begin_layout Plain Layout
23477 \begin_inset Quotes eld
23481 \begin_inset Quotes erd
23485 \begin_inset Quotes eld
23489 \begin_inset Quotes erd
23498 \begin_inset Newline newline
23502 \begin_inset Flex Code
23505 \begin_layout Plain Layout
23514 \begin_layout Subsubsection
23520 \begin_layout Standard
23521 This shows the complete history of the GIT document.
23525 \begin_inset Quotes eld
23529 \begin_inset Quotes erd
23534 is shown in a browser.
23537 \begin_layout Subsubsection
23541 \begin_layout Standard
23543 supports GIT hash number of the last commit to the file, author name, date
23544 and time of last commit.
23545 All those are extracted from
23547 git log -n 1 --pretty=format:%H%n%an%n%ai
23550 Tree version information is obtained via
23552 git describe --abbrev --dirty --long
23556 \begin_inset CommandInset ref
23558 reference "subsec:VCS-Revision-Information"
23565 \begin_layout Subsection
23569 \begin_layout Standard
23570 With the recent addition of the vc-command function \SpecialChar LyX
23571 power users are allowed
23572 to create their own commands for revision control.
23575 \begin_layout Standard
23576 As an example you can see how two TortoiseSVN commands could be integrated
23580 \begin_layout Description
23582 \begin_inset Flex Code
23585 \begin_layout Plain Layout
23586 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
23594 \begin_layout Description
23596 \begin_inset Flex Code
23599 \begin_layout Plain Layout
23600 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
23608 \begin_layout Subsection
23609 Version control and Document comparison
23612 \begin_layout Standard
23613 One of the typical uses of version control is to inspect the changes between
23614 revisions, usually by creating
23615 \begin_inset Flex Code
23618 \begin_layout Plain Layout
23625 While this is useful for plain text files, it is much less useful in the
23626 case of \SpecialChar LyX
23627 files, which have more a complicated structure.
23628 Hence we provide binding to the Document comparison feature.
23629 There are two ways of calling this feature - either by direct call of
23630 \begin_inset Flex Code
23633 \begin_layout Plain Layout
23640 function (for details see \SpecialChar LyX
23641 functions manual) or by icon/menu item
23642 \begin_inset Flex Noun
23645 \begin_layout Plain Layout
23646 Compare with older revision...
23652 One can either compare two chosen revisions of the document or he can simply
23653 compare the current version of edited text with older revisions (where
23655 \begin_inset Flex Noun
23658 \begin_layout Plain Layout
23664 ' revisions back means comparison of the edited file with last commited
23669 \begin_layout Standard
23670 This feature is supported for SVN and RCS though due to the more complicated
23671 versioning scheme of RCS there is a constraint – when addressing the revisions
23672 in dialog, numbers always point to the last number in RCS revision number,
23675 We don't currently support GIT addressing of revisions, one can just compare
23676 edited document with its revision X steps backs, where X is addressed as
23680 \begin_layout Section
23681 Literate Programming
23684 \begin_layout Standard
23689 (kayvan@sylvan.com)
23693 original documentation written by
23695 Edmar Wienskoski Jr.
23698 (edmar-w-jr@technologist.com)
23701 \begin_layout Subsection
23705 \begin_layout Standard
23706 The main purpose of this documentation is to show you how to use \SpecialChar LyX
23708 programming, where it is assumed that you are familiar with this programming
23709 technique, and know what
23710 \begin_inset Quotes eld
23714 \begin_inset Quotes erd
23718 \begin_inset Quotes eld
23722 \begin_inset Quotes erd
23726 If that is not the case, please follow the web links provided in the following
23728 There is a lot of good documentation out there covering old development
23729 history to the latest tools tips.
23732 \begin_layout Standard
23733 It is also assumed that you are familiar with \SpecialChar LyX
23734 itself to a point that you
23735 are comfortable changing your \SpecialChar LyX
23736 preferences, and X resources file.
23737 If that is not the case please refer to other \SpecialChar LyX
23738 documentation to cover your
23742 \begin_layout Subsection
23743 Literate Programming
23746 \begin_layout Standard
23747 From the Literate Programming FAQ:
23750 \begin_layout Quotation
23751 Literate programming is the combination of documentation and source together
23752 in a fashion suited for reading by human beings.
23753 In fact, literate programs should be enjoyable reading, even inviting!
23754 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
23755 and documentation in a single file.
23756 Literate programming tools then parse the file to produce either readable
23757 documentation or compilable source.
23758 The WEB style of literate programming was created by D.
23759 \begin_inset space \thinspace{}
23763 Knuth during the development of his \SpecialChar TeX
23764 typesetting software.
23768 \begin_layout Standard
23769 Another excerpt says:
23772 \begin_layout Quotation
23775 How is literate programming different from verbose commenting?
23778 \begin_layout Quotation
23779 There are three distinguishing characteristics.
23780 In order of importance, they are:
23784 \begin_layout Itemize
23785 flexible order of elaboration
23788 \begin_layout Itemize
23789 automatic support for browsing
23792 \begin_layout Itemize
23793 typeset documentation, especially diagrams and mathematics
23797 \begin_layout Standard
23798 Now that I sparked your curiosity, take a look in the references.
23801 \begin_layout Subsubsection
23805 \begin_layout Standard
23806 The complete Literate Programming FAQ can be found at:
23809 \begin_layout Quote
23810 Literate Programming FAQ
23811 \begin_inset Flex URL
23814 \begin_layout Plain Layout
23816 http://www.literateprogramming.com/lpfaq.pdf
23824 \begin_layout Standard
23825 The FAQ lists 23 (twenty three!) different literate programming tools.
23826 Where some are specialized or
23827 \begin_inset Quotes eld
23831 \begin_inset Quotes erd
23834 for particular programming languages, while other have general scope.
23839 for my own use for several reasons:
23842 \begin_layout Itemize
23843 It can generate the documentation either in \SpecialChar LaTeX
23847 \begin_layout Itemize
23848 It has a open architecture, i.
23849 \begin_inset space \thinspace{}
23853 \begin_inset space \space{}
23856 it is easy to plug in new filters and to perform special processing that
23861 \begin_layout Itemize
23862 There is a good selection of filters available already (the HTML is one
23866 \begin_layout Itemize
23870 \begin_layout Standard
23871 The Noweb web page can be found at:
23874 \begin_layout Quote
23876 \begin_inset Flex URL
23879 \begin_layout Plain Layout
23881 http://www.cs.virginia.edu/~nr/noweb/
23889 \begin_layout Standard
23890 Starting from there you can reach many other interesting links and even
23891 some literate program examples.
23894 \begin_layout Subsection
23896 and Literate Programming with Noweb
23899 \begin_layout Standard
23900 The \SpecialChar LyX
23901 support for Literate Programming is provided by using the generic \SpecialChar LyX
23903 converters mechanism.
23904 This support is provided in a
23905 \begin_inset Quotes eld
23909 \begin_inset Quotes erd
23913 \begin_inset space \thinspace{}
23917 \begin_inset space \space{}
23920 you will be able to use this new \SpecialChar LyX
23921 feature with some other literate programming
23922 tool of your choice by just changing your \SpecialChar LyX
23926 \begin_layout Subsubsection
23927 Generating documents and code (weaving and tangling)
23930 \begin_layout Paragraph
23931 Using the noweb module
23934 \begin_layout Standard
23935 If you have installed Noweb and \SpecialChar LyX
23936 successfully, whenever you open a new document,
23937 after you have chosen its document class, use the Document->Settings menu
23939 \begin_inset Quotes eld
23943 \begin_inset Quotes erd
23947 If Noweb is correctly installed, when you click on the
23948 \begin_inset Quotes eld
23952 \begin_inset Quotes erd
23955 link, you will see the
23956 \begin_inset Quotes eld
23960 \begin_inset Quotes erd
23963 module in the available list and you can add it to your document.
23966 \begin_layout Paragraph
23970 \begin_layout Standard
23972 enables you to write code with a layout named
23973 \begin_inset Flex Noun
23976 \begin_layout Plain Layout
23983 Noweb delimits chunks like this:
23986 \begin_layout LyX-Code
23990 \begin_layout LyX-Code
23994 \begin_layout LyX-Code
23998 \begin_layout LyX-Code
24002 \begin_layout LyX-Code
24006 \begin_layout Standard
24007 The problem is that whatever is written in between the << and the
24011 must be taken literally, i.
24012 \begin_inset space \thinspace{}
24016 \begin_inset space \space{}
24020 should be prevented from making any special interpretation of what has
24022 This is also handled by
24023 \begin_inset Flex Noun
24026 \begin_layout Plain Layout
24032 , that works like a normal paragraph but has a free spacing capability.
24035 \begin_layout Standard
24036 As a special note, you can also use the
24037 \begin_inset Quotes eld
24041 \begin_inset Quotes erd
24044 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
24048 \begin_layout LyX-Code
24052 \begin_layout LyX-Code
24053 def some_function(args):
24056 \begin_layout LyX-Code
24057 "This is the doc string for this function."
24060 \begin_layout LyX-Code
24061 print "My args: ", args
24064 \begin_layout LyX-Code
24065 @ %def some_function
24068 \begin_layout Standard
24069 For an example of this usage and the resulting cross-reference output, look
24070 at the Literate python program in
24072 LIBDIR/examples/listerrors.lyx
24074 which should make this all clear.
24077 \begin_layout Paragraph
24078 Generating the documentation
24081 \begin_layout Standard
24082 At this point you already have a new document file with a proper document
24083 class, and with some code and text on it.
24084 How do I print it? The answer is simple, you select
24086 View\SpecialChar menuseparator
24090 Just like you would do for a plain document.
24091 No special procedure is required.
24094 \begin_layout Standard
24095 To help orientate you, I will now explain what happens inside \SpecialChar LyX
24099 \begin_layout Enumerate
24102 Update\SpecialChar menuseparator
24105 menu option is chosen, a \SpecialChar LaTeX
24111 \begin_layout Standard
24112 If the document is of any literate class the generated file will be named
24113 with an extension name defined by the
24114 \begin_inset Quotes eld
24118 \begin_inset Quotes erd
24121 format (defined in the Preferences panel), otherwise the file will have
24130 \begin_layout Enumerate
24131 Note that the only difference so far is in the name of the file, no special
24132 processing is required by \SpecialChar LyX
24134 Given that you formatted the code using the
24135 \begin_inset Flex Noun
24138 \begin_layout Plain Layout
24144 layout that, by itself, takes care of the business.
24147 \begin_layout Enumerate
24148 If the document is of any literate class \SpecialChar LyX
24149 will then use the internal \SpecialChar LyX
24151 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
24156 \begin_layout Plain Layout
24157 The converters are defined in the
24159 Tools\SpecialChar menuseparator
24163 \begin_inset Quotes eld
24167 \begin_inset Quotes erd
24179 manual for general information about converters.
24184 to generate the \SpecialChar LaTeX
24189 \begin_layout Standard
24190 Otherwise it will just skip this step.
24194 \begin_layout Enumerate
24195 Finally, \SpecialChar LaTeX
24196 is invoked and the regular post processing continues as in a plain
24200 \begin_layout Standard
24201 Independence from a particular
24202 \begin_inset Quotes eld
24206 \begin_inset Quotes erd
24209 is easily achieved by changing the commands that are run by the various
24213 \begin_layout Paragraph
24214 Generating the code
24217 \begin_layout Standard
24218 When the build menu option is chosen or the corresponding button in the
24219 toolbar is pressed, a \SpecialChar LaTeX
24220 file is generated just like step 1 above.
24221 Next, \SpecialChar LyX
24227 This converter needs to be defined by the user and is not installed by
24228 default, though the Program format is.
24229 This converter (like any other converter) will have two parts:
24232 \begin_layout Enumerate
24233 The converter program itself.
24234 This program performs the conversion from the one format to the other (in
24235 this case, from the Noweb format to the Program pseudo-format).
24238 \begin_layout Enumerate
24239 The error log parser.
24240 This is a program whose sole purpose is to rewrite error messages in a
24241 format that \SpecialChar LyX
24243 This makes it possible for \SpecialChar LyX
24244 to place error boxes in the right places in
24248 \begin_layout Standard
24249 The first part, the
24250 \begin_inset Quotes eld
24254 \begin_inset Quotes erd
24257 setting, should be set to
24258 \begin_inset Newline newline
24262 \begin_inset Quotes eld
24270 \begin_inset Quotes erd
24274 \begin_inset Newline newline
24277 This basically means that \SpecialChar LyX
24279 \begin_inset Quotes eld
24283 \begin_inset Quotes erd
24286 (a program or script) with the name of the Noweb file (normally a file
24287 in the \SpecialChar LyX
24288 temp directory) and the directory path of the original \SpecialChar LyX
24293 \begin_layout Standard
24294 This is an implementation of
24295 \begin_inset Quotes eld
24299 \begin_inset Quotes erd
24302 that you can place in a directory on your path:
24305 \begin_layout Standard
24306 \begin_inset VSpace defskip
24312 \begin_layout Standard
24313 \begin_inset Newpage pagebreak
24319 \begin_layout Standard
24325 \begin_layout Standard
24331 \begin_layout Standard
24334 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
24337 \begin_layout Standard
24338 \begin_inset VSpace defskip
24344 \begin_layout Standard
24345 The next part of the converter setting is the
24346 \begin_inset Quotes eld
24350 \begin_inset Quotes erd
24353 which is to be set to
24354 \begin_inset Newline newline
24358 \begin_inset Quotes eld
24363 parselog=$$s/scripts/listerrors
24366 \begin_inset Quotes erd
24370 \begin_inset Newline newline
24373 This will run any errors that are generated by the
24374 \begin_inset Quotes eld
24378 \begin_inset Quotes erd
24381 process through the
24382 \begin_inset Quotes eld
24386 \begin_inset Quotes erd
24392 \begin_layout Standard
24393 The build will normally take place in \SpecialChar LyX
24394 's temporary directory, so the files
24395 produced by the conversion will be in that directory.
24397 will copy out what it regards as the `main' file, but the
24401 conversion may produce several files, and so most of these would then be
24402 deleted when \SpecialChar LyX
24404 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
24405 the build-script chunk can place the generated files in that location.
24408 \begin_layout Paragraph
24409 Build instructions in the document
24412 \begin_layout Standard
24413 The last piece of the integration between \SpecialChar LyX
24415 \begin_inset Quotes eld
24419 \begin_inset Quotes erd
24423 Generally, the instructions for building your program should be embedded
24424 in a chunk of its own.
24426 \begin_inset Quotes eld
24430 \begin_inset Quotes erd
24433 above uses the notangle command to look for this chunk (called
24434 \begin_inset Quotes eld
24438 \begin_inset Quotes erd
24441 ) and runs its contents through
24442 \begin_inset Quotes eld
24446 \begin_inset Quotes erd
24452 \begin_layout Standard
24453 Typically, such a chunk would look something like this:
24456 \begin_layout LyX-Code
24460 \begin_layout LyX-Code
24462 \begin_inset Newline newline
24465 if [ -z "${NOWEB_SOURCE}" ]
24466 \begin_inset Newline newline
24472 \begin_layout LyX-Code
24473 NOWEB_SOURCE=myfile.nw
24474 \begin_inset Newline newline
24478 \begin_inset Newline newline
24482 code to extract files ...
24483 use NOWEB_OUTPUT_DIR here ...]
24484 \begin_inset Newline newline
24488 code to compile files ...]
24489 \begin_inset Newline newline
24495 \begin_layout Standard
24498 LIBDIR/examples/listerrors.lyx
24502 LIBDIR/examples/Literate.lyx
24504 which implement two versions of the
24505 \begin_inset Quotes eld
24509 \begin_inset Quotes erd
24512 program for some illustrations of how all of these pieces go together or
24515 LIBDIR/examples/noweb2lyx.lyx.
24518 Interestingly, these three files show off the language-indepence of the
24520 literate programming support since they are written in Python, C and Perl
24524 \begin_layout Subsubsection
24525 Configuring \SpecialChar LyX
24529 \begin_layout Standard
24530 All the Literate Programming support is configured by the
24532 Tools\SpecialChar menuseparator
24536 \begin_inset Quotes eld
24540 \begin_inset Quotes erd
24544 The important parts are:
24547 \begin_layout Description
24549 \begin_inset space ~
24553 \begin_inset Quotes eld
24557 \begin_inset Quotes erd
24561 \begin_inset space ~
24564 format Set up via the File Formats tab, this is where the Noweb-specific
24574 , the file extension is set to
24579 This tells \SpecialChar LyX
24580 to create a file with a
24584 extension in the first step of the conversion process.
24587 \begin_layout Description
24589 \begin_inset space ~
24597 \begin_inset space ~
24600 format This is an empty format whose sole purpose is to be the endpoint
24601 of a conversion (which then allows us to set up a converter for it).
24604 \begin_layout Description
24614 This converter performs the
24615 \begin_inset Quotes eld
24619 \begin_inset Quotes erd
24622 of the literate document.
24623 For Noweb, it is set to
24624 \begin_inset Quotes eld
24629 noweave -delay -index $$i > $$o
24632 \begin_inset Quotes erd
24638 \begin_layout Description
24648 \begin_inset Quotes eld
24652 \begin_inset Quotes erd
24656 As stated above, the Converter is set to
24657 \begin_inset Quotes eld
24665 \begin_inset Quotes erd
24668 , with Flags set to
24669 \begin_inset Newline newline
24673 \begin_inset Quotes eld
24678 parselog=$$s/scripts/listerrors
24681 \begin_inset Quotes erd
24687 \begin_layout Subsubsection
24691 \begin_layout Standard
24692 There is also a new function implemented in the \SpecialChar LyX
24694 \begin_inset Quotes eld
24697 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
24701 \begin_layout Standard
24702 When debugging code with ddd/gdb, it is possible to invoke a text editor
24703 at the current execution position with a single key stroke.
24704 The default ddd configuration for that is shift-ctrl-V.
24705 It happens that you can define the editor command line invocation in ddd
24708 Edit\SpecialChar menuseparator
24709 Preferences\SpecialChar menuseparator
24712 dialog and changing the "Edit Sources" entry.
24715 \begin_layout Standard
24716 I take advantage of the newly created \SpecialChar LyX
24717 server function and this ddd feature,
24719 \begin_inset Quotes eld
24723 \begin_inset Quotes erd
24729 \begin_layout Standard
24730 \begin_inset VSpace defskip
24736 \begin_layout Standard
24739 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
24742 \begin_layout Standard
24743 \begin_inset VSpace defskip
24749 \begin_layout Standard
24750 With this, whenever you are using ddd and find a point in the program that
24751 you want to edit, you just press shift-ctrl-V (in the ddd window), and
24752 ddd will forward this information to \SpecialChar LyX
24753 through the \SpecialChar LyX
24754 server and then the
24756 window will show the same file with the cursor at the same position ddd
24758 No more guessing or long scrolling to locate a point in the program back
24762 \begin_layout Standard
24763 Note however that you must enable the \SpecialChar LyX
24764 server to get this feature working
24765 (it is disabled by default).
24766 You can enable it in
24778 ) by entering in the
24784 \begin_inset Quotes eld
24789 /home/<your-home-directory>/.lyx/lyxpipe
24792 \begin_inset Quotes erd
24798 \begin_layout Standard
24799 Read the \SpecialChar LyX
24800 server documentation in the
24802 Customization Manual
24804 for further information.
24807 \begin_layout Subsubsection
24811 \begin_layout Standard
24812 There are six new buttons that can be added to your \SpecialChar LyX
24814 Five of these buttons are short cuts to layout styles:
24837 The last one is a short cut to the
24838 \begin_inset Quotes eld
24842 \begin_inset Quotes erd
24849 \begin_layout Standard
24851 has a range of buttons that are available for tool bar customization.
24852 In my toolbar I like to combine the six short cuts above with two more:
24857 \SpecialChar menuseparator
24862 \SpecialChar menuseparator
24869 Document\SpecialChar menuseparator
24870 View\SpecialChar menuseparator
24874 Here is how it looks like:
24877 \begin_layout LyX-Code
24881 \begin_layout LyX-Code
24885 \begin_layout LyX-Code
24886 Icon "layout Standard"
24889 \begin_layout LyX-Code
24890 Icon "layout Section"
24893 \begin_layout LyX-Code
24894 Icon "layout \SpecialChar LaTeX
24898 \begin_layout LyX-Code
24899 Icon "layout \SpecialChar LyX
24903 \begin_layout LyX-Code
24904 Icon "layout Chunk"
24907 \begin_layout LyX-Code
24911 \begin_layout LyX-Code
24915 \begin_layout LyX-Code
24916 Icon "buffer-typeset"
24919 \begin_layout LyX-Code
24920 Icon "build-program"
24923 \begin_layout LyX-Code
24927 \begin_layout LyX-Code
24931 \begin_layout LyX-Code
24935 \begin_layout LyX-Code
24939 \begin_layout LyX-Code
24943 \begin_layout Subsubsection
24944 Colors customization
24947 \begin_layout Standard
24948 There are a number of colors in \SpecialChar LyX
24949 that can be customized in
24954 One of the things that bothers people is the \SpecialChar LaTeX
24956 The default color is red, since the chunks uses \SpecialChar LaTeX
24957 font, and there is a lot
24958 of chunks in literate documents, you may get tired of seeing everything
24960 You can change it by going to the tabs
24969 \begin_layout Standard
24970 The next thing is the visible presence of the newline character in the screen.
24971 You can choose the color of this particular character and make it blend
24973 I recommend you choosing a color that is close to the background but not
24974 equal, that way you still can see it is there, but it is not bothering
24978 \begin_layout Subsection
24983 \begin_layout Standard
24992 is documented in the
24996 example file and in the Sweave manual (menu
24998 Help\SpecialChar menuseparator
25004 \begin_layout Chapter
25008 \begin_layout Standard
25009 You can do everything with \SpecialChar LyX
25010 that you can do with \SpecialChar LaTeX
25012 However, \SpecialChar LyX
25013 cannot support every \SpecialChar LaTeX
25015 But you can always use \SpecialChar TeX
25017 This chapter shows you some more special things you might want to use.
25018 For other special things you can do with figures, tables, floats, boxes
25019 and notes, have a look at the
25022 \begin_inset space ~
25030 \begin_layout Section
25031 Multiple Text Columns
25034 \begin_layout Standard
25035 This feature is independent of the option
25037 Two-column document
25039 in the document settings under
25044 If you want to have 2
25045 \begin_inset space ~
25048 columns for the whole document, it is recommended to use the
25050 Two-column document
25053 For all other cases use this feature.
25056 \begin_layout Standard
25057 To use multiple text columns in your document, you have to load the module
25064 Document\SpecialChar menuseparator
25065 Settings\SpecialChar menuseparator
25068 ) and must have the \SpecialChar LaTeX
25076 \begin_layout Standard
25077 Footnotes within multiple columns will be placed at the bottom of the page
25078 and not under each column.
25079 Within the different columns you can use everything, with the limitation
25080 that for floats you need to use the float option
25087 \begin_layout Subsection
25091 \begin_layout Standard
25092 If you want to have 2
25093 \begin_inset space ~
25096 columns in your text, insert a multicolumn inset via the menu
25098 Insert\SpecialChar menuseparator
25100 \begin_inset space ~
25103 Insets\SpecialChar menuseparator
25105 \begin_inset space ~
25110 where the columns should start.
25111 Write all text that should be printed in 2
25112 \begin_inset space ~
25115 columns into this inset.
25118 \begin_layout Standard
25119 Here is an example:
25122 \begin_layout Standard
25124 \begin_inset Flex Multiple Columns
25127 \begin_layout Plain Layout
25132 The Adventure of the Empty House
25135 \begin_inset Newline newline
25138 by Sir Arthur Conan Doyle
25141 \begin_layout Plain Layout
25144 It was in the spring of the year 1894 that all London was interested, and
25145 the fashionable world dismayed, by the murder of the Honourable Ronald
25146 Adair under most unusual and inexplicable circumstances.
25147 The public has already learned those particulars of the crime which came
25148 out in the police investigation, but a good deal was suppressed upon that
25149 occasion, since the case for the prosecution was so overwhelmingly strong
25150 that it was not necessary to bring forward all the facts.
25151 Only now, at the end of nearly ten years, am I allowed to supply those
25152 missing links which make up the whole of that remarkable chain.
25153 The crime was of interest in itself, but that interest was as nothing to
25154 me compared to the inconceivable sequel, which afforded me the greatest
25155 shock and surprise of any event in my adventurous life.
25156 Even now, after this long interval, I find myself thrilling as I think
25157 of it, and feeling once more that sudden flood of joy, amazement, and increduli
25158 ty which utterly submerged my mind.
25159 Let me say to that public, which has shown some interest in those glimpses
25160 which I have occasionally given them of the thoughts and actions of a very
25161 remarkable man, that they are not to blame me if I have not shared my knowledge
25162 with them, for I should have considered it my first duty to do so, had
25163 I not been barred by a positive prohibition from his own lips, which was
25164 only withdrawn upon the third of last month.
25172 \begin_layout Standard
25173 To get 3 or more columns, set the cursor into the multicolumn inset and
25176 Insert\SpecialChar menuseparator
25178 \begin_inset space ~
25182 \begin_inset space ~
25188 The number of the desired columns is written into that inset (for 3
25189 \begin_inset space ~
25193 \begin_inset Quotes eld
25197 \begin_inset Quotes erd
25201 \begin_inset Newline newline
25204 Here is an example with 3
25205 \begin_inset space ~
25211 \begin_layout Standard
25212 \begin_inset Flex Multiple Columns
25215 \begin_layout Plain Layout
25218 \begin_inset Argument 1
25221 \begin_layout Plain Layout
25227 It can be imagined that my close intimacy with Sherlock Holmes had interested
25228 me deeply in crime, and that after his disappearance I never failed to
25229 read with care the various problems which came before the public.
25230 And I even attempted, more than once, for my own private satisfaction,
25231 to employ his methods in their solution, though with indifferent success.
25232 There was none, however, which appealed to me like this tragedy of Ronald
25234 As I read the evidence at the inquest, which led up to a verdict of willful
25235 murder against some person or persons unknown, I realized more clearly
25236 than I had ever done the loss which the community had sustained by the
25237 death of Sherlock Holmes.
25238 There were points about this strange business which would, I was sure,
25239 have specially appealed to him, and the efforts of the police would have
25240 been supplemented, or more probably anticipated, by the trained observation
25241 and the alert mind of the first criminal agent in Europe.
25242 All day, as I drove upon my round, I turned over the case in my mind and
25243 found no explanation which appeared to me to be adequate.
25244 At the risk of telling a twice-told tale, I will recapitulate the facts
25245 as they were known to the public at the conclusion of the inquest.
25253 \begin_layout Standard
25254 You can have up to 10
25255 \begin_inset space ~
25258 columns if you want to, but that might not be very pleasant for the readers
25262 \begin_layout Standard
25263 \begin_inset Newpage newpage
25269 \begin_layout Subsection
25270 Columns inside Columns
25273 \begin_layout Standard
25274 You can also have columns inside columns:
25277 \begin_layout Standard
25278 \begin_inset Flex Multiple Columns
25281 \begin_layout Plain Layout
25284 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
25285 at that time governor of one of the Australian colonies.
25286 Adair's mother had returned from Australia to undergo the operation for
25287 cataract, and she, her son Ronald, and her daughter Hilda were living together
25291 \begin_layout Plain Layout
25292 \begin_inset Flex Multiple Columns
25295 \begin_layout Plain Layout
25298 The youth moved in the best society–had, so far as was known, no enemies
25299 and no particular vices.
25300 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
25301 had been broken off by mutual consent some months before, and there was
25302 no sign that it had left any very profound feeling behind it.
25303 For the rest {sic} the man's life moved in a narrow and conventional circle,
25304 for his habits were quiet and his nature unemotional.
25305 Yet it was upon this easy-going young aristocrat that death came, in most
25306 strange and unexpected form, between the hours of ten and eleven-twenty
25307 on the night of March 30, 1894.
25315 \begin_layout Plain Layout
25318 Ronald Adair was fond of cards–playing continually, but never for such stakes
25320 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
25321 It was shown that, after dinner on the day of his death, he had played
25322 a rubber of whist at the latter club.
25323 He had also played there in the afternoon.
25328 The evidence of those who had played with him– Mr.
25329 Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
25330 and that there was a fairly equal fall of the cards.
25331 Adair might have lost five pounds, but not more.
25332 His fortune was a considerable one, and such a loss could not in any way
25334 He had played nearly every day at one club or other, but he was a cautious
25335 player, and usually rose a winner.
25336 It came out in evidence that, in partnership with Colonel Moran, he had
25337 actually won as much as four hundred and twenty pounds in a sitting, some
25338 weeks before, from Godfrey Milner and Lord Balmoral.
25339 So much for his recent history as it came out at the inquest.
25347 \begin_layout Subsection
25351 \begin_layout Standard
25352 The examples in this section show some more special features of multiple
25356 \begin_layout Standard
25357 For more features of multiple columns, have a look at the documentation
25358 of the \SpecialChar LaTeX
25364 \begin_inset CommandInset citation
25374 \begin_layout Subsubsection
25378 \begin_layout Standard
25379 To add a preface text for multiple columns, set the cursor into the multicolumn
25380 inset and use the menu
25382 Insert\SpecialChar menuseparator
25386 Write your preface text into that inset.
25387 \begin_inset Newline newline
25390 This is an example with some preface text:
25393 \begin_layout Standard
25394 \begin_inset VSpace bigskip
25400 \begin_layout Standard
25401 \begin_inset Flex Multiple Columns
25404 \begin_layout Plain Layout
25405 \begin_inset Argument 2
25408 \begin_layout Plain Layout
25409 And the story continues and continues and continues and continues\SpecialChar ldots
25417 On the evening of the crime, he returned from the club exactly at ten.
25418 His mother and sister were out spending the evening with a relation.
25419 The servant deposed that she heard him enter the front room on the second
25420 floor, generally used as his sitting-room.
25421 She had lit a fire there, and as it smoked she had opened the window.
25422 No sound was heard from the room until eleven-twenty, the hour of the return
25423 of Lady Maynooth and her daughter.
25424 Desiring to say good-night, she attempted to enter her son's room.
25425 The door was locked on the inside, and no answer could be got to their
25426 cries and knocking.
25427 Help was obtained, and the door forced.
25428 The unfortunate young man was found lying near the table.
25429 His head had been horribly mutilated by an expanding revolver bullet, but
25430 no weapon of any sort was to be found in the room.
25438 \begin_layout Standard
25439 You can also use a section heading as the preface if you use a section command
25440 as \SpecialChar TeX
25442 For example the command
25445 \begin_layout Standard
25450 subsection{subsection title}
25453 \begin_layout Standard
25454 creates a subsection.
25455 In this example the preface is a subsubsection:
25458 \begin_layout Standard
25459 \begin_inset Flex Multiple Columns
25462 \begin_layout Plain Layout
25463 \begin_inset Argument 2
25466 \begin_layout Plain Layout
25470 \begin_layout Plain Layout
25479 This is a subsubsection heading as a preface
25483 \begin_layout Plain Layout
25497 A minute examination of the circumstances served only to make the case more
25499 In the first place, no reason could be given why the young man should have
25500 fastened the door upon the inside.
25501 There was the possibility that the murderer had done this, and had afterwards
25502 escaped by the window.
25503 The drop was at least twenty feet, however, and a bed of crocuses in full
25505 Neither the flowers nor the earth showed any sign of having been disturbed,
25506 nor were there any marks upon the narrow strip of grass which separated
25507 the house from the road.
25508 Apparently, therefore, it was the young man himself who had fastened the
25510 But how did he come by his death? No one could have climbed up to the window
25511 without leaving traces.
25512 Suppose a man had fired through the window, he would indeed be a remarkable
25513 shot who could with a revolver inflict so deadly a wound.
25514 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
25515 a hundred yards of the house.
25516 No one had heard a shot.
25524 \begin_layout Standard
25525 If there is less vertical space than 6
25526 \begin_inset space ~
25529 text lines is left on the page at the beginning of the multiple columns,
25530 a page break will be inserted before the multiple columns.
25531 Depending on the number of lines of the preface text, you might want to
25533 This is done by setting the cursor into the mulitcolumn inset behind the
25534 preface (if there is any) and using the menu
25536 Insert\SpecialChar menuseparator
25538 \begin_inset space ~
25542 \begin_inset space ~
25546 \begin_inset space ~
25552 Insert into that inset the amount of space like e.
25553 \begin_inset space \thinspace{}
25557 \begin_inset space \space{}
25561 \begin_inset Quotes eld
25565 \begin_inset Quotes erd
25569 \begin_inset Newline newline
25572 In this example the space is set to 7
25573 \begin_inset space ~
25576 text lines by using
25577 \begin_inset Quotes eld
25583 \begin_inset Quotes erd
25592 needs to be inserted as \SpecialChar TeX
25596 \begin_layout Standard
25597 \begin_inset Flex Multiple Columns
25600 \begin_layout Plain Layout
25601 \begin_inset Argument 3
25604 \begin_layout Plain Layout
25609 \begin_layout Plain Layout
25625 On the evening of the crime, he returned from the club exactly at ten.
25626 His mother and sister were out spending the evening with a relation.
25627 The servant deposed that she heard him enter the front room on the second
25628 floor, generally used as his sitting-room.
25629 She had lit a fire there, and as it smoked she had opened the window.
25630 No sound was heard from the room until eleven-twenty, the hour of the return
25631 of Lady Maynooth and her daughter.
25632 Desiring to say good-night, she attempted to enter her son's room.
25633 The door was locked on the inside, and no answer could be got to their
25634 cries and knocking.
25635 Help was obtained, and the door forced.
25636 The unfortunate young man was found lying near the table.
25637 His head had been horribly mutilated by an expanding revolver bullet, but
25638 no weapon of any sort was to be found in the room.
25646 \begin_layout Subsubsection
25650 \begin_layout Standard
25651 The amount of space before and after multiple columns can be changed by
25652 changing the length
25659 For example the command
25662 \begin_layout Standard
25672 \begin_layout Standard
25673 in \SpecialChar TeX
25674 Code changes its value to 3
25675 \begin_inset space \thinspace{}
25679 The change must be made before the multiple columns' start.
25680 The predefined value is 13
25681 \begin_inset space \thinspace{}
25687 \begin_layout Standard
25695 \begin_inset space \thinspace{}
25701 \begin_layout Standard
25705 \begin_layout Plain Layout
25711 multicolsep}{2.5cm}
25719 \begin_layout Standard
25720 \begin_inset Flex Multiple Columns
25723 \begin_layout Plain Layout
25726 All day I turned these facts over in my mind, endeavouring to hit upon some
25727 theory which could reconcile them all, and to find that line of least resistanc
25728 e which my poor friend had declared to be the starting-point of every investigat
25730 I confess that I made little progress.
25731 In the evening I strolled across the Park, and found myself about six o'clock
25732 at the Oxford Street end of Park Lane.
25733 A group of loafers upon the pavements, all staring up at a particular window,
25734 directed me to the house which I had come to see.
25735 A tall, thin man with coloured glasses, whom I strongly suspected of being
25736 a plain-clothes detective, was pointing out some theory of his own, while
25737 the others crowded round to listen to what he said.
25738 I got as near him as I could, but his observations seemed to me to be absurd,
25739 so I withdrew again in some disgust.
25740 As I did so I struck against an elderly, deformed man, who had been behind
25741 me, and I knocked down several books which he was carrying.
25749 \begin_layout Standard
25750 \begin_inset Note Greyedout
25753 \begin_layout Plain Layout
25758 The values you set with
25764 will be used for all following multiple columns until you change them again.
25772 \begin_layout Standard
25776 \begin_layout Plain Layout
25788 \begin_inset Note Note
25791 \begin_layout Plain Layout
25792 go back to the default
25800 \begin_layout Standard
25801 \begin_inset Newpage newpage
25807 \begin_layout Subsubsection
25811 \begin_layout Standard
25812 A column break can be forced by inserting the command
25818 as \SpecialChar TeX
25819 Code to that position in the text where the column should be broken.
25820 Note that this leads in most cases to whitespace in the text.
25821 \begin_inset Newline newline
25824 Here is an example:
25827 \begin_layout Standard
25828 \begin_inset Flex Multiple Columns
25831 \begin_layout Plain Layout
25834 \begin_inset Quotes eld
25837 You're surprised to see me, sir,
25838 \begin_inset Quotes erd
25841 said he, in a strange, croaking voice.
25844 \begin_layout Plain Layout
25847 I acknowledged that I was.
25850 \begin_layout Plain Layout
25853 \begin_inset Quotes eld
25856 Well, I've a conscience, sir, and when I chanced to see you go into this
25857 house, as I came hobbling after you, I thought to myself, I'll just step
25858 in and see that kind gentleman, and tell him that if I was a bit gruff
25859 in my manner there was not any harm meant, and that I am much obliged to
25860 him for picking up my books.
25861 \begin_inset Quotes erd
25867 \begin_layout Plain Layout
25870 \begin_inset Quotes eld
25873 You make too much of a trifle,
25874 \begin_inset Quotes erd
25879 \begin_inset Quotes eld
25882 May I ask how you knew who I was?
25883 \begin_inset Quotes erd
25886 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
25890 \begin_layout Plain Layout
25902 \begin_layout Plain Layout
25905 \begin_inset Quotes eld
25908 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25909 you'll find my little bookshop at the corner of Church Street, and very
25910 happy to see you, I am sure.
25911 Maybe you collect yourself, sir.
25915 \begin_inset space ~
25928 –a bargain, every one of them.
25929 With five volumes you could just fill that gap on that second shelf.
25930 It looks untidy, does it not, sir?
25931 \begin_inset Quotes erd
25942 \begin_layout Subsubsection
25946 \begin_layout Standard
25947 The width of the columns is automatically calculated, but you can modify
25948 the space between the columns.
25949 This is done by changing the length
25956 Its predefined value is 10
25957 \begin_inset space \thinspace{}
25961 Here is an example where
25968 \begin_inset space \thinspace{}
25974 \begin_layout Standard
25978 \begin_layout Plain Layout
25992 \begin_layout Standard
25993 \begin_inset Flex Multiple Columns
25996 \begin_layout Plain Layout
25999 My observations of No.
26000 \begin_inset space \space{}
26003 427 Park Lane did little to clear up the problem in which I was interested.
26004 The house was separated from the street by a low wall and railing, the
26005 whole not more than five feet high.
26006 It was perfectly easy, therefore, for anyone to get into the garden, but
26007 the window was entirely inaccessible, since there was no water pipe or
26008 anything which could help the most active man to climb it.
26009 More puzzled than ever, I retraced my steps to Kensington.
26010 I had not been in my study five minutes when the maid entered to say that
26011 a person desired to see me.
26012 To my astonishment it was none other than my strange old book collector,
26013 his sharp, wizened face peering out from a frame of white hair, and his
26014 precious volumes, a dozen of them at least, wedged under his right arm.
26022 \begin_layout Standard
26026 \begin_layout Plain Layout
26038 \begin_inset Note Note
26041 \begin_layout Plain Layout
26042 go back to the default
26050 \begin_layout Subsubsection
26054 \begin_layout Standard
26055 Between the columns a rule with a width of the length
26062 If this rule width is set to 0
26063 \begin_inset space \thinspace{}
26066 pt (this is the default), the rule is suppressed.
26067 In the following example the rule is 2
26068 \begin_inset space \thinspace{}
26074 \begin_layout Standard
26078 \begin_layout Plain Layout
26084 columnseprule}{2pt}
26092 \begin_layout Standard
26093 \begin_inset Flex Multiple Columns
26096 \begin_layout Plain Layout
26099 \begin_inset Quotes eld
26102 You're surprised to see me, sir,
26103 \begin_inset Quotes erd
26106 said he, in a strange, croaking voice.
26109 \begin_layout Plain Layout
26112 I acknowledged that I was.
26115 \begin_layout Plain Layout
26118 \begin_inset Quotes eld
26121 Well, I've a conscience, sir, and when I chanced to see you go into this
26122 house, as I came hobbling after you, I thought to myself, I'll just step
26123 in and see that kind gentleman, and tell him that if I was a bit gruff
26124 in my manner there was not any harm meant, and that I am much obliged to
26125 him for picking up my books.
26126 \begin_inset Quotes erd
26132 \begin_layout Plain Layout
26135 \begin_inset Quotes eld
26138 You make too much of a trifle,
26139 \begin_inset Quotes erd
26144 \begin_inset Quotes eld
26147 May I ask how you knew who I was?
26148 \begin_inset Quotes erd
26154 \begin_layout Plain Layout
26157 \begin_inset Quotes eld
26160 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
26161 you'll find my little bookshop at the corner of Church Street, and very
26162 happy to see you, I am sure.
26163 Maybe you collect yourself, sir.
26167 \begin_inset space ~
26180 –a bargain, every one of them.
26181 With five volumes you could just fill that gap on that second shelf.
26182 It looks untidy, does it not, sir?
26183 \begin_inset Quotes erd
26194 \begin_layout Standard
26195 \begin_inset VSpace defskip
26201 \begin_layout Standard
26202 The rule can be colored by redefining the command
26209 This is done by inserting the command
26210 \begin_inset Newline newline
26219 columnseprulecolor}{
26224 \begin_inset Newline newline
26227 as \SpecialChar TeX
26228 Code before the multicolumn inset.
26233 in this command by a color of your choice.
26234 You can use all pre- and self-defined colors.
26242 \begin_inset space ~
26247 for more information about pre- and self-defined colors.
26248 To go back to the default color insert the command
26249 \begin_inset Newline newline
26258 columnseprulecolor}{
26263 \begin_inset Newline newline
26266 Here is the example with a cyan rule and 1
26267 \begin_inset space \thinspace{}
26270 cm column separation:
26273 \begin_layout Standard
26277 \begin_layout Plain Layout
26286 \begin_layout Plain Layout
26292 columnseprulecolor}{
26302 \begin_layout Standard
26303 \begin_inset Flex Multiple Columns
26306 \begin_layout Plain Layout
26309 \begin_inset Quotes eld
26312 You're surprised to see me, sir,
26313 \begin_inset Quotes erd
26316 said he, in a strange, croaking voice.
26319 \begin_layout Plain Layout
26322 I acknowledged that I was.
26325 \begin_layout Plain Layout
26328 \begin_inset Quotes eld
26331 Well, I've a conscience, sir, and when I chanced to see you go into this
26332 house, as I came hobbling after you, I thought to myself, I'll just step
26333 in and see that kind gentleman, and tell him that if I was a bit gruff
26334 in my manner there was not any harm meant, and that I am much obliged to
26335 him for picking up my books.
26336 \begin_inset Quotes erd
26342 \begin_layout Plain Layout
26345 \begin_inset Quotes eld
26348 You make too much of a trifle,
26349 \begin_inset Quotes erd
26354 \begin_inset Quotes eld
26357 May I ask how you knew who I was?
26358 \begin_inset Quotes erd
26364 \begin_layout Plain Layout
26367 \begin_inset Quotes eld
26370 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
26371 you'll find my little bookshop at the corner of Church Street, and very
26372 happy to see you, I am sure.
26373 Maybe you collect yourself, sir.
26377 \begin_inset space ~
26390 –a bargain, every one of them.
26391 With five volumes you could just fill that gap on that second shelf.
26392 It looks untidy, does it not, sir?
26393 \begin_inset Quotes erd
26404 \begin_layout Standard
26408 \begin_layout Plain Layout
26414 columnseprule}{0pt}
26417 \begin_layout Plain Layout
26423 columnseprulecolor}{
26431 \begin_inset Note Note
26434 \begin_layout Plain Layout
26435 go back to the default
26443 \begin_layout Section
26444 Non-standard Paragraph Shapes
26447 \begin_layout Standard
26450 as well as any other text processor uses by default rectangular paragraphs.
26451 For special cases like for example posters, invitation cards or poems you
26452 can modify the paragraph shape to one of your choice.
26453 This can be done by using the \SpecialChar LaTeX
26458 which is loaded by using in the document settings the module
26460 Custom paragraph shapes
26465 \begin_layout Subsection
26469 \begin_layout Standard
26474 provides the following shapes:
26477 \begin_layout Standard
26478 \begin_inset Tabular
26479 <lyxtabular version="3" rows="13" columns="3">
26480 <features booktabs="true" islongtable="true" longtabularalignment="center">
26481 <column alignment="center" valignment="middle" width="16col%">
26482 <column alignment="center" valignment="middle" width="40col%">
26483 <column alignment="center" valignment="middle" width="35col%">
26484 <row endhead="true">
26485 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26488 \begin_layout Plain Layout
26494 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26497 \begin_layout Plain Layout
26503 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26506 \begin_layout Plain Layout
26514 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26517 \begin_layout Plain Layout
26523 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26526 \begin_layout Plain Layout
26527 Circle with circular hole (in the size of a CD/DVD)
26532 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26535 \begin_layout Plain Layout
26536 Cannot be scaled, take care there is not too much text
26543 <cell alignment="center" valignment="top" topline="true" usebox="none">
26546 \begin_layout Plain Layout
26552 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26555 \begin_layout Plain Layout
26561 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26564 \begin_layout Plain Layout
26565 Fragile, calculation might fail
26572 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26575 \begin_layout Plain Layout
26581 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26584 \begin_layout Plain Layout
26585 Rhomboid (symbolizing a
26586 \begin_inset Quotes eld
26590 \begin_inset Quotes erd
26598 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26601 \begin_layout Plain Layout
26609 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26612 \begin_layout Plain Layout
26618 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26621 \begin_layout Plain Layout
26627 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26630 \begin_layout Plain Layout
26638 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26641 \begin_layout Plain Layout
26647 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26650 \begin_layout Plain Layout
26656 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26659 \begin_layout Plain Layout
26667 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26670 \begin_layout Plain Layout
26676 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26679 \begin_layout Plain Layout
26680 Nut for bolt (hexagon with circular hole)
26685 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26688 \begin_layout Plain Layout
26696 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26699 \begin_layout Plain Layout
26705 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26708 \begin_layout Plain Layout
26714 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26717 \begin_layout Plain Layout
26725 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26728 \begin_layout Plain Layout
26734 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26737 \begin_layout Plain Layout
26743 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26746 \begin_layout Plain Layout
26754 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26757 \begin_layout Plain Layout
26763 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26766 \begin_layout Plain Layout
26772 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26775 \begin_layout Plain Layout
26783 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26786 \begin_layout Plain Layout
26792 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26795 \begin_layout Plain Layout
26796 Normal/reversed rain drop
26801 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26804 \begin_layout Plain Layout
26805 Fragile, calculation might fail
26812 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26815 \begin_layout Plain Layout
26822 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26825 \begin_layout Plain Layout
26826 The \SpecialChar TeX
26832 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26835 \begin_layout Plain Layout
26843 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26846 \begin_layout Plain Layout
26848 \begin_inset Newline newline
26856 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26859 \begin_layout Plain Layout
26860 Triangles in different orientations
26865 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26868 \begin_layout Plain Layout
26882 \begin_layout Standard
26883 To use a shape for your paragraph, simply select it in \SpecialChar LyX
26885 for environments in the toolbar.
26888 \begin_layout Standard
26889 \begin_inset Newpage newpage
26895 \begin_layout Standard
26896 Here is an example paragraph in the shape of a nut:
26899 \begin_layout Standard
26900 \begin_inset VSpace bigskip
26909 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26910 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26912 At vero eos et accusam et justo duo dolores et ea rebum.
26913 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26915 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26916 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26920 \begin_layout Standard
26921 \begin_inset VSpace bigskip
26927 \begin_layout Standard
26928 \begin_inset Note Greyedout
26931 \begin_layout Plain Layout
26936 : shapepar paragraphs cannot run over a page break.
26944 \begin_layout Standard
26945 \begin_inset VSpace bigskip
26951 \begin_layout Standard
26956 takes care that the shape will always be preserved, no matter how much
26957 text is in the paragraph.
26958 Therefore the paragraph size changes with the amount of contained text.
26959 This can lead to paragraph sizes exceeding the page margins.
26960 To demonstrate the size scaling, here is the same example paragraph but
26961 with twice as much text:
26964 \begin_layout Standard
26965 \begin_inset Newpage newpage
26974 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26975 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26977 At vero eos et accusam et justo duo dolores et ea rebum.
26978 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26980 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26981 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26983 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26984 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26986 At vero eos et accusam et justo duo dolores et ea rebum.
26987 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26989 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26990 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26994 \begin_layout Standard
26995 \begin_inset VSpace bigskip
27001 \begin_layout Standard
27002 An exception is the shape
27007 It cannot be scaled because it must fit the size of a CD/DVD.
27008 Therefore the amount of text that fits into the shape is limited.
27009 \begin_inset Newline newline
27020 shape are fragile, meaning that the calculation of their size can fail,
27021 depending on the amount of text.
27022 You will then get the \SpecialChar LaTeX
27024 \begin_inset Quotes eld
27027 Arithmetic overflow
27028 \begin_inset Quotes erd
27032 In this case one can try to remove or add some text; if nothing works one
27033 has to use another shape.
27036 \begin_layout Standard
27037 \begin_inset VSpace bigskip
27043 \begin_layout Standard
27044 For shapes with tips you will maybe see that \SpecialChar LaTeX
27045 's hyphenation routine fails
27046 for text in the tips.
27047 Therefore it is often necessary to add hyphenation points
27052 arg "specialchar-insert hyphenation"
27057 ) to the corresponding text parts.
27060 \begin_layout Standard
27061 \begin_inset VSpace bigskip
27067 \begin_layout Standard
27068 Shapepar paragraphs are either always centered or placed on the page so
27069 that their left border touches the left page margin.
27070 You can therefore not use the paragraph dialog to align such paragraphs.
27071 A solution is to put the paragraph into a minipage or parbox and align
27073 The problem is hereby to find the right width for the box.
27074 Because if it is too wide and you center the box, the paragraph is not
27075 centered too because it sticks at the left side of the box.
27076 So you might have to play a bit with the width until it fits.
27077 Here are two heart-shaped paragraphs, the first one is not aligned, the
27078 second one is right-aligned:
27081 \begin_layout Standard
27082 \begin_inset Newpage newpage
27088 \begin_layout Heart
27092 Lo\SpecialChar softhyphen
27093 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
27094 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
27096 At vero eos et accusam et justo duo dolores et ea rebum.
27097 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
27101 \begin_layout Standard
27102 \begin_inset VSpace bigskip
27108 \begin_layout Standard
27111 \begin_inset Box Frameless
27121 height_special "totalheight"
27126 backgroundcolor "none"
27129 \begin_layout Heart
27133 Lo\SpecialChar softhyphen
27134 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
27135 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
27137 At vero eos et accusam et justo duo dolores et ea rebum.
27138 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
27147 \begin_layout Subsection
27151 \begin_layout Standard
27152 You can define any shape you want.
27153 Doing this manually is a lot of work because every coordinate must be specified.
27154 But there is a way to let the computer calculate the coordinates:
27157 \begin_layout Enumerate
27158 Install the program
27159 \begin_inset CommandInset href
27162 target "http://www.ctan.org/tex-archive/graphics/jpgfdraw"
27170 \begin_layout Enumerate
27177 TeX/LaTeX\SpecialChar menuseparator
27178 Settings\SpecialChar menuseparator
27181 and select the font size you are using in your document.
27182 For example this document uses the size 12
27183 \begin_inset space \thinspace{}
27189 \begin_layout Enumerate
27193 \begin_layout Enumerate
27196 TeX/LaTeX\SpecialChar menuseparator
27199 to export the shape to coordinates.
27200 In the appearing dialog use either the outline of your shape for the coordinate
27201 s or the path itself.
27205 \begin_layout Plain Layout
27206 For more information see
27207 \begin_inset CommandInset href
27209 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
27222 \begin_layout Standard
27223 The coordinates are written into a \SpecialChar TeX
27225 To use it for your \SpecialChar LyX
27229 \begin_layout Enumerate
27230 Place the cursor before the first character of your paragraph (or into a
27234 \begin_layout Enumerate
27235 Open in \SpecialChar LyX
27238 Insert\SpecialChar menuseparator
27239 File\SpecialChar menuseparator
27241 \begin_inset space ~
27246 , select the file and use
27255 \begin_layout Standard
27256 \begin_inset VSpace defskip
27262 \begin_layout Standard
27263 \begin_inset Note Greyedout
27266 \begin_layout Plain Layout
27271 : The changed shape only applies to the current paragraph; everything is
27272 reset to normal for the next paragraph.
27273 Therefore the shape definition file must be input into every paragraph
27274 with the desired shape.
27282 \begin_layout Standard
27283 \begin_inset VSpace bigskip
27289 \begin_layout Standard
27290 Here is an example:
27293 \begin_layout Standard
27294 \begin_inset VSpace bigskip
27300 \begin_layout Standard
27301 \begin_inset CommandInset include
27303 filename "SpecialParagraphShape.tex"
27309 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
27310 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
27312 At vero eos et accusam et justo duo dolores et ea rebum.
27313 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
27315 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
27316 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
27320 \begin_layout Standard
27321 \begin_inset VSpace bigskip
27327 \begin_layout Standard
27332 to draw complexer shapes in
27336 you can draw the shape in a program of your choice and import the resulting
27342 Then you only need to draw a line or spline along the outline of the image.
27345 \begin_layout Standard
27346 \begin_inset VSpace bigskip
27352 \begin_layout Standard
27355 Custom paragraph shapes
27357 also provides the two commands
27365 which can be used to define custom shapes coordinate by coordinate.
27369 \begin_layout Plain Layout
27370 These commands are internally used for all shapes described here.
27375 For information how these styles are used and about further customization
27376 possibilities, have a look at the documentation of the package
27381 \begin_inset CommandInset citation
27391 \begin_layout Bibliography
27392 \begin_inset CommandInset bibitem
27393 LatexCommand bibitem
27399 Documentation of the \SpecialChar LaTeX
27401 \begin_inset CommandInset href
27404 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
27412 \begin_layout Bibliography
27413 \begin_inset CommandInset bibitem
27414 LatexCommand bibitem
27420 Documentation of the \SpecialChar LaTeX
27422 \begin_inset CommandInset href
27425 target "http://mirrors.ctan.org/macros/latex/contrib/shapepar/shapepar.pdf"