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 % Improve line breaking
34 \emergencystretch 1.5em
37 \options bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
38 \use_default_options false
46 \maintain_unincluded_children false
48 \language_package default
51 \font_roman "lmodern" "default"
52 \font_sans "lmss" "default"
53 \font_typewriter "lmtt" "default"
54 \font_math "auto" "auto"
55 \font_default_family default
56 \use_non_tex_fonts false
59 \font_sf_scale 100 100
60 \font_tt_scale 100 100
62 \use_dash_ligatures true
64 \default_output_format pdf2
66 \bibtex_command default
67 \index_command default
71 \pdf_title "LyX's Additional Features manual"
72 \pdf_author "LyX Team"
73 \pdf_subject "LyX's additional features documentation"
74 \pdf_keywords "LyX, Documentation, Additional"
76 \pdf_bookmarksnumbered true
77 \pdf_bookmarksopen false
78 \pdf_bookmarksopenlevel 1
83 \pdf_pdfusetitle false
84 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
87 \use_package amsmath 1
88 \use_package amssymb 1
91 \use_package mathdots 1
92 \use_package mathtools 0
94 \use_package stackrel 0
95 \use_package stmaryrd 0
96 \use_package undertilde 0
98 \cite_engine_type default
102 \paperorientation portrait
107 \notefontcolor #0000ff
114 \paragraph_separation indent
115 \paragraph_indentation default
117 \math_indentation default
118 \math_numbering_side default
119 \quotes_style english
123 \paperpagestyle headings
124 \tracking_changes true
125 \output_changes false
129 \author -712698321 "Jürgen Spitzmüller"
135 Additional \SpecialChar LyX
139 \begin_layout Subtitle
144 by the \SpecialChar LyX
149 \begin_layout Plain Layout
151 Principal maintainer of this file is
156 If you have comments or error corrections, please send them to the \SpecialChar LyX
159 \begin_inset Flex Code
162 \begin_layout Plain Layout
164 <lyx-docs@lists.lyx.org>
177 \begin_layout Standard
178 \begin_inset CommandInset toc
179 LatexCommand tableofcontents
186 \begin_layout Chapter
190 \begin_layout Standard
191 This manual is essentially Part II of the
193 User's Guide\SpecialChar endofsentence
196 The reason for separating the two documents is simple: the
200 is already quite lengthy, and it contains information on all of the basic
201 features one needs to know in order to prepare most documents.
202 However, the \SpecialChar LyX
203 Team has worked to make \SpecialChar LyX
204 extensible through various configuration
205 files and external packages.
206 That means that if you want to support the Fizzwizzle \SpecialChar LaTeX
208 create a layout file (or module) for it without having to alter \SpecialChar LyX
210 We've already had contributions of several new features this way, and some
211 of them are documented here.
212 There are also some more `advanced' features, such as how to control the
213 presentation of bibliographies and how to work with multi-part documents,
214 that are not covered in the
218 and are discussed here.
221 \begin_layout Standard
222 This manual also documents some special features, like fax support, version
223 control, and SGML support, which require additional software to work properly.
224 There is also a chapter on \SpecialChar LyX
226 And lastly, there's a chapter of \SpecialChar LaTeX
227 tools and tips, things you can use to
228 spruce up your documents by directly using the powerful features of \SpecialChar LaTeX
230 After all, \SpecialChar LyX
235 only WYSIWYM and will only ever interface to some, not all, \SpecialChar LaTeX
239 \begin_layout Standard
240 If you haven't read the
244 yet, you are definitely in the wrong manual.
249 is the first place to go, since it describes the notation and format of
251 You should also be thoroughly familiar with the
255 and all of the basic features of \SpecialChar LyX
256 before attempting to read this one.
259 \begin_layout Standard
260 Since many of the topics in this manual depend heavily on \SpecialChar LyX
262 with \SpecialChar LaTeX
263 , this first chapter covers the inner workings of \SpecialChar LyX
266 to generate exactly the \SpecialChar LaTeX
268 It is obviously for more seasoned \SpecialChar LyX
272 \begin_layout Chapter
274 and \SpecialChar LaTeX
278 \begin_layout Section
280 Uses \SpecialChar LaTeX
284 \begin_layout Standard
285 This chapter is for both \SpecialChar TeX
286 -nicians and the \SpecialChar LaTeX
288 In it, we'll explain how \SpecialChar LyX
289 and \SpecialChar LaTeX
290 work together to produce printable output.
291 This is the only place in any of the manuals where we assume you know something
292 about \SpecialChar LaTeX
296 \begin_layout Standard
297 At one time, \SpecialChar LyX
299 \begin_inset Quotes eld
302 WYSIWYM frontend to \SpecialChar LaTeX
304 \begin_inset Quotes erd
307 but that's no longer true.
308 There are frontends to \SpecialChar LaTeX
313 \begin_layout Plain Layout
314 Some familar ones are \SpecialChar TeX
315 maker and kile, on Linux, and \SpecialChar TeX
317 There are also the \SpecialChar LaTeX
318 modes for vi and emacs, of course.
323 These are basically text editors with the ability to run \SpecialChar LaTeX
325 errors in the file you're editing.
326 Although \SpecialChar LyX
335 run \SpecialChar LaTeX
336 , and it also indicates errors in the file, it also does much, much
338 For one thing, you don't need to know \SpecialChar LaTeX
339 to use \SpecialChar LyX
342 has added its own extensions to \SpecialChar LaTeX
344 Try the following sometime: select
345 \begin_inset Flex Noun
348 \begin_layout Plain Layout
349 Export\SpecialChar menuseparator
356 \begin_inset Flex Noun
359 \begin_layout Plain Layout
366 \begin_inset Flex Noun
369 \begin_layout Plain Layout
370 View\SpecialChar menuseparator
380 ), then look at the preamble of the resulting
381 \begin_inset Flex Code
384 \begin_layout Plain Layout
391 You'll notice a variety of new macros defined specifically by \SpecialChar LyX
393 These macros are defined automatically, according to the features you use
397 \begin_layout Standard
398 There are several commands that automatically invoke \SpecialChar LaTeX
403 \begin_layout Itemize
404 \begin_inset Flex Noun
407 \begin_layout Plain Layout
408 Document\SpecialChar menuseparator
417 \begin_layout Itemize
418 \begin_inset Flex Noun
421 \begin_layout Plain Layout
422 Document\SpecialChar menuseparator
431 \begin_layout Standard
432 They will only invoke \SpecialChar LaTeX
433 if the file has changed since the last time \SpecialChar LaTeX
439 \begin_layout Standard
440 When \SpecialChar LyX
441 runs \SpecialChar LaTeX
442 on the file you're editing, it performs these steps:
445 \begin_layout Enumerate
446 Convert the document to \SpecialChar LaTeX
447 and save to a file with the extension
448 \begin_inset Flex Code
451 \begin_layout Plain Layout
458 \begin_inset Flex Code
461 \begin_layout Plain Layout
470 \begin_layout Enumerate
471 Run \SpecialChar LaTeX
473 \begin_inset Flex Code
476 \begin_layout Plain Layout
482 file (maybe several times), and run any other commands (such as
483 \begin_inset Flex Code
486 \begin_layout Plain Layout
493 \begin_inset Flex Code
496 \begin_layout Plain Layout
502 ) needed to compile the \SpecialChar LaTeX
506 \begin_layout Enumerate
507 If there are any errors, show the error log.
510 \begin_layout Standard
511 If you have run \SpecialChar LaTeX
513 \begin_inset Flex Noun
516 \begin_layout Plain Layout
517 View\SpecialChar menuseparator
524 then runs a DVI viewer to display the DVI-file.
526 \begin_inset Flex Noun
529 \begin_layout Plain Layout
530 View\SpecialChar menuseparator
537 performs further steps:
540 \begin_layout Itemize
542 \begin_inset Flex Code
545 \begin_layout Plain Layout
551 to convert the DVI file to PostScript.
554 \begin_layout Itemize
555 Run a PostScript viewer, such as
556 \begin_inset Flex Code
559 \begin_layout Plain Layout
565 , to display the PostScript file.
568 \begin_layout Standard
570 does similar things when viewing, or exporting, other formats.
573 \begin_layout Section
574 Translating \SpecialChar LaTeX
575 files into \SpecialChar LyX
579 \begin_layout Standard
580 You can import a \SpecialChar LaTeX
581 file into \SpecialChar LyX
583 \begin_inset Flex Noun
586 \begin_layout Plain Layout
587 File\SpecialChar menuseparator
588 Import\SpecialChar menuseparator
594 command in \SpecialChar LyX
596 This will call a program named
597 \begin_inset Flex Code
600 \begin_layout Plain Layout
606 which will create a file
607 \begin_inset Flex Code
610 \begin_layout Plain Layout
617 \begin_inset Flex Code
620 \begin_layout Plain Layout
628 will then open that file.
632 \begin_layout Plain Layout
633 \begin_inset Flex Code
636 \begin_layout Plain Layout
642 can also be run from the command line, of course.
650 \begin_layout Standard
651 \begin_inset Flex Code
654 \begin_layout Plain Layout
660 will translate most legal \SpecialChar LaTeX
661 , but not everything.
662 It will put things it doesn't understand into \SpecialChar TeX
663 code, so after translating
665 \begin_inset Flex Code
668 \begin_layout Plain Layout
674 , you can look for \SpecialChar TeX
675 code and hand-edit it until it looks right.
678 \begin_layout Standard
679 If you don't know what \SpecialChar TeX
680 code is, read the next section.
683 \begin_layout Section
684 \begin_inset CommandInset label
686 name "sec:Inserting-TeX-Code"
690 Inserting \SpecialChar TeX
691 Code into \SpecialChar LyX
695 \begin_layout Standard
696 Anything you can do in \SpecialChar LaTeX
697 you can do in \SpecialChar LyX
698 , for a very simple reason: You can
699 always insert \SpecialChar TeX
700 code into any \SpecialChar LyX
703 cannot, and will never be able to, display every possible \SpecialChar LaTeX
705 If ever you need to insert \SpecialChar LaTeX
706 commands into your \SpecialChar LyX
707 document, you can use the
709 \begin_inset Flex Code
712 \begin_layout Plain Layout
719 box, which you can insert into your document with
720 \begin_inset Flex Noun
723 \begin_layout Plain Layout
724 Insert\SpecialChar menuseparator
734 or the keyboard shortcut
743 \begin_layout Standard
744 Here's an example of inserting \SpecialChar LaTeX
745 commands in a \SpecialChar LyX
747 The code looks like this:
750 \begin_layout LyX-Code
754 \begin_inset Newline newline
760 \begin_inset Newline newline
763 This is an example of a minipage environment.
765 \begin_inset Newline newline
768 can put nearly everything in it, even (non-floating)
769 \begin_inset Newline newline
774 \begin_inset Newline newline
780 \begin_inset Newline newline
784 \begin_inset Newline newline
790 \begin_inset Newline newline
796 \begin_inset Newline newline
802 \begin_inset Newline newline
807 \begin_inset Newline newline
813 \begin_inset Newline newline
819 \begin_inset Newline newline
825 \begin_inset Newline newline
833 \begin_layout LyX-Code
837 \begin_layout Standard
839 \begin_inset Flex Code
842 \begin_layout Plain Layout
849 box containing this text is directly after this paragraph.
850 Those of you reading the manual in \SpecialChar LyX
851 will only see the \SpecialChar TeX
853 Those reading a printed version of the manuals will see the actual results:
854 \begin_inset VSpace bigskip
860 \begin_layout Standard
864 \begin_layout Plain Layout
871 \begin_layout Plain Layout
878 \begin_layout Plain Layout
880 This is an example of a minipage environment.
881 You can put nearly everything in it, even (non-floating) figures and tables.
885 \begin_layout Plain Layout
892 \begin_layout Plain Layout
897 \begin_layout Plain Layout
904 \begin_layout Plain Layout
911 \begin_layout Plain Layout
918 \begin_layout Plain Layout
924 \begin_layout Plain Layout
931 \begin_layout Plain Layout
938 \begin_layout Plain Layout
945 \begin_layout Plain Layout
955 \begin_inset VSpace bigskip
961 \begin_layout Standard
962 In addition to using \SpecialChar TeX
963 code, you can also create a separate file containing
964 some complex \SpecialChar LaTeX
965 structure and then use
966 \begin_inset Flex Noun
969 \begin_layout Plain Layout
970 Insert\SpecialChar menuseparator
980 to include your file (you should select the type
981 \begin_inset Flex Code
984 \begin_layout Plain Layout
991 We recommend that you only do this if you have a
992 \begin_inset Flex Code
995 \begin_layout Plain Layout
1006 Otherwise, you'll have a big job tracking down \SpecialChar LaTeX
1010 \begin_layout Standard
1011 There are a few last points to emphasize:
1014 \begin_layout Itemize
1020 check if your \SpecialChar LaTeX
1024 \begin_layout Itemize
1025 Beware of reinventing the wheel.
1028 \begin_layout Standard
1029 On that last point, \SpecialChar LyX
1030 does have quite a few features tucked into it, and
1032 Be sure to check the manuals to make sure that \SpecialChar LyX
1033 doesn't have such-and-such
1034 feature before you decide you have to do it by hand.
1035 Moreover, there are numerous \SpecialChar LaTeX
1036 packages out there to do all sorts of things,
1037 from labels to envelopes to fancy multipage tables.
1039 \begin_inset CommandInset href
1042 target "http://www.ctan.org/"
1050 \begin_layout Standard
1051 If you do need to do some wild and fancy things within your document, be
1052 sure to check out a good \SpecialChar LaTeX
1053 book for assistance.
1054 There are a number of them listed in the bibliography of the
1061 \begin_layout Section
1063 and the \SpecialChar LaTeX
1067 \begin_layout Subsection
1068 About the \SpecialChar LaTeX
1072 \begin_layout Standard
1073 If you already know \SpecialChar LaTeX
1074 , there is no need to explain here what the preamble
1076 If you don't, the following will give you some ideas—we recommend again
1077 that you consult a \SpecialChar LaTeX
1078 book for further information.
1079 In any case, you should read the points below, because they explain what
1080 you can do and what you don't need to do in the \SpecialChar LaTeX
1081 preamble of a \SpecialChar LyX
1085 \begin_layout Standard
1086 The \SpecialChar LaTeX
1087 preamble comes at the very beginning of a document,
1095 \begin_layout Itemize
1096 Declare the document class.
1098 \begin_inset Newline newline
1102 already does this for you.
1103 If you're a seasoned \SpecialChar LaTeX
1104 -nician, and you have a custom document class you
1105 want to use, check out the
1107 Customization Manual
1109 for information on how to make \SpecialChar LyX
1113 \begin_layout Itemize
1114 Declare the usage of packages.
1116 \begin_inset Newline newline
1120 packages provide special commands, which are only available within a document
1121 when the package has been declared in the preamble.
1122 In addition to providing special commands, the inclusion of a package can
1123 change the document.
1124 For example, the package
1125 \begin_inset Flex Code
1128 \begin_layout Plain Layout
1134 forces all paragraphs to be indented.
1135 There are other packages for labels, envelopes, margins, etc.
1139 \begin_layout Itemize
1140 Set counters, variables, lengths and widths.
1142 \begin_inset Newline newline
1145 There are several \SpecialChar LaTeX
1146 counters and variables that
1150 be set globally from within the preamble in order to have the desired effect.
1151 (There are variables that you can set and reset inside the document, too.)
1152 Margins are a good example of something that must be set in the preamble.
1153 Another example is the label format for lists.
1154 You can actually set these just about anywhere, but it's best to do it
1155 just once, inside the preamble.
1158 \begin_layout Itemize
1159 Declare user defined commands (with
1160 \begin_inset Flex Code
1163 \begin_layout Plain Layout
1172 \begin_inset Flex Code
1175 \begin_layout Plain Layout
1184 \begin_inset Newline newline
1187 These are abbreviations for \SpecialChar LaTeX
1188 commands which appear very often inside a document.
1189 Although the preamble is a good place to declare such commands, they
1193 be declared anywhere (before they are used for the first time, of course).
1194 This can be useful if there is a lot of raw \SpecialChar LaTeX
1195 code in your document, which
1196 normally should not be the case.
1199 \begin_layout Standard
1201 adds its own set of definitions to the preamble of the
1202 \begin_inset Flex Code
1205 \begin_layout Plain Layout
1212 This makes \SpecialChar LaTeX
1213 files generated by \SpecialChar LyX
1217 \begin_layout Subsection
1218 Changing the Preamble
1221 \begin_layout Standard
1222 The commands which \SpecialChar LyX
1223 adds to the preamble of a \SpecialChar LaTeX
1224 file are fixed; you can't
1225 change them without patching \SpecialChar LyX
1227 You can, however, add your own stuff to the preamble by selecting
1228 \begin_inset Flex Noun
1231 \begin_layout Plain Layout
1234 \begin_inset space ~
1243 \begin_inset Flex Noun
1246 \begin_layout Plain Layout
1247 Document\SpecialChar menuseparator
1255 adds anything in the
1256 \begin_inset Flex Noun
1259 \begin_layout Plain Layout
1265 dialog to its own built-in preamble.
1266 Before adding your own declarations in the preamble, you should make sure
1267 that \SpecialChar LyX
1268 doesn't already support what you want to do.
1269 (Remember what we said about reinventing the wheel?) Also,
1271 make sure your preamble code is correct
1275 doesn't check it for you.
1276 If there is an error, you're likely to get an error like
1277 \begin_inset Quotes eld
1281 \begin_inset Flex Code
1284 \begin_layout Plain Layout
1293 \begin_inset Quotes erd
1297 If you see this error, check your preamble.
1300 \begin_layout Subsection
1304 \begin_layout Standard
1305 Here are some examples of what you can add to a preamble, and what they
1309 \begin_layout Subsubsection
1313 \begin_layout Standard
1314 There are two variables under \SpecialChar LaTeX
1315 that control page position:
1316 \begin_inset Flex Code
1319 \begin_layout Plain Layout
1328 \begin_inset Flex Code
1331 \begin_layout Plain Layout
1340 Their names should be self-explanatory.
1341 These variables are useful if you think for a moment about computer labels.
1342 Sometimes, the size of a print medium and the area of the medium that you
1343 can actually print on aren't the same.
1345 \begin_inset Flex Code
1348 \begin_layout Plain Layout
1357 \begin_inset Flex Code
1360 \begin_layout Plain Layout
1371 \begin_layout Standard
1372 The default values for
1373 \begin_inset Flex Code
1376 \begin_layout Plain Layout
1385 \begin_inset Flex Code
1388 \begin_layout Plain Layout
1397 \begin_inset space \thinspace{}
1401 \begin_inset space \thinspace{}
1405 \begin_inset space \space{}
1408 the page isn't shifted.
1409 Unfortunately, some DVI drivers always seem to shift the page.
1410 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1411 If you're using \SpecialChar LyX
1412 on a system that you don't personally maintain, and your
1413 sysadmin is a doofus,
1414 \begin_inset Flex Code
1417 \begin_layout Plain Layout
1426 \begin_inset Flex Code
1429 \begin_layout Plain Layout
1438 Suppose your left and top margins are always 0.5
1439 \begin_inset space \thinspace{}
1443 You can add this to the preamble:
1446 \begin_layout LyX-Code
1454 \begin_layout LyX-Code
1462 \begin_layout Standard
1463 and your margins should now be correct.
1466 \begin_layout Subsubsection
1470 \begin_layout Standard
1471 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1472 There's a rather nice package, available at your nearest CTAN archive,
1473 for printing sheets of labels:
1474 \begin_inset Flex Code
1477 \begin_layout Plain Layout
1484 Now, your system may not have this package installed by default.
1485 We leave that up to you to check.
1486 You'll also want to read the documentation for it; we're not going to do
1488 Since this is an example, however, we'll give you an example of how you
1492 \begin_layout Standard
1493 First, make sure you're using the
1494 \begin_inset Flex Code
1497 \begin_layout Plain Layout
1504 Next, you need to put the following in your preamble:
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 LyX-Code
1549 \begin_layout Standard
1550 This sets things up for Avery label sheets, stock #5360.
1551 You're now ready to print labels, but you'll need to insert \SpecialChar LaTeX
1554 \begin_inset Flex Code
1557 \begin_layout Plain Layout
1566 \begin_inset Flex Code
1569 \begin_layout Plain Layout
1577 around each label text.
1578 This and other special features of
1579 \begin_inset Flex Code
1582 \begin_layout Plain Layout
1588 are explained in its documentation.
1591 \begin_layout Standard
1592 Someday, someone may write a \SpecialChar LyX
1593 layout file to support this package directly.
1594 Maybe that someone is you.
1597 \begin_layout Subsubsection
1598 Example #3: Paragraph Indentation
1601 \begin_layout Standard
1602 Americans are trained to indent the first line of
1607 As with all of their other weird quirks, most Americans will whine and
1608 moan until they can have their way and indent the first line of all paragraphs.
1617 \begin_layout Standard
1618 Of course, this behavior isn't standard typography.
1619 In books, you typically only indent the first line of a paragraph
1623 it follows another one.
1624 The idea behind indenting the first line of a paragraph is to distinguish
1625 neighboring paragraphs from one another.
1626 If there is no previous paragraph—for example, if it follows a figure or
1627 is the first paragraph in a section—then there is no need for indentation.
1631 \begin_layout Standard
1632 If you're a typical American (we're still joking!), though, you don't care
1633 about such esoteric things; you want your indentation! Add this to the
1637 \begin_layout LyX-Code
1640 usepackage{indentfirst}
1643 \begin_layout Standard
1644 If your \SpecialChar TeX
1645 distribution isn't braindead, you'll have this package, and all
1646 of your paragraphs will get the indentation the Founding Fathers intended
1650 \begin_layout Subsubsection
1651 Example #4: This Document
1654 \begin_layout Standard
1655 You can also check out the preamble of this document to get an idea of some
1656 of the advanced things you can do.
1659 \begin_layout Section
1661 and \SpecialChar LaTeX
1665 \begin_layout Standard
1666 When \SpecialChar LyX
1667 calls \SpecialChar LaTeX
1668 , it tells \SpecialChar LaTeX
1669 to blithely ignore any errors and keep going.
1670 It then uses the logfile from the \SpecialChar LaTeX
1671 run to do a post-mortem.
1672 After analyzing the logfile, \SpecialChar LyX
1673 displays a dialog listing the errors.
1674 Clicking on any one of them will take you to the position in your \SpecialChar LyX
1676 where the error occurred.
1680 \begin_layout Plain Layout
1682 Analyzing the logfile is a tough job, and \SpecialChar LyX
1683 doesn't always go to the right
1685 There are also cases where \SpecialChar LaTeX
1686 reports the error on one line, but the actual
1688 This is not unlike forgetting a closing brace in a program: You'll get
1689 an error, but only later.
1697 \begin_layout Standard
1698 Some folks also like to look at the log file directly: It is available from
1700 \begin_inset Flex Noun
1703 \begin_layout Plain Layout
1704 Document\SpecialChar menuseparator
1706 \begin_inset space ~
1715 There are some fairly common error messages and warnings.
1716 We'll cover those here.
1717 You should look at a good \SpecialChar LaTeX
1718 book for a complete listing.
1721 \begin_layout Itemize
1722 \begin_inset Flex Code
1725 \begin_layout Plain Layout
1732 \begin_inset Newline newline
1735 Anything beginning with these words is a warning message for the purpose
1737 \begin_inset Quotes eld
1741 \begin_inset Quotes erd
1744 the \SpecialChar LaTeX
1746 You'll get messages like this if you added or changed cross-references
1747 or bibliography entries, in which case, \SpecialChar LaTeX
1748 is trying to tell you that you
1749 need to make another run.
1750 You can by-and-large ignore these.
1753 \begin_layout Itemize
1754 \begin_inset Flex Code
1757 \begin_layout Plain Layout
1764 \begin_inset Newline newline
1767 Another warning message, this time about fonts which \SpecialChar LaTeX
1769 The rest of the message will often say something about a replacement font
1770 that \SpecialChar LaTeX
1772 You can safely ignore these, too.
1775 \begin_layout Itemize
1776 \begin_inset Flex Code
1779 \begin_layout Plain Layout
1788 \begin_inset Newline newline
1798 \change_inserted -712698321 1501222056
1799 It seems to generate at least one of these messages for just about any document
1803 They are warnings about lines that were too long and run past the right
1806 \change_inserted -712698321 1501222913
1807 This happens if \SpecialChar LaTeX
1808 does not find a reasonable way to break the lines (notoriously
1809 often with typewriter font, since this does not allow for automatic break
1814 \change_deleted -712698321 1501221633
1816 \change_inserted -712698321 1501221635
1819 , this is unnoticeable in the final output.
1820 (It can be just a point or two.)
1821 \change_deleted -712698321 1501221644
1822 Or, only one or two characters extend past the margin
1823 \change_inserted -712698321 1501222092
1824 Sometimes, however, the lines run rather visibly into the margin; something
1825 you will not want to have in your final print
1829 \change_deleted -712698321 1501222038
1831 seems to generate at least one of these messages for just about any document
1835 \begin_inset Newline newline
1839 \change_deleted -712698321 1501222960
1840 You can ignore these messages.
1841 Your eyes will tell you if there's a problem with something that's too
1842 wide; just look at the output.
1846 \begin_layout Plain Layout
1847 You can also enable the `draft' option in
1848 \begin_inset Flex Noun
1851 \begin_layout Plain Layout
1852 Document\SpecialChar menuseparator
1858 , and then \SpecialChar LaTeX
1859 will draw a black box in the margin of lines that are overfull.
1865 \change_inserted -712698321 1501223436
1866 There are several global ways to try to minimize the overfull lines.
1869 Enable micro-typographic extensions
1873 Document\SpecialChar menuseparator
1874 Settings\SpecialChar menuseparator
1877 might already improve things a lot.
1878 Furthermore, \SpecialChar LaTeX
1879 code such as the following in
1881 Document\SpecialChar menuseparator
1882 Settings\SpecialChar menuseparator
1885 usually reduces the overfull lines drastically (we use this in the preamble
1890 \begin_layout LyX-Code
1892 \change_inserted -712698321 1501223447
1896 \begin_inset Newline newline
1902 \begin_inset Newline newline
1907 emergencystretch 1.5em
1908 \begin_inset Newline newline
1916 \begin_layout Standard
1918 \change_inserted -712698321 1501223436
1919 In some cases, however, you eventually have to rewrite the text to get the
1920 line breaking right.
1924 \begin_layout Plain Layout
1926 \change_inserted -712698321 1501223436
1927 For more information, see
1928 \begin_inset Flex URL
1931 \begin_layout Plain Layout
1933 \change_inserted -712698321 1501223436
1935 http://www.tex.ac.uk/FAQ-overfull.html
1948 \begin_layout Standard
1950 \change_inserted -712698321 1501223436
1951 In any case, you should check the respective lines, at least for the final
1952 version of your document.
1953 Your eyes will tell you if there's a problem with something that's too
1958 \begin_layout Plain Layout
1960 \change_inserted -712698321 1501223436
1961 You can also enable the `draft' option in
1962 \begin_inset Flex Noun
1965 \begin_layout Plain Layout
1967 \change_inserted -712698321 1501223436
1968 Document\SpecialChar menuseparator
1974 , and then \SpecialChar LaTeX
1975 will draw a black box in the margin of lines that are overfull.
1984 \begin_layout Itemize
1985 \begin_inset Flex Code
1988 \begin_layout Plain Layout
1997 \begin_inset Newline newline
2000 Not quite as common as its cousin.
2002 \change_inserted -712698321 1501223875
2003 This happens again if
2007 \change_inserted -712698321 1501223913
2008 does not find a reasonable break point and consequently generates too loose
2011 \change_deleted -712698321 1501223919
2012 seems to like to print lines that are a bit too wide as opposed to ones
2013 that are a bit too narrow.
2014 We have no idea why.
2015 \change_inserted -712698321 1501223940
2016 As with the overfull lines, you should check if this is a visible problem.
2021 \begin_layout Itemize
2022 \begin_inset Flex Code
2025 \begin_layout Plain Layout
2034 \begin_inset Flex Code
2037 \begin_layout Plain Layout
2046 \begin_inset Newline newline
2049 Warnings about troubles breaking the page.
2050 Once again, just look at the output.
2051 Your eyes will tell you where something has gone wrong.
2054 \begin_layout Itemize
2055 \begin_inset Flex Code
2058 \begin_layout Plain Layout
2060 \begin_inset Quotes els
2064 \begin_inset Quotes ers
2073 \begin_inset Newline newline
2077 \begin_inset Quotes eld
2081 \begin_inset Quotes erd
2084 isn't installed on this system.
2085 This usually appears because some package your document needs isn't installed.
2086 If you didn't touch the preamble or didn't use the
2087 \begin_inset Flex Code
2090 \begin_layout Plain Layout
2098 command, then one of the packages \SpecialChar LyX
2099 tried to load is missing.
2101 \begin_inset Flex Noun
2104 \begin_layout Plain Layout
2105 Help\SpecialChar menuseparator
2112 to get a list of packages that \SpecialChar LyX
2114 This file is updated whenever you reconfigure \SpecialChar LyX
2116 \begin_inset Flex Noun
2119 \begin_layout Plain Layout
2120 Tools\SpecialChar menuseparator
2126 ) and tells you which packages have been detected and what they do.
2127 \begin_inset Newline newline
2131 \begin_inset Flex Code
2134 \begin_layout Plain Layout
2142 command and the package in question isn't installed, then you'll need to
2143 install it yourself.
2146 \begin_layout Itemize
2147 \begin_inset Flex Code
2150 \begin_layout Plain Layout
2151 LaTeX Error: Unknown option
2157 \begin_inset Newline newline
2160 Error messages beginning with this are trying to tell you that you specified
2161 a bad or undefined option to a package.
2162 Check the package's documentation.
2165 \begin_layout Itemize
2166 \begin_inset Flex Code
2169 \begin_layout Plain Layout
2170 Undefined control sequence
2176 \begin_inset Newline newline
2179 If you've inserted \SpecialChar LaTeX
2180 code into your document, but made a typo, you'll get
2182 You may have forgotten to load a package.
2183 In any case, this error message usually means that you used an undefined
2188 \begin_layout Standard
2189 There are other error and warning messages.
2190 Some are self-explanatory.
2191 These are usually \SpecialChar LaTeX
2193 Others are downright cryptic.
2194 These are usually \SpecialChar TeX
2195 error messages, and we really have
2199 what they mean or how to decipher them.
2203 \begin_layout Standard
2204 There's a general sequence you should follow if you get error messages:
2207 \begin_layout Enumerate
2208 Look at the \SpecialChar LaTeX
2209 code you inserted for typos.
2212 \begin_layout Enumerate
2213 If there are no typos, check that you used the command(s) correctly.
2216 \begin_layout Enumerate
2217 If you get a bunch of error boxes piled up at the very top of the document—and
2218 especially if you see a
2219 \begin_inset Quotes eld
2223 \begin_inset Flex Code
2226 \begin_layout Plain Layout
2235 \begin_inset Quotes erd
2238 error—it means that there are errors in the preamble.
2239 Start debugging your preamble.
2242 \begin_layout Enumerate
2243 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2245 document, the first suspect is your \SpecialChar LaTeX
2246 distribution itself.
2247 Check for missing packages and install them.
2250 \begin_layout Enumerate
2251 Okay, so there are no missing packages.
2252 Did you use any of the fine-tuning options in \SpecialChar LyX
2253 ? Specifically, did you
2257 any of them, like trying to manually insert lots of
2258 \begin_inset Flex Code
2261 \begin_layout Plain Layout
2263 \begin_inset space ~
2272 \begin_inset Flex Code
2275 \begin_layout Plain Layout
2282 \begin_inset Flex Code
2285 \begin_layout Plain Layout
2291 ? Did you try to kludge something together with these instead of using the
2292 appropriate paragraph environment?
2295 \begin_layout Enumerate
2296 All right, you didn't use any of the fine-tuning options, you played by
2298 Did you try to pull a fancy maneuver? Did you do something funky inside
2299 a table or an equation, like inserting a graphic into a table cell?
2302 \begin_layout Enumerate
2303 Do you have long sections of text where \SpecialChar LaTeX
2304 cannot find a place to break a
2305 line? By default, \SpecialChar LaTeX
2306 is rather strict about how much extra inter-word spacing
2307 it will add in order to break a line.
2308 Preferably, you should rework the paragraph to avoid the problem.
2311 \begin_layout Enumerate
2312 Did you go overboard with the nesting? \SpecialChar LyX
2313 (currently) doesn't check to make
2314 sure you're in the limits for nesting environments.
2315 If you nested a bunch of environments to the
2316 \begin_inset Formula $17^{\mathrm{th}}$
2319 level, that's the problem.
2320 (The limit in \SpecialChar LaTeX
2324 \begin_layout Enumerate
2325 Okay, you didn't get any error messages, but your output looks awful.
2326 If you have a table or figure that's too wide or long for the page, you
2331 \begin_layout Enumerate
2332 rescale the figure so it fits.
2335 \begin_layout Enumerate
2336 trim down the table so it fits.
2340 \begin_layout Enumerate
2341 If something else is wrong with the output, and you didn't try to pull anything
2342 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2345 \begin_layout Standard
2346 If all this doesn't help—well, then
2350 you might have found a bug in \SpecialChar LyX
2355 \begin_layout Chapter
2359 \begin_layout Section
2360 Customizing Bibliographies with Bib\SpecialChar TeX
2364 \begin_layout Standard
2365 The most basic information about how to use Bib\SpecialChar TeX
2370 with \SpecialChar LyX
2371 is contained in the section
2373 Bibliography databases
2380 The following subsections explain special bibliography features supported
2385 \begin_layout Subsection
2386 Alternative Citation Styles
2389 \begin_layout Standard
2390 Standard Bib\SpecialChar TeX
2392 \begin_inset space \thinspace{}
2396 \begin_inset space \space{}
2400 \begin_inset Quotes eld
2404 \begin_inset Quotes erd
2407 ) to refer to a cited work.
2408 However, in many scientific disciplines, other citation styles are in use.
2409 The most common one is the author-year style (e.
2410 \begin_inset space \thinspace{}
2414 \begin_inset space \space{}
2418 \begin_inset Quotes eld
2422 \begin_inset Quotes erd
2427 supports three packages that provide this style,
2428 \begin_inset Flex Code
2431 \begin_layout Plain Layout
2438 \begin_inset Flex Code
2441 \begin_layout Plain Layout
2448 \begin_inset Flex Code
2451 \begin_layout Plain Layout
2458 Each of these packages has their pros and cons, which cannot be listed
2460 If you only want to have simple author-year (or author-numerical) style,
2461 or if you want to use one of the countless style files for
2462 \begin_inset Flex Code
2465 \begin_layout Plain Layout
2471 , then the established
2472 \begin_inset Flex Code
2475 \begin_layout Plain Layout
2481 package is probably your choice.
2482 If you look for specific citation styles common in law studies, you might
2484 \begin_inset Flex Code
2487 \begin_layout Plain Layout
2494 If you want to have full control over the formatting or look for advanced
2495 features such as ibidem, footnote citations, full title citations, advanced
2496 date formats (such as 400 BC) or full localization to other languages than
2497 English, you should definitely consider
2498 \begin_inset Flex Code
2501 \begin_layout Plain Layout
2507 , which exceeds all other packages in terms of features, but is also quite
2508 heavy and more resource-hungry.
2511 \begin_layout Standard
2512 The handling of these packages in \SpecialChar LyX
2513 is basically the same.
2515 \begin_inset Flex Noun
2518 \begin_layout Plain Layout
2519 Document\SpecialChar menuseparator
2526 \begin_inset Flex Noun
2529 \begin_layout Plain Layout
2536 \begin_inset Flex Noun
2539 \begin_layout Plain Layout
2546 \begin_inset Flex Noun
2549 \begin_layout Plain Layout
2556 \begin_inset Flex Noun
2559 \begin_layout Plain Layout
2560 Biblatex (Natbib mode)
2566 \begin_inset Flex Noun
2569 \begin_layout Plain Layout
2576 \begin_inset Flex Noun
2579 \begin_layout Plain Layout
2586 \begin_inset space ~
2589 6.5.3 in the User's Guide for more information on these choices).
2590 With all these packages, you will get some extra features in the citation
2591 dialog and you can select the style of the reference (
2592 \begin_inset Quotes eld
2596 \begin_inset Quotes erd
2600 \begin_inset Quotes eld
2604 \begin_inset Quotes erd
2608 \begin_inset Quotes eld
2612 \begin_inset Quotes erd
2616 \begin_inset Quotes eld
2620 \begin_inset Quotes erd
2624 Note that either package needs specifically designed style files.
2625 They all ship their own, but there are lots of additional style files,
2626 and there is even an interactive style file builder
2630 \begin_layout Plain Layout
2632 \begin_inset Flex URL
2635 \begin_layout Plain Layout
2637 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2648 \begin_inset Flex Code
2651 \begin_layout Plain Layout
2660 \begin_layout Subsection
2661 Subdivided Bibliographies
2664 \begin_layout Standard
2665 Sometimes you might need to divide your bibliography into several sections.
2666 If you are for instance a historian, the possibility to separate sources
2667 and scientific works is most likely a
2668 \begin_inset Quotes eld
2672 \begin_inset Quotes erd
2676 Unfortunately, Bib\SpecialChar TeX
2677 itself does not allow you to do this.
2678 But with the help of some \SpecialChar LaTeX
2679 packages, Bib\SpecialChar TeX
2680 can be extended to fit your needs.
2683 \begin_layout Standard
2685 provides native support for one of these packages,
2693 \begin_layout Plain Layout
2695 \begin_inset Flex URL
2698 \begin_layout Plain Layout
2700 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2710 The advantage of this package (compared to other packages such as
2714 ) is that you don't need to define new citation commands.
2715 Instead, you need to prepare different bibliographic databases which include
2716 the entries for the different sections of the bibliography.
2717 For example: If you want to divide your bibliography into the sections
2719 \begin_inset Quotes eld
2723 \begin_inset Quotes erd
2727 \begin_inset Quotes eld
2731 \begin_inset Quotes erd
2734 , you first need to create two bibliographic databases, e.
2735 \begin_inset space \thinspace{}
2739 \begin_inset space \space{}
2743 \begin_inset Flex Code
2746 \begin_layout Plain Layout
2753 \begin_inset Flex Code
2756 \begin_layout Plain Layout
2766 \begin_layout Standard
2768 \begin_inset Flex Noun
2771 \begin_layout Plain Layout
2772 Document\SpecialChar menuseparator
2779 \begin_inset Flex Noun
2782 \begin_layout Plain Layout
2789 \begin_inset Flex Noun
2792 \begin_layout Plain Layout
2793 Subdivided bibliography
2799 Now you can insert multiple Bib\SpecialChar TeX
2800 bibliographies, one for each section of
2802 Returning to our example: Insert the Bib\SpecialChar TeX
2804 \begin_inset Flex Code
2807 \begin_layout Plain Layout
2813 and a second one for the database
2814 \begin_inset Flex Code
2817 \begin_layout Plain Layout
2824 You are free to use the same or different styles for each section.
2825 Additionally, you can choose if the bibliography section should contain
2827 \begin_inset Quotes eld
2830 all cited references
2831 \begin_inset Quotes erd
2834 of the specified database(s) (which is the default),
2835 \begin_inset Quotes eld
2838 all uncited references
2839 \begin_inset Quotes erd
2843 \begin_inset Quotes eld
2847 \begin_inset Quotes erd
2851 This might be useful if you would like to separate your bibliography into
2853 \begin_inset Quotes eld
2857 \begin_inset Quotes erd
2861 \begin_inset Quotes eld
2865 \begin_inset Quotes erd
2869 \begin_inset Quotes eld
2873 \begin_inset Quotes erd
2877 The titles for the sections can be added as ordinary sections or subsections.
2879 \begin_inset Flex Code
2882 \begin_layout Plain Layout
2888 removes the bibliography title, you have to manually re-add that, too (as
2889 a chapter* or section*, for instance).
2892 \begin_layout Standard
2897 , the procedure is a bit different.
2906 , the aforementioned
2907 \begin_inset Flex Noun
2910 \begin_layout Plain Layout
2911 Subdivided bibliography
2916 option is disabled if you use
2925 provides its own means to generate subdivided bibliographies.
2926 You can either add keywords to bibliography entries via the
2927 \begin_inset Flex Code
2930 \begin_layout Plain Layout
2936 entry option and then filter bibliography sections by keyword (by adding
2938 \begin_inset Flex Code
2941 \begin_layout Plain Layout
2948 \begin_inset Flex Noun
2951 \begin_layout Plain Layout
2957 field of the dialog that opens if you right-click on the
2958 \begin_inset Flex Noun
2961 \begin_layout Plain Layout
2962 Biblatex Generated Bibliography
2967 button), or you can filter by entry types (such as
2976 \begin_inset space \thinspace{}
2981 \begin_inset Flex Code
2984 \begin_layout Plain Layout
2991 \begin_inset Flex Code
2994 \begin_layout Plain Layout
3001 \begin_inset Flex Noun
3004 \begin_layout Plain Layout
3010 field, or you can create so-called
3011 \begin_inset Quotes eld
3014 Bibliography Categories
3015 \begin_inset Quotes erd
3018 to which you can assign individual entries.
3019 Please refer to the Biblatex manual, section
3021 Subdivided Bibliographies
3026 \begin_layout Subsection
3027 Multiple Bibliographies
3028 \change_inserted -712698321 1501227893
3030 \begin_inset CommandInset label
3032 name "subsec:Multiple-Bibliographies"
3041 \begin_layout Standard
3042 Multiple bibliographies, e.
3043 \begin_inset space \thinspace{}
3047 \begin_inset space \space{}
3050 a bibliography for each part, chapter, section, subsection or child (sub-documen
3051 t) of the document, are also supported by \SpecialChar LyX
3053 In order to enable it, go to
3054 \begin_inset Flex Noun
3057 \begin_layout Plain Layout
3058 Document\SpecialChar menuseparator
3059 Settings\SpecialChar menuseparator
3065 and select the relevant unit (e.
3066 \begin_inset space \thinspace{}
3070 \begin_inset Quotes eld
3074 \begin_inset Quotes erd
3078 \begin_inset Flex Noun
3081 \begin_layout Plain Layout
3082 Multiple Bibliographies
3088 Then add a Bib(la)\SpecialChar TeX
3089 bibliography to each unit (e.
3090 \begin_inset space \thinspace{}
3093 g., section) of your document.
3094 In the output, a separate bibliography, containing only the references
3095 done in the current unit is generated.
3098 \begin_layout Standard
3099 If you use Bib\SpecialChar TeX
3101 \begin_inset Flex Code
3104 \begin_layout Plain Layout
3111 \change_deleted -712698321 1501067466
3113 \change_inserted -712698321 1501067466
3117 \begin_inset Flex Code
3120 \begin_layout Plain Layout
3126 package is used to create multiple bibliographies.
3127 The former package is used if you select
3128 \begin_inset Quotes eld
3132 \begin_inset Quotes erd
3140 \begin_inset Flex Noun
3143 \begin_layout Plain Layout
3144 Sectioned Bibliography
3151 \begin_inset Flex Code
3154 \begin_layout Plain Layout
3164 \begin_layout Plain Layout
3165 An alternative approach, if you are willing to use some
3166 \begin_inset Flex Noun
3169 \begin_layout Plain Layout
3177 \begin_inset space ~
3181 \begin_inset CommandInset ref
3183 reference "sec:Inserting-TeX-Code"
3188 \begin_inset Flex Code
3191 \begin_layout Plain Layout
3203 \begin_inset Flex Code
3206 \begin_layout Plain Layout
3212 is used, \SpecialChar LyX
3213 encloses the specified units in
3214 \begin_inset Flex Code
3217 \begin_layout Plain Layout
3224 \begin_inset Flex Code
3227 \begin_layout Plain Layout
3236 \begin_inset Flex Code
3239 \begin_layout Plain Layout
3247 in order to create the units.
3248 Note that this approach has some limitations.
3249 First, every citation reference has to be inside some
3250 \begin_inset Flex Code
3253 \begin_layout Plain Layout
3260 So citations outside a defined unit (e.
3261 \begin_inset space \thinspace{}
3264 g., before the first section if you use
3265 \begin_inset Quotes eld
3269 \begin_inset Quotes erd
3273 \begin_inset Quotes eld
3277 \begin_inset Quotes erd
3281 You can also create your own units by entering
3282 \begin_inset Flex Code
3285 \begin_layout Plain Layout
3294 \begin_inset Flex Code
3297 \begin_layout Plain Layout
3306 code (for instance to work around the mentioned limitation).
3308 \begin_inset Flex Code
3311 \begin_layout Plain Layout
3318 A second limitation is that
3319 \begin_inset Flex Code
3322 \begin_layout Plain Layout
3328 always processes all references of a bibliography database, even if they
3330 This can result in odd labels (e.
3331 \begin_inset space \thinspace{}
3336 \begin_inset Quotes eld
3340 \begin_inset Quotes erd
3343 if two works of this author from 2014 are in the database, even if only
3347 \begin_layout Standard
3353 \begin_inset Flex Code
3356 \begin_layout Plain Layout
3362 option is used instead.
3363 If you need specific units, you can start them with the \SpecialChar TeX
3365 \begin_inset Flex Code
3368 \begin_layout Plain Layout
3377 \begin_inset Flex Code
3380 \begin_layout Plain Layout
3389 If you also want to control the end of the unit, use the environment
3390 \begin_inset Flex Code
3393 \begin_layout Plain Layout
3403 \begin_inset Flex Code
3406 \begin_layout Plain Layout
3416 \begin_inset Flex Code
3419 \begin_layout Plain Layout
3426 In addition to the individual bibliography of the current unit,
3430 also provides an easy way to output all bibliographies, subsequently, at
3432 \begin_inset space \thinspace{}
3435 g., at the end of the document).
3437 \begin_inset Quotes eld
3441 \begin_inset Quotes erd
3444 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve
3450 manual for more information on this topic.
3453 \begin_layout Section
3457 \begin_layout Subsection
3461 \begin_layout Standard
3462 When you are working on a large file with many sections, it is often convenient
3463 to break up the document into several files, or perhaps you have something
3464 where a table may change from time to time, but the preceding text does
3466 In these cases, you should seriously consider using multipart documents.
3467 For example, scientific papers often have five major sections: the introduction
3468 , observations, results, discussion, and conclusion.
3469 Each of these could be its own separate \SpecialChar LyX
3471 \begin_inset Quotes eld
3475 \begin_inset Quotes erd
3478 file which contains the title, authors, abstract, references, etc., plus
3479 the five included files.
3480 It is important to note that each of these files is a full \SpecialChar LyX
3482 can be formatted and printed on its own, as well as included in a master
3484 Each of these files must have the same document class, however—don't attempt
3485 to mix book classes with article classes.
3486 You may also include \SpecialChar LaTeX
3487 files; however, these files must not have their own
3489 \begin_inset space \thinspace{}
3493 \begin_inset space \space{}
3496 everything up to and including the
3497 \begin_inset Flex Code
3500 \begin_layout Plain Layout
3509 \begin_inset Flex Code
3512 \begin_layout Plain Layout
3520 line must be deleted) or else errors will be generated when you try to
3524 \begin_layout Standard
3526 allows you to include files quite easily with
3527 \begin_inset Flex Noun
3530 \begin_layout Plain Layout
3531 Insert\SpecialChar menuseparator
3533 \change_deleted -712698321 1501147443
3535 \change_inserted -712698321 1501147443
3539 \begin_inset space ~
3548 When you click on this selection a small box is inserted into the file
3549 at the current cursor location.
3550 Clicking on the box raises a dialog which allows you to select the file
3551 to be included, and the method of its inclusion.
3555 \begin_layout Standard
3556 The file selection box should by now be obvious.
3557 The three inclusion methods are
3558 \begin_inset Quotes eld
3562 \begin_inset Quotes erd
3566 \begin_inset Quotes eld
3570 \begin_inset Quotes erd
3574 \begin_inset Quotes eld
3578 \begin_inset Quotes erd
3583 \change_deleted -712698321 1501225702
3585 \change_inserted -712698321 1501225703
3589 \begin_inset Quotes eld
3593 \begin_inset Quotes erd
3597 \begin_inset Quotes eld
3601 \begin_inset Quotes erd
3605 \change_deleted -712698321 1501225710
3606 is really only meaningful to \SpecialChar LaTeX
3608 \change_inserted -712698321 1501225747
3609 are similar in many ways, but there are also some notable differences:
3612 \begin_layout Enumerate
3614 \change_deleted -712698321 1501225754
3615 , but the practical difference is that f
3616 \change_inserted -712698321 1501225754
3620 \begin_inset Quotes eld
3624 \begin_inset Quotes erd
3627 are typeset beginning on a new page, while files that are
3628 \begin_inset Quotes eld
3632 \begin_inset Quotes erd
3635 are typeset starting on the current page.
3636 \change_inserted -712698321 1501225760
3640 \begin_layout Enumerate
3642 \change_inserted -712698321 1501225830
3643 \begin_inset Quotes eld
3647 \begin_inset Quotes erd
3650 files cannot themselves
3651 \begin_inset Quotes eld
3655 \begin_inset Quotes erd
3659 \begin_inset Quotes eld
3663 \begin_inset Quotes erd
3668 \begin_inset Quotes eld
3672 \begin_inset Quotes erd
3675 , on the other hand, infinite sub-inputting is possible.
3678 \begin_layout Enumerate
3680 \change_inserted -712698321 1501226017
3681 \begin_inset Quotes eld
3685 \begin_inset Quotes erd
3688 allow for the output of only selected
3689 \begin_inset Quotes eld
3693 \begin_inset Quotes erd
3696 files, while maintaining the actual counters (pagination etc.) and references
3697 (please refer to the section
3700 \begin_inset space ~
3708 \begin_inset space ~
3713 manual for details).
3718 \begin_layout Standard
3720 \change_inserted -712698321 1501225947
3722 \begin_inset Quotes eld
3726 \begin_inset Quotes erd
3729 is the preferred method for chapters that are outsourced to child documents,
3731 \begin_inset Quotes eld
3735 \begin_inset Quotes erd
3738 is more suitable for arbitrary file inheritance.
3741 \begin_layout Standard
3743 \change_deleted -712698321 1501226562
3744 Generally, the master file is converted into a full \SpecialChar LaTeX
3745 file before typesetting,
3746 while the included files are converted to \SpecialChar LaTeX
3747 files that do not have all the
3748 preamble information.
3753 \begin_layout Standard
3755 \begin_inset Quotes eld
3759 \begin_inset Quotes erd
3762 included file allows you to include a file typeset exactly as it appears
3764 \begin_inset space \thinspace{}
3768 \begin_inset space \space{}
3772 \begin_inset Flex Code
3775 \begin_layout Plain Layout
3781 mode, with the characters set in a fixed-width typewriter font.
3782 Normally, spaces in this file are invisible, though two consecutive spaces
3783 are conserved, unlike \SpecialChar LyX
3784 's normal treatment of spaces.
3785 However, setting the
3786 \begin_inset Flex Noun
3789 \begin_layout Plain Layout
3791 \begin_inset space ~
3795 \begin_inset space ~
3799 \begin_inset space ~
3807 checkbox typesets a mark to unambiguously define the presence of a space.
3809 \change_inserted -712698321 1501226563
3813 \begin_layout Standard
3815 \change_inserted -712698321 1501226564
3816 Generally, the master file is converted into a full \SpecialChar LaTeX
3817 file before typesetting,
3818 while the included files are converted to \SpecialChar LaTeX
3819 files that do not have all the
3820 preamble information.
3825 \begin_layout Subsection
3826 Cross-References Between Files
3829 \begin_layout Standard
3830 \begin_inset Box Shadowbox
3840 height_special "totalheight"
3845 backgroundcolor "none"
3848 \begin_layout Plain Layout
3849 This section is somewhat out of date.
3850 Need to describe default master documents and how children are opened when
3860 \begin_layout Standard
3861 It is possible to set up cross-references between the different files.
3862 First, open all the files in question: let's call them A and B in a two
3863 file example, where B is included in A.
3864 Let's say you insert a label in A, then want to reference it in B.
3865 Open the cross-reference dialog whilst in document B, and you can select
3867 \begin_inset Quotes eld
3871 \begin_inset Quotes erd
3877 \begin_layout Subsection
3878 Bibliography Lists in all Subdocuments
3881 \begin_layout Standard
3883 \change_deleted -712698321 1501227275
3884 \begin_inset Box Frameless
3894 height_special "totalheight"
3899 backgroundcolor "none"
3902 \begin_layout Plain Layout
3903 This section also needs updating.
3904 There is now material about this on the wiki, and it could be copied here.
3914 \begin_layout Standard
3916 \change_inserted -712698321 1501226979
3917 If you work with child documents, you might want to have only one main bibliogra
3918 phy at the end, but still be able to have a selected bibliography for the
3919 child if you output it on its own.
3920 Here is how to achieve this.
3923 \begin_layout Standard
3925 \change_inserted -712698321 1501227105
3926 For the main document, you just insert a bibliography inset at the place
3927 where the main bibliography has to appear (within the master file or within
3929 If the bibliography inset is in the master file, the references will be
3930 inherited by all children, so they are available in the citation dialog
3934 \begin_layout Standard
3936 \change_inserted -712698321 1501227910
3937 For child-specific bibliographies, insert bibliography insets within the
3938 child documents, at the place where the bibliography should appear when
3939 the child is compiled separately.
3940 However, the trick is to insert them into a branch (
3942 Insert\SpecialChar menuseparator
3943 Branch\SpecialChar menuseparator
3944 Insert New Branch...
3947 \begin_inset space \thinspace{}
3952 \begin_inset Quotes eld
3956 \begin_inset Quotes erd
3960 Within the children, activate the branch (
3962 Document\SpecialChar menuseparator
3963 Settings...\SpecialChar menuseparator
3967 Within the master, deactivate the branch (
3969 Document\SpecialChar menuseparator
3970 Settings...\SpecialChar menuseparator
3974 Now the child's bibliography will be ignored by the master, but considered
3978 \begin_layout Standard
3980 \change_inserted -712698321 1501228082
3981 If you need multiple bibliographies (e.
3982 \begin_inset space \thinspace{}
3985 g., one per child in the
3989 ), please refer to sec.
3990 \begin_inset space ~
3994 \begin_inset CommandInset ref
3996 reference "subsec:Multiple-Bibliographies"
4005 \begin_layout Standard
4007 \change_deleted -712698321 1501227257
4008 Copy the bibliography list with all entries to all subdocuments and transform
4010 This way \SpecialChar LyX
4012 \begin_inset Flex Code
4015 \begin_layout Plain Layout
4021 -files and you can easily insert references without making the bibliography
4025 \begin_layout Standard
4027 \change_deleted -712698321 1501227257
4028 As the bibliography list is in a comment, \SpecialChar LaTeX
4029 won't use it and the references
4030 will look like this: [?], instead of like this: [1].
4031 One solution is to use the \SpecialChar LaTeX
4033 \begin_inset Flex Code
4036 \begin_layout Plain Layout
4042 that will only include comments by processing the files separately.
4043 To do this, add in the \SpecialChar LaTeX
4044 preamble of every subdocument the following:
4047 \begin_layout LyX-Code
4049 \change_deleted -712698321 1501227257
4055 \begin_layout LyX-Code
4057 \change_deleted -712698321 1501227257
4060 includecomment{comment}
4063 \begin_layout Standard
4065 \change_deleted -712698321 1501227257
4067 \begin_inset Flex URL
4070 \begin_layout Plain Layout
4072 http://wiki.lyx.org/FAQ/Unsorted#toc31
4082 \begin_layout Section
4087 \begin_layout Standard
4088 Users sometimes need to be able to
4089 \begin_inset Quotes eld
4093 \begin_inset Quotes erd
4097 file together with all the images (and other files) on which it depends,
4098 either for sending to a publisher or for sharing with a co-author.
4100 2.0 includes a Python script (
4101 \begin_inset Flex Code
4104 \begin_layout Plain Layout
4110 ) that automates this process.
4111 To use it, you must have either the
4112 \begin_inset Flex Code
4115 \begin_layout Plain Layout
4122 \begin_inset Flex Code
4125 \begin_layout Plain Layout
4131 python modules installed on your system.
4132 By default, the script prefers the
4133 \begin_inset Flex Code
4136 \begin_layout Plain Layout
4143 \begin_inset Flex Code
4146 \begin_layout Plain Layout
4152 format on Unix-like systems and the
4153 \begin_inset Flex Code
4156 \begin_layout Plain Layout
4165 \begin_layout Standard
4167 's configuration process will set the script up to export a `\SpecialChar LyX
4169 and this format will then be available under
4170 \begin_inset Flex Code
4173 \begin_layout Plain Layout
4174 File\SpecialChar menuseparator
4183 \begin_layout Standard
4184 Independently of the platform, the generation of a particular archive format
4185 can be forced by adding either the
4186 \begin_inset Flex Code
4189 \begin_layout Plain Layout
4196 \begin_inset Flex Code
4199 \begin_layout Plain Layout
4206 \begin_inset Flex Code
4209 \begin_layout Plain Layout
4216 \begin_inset Flex Code
4219 \begin_layout Plain Layout
4225 format) switch to the
4226 \begin_inset Flex Code
4229 \begin_layout Plain Layout
4231 \SpecialChar menuseparator
4239 \begin_inset Flex Code
4242 \begin_layout Plain Layout
4243 Tools\SpecialChar menuseparator
4244 Preferences\SpecialChar menuseparator
4245 File Handling\SpecialChar menuseparator
4252 (Make sure you add the switch after the script name, not before it.)
4255 \begin_layout Section
4256 Fancy Headers and Footers
4259 \begin_layout Standard
4260 The default page layout is rather plain; for an
4261 \begin_inset Flex Code
4264 \begin_layout Plain Layout
4270 document class, all you get is a centered page number at the bottom of
4272 This document uses KOMA-script's book class, so it appears to be a bit
4274 But to really put on a show, you need to set the document page style to
4276 \begin_inset Quotes eld
4280 \begin_inset Quotes erd
4283 , as mentioned in the
4288 This section describes the \SpecialChar LaTeX
4289 code you need to insert in your \SpecialChar LaTeX
4291 order to get the desired effects.
4294 \begin_layout Standard
4295 For more information on fancy headers, see the
4296 \begin_inset Flex Code
4299 \begin_layout Plain Layout
4305 package documentation.
4307 \begin_inset Flex URL
4310 \begin_layout Plain Layout
4312 http://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
4320 \begin_layout Standard
4321 The page header is divided into three fields, not surprisingly labeled
4322 \begin_inset Quotes eld
4326 \begin_inset Quotes erd
4330 \begin_inset Quotes eld
4334 \begin_inset Quotes erd
4338 \begin_inset Quotes eld
4342 \begin_inset Quotes erd
4346 The footer is also divided into these three fields.
4347 The \SpecialChar LaTeX
4348 commands to set these fields in the simplest manner are
4349 \begin_inset Flex Code
4352 \begin_layout Plain Layout
4361 \begin_inset Flex Code
4364 \begin_layout Plain Layout
4373 \begin_inset Flex Code
4376 \begin_layout Plain Layout
4385 \begin_inset Flex Code
4388 \begin_layout Plain Layout
4397 Suppose you wish to put your name in the upper left hand corner of each
4399 Simply insert the following command in the preamble:
4402 \begin_layout Standard
4411 \begin_layout Standard
4412 You will now see your name in the upper left.
4413 If a field has a default entry that you would like to get rid of (often
4414 the page number appears in the central footer) simply include a command
4415 with a blank argument, e.
4416 \begin_inset space \thinspace{}
4422 \begin_layout Standard
4430 \begin_layout Standard
4431 Let's get really fancy: lets put the section number with the word
4432 \begin_inset Quotes eld
4436 \begin_inset Quotes erd
4440 \begin_inset space \thinspace{}
4444 \begin_inset space \space{}
4447 Section 3) in the upper left, the page number (e.
4448 \begin_inset space \thinspace{}
4452 \begin_inset space \space{}
4455 Page 4) in the upper right, your name in the lower left, and the date in
4457 The following commands should now appear in the preamble:
4460 \begin_layout Standard
4470 \begin_layout Standard
4478 \begin_layout Standard
4488 \begin_layout Standard
4497 \begin_layout Standard
4505 \begin_layout Standard
4515 \begin_layout Standard
4517 \begin_inset Flex Code
4520 \begin_layout Plain Layout
4529 \begin_inset Flex Code
4532 \begin_layout Plain Layout
4540 access \SpecialChar LaTeX
4541 's section and page counters, and so print out the current section
4544 \begin_inset Flex Code
4547 \begin_layout Plain Layout
4555 simply prints out today's date.
4558 \begin_layout Standard
4559 The thicknesses of the horizontal rules drawn beneath the header and above
4560 the footer can also be modified.
4561 If you don't want one of the rules, set its thickness to 0.
4562 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
4568 \begin_inset Flex Code
4571 \begin_layout Plain Layout
4576 headrulewidth}{0.4pt}
4582 \begin_inset Flex Code
4585 \begin_layout Plain Layout
4590 footrulewidth}{0.4pt}
4595 to set the thicknesses.
4598 \begin_layout Standard
4599 You can switch the header/footer settings on and off for individual pages
4601 \begin_inset Flex Code
4604 \begin_layout Plain Layout
4607 thispagestyle{empty}
4613 \begin_inset Flex Code
4616 \begin_layout Plain Layout
4619 thispagestyle{plain}
4625 \begin_inset Flex Code
4628 \begin_layout Plain Layout
4631 thispagestyle{fancy}
4637 Simply insert them in the text on the page you want changed and mark them
4640 In fact, title pages are marked as plain by default, while following pages
4641 are marked fancy when using the global fancy setting.
4644 \begin_layout Standard
4645 As a final example, it is possible to include an image in the header or
4647 Suppose you want to put a company logo in the upper lefthand corner.
4648 You might try something like
4651 \begin_layout Standard
4660 includegraphics{logo.eps}}}
4663 \begin_layout Standard
4665 (you may need to preface this with
4666 \begin_inset Flex Code
4669 \begin_layout Plain Layout
4673 usepackage{graphics}
4678 if you don't include graphics elsewhere in your document).
4681 \begin_layout Section
4682 Itemize Bullet Selection
4683 \begin_inset CommandInset label
4692 \begin_layout Standard
4698 \begin_layout Subsection
4702 \begin_layout Standard
4704 provides 216 bullet shapes that can be accessed from a simple dialog.
4705 Using this dialog you can easily specify what bullet shape to use at each
4706 level of an itemized list.
4707 These settings are document-wide so you won't be able to specify different
4708 sets of bullets for different paragraphs.
4712 \begin_layout Plain Layout
4713 Well, actually you can but you'll have to do it by hand.
4721 \begin_layout Subsection
4725 \begin_layout Standard
4726 Open the dialog by selecting the
4727 \begin_inset Flex Noun
4730 \begin_layout Plain Layout
4731 Document\SpecialChar menuseparator
4737 menu item and then select the
4738 \begin_inset Flex Noun
4741 \begin_layout Plain Layout
4750 \begin_layout Standard
4751 The dialog provides you with a table of bullet shapes.
4752 A column of buttons on the left of the table provides access to the six
4753 different panels of bullet shapes.
4754 The row of buttons across the top is used to select which bullet depth
4756 A text entry under the table shows the currently selected bullet shape's
4758 equivalent and this can be edited if desired.
4759 If you do modify the text you will also need to specify any needed packages
4760 in the \SpecialChar LaTeX
4764 \begin_layout Standard
4765 The six panels are divided up by the packages they require.
4766 The following table shows the mappings from button name to \SpecialChar LaTeX
4770 \begin_layout Standard
4772 \begin_inset Tabular
4773 <lyxtabular version="3" rows="7" columns="2">
4774 <features tabularvalignment="middle">
4775 <column alignment="center" valignment="top" width="0pt">
4776 <column alignment="center" valignment="top" width="0pt">
4778 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4781 \begin_layout Plain Layout
4796 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4799 \begin_layout Plain Layout
4816 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4819 \begin_layout Plain Layout
4834 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4837 \begin_layout Plain Layout
4846 base \SpecialChar LaTeX
4854 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4857 \begin_layout Plain Layout
4872 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4875 \begin_layout Plain Layout
4892 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4895 \begin_layout Plain Layout
4910 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4913 \begin_layout Plain Layout
4930 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4933 \begin_layout Plain Layout
4948 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4951 \begin_layout Plain Layout
4968 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4971 \begin_layout Plain Layout
4986 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4989 \begin_layout Plain Layout
5006 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
5009 \begin_layout Plain Layout
5024 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
5027 \begin_layout Plain Layout
5050 \begin_layout Standard
5052 doesn't stop you using bullets from packages you don't have.
5053 If you get errors from \SpecialChar LaTeX
5054 when you try to view or print the file, then it
5055 is likely you are missing a package.
5059 \begin_layout Plain Layout
5061 doesn't restrict your use since you may be editing locally and exporting
5070 \begin_layout Subsection
5074 \begin_layout Standard
5075 Select which bullet depth you want to change then select the bullet shape
5077 Any changes will not be visible in \SpecialChar LyX
5078 , but are visible when viewing the document.
5081 \begin_layout Standard
5082 You can reset a bullet shape to the default simply by clicking your right
5083 mouse button on the appropriate bullet depth button.
5087 \begin_layout Plain Layout
5092 want to have multiple sets of paragraphs with different sets of bullets
5093 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
5095 The bullet selection dialog can help though because it provides you with
5096 the \SpecialChar LaTeX
5097 code for a wide range of bullet shapes.
5098 To make your own custom paragraphs you have the following options:
5101 \begin_layout Plain Layout
5105 \begin_layout Plain Layout
5121 \begin_layout Plain Layout
5125 \begin_layout Plain Layout
5147 \begin_layout Itemize
5148 Use the \SpecialChar LaTeX
5150 \begin_inset Flex Code
5153 \begin_layout Plain Layout
5161 to specify a new bullet shape for a given depth.
5162 You'll also need to save the current bullet shape so you can restore it
5164 In this itemized list the following \SpecialChar LaTeX
5165 code was used to change the bullet
5166 used for the first depth.
5170 \begin_layout LyX-Code
5180 \begin_layout LyX-Code
5197 \begin_layout Itemize
5198 Note that the itemize depth is specified in Roman numerals as part of the
5208 \begin_layout Itemize
5210 \change_deleted -712698321 1501149643
5214 \begin_layout Plain Layout
5216 \change_deleted -712698321 1501149634
5227 \change_deleted -712698321 1501149636
5236 \change_inserted -712698321 1501149643
5238 \begin_inset Argument item:1
5241 \begin_layout Plain Layout
5243 \change_inserted -712698321 1501149643
5247 \begin_layout Plain Layout
5249 \change_inserted -712698321 1501149643
5271 Specify each individual entry by starting each item with the bullet shape
5273 \change_deleted -712698321 1501149707
5275 \change_inserted -712698321 1501149740
5277 \begin_inset Quotes eld
5281 \begin_inset Quotes erd
5286 Insert\SpecialChar menuseparator
5292 \begin_inset Flex Noun
5295 \begin_layout Plain Layout
5303 For example, this item was started with
5304 \begin_inset Flex Code
5307 \begin_layout Plain Layout
5309 \change_deleted -712698321 1501149692
5319 \change_deleted -712698321 1501149693
5330 \begin_layout Plain Layout
5334 \begin_layout Plain Layout
5350 \begin_layout Plain Layout
5351 You'll also need to revert the labelitem back to its previous setting for
5352 the global bullet shape settings to remain in effect.
5353 The way used here was:
5356 \begin_layout LyX-Code
5371 \begin_layout Chapter
5373 and the World Wide Web
5376 \begin_layout Standard
5378 has long supported the export of documents to various web-friendly formats,
5381 \change_inserted -712698321 1501076595
5384 on 2.0, however, HTML export was always accomplished by the use of external
5389 \begin_layout Plain Layout
5390 For details on the use of external converters with \SpecialChar LyX
5395 section of the Customization manual.
5400 These fall into two large groups: there are converters that use \SpecialChar LaTeX
5402 intermediate format, such as
5403 \begin_inset Flex Code
5406 \begin_layout Plain Layout
5413 \begin_inset Flex Code
5416 \begin_layout Plain Layout
5423 \begin_inset Flex Code
5426 \begin_layout Plain Layout
5432 , relying upon \SpecialChar LyX
5433 to produce the \SpecialChar LaTeX
5434 ; and there is a converter that works directly
5437 \begin_inset Flex Code
5440 \begin_layout Plain Layout
5448 All of these have different advantages and disadvantages.
5452 \begin_layout Standard
5453 The \SpecialChar LaTeX
5454 -based converters have the advantage that, in principle, they know everythin
5455 g about the exported document that \SpecialChar LaTeX
5457 Such converters do not care, for example, if a certain block of code was
5458 produced by \SpecialChar LyX
5459 or was Evil Red Text.
5460 These converters know about
5461 \begin_inset Flex Code
5464 \begin_layout Plain Layout
5470 files, counters, and references, and can often make use of the
5471 \begin_inset Flex Code
5474 \begin_layout Plain Layout
5480 files generated by Bib\SpecialChar TeX
5482 On the other hand, \SpecialChar LaTeX
5483 is a very hard language to parse—it is sometimes said
5484 that only \SpecialChar TeX
5485 itself understands \SpecialChar TeX
5486 —and \SpecialChar LaTeX
5487 -based converters will often choke on
5488 what seem to be quite simple constructs; complex ones can throw them completely
5489 , and as of this writing, for example, the
5493 manual will not export with
5494 \begin_inset Flex Code
5497 \begin_layout Plain Layout
5503 , though the others will.
5504 The other issue concerns how math is handled.
5505 These converters typically convert the formulae into little pictures that
5506 are then linked from the HTML document.
5507 Since these are actually generated by \SpecialChar LaTeX
5508 , they are accurate.
5509 But they do not scale well, and just getting them to look as if they are
5510 actually meant to be in your document—so that the font sizes seem to be
5511 roughly the same—can be a challenge.
5514 \begin_layout Standard
5516 \begin_inset Flex Code
5519 \begin_layout Plain Layout
5527 \begin_inset CommandInset href
5529 name "http://elyxer.nongnu.org/"
5530 target "http://elyxer.nongnu.org/"
5535 ) solves some of these problems.
5536 In particular, the formulae it produces scale perfectly, since it renders
5537 math using a combination of HTML and CSS rather than converting the formulae
5539 But even moderately complex formula are rendered less well than with
5540 \begin_inset Flex Code
5543 \begin_layout Plain Layout
5549 ; this reflects the limitations of HTML.
5553 \begin_layout Plain Layout
5555 \begin_inset Flex Code
5558 \begin_layout Plain Layout
5565 can also use jsMath and MathJax for equations, but this setting is only
5566 available globally and requires one to have access to a server that runs
5572 More importantly (as of version 1.1.1, at least),
5573 \begin_inset Flex Code
5576 \begin_layout Plain Layout
5583 has limited support for math macros and no support for user-defined paragraph
5584 or character styles.
5585 These limitations make
5586 \begin_inset Flex Code
5589 \begin_layout Plain Layout
5596 unsuitable for many of the documents \SpecialChar LyX
5598 In principle, of course, these problems could be solved, but the \SpecialChar LyX
5600 have decided to follow a different path and have made \SpecialChar LyX
5602 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
5603 , DocBook, and plaintext.
5606 \begin_layout Standard
5607 As of this writing, XHTML output remains under development and should probably
5609 \begin_inset Quotes eld
5613 \begin_inset Quotes erd
5620 \begin_layout Plain Layout
5622 \begin_inset Flex Code
5625 \begin_layout Plain Layout
5627 \change_inserted -712698321 1501078933
5635 , which can be found in the \SpecialChar LyX
5637 \begin_inset CommandInset href
5639 name "accessed online"
5640 target "http://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
5645 , usually contains up-to-date information about the state of XHTML output.
5646 See also the list of XHTML bugs on
5647 \begin_inset CommandInset href
5649 name "the bug tracker"
5650 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"
5660 Still, the developers have chosen this approach because it has several
5661 potential advantages over the other two.
5664 \begin_layout Standard
5665 These advantages are primarily due to the fact that the XHTML output routines,
5666 since they are part of \SpecialChar LyX
5667 , know everything \SpecialChar LyX
5668 knows about the document being
5673 \begin_layout Plain Layout
5674 Another advantage is that, since these routines are internal to \SpecialChar LyX
5676 immune to changes in \SpecialChar LyX
5677 's file format, or to changes in the semantics of
5683 So they know about the table of contents (as displayed in the outline),
5684 about the counters associated with different paragraph styles, and about
5685 user-defined styles.
5686 The XHTML output routines know what \SpecialChar LyX
5687 knows about internationalization,
5688 too, so they will output
5689 \begin_inset Quotes eld
5693 \begin_inset Quotes erd
5697 \begin_inset Quotes eld
5705 \begin_inset Quotes erd
5708 , depending upon the language in effect at the time.
5712 \begin_layout Standard
5713 Quite generally, the output routines know what \SpecialChar LyX
5714 knows about document layout,
5715 that is, about how the document is to be rendered on screen.
5716 We use this information when we output the document as XHTML.
5717 In particular, \SpecialChar LyX
5722 generates CSS style information corresponding to the layout information
5723 it uses to render the document on screen: if section headings are supposed
5724 to be sans-serif and bold as seen in \SpecialChar LyX
5725 , then (by default) they will be sans-seri
5726 f and bold when viewed in a web browser, too.
5727 And this is true not just for pre-defined styles, like Section, but for
5728 any style, including user-defined styles.
5729 Indeed, the XHTML output routines make no distinction between user-defined
5730 paragraph and character styles and \SpecialChar LyX
5731 's own pre-defined styles: in each case,
5732 everything \SpecialChar LyX
5733 knows about the styles is contained in the layout files.
5734 And much the same is true as regards pre-defined textual insets, such as
5735 footnotes, and various custom insets.
5739 \begin_layout Standard
5740 The result is that XHTML output can be customized and extended in exactly
5741 the same way \SpecialChar LaTeX
5742 output can be customized and extended: through layout files
5744 See chapter five of the
5748 manual for the details.
5751 \begin_layout Standard
5752 The remainder of this chapter contains more detailed information on XHTML
5753 output, its limitations, and ways to work around those limitations.
5756 \begin_layout Section
5757 Math Output in XHTML
5760 \begin_layout Standard
5762 offers four choices for how math is rendered.
5763 These have various advantages and disadvantages:
5766 \begin_layout Itemize
5768 \begin_inset Newline newline
5771 MathML is a dialect of XML designed specifically for mathematics on the
5772 web, and it typically renders very well in browsers that support it.
5773 The disadvantage is that not all browsers support MathML, and support is
5774 not complete even in the Gecko-based browsers, such as Firefox.
5775 \begin_inset Newline newline
5779 is unable to render a formula as MathML—for example, if the formula
5781 \begin_inset Flex Code
5784 \begin_layout Plain Layout
5790 package or ERT—then it will instead output the formula as an image.
5794 \begin_layout Itemize
5796 \begin_inset Newline newline
5800 \begin_inset Flex Code
5803 \begin_layout Plain Layout
5809 outputs math as HTML, styled by CSS.
5813 \begin_layout Plain Layout
5815 has borrowed some of the CSS for its HTML output from
5816 \begin_inset Flex Code
5819 \begin_layout Plain Layout
5830 For simple formulae, this can work quite well, though with more complicated
5831 formulae it tends to break down.
5832 Still, this method has the advantage that it is very widely supported and
5833 so it may be appropriate for documents that contain only a little, fairly
5835 \begin_inset Newline newline
5838 If Lyx is unable to render a formula as HTML—for example, if the formula
5840 \begin_inset Flex Code
5843 \begin_layout Plain Layout
5849 package or ERT—then it will instead output the formula as an image.
5853 \begin_layout Itemize
5855 \begin_inset Newline newline
5859 \begin_inset Flex Code
5862 \begin_layout Plain Layout
5869 will output formulae as images, the very same images, in fact, that are
5870 used for instant preview.
5874 \begin_layout Plain Layout
5875 Instant preview does
5879 have to be on for images to be output, however.
5884 The advantage to this method is that the images are simply generated by
5886 , so they are very accurate.
5887 The disadvantage, as mentioned earlier, is that these are bitmapped images,
5888 so they do not scale terribly well, and one cannot copy them, etc.
5890 \change_deleted -712698321 1501075981
5891 (As of this writing, there are also problems about equation numbering.
5893 \begin_inset CommandInset href
5896 target "http://www.lyx.org/trac/ticket/6894"
5904 \begin_inset Newline newline
5907 The size of the images can be controlled by setting the
5908 \begin_inset Quotes eld
5912 \begin_inset Quotes erd
5916 \begin_inset Flex Noun
5919 \begin_layout Plain Layout
5920 Document\SpecialChar menuseparator
5921 Settings\SpecialChar menuseparator
5923 \change_deleted -712698321 1501076136
5925 \change_inserted -712698321 1501076137
5937 \begin_layout Plain Layout
5938 For those who want to know, this controls the resolution of the image in
5939 dots per inch and is based upon a default of 75 dpi.
5945 \begin_inset Newline newline
5949 for some reason fails to create an image for a formula (e.g., if a required
5951 package is not installed), then it will fall back to outputing the raw
5956 \begin_layout Itemize
5959 \begin_inset Newline newline
5962 Finally, \SpecialChar LyX
5963 will happily output math as \SpecialChar LaTeX
5965 As well as being the output of last resort, this method can be used with
5967 \begin_inset CommandInset href
5970 target "http://www.math.union.edu/~dpvc/jsMath/"
5975 , which uses JavaScript to render \SpecialChar LaTeX
5976 embedded in HTML documents.
5978 wraps the \SpecialChar LaTeX
5980 \begin_inset Flex Code
5983 \begin_layout Plain Layout
5989 (for inline formulas) or
5990 \begin_inset Flex Code
5993 \begin_layout Plain Layout
5999 (for displayed formulas) with
6000 \begin_inset Flex Code
6003 \begin_layout Plain Layout
6009 , as is required for jsMath.
6012 \begin_layout Standard
6013 One of these output methods must be selected under
6014 \begin_inset Flex Noun
6017 \begin_layout Plain Layout
6018 Document\SpecialChar menuseparator
6019 Settings\SpecialChar menuseparator
6021 \change_deleted -712698321 1501076586
6023 \change_inserted -712698321 1501076587
6032 By default, \SpecialChar LyX
6034 This is a document-wide setting, therefore.
6037 \begin_layout Standard
6038 Eventually, \SpecialChar LyX
6039 will offer the user the option to select an alternate output
6040 method for a particular inset, say, one that isn't being rendered very
6045 \begin_layout Plain Layout
6046 That said, since \SpecialChar LyX
6047 falls back to images if the inset contains ERT, then one
6048 can force output as an image by putting some harmless ERT into the math,
6050 \begin_inset Formula $a=b\relax$
6061 \begin_layout Section
6062 Bibliography and Citations
6065 \begin_layout Standard
6066 XHTML output fully supports bibliographies and citations.
6070 \begin_layout Standard
6071 Citation labels are generated by the same machinery that generates \SpecialChar LyX
6073 labels, so the labels will look in the output much as they do in \SpecialChar LyX
6076 If you are using numerical citations, then \SpecialChar LyX
6077 will output numerical labels,
6078 such as [1] or [17], rather than simply showing the citation key in square
6079 brackets, as it does on-screen.
6080 If you are using author-year citations, then \SpecialChar LyX
6081 will add lowercase letters
6082 to the years, just as Bib\SpecialChar TeX
6083 does, if it finds more than one citation for
6084 a given author-year combination.
6085 The labels will be printed with the bibliography entries.
6086 Note that there is, at present, no way to customize the appearance of the
6087 labels, for example, to choose between square brackets and parentheses.
6090 \begin_layout Standard
6091 Bibliography output is handled by the same machinery that handles the presentati
6092 on of reference information in the citation dialog, so you will see in the
6093 XHTML output pretty much what you would see if you were to look at a given
6094 entry in the citation dialog.
6095 The formatting can be customized in your layout file or, preferably, in
6101 manual for the details.
6104 \begin_layout Standard
6105 The main defect at present is that cross-referenced information is printed
6106 with every entry with which it is associated.
6107 So you can see things like this:
6112 \begin_inset Quotes eld
6115 Context and Logical Form
6116 \begin_inset Quotes erd
6121 Language in Context: Selected Essays
6123 (Oxford: Oxford University Press, 2007), pp.
6129 \begin_inset Quotes eld
6132 Semantics in Context
6133 \begin_inset Quotes erd
6138 Language in Context: Selected Essays
6140 (Oxford: Oxford University Press, 2007), pp.
6144 \begin_layout Standard
6145 This should be fixed before long.
6148 \begin_layout Standard
6149 There is no support at present for sectioned bibliographies.
6150 If you have multiple bibliographies, then \SpecialChar LyX
6151 will print the same bibliography
6155 \begin_layout Section
6159 \begin_layout Standard
6161 will happily export indexes as XHTML, but with certain limitations at the
6165 \begin_layout Standard
6166 Index export will be most reliable when you do not attempt to use the fancy
6167 constructs that are described in the section on indexes in the
6175 \begin_layout Plain Layout
6176 The main issue here is that \SpecialChar LyX
6177 itself does not really handle these.
6178 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
6184 We'll describe how they are handled using the subsection headings from
6188 \begin_layout Itemize
6189 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
6190 makes an effort to support these,
6191 but the entries must be separated by
6192 \begin_inset Quotes eld
6196 \begin_inset Quotes erd
6199 , that is, there must be spaces around the exclamation point.
6200 This is because it is otherwise too difficult to check for escaped exclamation
6201 points, ones in math, and so forth.
6204 \begin_layout Itemize
6205 Page Ranges: There is no support at all for page ranges, since these make
6206 no sense with XHMTL.
6207 Instead, you will just get two index entries, one at either end.
6210 \begin_layout Itemize
6211 Cross-referencing: There is no support for cross-referencing.
6213 finds an entry containing the
6214 \begin_inset Quotes eld
6217 |see\SpecialChar ldots
6219 \begin_inset Quotes erd
6222 construct, it is just dropped, and the rest is treated as an ordinary index
6226 \begin_layout Itemize
6227 Index Entry Order: \SpecialChar LyX
6228 does support attempts to fix the sorting order.
6229 It will take what is before the first `@' it finds and use that for sorting,
6230 taking what follows the first `@' to be the actual entry.
6231 At present, \SpecialChar LyX
6232 does not check for escaped `@', so do not try to index email
6236 \begin_layout Itemize
6237 Index Entry Layout: You can format entries by using the text style dialog,
6238 or by using any other method available within \SpecialChar LyX
6240 There is no support for constructs like:
6241 \begin_inset Quotes eld
6245 \begin_inset Quotes erd
6249 Indeed, if \SpecialChar LyX
6250 finds a pipe symbol, `|', in an entry, it will delete it and
6251 everything that follows it.
6254 \begin_layout Itemize
6255 Multiple Indexes: There is no support for multiple indexes.
6256 Rather, all index entries will be printed as one large index.
6257 To avoid our printing several versions of the index, we print only the
6258 main index, so make sure you have one.
6261 \begin_layout Section
6262 Nomenclature and Glossary
6265 \begin_layout Standard
6266 There is at present no support for glossaries.
6267 Adding it would be fairly trivial, and welcome.
6270 \begin_layout Chapter
6271 The \SpecialChar LyX
6275 \begin_layout Section
6279 \begin_layout Standard
6280 The `\SpecialChar LyX
6281 server' allows other programs to talk to \SpecialChar LyX
6282 , invoke \SpecialChar LyX
6283 commands, and retrieve
6284 information about the \SpecialChar LyX
6286 This is only intended for advanced users, but they should find it useful.
6287 It is by writing to the \SpecialChar LyX
6288 server, for example, that bibliography managers,
6289 such as JabRef, are able to
6290 \begin_inset Quotes eld
6294 \begin_inset Quotes erd
6297 citations to \SpecialChar LyX
6301 \begin_layout Section
6302 Starting the \SpecialChar LyX
6306 \begin_layout Standard
6307 The \SpecialChar LyX
6308 server works through the use of a pair of named pipes.
6309 These are usually located in
6310 \begin_inset Flex Code
6313 \begin_layout Plain Layout
6319 , (except on Windows, where
6323 named pipes are special objects located in
6324 \begin_inset Flex Code
6327 \begin_layout Plain Layout
6339 ) and have the names
6340 \begin_inset Quotes eld
6344 \begin_inset Flex Code
6347 \begin_layout Plain Layout
6354 \begin_inset Quotes erd
6358 \begin_inset Quotes eld
6362 \begin_inset Flex Code
6365 \begin_layout Plain Layout
6372 \begin_inset Quotes erd
6376 External programs write into
6377 \begin_inset Flex Code
6380 \begin_layout Plain Layout
6386 and read back data from
6387 \begin_inset Flex Code
6390 \begin_layout Plain Layout
6397 The stem of the pipe names can be defined in the
6398 \begin_inset Flex Noun
6401 \begin_layout Plain Layout
6402 Tools\SpecialChar menuseparator
6409 \begin_inset Flex Code
6412 \begin_layout Plain Layout
6413 "/home/myhome/lyxpipe"
6419 \begin_inset Flex Code
6422 \begin_layout Plain Layout
6436 on Windows (where any working path instead of lyxpipe can be used, for
6438 \begin_inset Flex Code
6441 \begin_layout Plain Layout
6464 configure this manually in order for the server to start.
6467 \begin_layout Standard
6470 \begin_inset Flex Code
6473 \begin_layout Plain Layout
6480 \begin_inset Flex Code
6483 \begin_layout Plain Layout
6489 ' to create the pipes.
6490 If one of the pipes already exists, \SpecialChar LyX
6491 will assume that another \SpecialChar LyX
6493 is already running and will not start the server.
6494 On POSIX (Unix like) systems, if for some other reason, an unused
6495 \begin_inset Quotes eld
6499 \begin_inset Quotes erd
6502 pipe is left in existence when \SpecialChar LyX
6503 closes, then \SpecialChar LyX
6504 will try to delete it.
6505 If this fails for some reason, you will need to delete the pipes manually
6506 and then restart \SpecialChar LyX
6508 On Windows, pipes are deleted by the OS on program termination or crash,
6510 \begin_inset Quotes eld
6514 \begin_inset Quotes erd
6517 pipes should not be possible.
6520 \begin_layout Standard
6521 To have several \SpecialChar LyX
6522 processes with servers at the same time, you have to use
6523 different configurations, perhaps by using separate user directories, each
6525 \begin_inset Flex Code
6528 \begin_layout Plain Layout
6534 file, for each process.
6537 \begin_layout Standard
6538 If you are developing a client program, you might find it useful to enable
6539 debugging information from the \SpecialChar LyX
6541 Do this by starting \SpecialChar LyX
6543 \begin_inset Flex Code
6546 \begin_layout Plain Layout
6555 \begin_layout Standard
6556 You can find a complete example client written in C++ in the source distribution
6558 \begin_inset Flex Code
6561 \begin_layout Plain Layout
6562 development/lyxserver/server_monitor.cpp
6570 \begin_layout Standard
6571 Another useful tool is the command-line based client found in
6572 \begin_inset Flex Code
6575 \begin_layout Plain Layout
6576 src/client/lyxclient
6584 \begin_layout Section
6585 Normal communication
6588 \begin_layout Standard
6589 To issue a \SpecialChar LyX
6590 call, the client writes a line of ASCII text into the input
6592 This line has the following format:
6609 \begin_layout Description
6610 clientname is a name that the client can choose arbitrarily.
6611 Its only use is that \SpecialChar LyX
6612 will echo it if it sends an answer—so a client can
6613 dispatch results from different requesters.
6616 \begin_layout Description
6617 function is the function you want \SpecialChar LyX
6619 It is the same as the commands you'd use in the minibuffer.
6622 \begin_layout Description
6623 argument is an optional argument which is meaningful only to some functions
6625 \begin_inset Quotes eld
6629 \begin_inset Quotes erd
6632 LFUN will insert the argument as text at the cursor position).
6635 \begin_layout Standard
6636 The answer from \SpecialChar LyX
6637 will arrive in the output pipe and be of the form
6654 \begin_layout Standard
6663 are just echoed from the command request, while
6667 is more or less useful information filled according to how the command
6668 execution worked out.
6669 Some commands, such as
6670 \begin_inset Quotes eld
6674 \begin_inset Quotes erd
6677 , will return information about the internal state of \SpecialChar LyX
6679 return an empty data-response.
6680 This means that the command execution went fine.
6683 \begin_layout Standard
6684 In case of errors, the response from \SpecialChar LyX
6702 \begin_layout Standard
6707 should contain an explanation of why the command failed.
6710 \begin_layout Standard
6714 \begin_layout LyX-Code
6715 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
6716 \begin_inset Newline newline
6719 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
6720 \begin_inset Newline newline
6723 read a <~/.lyxpipe.out
6724 \begin_inset Newline newline
6730 \begin_layout Subsection
6731 AppleScript (Mac OS X)
6734 \begin_layout Standard
6735 Since \SpecialChar LyX
6736 2.1, \SpecialChar LyX
6737 supports basic interactions with AppleScript for normal communicatio
6738 n through the command run.
6739 This command takes a direct argument (the
6743 to perform) and an optional argument.
6744 It either returns the output of the function or triggers an error with
6745 the error message and code.
6748 \begin_layout Standard
6752 \begin_layout LyX-Code
6753 tell application "\SpecialChar LyX
6757 \begin_layout LyX-Code
6761 \begin_layout LyX-Code
6762 -- Stores the current file name into f
6765 \begin_layout LyX-Code
6766 set f to (run "server-get-filename" with argument "")
6769 \begin_layout LyX-Code
6770 on error the error_message number the error_number
6773 \begin_layout LyX-Code
6774 display dialog "Error: " & the error_number & ".
6778 \begin_layout LyX-Code
6779 & the error_message buttons {"OK"} default button 1
6782 \begin_layout LyX-Code
6786 \begin_layout LyX-Code
6790 \begin_layout Section
6794 \begin_layout Standard
6796 can notify clients of events going on asynchronously.
6797 Currently it will only do this if the user binds a key sequence with the
6799 \begin_inset Quotes eld
6803 \begin_inset Quotes erd
6807 The format of the string \SpecialChar LyX
6808 sends is as follows:
6812 \begin_inset Flex Code
6815 \begin_layout Plain Layout
6826 \begin_layout Standard
6831 is the printed representation of the key sequence that was actually typed
6835 \begin_layout Standard
6836 This mechanism can be used to extend \SpecialChar LyX
6837 's command set and implement macros.
6838 Bind some key sequence to
6839 \begin_inset Quotes eld
6843 \begin_inset Quotes erd
6847 Then start a client that listens on the output pipe, dispatches the command
6848 according to the sequence, and starts a function that may use \SpecialChar LyX
6851 requests to issue a command or a series of commands to \SpecialChar LyX
6855 \begin_layout Section
6856 The simple \SpecialChar LyX
6860 \begin_layout Standard
6862 implements a simple protocol that can be used for session management.
6863 All messages are of the form
6876 \begin_layout Standard
6882 \begin_inset Quotes eld
6886 \begin_inset Quotes erd
6890 \begin_inset Quotes eld
6894 \begin_inset Quotes erd
6899 \begin_inset Quotes eld
6903 \begin_inset Quotes erd
6906 is received from a client, \SpecialChar LyX
6907 will report back to inform the client that
6908 it's listening to it's messages, while
6909 \begin_inset Quotes eld
6913 \begin_inset Quotes erd
6916 sent from \SpecialChar LyX
6917 will inform clients that \SpecialChar LyX
6921 \begin_layout Section
6922 Reverse DVI/PDF search
6925 \begin_layout Standard
6926 Some DVI/PDF viewers
6930 \begin_layout Plain Layout
6931 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
6932 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
6941 facility (also called
6946 This means that you can tell \SpecialChar LyX
6947 to put the cursor to a specific line in the
6948 document by clicking at the respective position in the DVI/PDF output.
6949 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
6951 This is done via the \SpecialChar LyX
6952 server either by using the named pipe (
6956 ), or the UNIX domain socket (
6960 ) that \SpecialChar LyX
6961 creates in its temporary directory (this is the way the
6962 \begin_inset Flex Code
6965 \begin_layout Plain Layout
6971 program communicates with \SpecialChar LyX
6973 In some cases, you need a helper script that mediates between the viewer
6974 and \SpecialChar LyX
6975 , in others, the viewer can communicate with \SpecialChar LyX
6977 This depends on the selected viewer and on your operating system.
6978 The same applies to the way viewers need to be configured and the way the
6979 reverse search is actually performed.
6980 In what follows, we will thus describe how to setup reverse search for
6982 Before we turn to this, though, we will explain what needs to be done generally
6983 to enable reverse search in the DVI/PDF output.
6986 \begin_layout Subsection
6988 \begin_inset CommandInset label
6990 name "subsec:rev-search"
6997 \begin_layout Standard
6998 In most cases \SpecialChar LyX
6999 will do the work for you by
7000 \change_inserted -712698321 1500975045
7001 pressing the following button in the toolbar:
7004 arg "buffer-toggle-output-sync"
7008 Alternatively, you can also enable the feature by checking
7010 Synchronize with Output
7013 \begin_inset Flex Noun
7016 \begin_layout Plain Layout
7018 \change_inserted -712698321 1500975071
7019 Document\SpecialChar menuseparator
7020 Settings\SpecialChar menuseparator
7027 \change_deleted -712698321 1500974764
7029 \begin_inset Flex Noun
7032 \begin_layout Plain Layout
7033 Synchronize with Output
7039 \begin_inset Flex Noun
7042 \begin_layout Plain Layout
7043 Document\SpecialChar menuseparator
7044 Settings\SpecialChar menuseparator
7053 In such a case \SpecialChar LyX
7054 will automatically insert the necessary Sync\SpecialChar TeX
7056 PDF) or load the srcltx package (for DVI) respectively.
7057 This option can be easily reached also on
7058 \begin_inset Flex Code
7061 \begin_layout Plain Layout
7070 \begin_layout Standard
7071 If you need a different setting, you can select or input a custom macro
7072 from the drop down box just below
7073 \begin_inset Flex Noun
7076 \begin_layout Plain Layout
7077 Document\SpecialChar menuseparator
7078 Settings\SpecialChar menuseparator
7079 Output\SpecialChar menuseparator
7080 Synchronize with Output
7088 \begin_layout Standard
7089 Note that the method
7090 \begin_inset Flex Code
7093 \begin_layout Plain Layout
7101 enables gzip compression.
7102 If your viewer does not support it, you should instead use
7103 \begin_inset Flex Code
7106 \begin_layout Plain Layout
7117 \begin_layout Standard
7118 Please also note that including the
7119 \begin_inset Flex Code
7122 \begin_layout Plain Layout
7129 \begin_inset Flex Code
7132 \begin_layout Plain Layout
7138 sometimes has an undesired impact on the typesetting.
7139 Thus, you should switch output synchronization off for the final typesetting
7141 \begin_inset Flex Code
7144 \begin_layout Plain Layout
7151 \begin_inset Flex Code
7154 \begin_layout Plain Layout
7164 \begin_layout Standard
7165 In case you need some more special settings that are not covered by the
7166 automatic settings, read the next section about how to set up output synchroniz
7168 If the automatic setup suits your needs, you can readily jump to section
7169 \begin_inset space ~
7173 \begin_inset CommandInset ref
7175 reference "subsec:configuring-viewers"
7179 , where the necessary configuration steps in your viewer – needed both with
7180 the automatic and the manual setup – are described.
7183 \begin_layout Subsection
7187 \begin_layout Standard
7189 provides several different methods for reverse search.
7190 Some are built-in in the
7191 \begin_inset Flex Code
7194 \begin_layout Plain Layout
7200 program, some are provided by external packages.
7201 Your choice depends on whether your \SpecialChar LaTeX
7202 distribution already provides a given
7203 method (the built-in methods are rather new) and whether your viewer can
7205 The available methods are described in the following.
7208 \begin_layout Subsubsection*
7209 Built-in DVI-search via src-specials (DVI only)
7212 \begin_layout Standard
7213 This method provides the DVI file with the necessary information for reverse
7215 It is available in \SpecialChar LaTeX
7216 since quite some time (any somewhat recent \SpecialChar LaTeX
7218 should include it), and it works reliably.
7219 To enable it, change the
7220 \begin_inset Flex Noun
7223 \begin_layout Plain Layout
7234 \begin_inset Flex Noun
7237 \begin_layout Plain Layout
7248 \begin_inset Flex Noun
7251 \begin_layout Plain Layout
7252 Preferences\SpecialChar menuseparator
7253 File Handling\SpecialChar menuseparator
7260 \begin_inset Flex Code
7263 \begin_layout Plain Layout
7264 latex -src-specials $$i
7270 If this doesn't work, check if your \SpecialChar TeX
7271 engine needs different options (the
7272 syntax might differ in some distributions).
7275 \begin_layout Subsubsection*
7276 External Packages (PDFSync and scrltx)
7279 \begin_layout Standard
7288 provide reverse search facility for PDF output (via pdflatex) and DVI output,
7290 In order to enable it, load the packages in the \SpecialChar LyX
7294 \begin_layout Itemize
7295 \begin_inset Flex Code
7298 \begin_layout Plain Layout
7306 for reverse PDF search,
7309 \begin_layout Itemize
7310 \begin_inset Flex Code
7313 \begin_layout Plain Layout
7316 usepackage[active]{srcltx}
7321 for reverse DVI search.
7324 \begin_layout Standard
7325 If you want to be able to perform both DVI and PDF reverse searches, you
7326 can also insert in the preamble the following lines
7329 \begin_layout LyX-Code
7333 \begin_inset Newline newline
7339 \begin_inset Newline newline
7345 \begin_inset Newline newline
7351 \begin_inset Newline newline
7356 usepackage[active]{srcltx}
7357 \begin_inset Newline newline
7365 \begin_layout Standard
7366 This way, you can preview the file as either DVI or PDF (pdflatex) and the
7367 right package will be used.
7370 \begin_layout Standard
7371 Note that PDFSync might affect the output layout of your document.
7372 It is therefore advised to disable PDFsync for final documents.
7375 \begin_layout Subsubsection*
7376 Built-in reverse search via Sync\SpecialChar TeX
7380 \begin_layout Standard
7382 \begin_inset Flex Code
7385 \begin_layout Plain Layout
7391 have built-in support for both PDF and DVI reverse search.
7394 Sync\SpecialChar TeX
7397 facility is basically the result of the integration of the PDFSync package
7398 to the pdftex program and its merge with the
7403 You need at least \SpecialChar TeX
7404 Live 2008 or a recent Mik\SpecialChar TeX
7405 distribution in order to use
7410 \begin_layout Plain Layout
7411 For some reason, Mik\SpecialChar TeX
7412 does not understand/obey the command \SpecialChar LyX
7414 the preamble when you check the "Enable Forward/Reverse Search" button
7415 in the toolbar and does not generate the necessary info.
7418 \begin_layout Plain Layout
7419 The generation of the required info can be forced by changing the converter
7421 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
7422 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
7423 the -synctex=1 switch).
7428 Also note that only a few PDF viewers (
7429 \change_inserted -712698321 1500977288
7432 Okular and Qpdfview on Unix, Skim on the Mac, SumatraPDF on Windows
7433 \change_inserted -712698321 1500977299
7434 ; see the next section for details
7436 ) already provide Sync\SpecialChar TeX
7440 \begin_layout Standard
7441 To enable Sync\SpecialChar TeX
7442 for DVI output, change the
7443 \begin_inset Flex Noun
7446 \begin_layout Plain Layout
7457 \begin_inset Flex Noun
7460 \begin_layout Plain Layout
7471 \begin_inset Flex Noun
7474 \begin_layout Plain Layout
7475 Preferences\SpecialChar menuseparator
7476 File Handling\SpecialChar menuseparator
7483 \begin_inset Flex Code
7486 \begin_layout Plain Layout
7487 latex -synctex=1 $$i
7492 , and for PDF output, change the
7493 \begin_inset Flex Noun
7496 \begin_layout Plain Layout
7501 (pdflatex) -> PDF (pdflatex)
7507 \change_deleted -712698321 1500977453
7511 \begin_inset Flex Code
7514 \begin_layout Plain Layout
7515 pdflatex -synctex=1 $$i
7522 \change_inserted -712698321 1500977740
7523 Should your viewer not be considered in the following description, or in
7524 case of missing success, please
7525 \change_deleted -712698321 1500977741
7527 \change_inserted -712698321 1500977744
7530 heck the documentation of your viewer whether the viewer needs to be configured
7531 for the use with Sync\SpecialChar TeX
7536 \begin_layout Plain Layout
7537 Note that the option
7538 \begin_inset Flex Code
7541 \begin_layout Plain Layout
7547 option enables gzip compression.
7548 If your viewer does not support it, you should instead use
7549 \begin_inset Flex Code
7552 \begin_layout Plain Layout
7566 \begin_layout Subsection
7567 Configuring and using specific viewers
7568 \begin_inset CommandInset label
7570 name "subsec:configuring-viewers"
7577 \begin_layout Subsubsection*
7578 Xdvi (all platforms)
7581 \begin_layout Standard
7583 \begin_inset Flex Code
7586 \begin_layout Plain Layout
7592 , you don't need to do anything else for performing a reverse DVI search,
7594 already provides the necessary hooks for automatically using the
7595 \begin_inset Flex Code
7598 \begin_layout Plain Layout
7605 Just setup your document as described above (reverse search is triggered
7606 by Ctrl-click or Alt-click on Mac OSX, respectively).
7609 \begin_layout Standard
7610 However, if for whatever reason you want to use the named pipe instead of
7611 the socket for communicating with \SpecialChar LyX
7612 , simply change the DVI viewer in
7613 \begin_inset Flex Noun
7616 \begin_layout Plain Layout
7617 Preferences\SpecialChar menuseparator
7618 File Handling\SpecialChar menuseparator
7628 \begin_layout Plain Layout
7629 On Mac OSX you have to use
7630 \begin_inset Flex Code
7633 \begin_layout Plain Layout
7634 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
7645 \begin_inset Flex Code
7648 \begin_layout Plain Layout
7649 xdvi -editor "lyxeditor.sh %f %l"
7655 \begin_inset Flex Code
7658 \begin_layout Plain Layout
7664 is a suitable script.
7665 For example, a minimal shell script is the following one:
7668 \begin_layout LyX-Code
7670 \begin_inset Newline newline
7673 LYXPIPE="/path/to/lyxpipe"
7674 \begin_inset Newline newline
7677 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
7678 \begin_inset Newline newline
7681 echo "$COMMAND" > "${LYXPIPE}".in || exit
7682 \begin_inset Newline newline
7685 read TMP < "${LYXPIPE}".out || exit
7688 \begin_layout Standard
7690 \begin_inset Flex Code
7693 \begin_layout Plain Layout
7699 is the LyXServer pipe path specified in
7700 \begin_inset Flex Noun
7703 \begin_layout Plain Layout
7704 Preferences\SpecialChar menuseparator
7714 \begin_layout Plain Layout
7716 \begin_inset Flex Code
7719 \begin_layout Plain Layout
7725 folder of a source distribution you can find a
7726 \begin_inset Flex Code
7729 \begin_layout Plain Layout
7735 script which is able to locate the
7739 based on your preferences.
7747 \begin_layout Subsubsection*
7751 \begin_layout Standard
7753 \begin_inset Flex Code
7756 \begin_layout Plain Layout
7757 /Applications/MacDviX_Folder/calleditor.script
7762 , add the following lines:
7765 \begin_layout LyX-Code
7766 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
7767 \begin_inset Newline newline
7773 \begin_layout Standard
7774 Modify the lines accordingly if you install \SpecialChar LyX
7775 somewhere else than in the
7776 Applications folder.
7779 \begin_layout Standard
7780 Reverse search is triggered by Alt-click (OPTION-click).
7783 \begin_layout Subsubsection*
7787 \begin_layout Standard
7789 \begin_inset Flex Code
7792 \begin_layout Plain Layout
7793 open -a Skim.app $$i
7798 to the viewer setting in
7799 \begin_inset Flex Noun
7802 \begin_layout Plain Layout
7803 Preferences\SpecialChar menuseparator
7804 File Handling\SpecialChar menuseparator
7805 File formats\SpecialChar menuseparator
7812 \begin_inset Flex Noun
7815 \begin_layout Plain Layout
7816 Skim\SpecialChar menuseparator
7817 Preferences\SpecialChar menuseparator
7824 \begin_inset Flex Noun
7827 \begin_layout Plain Layout
7833 preset and enter command
7834 \begin_inset Flex Noun
7837 \begin_layout Plain Layout
7838 /Applications/\SpecialChar LyX
7839 .app/Contents/MacOS/lyxeditor
7847 \begin_layout Standard
7848 Reverse search is triggered by COMMAND-SHIFT-click
7851 \begin_layout Subsubsection*
7855 \begin_layout Standard
7856 Reverse search with evince does not work out of the box, but it can be achieved
7857 by means of some third party helper scripts.
7859 \begin_inset CommandInset href
7861 target "http://wiki.lyx.org/LyX/SyncTeX"
7869 \begin_layout Subsubsection*
7873 \begin_layout Standard
7875 \begin_inset Flex Noun
7878 \begin_layout Plain Layout
7879 Settings\SpecialChar menuseparator
7880 Configure Okular\SpecialChar menuseparator
7887 \change_inserted -712698321 1500981642
7889 \change_deleted -712698321 1500981641
7893 \change_deleted -712698321 1500981634
7895 \begin_inset Quotes eld
7899 \change_inserted -712698321 1500981635
7903 \begin_inset Quotes erd
7907 \change_inserted -712698321 1500981659
7909 This inserts the appropriate
7910 \change_deleted -712698321 1500981663
7914 \change_inserted -712698321 1500981665
7918 \begin_inset Flex Code
7921 \begin_layout Plain Layout
7928 \change_inserted -712698321 1500981668
7934 \begin_layout Standard
7935 Reverse search is triggered by SHIFT-click.
7938 \begin_layout Subsubsection*
7942 \begin_layout Standard
7943 Qpdfview supports Sync\SpecialChar TeX
7944 since version 0.3.5.
7946 \begin_inset Flex Noun
7949 \begin_layout Plain Layout
7950 Edit\SpecialChar menuseparator
7951 Settings\SpecialChar menuseparator
7957 , click on the input field of the
7958 \begin_inset Quotes eld
7962 \begin_inset Quotes erd
7965 item and add the command
7966 \begin_inset Flex Code
7969 \begin_layout Plain Layout
7978 \begin_layout Standard
7979 Reverse search is triggered by double-click or, in more recent versions,
7983 \begin_layout Subsubsection*
7987 \begin_layout Standard
7988 Launch yap, choose its
7989 \begin_inset Flex Noun
7992 \begin_layout Plain Layout
7993 View\SpecialChar menuseparator
8000 \begin_inset Quotes eld
8004 \begin_inset Quotes erd
8009 \begin_inset Quotes eld
8012 New\SpecialChar ldots
8014 \begin_inset Quotes erd
8017 button and, in the window that opens, enter
8018 \begin_inset Quotes eld
8023 \begin_inset Quotes erd
8026 (or any other name you like) in the
8027 \begin_inset Quotes eld
8031 \begin_inset Quotes erd
8035 Now click on the button labeled
8036 \begin_inset Quotes eld
8041 \begin_inset Quotes erd
8044 to open a file dialog and navigate to the directory containing the batch
8046 \begin_inset Flex Code
8049 \begin_layout Plain Layout
8057 \begin_inset Flex Code
8060 \begin_layout Plain Layout
8066 and then specify the program arguments as
8067 \begin_inset Flex Code
8070 \begin_layout Plain Layout
8078 \begin_inset Flex Code
8081 \begin_layout Plain Layout
8087 wrapper is used for communicating with \SpecialChar LyX
8095 \begin_layout LyX-Code
8097 \begin_inset Newline newline
8100 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
8109 \begin_inset Newline newline
8123 \begin_layout Standard
8124 Make sure that the \SpecialChar LyX
8125 Server pipe path you specified in \SpecialChar LyX
8127 \begin_inset Flex Code
8130 \begin_layout Plain Layout
8144 , otherwise change the
8145 \begin_inset Flex Code
8148 \begin_layout Plain Layout
8154 wrapper accordingly.
8157 \begin_layout Standard
8158 In yap, reverse search is triggered by double-click.
8161 \begin_layout Subsubsection*
8162 SumatraPDF (Windows)
8165 \begin_layout Standard
8166 In order to use SumatraPDF for inverse search, enter
8167 \begin_inset Flex Code
8170 \begin_layout Plain Layout
8171 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
8176 in the viewer setting in
8177 \begin_inset Flex Noun
8180 \begin_layout Plain Layout
8181 Preferences\SpecialChar menuseparator
8182 File Handling\SpecialChar menuseparator
8183 File formats\SpecialChar menuseparator
8190 \begin_inset Flex Code
8193 \begin_layout Plain Layout
8199 is the previous wrapper.
8200 If SumatraPDF.exe is not in your command PATH, use its full file name.
8203 \begin_layout Standard
8204 Reverse search is triggered by double-click.
8207 \begin_layout Subsubsection*
8211 \begin_layout Standard
8212 First of all, make sure that yap is your default DVI viewer in the Windows
8213 environment, then launch it, choose its
8214 \begin_inset Flex Noun
8217 \begin_layout Plain Layout
8218 View\SpecialChar menuseparator
8225 \begin_inset Quotes eld
8229 \begin_inset Quotes erd
8234 \begin_inset Quotes eld
8237 New\SpecialChar ldots
8239 \begin_inset Quotes erd
8242 button and, in the window that opens, enter
8243 \begin_inset Quotes eld
8248 \begin_inset Quotes erd
8251 (or any other name you like) in the
8252 \begin_inset Quotes eld
8256 \begin_inset Quotes erd
8260 Now click on the button labeled
8261 \begin_inset Quotes eld
8266 \begin_inset Quotes erd
8269 to open a file dialog and navigate to the directory containing the
8270 \begin_inset Flex Code
8273 \begin_layout Plain Layout
8279 program (which is installed by default on Cygwin along with the \SpecialChar LyX
8282 \begin_inset Flex Code
8285 \begin_layout Plain Layout
8291 and then specify the program arguments as
8292 \begin_inset Flex Code
8295 \begin_layout Plain Layout
8302 In this way, you will be using the
8306 for communicating with \SpecialChar LyX
8308 If, for whatever reason, you want to use the
8313 \begin_inset Flex Code
8316 \begin_layout Plain Layout
8322 option and be sure to specify the \SpecialChar LyX
8323 Server pipe path in the \SpecialChar LyX
8327 \begin_layout Standard
8328 In yap, reverse search is triggered by double-click.
8331 \begin_layout Subsubsection*
8335 \begin_layout Standard
8336 In order to use SumatraPDF for inverse search, enter
8337 \begin_inset Flex Code
8340 \begin_layout Plain Layout
8341 SumatraPDF -inverse-search "lyxeditor -g %f %l"
8346 in the viewer setting in
8347 \begin_inset Flex Noun
8350 \begin_layout Plain Layout
8351 Preferences\SpecialChar menuseparator
8352 File Handling\SpecialChar menuseparator
8353 File formats\SpecialChar menuseparator
8360 If SumatraPDF.exe is not in your command PATH, use its full posix path.
8362 \begin_inset Flex Code
8365 \begin_layout Plain Layout
8371 enables communication via the
8377 \begin_inset Flex Code
8380 \begin_layout Plain Layout
8386 option if you want to use the
8390 , and be sure to specify the \SpecialChar LyX
8391 Server pipe path in the \SpecialChar LyX
8395 \begin_layout Standard
8396 Reverse search is triggered by double-click.
8399 \begin_layout Section
8403 \begin_layout Standard
8404 Forward search is, as the name implies, in a sense the
8405 \begin_inset Quotes eld
8409 \begin_inset Quotes erd
8413 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
8415 If forward search is set up (as described in what follows), you can put
8416 the cursor anywhere in your \SpecialChar LyX
8418 \begin_inset Flex Noun
8421 \begin_layout Plain Layout
8422 Navigate\SpecialChar menuseparator
8429 \begin_inset Flex Noun
8432 \begin_layout Plain Layout
8438 in the context menu via right mouse click), and then the viewer will jump
8439 to that position as well.
8440 This implies, of course, that your viewer supports this function.
8443 \begin_layout Standard
8444 To make forward search possible, you first need to provide the generated
8445 output PDF/DVI file with additional information about the \SpecialChar TeX
8447 This can be done via the methods described in the section
8448 \begin_inset CommandInset ref
8450 reference "subsec:rev-search"
8457 \begin_layout Standard
8458 Additionally, you need to configure \SpecialChar LyX
8459 for using your viewers in
8460 \begin_inset Flex Noun
8463 \begin_layout Plain Layout
8464 Tools\SpecialChar menuseparator
8465 Preferences\SpecialChar menuseparator
8466 Output\SpecialChar menuseparator
8473 We provide a range of tested configurations for some viewers, which you
8474 can select from the drop down list.
8475 If none of these configurations suits you, you have to find out and enter
8476 a suitable configuration yourself.
8477 The definition syntax uses the following placeholders:
8480 \begin_layout Itemize
8482 \begin_inset Flex Code
8485 \begin_layout Plain Layout
8494 \begin_layout Itemize
8496 \begin_inset Flex Code
8499 \begin_layout Plain Layout
8505 : name of the (temporary) exported .tex file (without path)
8508 \begin_layout Itemize
8510 \begin_inset Flex Code
8513 \begin_layout Plain Layout
8519 : name of the (temporary) exported .tex file (including path)
8522 \begin_layout Itemize
8524 \begin_inset Flex Code
8527 \begin_layout Plain Layout
8533 : name of the exported output file (either dvi or pdf, depending on which
8534 one exists in the temporary directory)
8537 \begin_layout Standard
8538 Note that only some of the viewers provide full and usable forward search
8539 functionality out of the box, among them yap, xdvi, okular
8543 \begin_layout Plain Layout
8544 You might want to set
8545 \begin_inset Flex Code
8548 \begin_layout Plain Layout
8555 \begin_inset Flex Noun
8558 \begin_layout Plain Layout
8559 Tools\SpecialChar menuseparator
8560 Preferences\SpecialChar menuseparator
8561 File Handling\SpecialChar menuseparator
8563 \begin_inset space ~
8576 , qpdfview, and SumatraPDF
8580 \begin_layout Plain Layout
8581 SumatraPDF can also use DDE commands through the external program CMCDDE
8583 \begin_inset CommandInset href
8585 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
8596 Others, such as evince
8600 \begin_layout Plain Layout
8601 Forward search with evince can be achieved by means of third party helper
8604 \begin_inset CommandInset href
8606 target "http://wiki.lyx.org/LyX/SyncTeX"
8616 , require some extra tools in order to use forward search.
8617 While many of the widespread PDF viewers (most notably Adobe Reader) do
8618 not support forward search at all, some other viewers – e.
8619 \begin_inset space \thinspace{}
8623 xpdf – allow at least to reload the document and jump to a specific page
8624 of the file, so you can at least navigate
8625 \begin_inset Quotes eld
8629 \begin_inset Quotes erd
8633 This latter functionality is provided by an external call of synctex (see
8634 the predefined example configurations).
8638 \begin_layout Standard
8639 Forward search works both with DVI and PDF output.
8641 simply checks which preview format you have used before (i.
8642 \begin_inset space \thinspace{}
8645 e., which format is already there in the temporary directory) and chooses
8646 the appropriate configuration for the respective format.
8649 \begin_layout Chapter
8650 Special Document Classes
8653 \begin_layout Section
8657 \begin_layout Standard
8663 \begin_layout Subsection
8667 \begin_layout Standard
8668 This section describes how \SpecialChar LyX
8669 can be used to write articles for submission
8670 to the scientific journal
8672 Astronomy and Astrophysics
8675 \begin_inset Flex URL
8678 \begin_layout Plain Layout
8680 http://www.edpsciences.fr/aa/
8685 ) using Version 5.01 of the document class
8690 This package can be downloaded from the ftp site
8693 \begin_layout Standard
8694 \begin_inset VSpace medskip
8700 \begin_layout Standard
8702 \begin_inset Flex URL
8705 \begin_layout Plain Layout
8707 ftp://ftp.edpsciences.org/pub/aa/readme.html
8715 \begin_layout Standard
8716 \begin_inset VSpace medskip
8722 \begin_layout Standard
8723 A manual comes together with that package, and this text is not meant to
8724 replace the original manual but is merely a short guide in how to realize
8725 the correct form of your paper.
8729 \begin_layout Standard
8730 Please note that the publisher of the journal was changed from Springer
8731 to EDP Sciences starting January 1, 2001.
8732 That change involved also some slight changes to the style files, namely
8733 the removal of the thesaurus command.
8734 The \SpecialChar LyX
8735 class aa supports the newest version of these style files, V 5.01.
8736 If you have an older version installed, please upgrade.
8737 For compatibility, the old (version 4) layout has been kept as
8742 Please refer to the comments in
8745 Dir/layouts/aapaper.layout
8750 \begin_layout Subsection
8754 \begin_layout Standard
8755 It is recommended you start from the example template distributed with \SpecialChar LyX
8757 If you are not using a template, note the following settings:
8760 \begin_layout Itemize
8767 Document\SpecialChar menuseparator
8770 dialog (OK, that one was obvious).
8773 \begin_layout Itemize
8774 Don't change the option
8777 \begin_inset space ~
8787 The whole layout is done by the macros, you shouldn't change anything.
8790 \begin_layout Subsection
8794 \begin_layout Standard
8795 First thing to enter is the header information.
8796 It consists of seven entries, of which some are optional.
8800 \begin_layout Itemize
8808 \begin_layout Itemize
8816 \begin_layout Itemize
8824 \begin_layout Itemize
8832 \begin_layout Itemize
8837 : [optional] if more than one author: whom to contact for offprint requests.
8840 \begin_layout Itemize
8845 : [optional] mail address for contacts.
8848 \begin_layout Itemize
8856 Received: <date>; Accepted <date>
8859 \begin_layout Standard
8860 There is no need to issue the
8866 command, this is done automatically by \SpecialChar LyX
8867 when the header is finished.
8868 Although the order of the single header entries doesn't matter it is advised
8869 to keep the above sequence, just to get the best optics and meets the layout
8870 of the real document.
8873 \begin_layout Standard
8874 If you want to place footnotes in the header block, e.
8875 \begin_inset space \thinspace{}
8879 \begin_inset space \space{}
8882 to state your present address, just use the standard footnote via the menu
8885 Insert\SpecialChar menuseparator
8890 will automagically use the term
8897 \change_inserted -712698321 1501150851
8901 \begin_layout Standard
8903 \change_inserted -712698321 1501150892
8906 Edit\SpecialChar menuseparator
8909 , you'll find two insets which are relevant for the titling:
8912 \begin_layout Itemize
8914 \change_inserted -712698321 1501150936
8921 to mark corresponding author\SpecialChar breakableslash
8923 The institutes are numbered sequentially as they appear in the
8927 field, so you have to put a marker to each author.
8930 \begin_layout Itemize
8932 \change_inserted -712698321 1501150947
8937 to supply an email address for fast contact.
8942 \begin_layout Standard
8943 In addition to these topics, the macros use
8944 \change_deleted -712698321 1501150958
8946 \change_inserted -712698321 1501150961
8949 additional \SpecialChar LaTeX
8951 \change_deleted -712698321 1501150963
8955 \change_deleted -712698321 1501150967
8957 \change_inserted -712698321 1501150967
8960 no counterpart in \SpecialChar LyX
8964 \begin_layout Itemize
8971 to separate different names for more than one author and institute, respectivel
8975 \begin_layout Itemize
8977 \change_deleted -712698321 1501150911
8984 to mark corresponding author/institute pairs.
8985 The institutes are numbered sequentially as they appear in the
8989 field, so you have to put a marker to each author.
8992 \begin_layout Itemize
8994 \change_deleted -712698321 1501150911
9001 to supply an email address for fast contact.
9006 \begin_layout Standard
9008 \change_deleted -712698321 1501150972
9010 \change_inserted -712698321 1501150972
9013 he appropriate command has to be entered in \SpecialChar LyX
9014 and marked as \SpecialChar LaTeX
9020 \begin_layout Subsection
9024 \begin_layout Standard
9025 The abstract should immediately follow the header block.
9026 With version 5 the abstract environment was changed to a command, and there
9027 is now a resctriction to only one paragraph.
9028 In addition, it should contain an entry with the keywords.
9030 \change_deleted -712698321 1501151111
9031 not yet implemented for \SpecialChar LyX
9032 , therefore you have to enter the \SpecialChar LaTeX
9039 by hand and mark it as \SpecialChar LaTeX
9041 \change_inserted -712698321 1501151122
9042 done via the paragraph style
9049 Refer to the example paper.
9052 \begin_layout Subsection
9053 Supported environments
9056 \begin_layout Standard
9057 The A&A paper layout supports the following environments for structuring
9061 \begin_layout Itemize
9067 \begin_layout Itemize
9073 \begin_layout Itemize
9079 \begin_layout Itemize
9085 \begin_layout Itemize
9091 \begin_layout Itemize
9097 \begin_layout Itemize
9103 \begin_layout Itemize
9109 \begin_layout Itemize
9115 \begin_layout Itemize
9121 \begin_layout Itemize
9127 \begin_layout Itemize
9134 \begin_layout Subsection
9135 Commands not supported by \SpecialChar LyX
9139 \begin_layout Standard
9140 Some commands are not yet supported by the
9144 layout for \SpecialChar LyX
9146 Some have already been mentioned.
9147 For the sake of completeness, they are listed all together here:
9150 \begin_layout Itemize
9158 \begin_layout Itemize
9160 \change_deleted -712698321 1501151229
9170 \begin_layout Itemize
9172 \change_deleted -712698321 1501151308
9182 \begin_layout Itemize
9190 \begin_layout Itemize
9192 \change_deleted -712698321 1501151231
9200 \begin_layout Itemize
9202 \change_deleted -712698321 1501151231
9212 \begin_layout Itemize
9220 \begin_layout Itemize
9228 \begin_layout Standard
9229 If you want to use any of these commands, you have to enter them yourself.
9232 Do not forget to mark them as \SpecialChar LaTeX
9236 \begin_layout Subsection
9237 Figure and Table Floats
9240 \begin_layout Standard
9242 provides support for the necessary float environments
9244 figure, figure*, table
9250 , therefore we won't tell much about it here.
9254 \begin_inset space ~
9260 Just remember that tables should be left-aligned.
9261 For that, select the table and change the alignment in
9263 Edit\SpecialChar menuseparator
9265 \begin_inset space ~
9271 \begin_layout Standard
9272 There is only one special thing: the figures with caption besides the figure.
9273 To create such a figure, you have to do the following:
9276 \begin_layout Enumerate
9277 Create a wide figure float:
9279 Insert\SpecialChar menuseparator
9280 Float\SpecialChar menuseparator
9283 , then right click in the figure and select
9286 \begin_inset space ~
9294 \begin_layout Enumerate
9295 Enter your caption text.
9298 \begin_layout Enumerate
9303 to move the cursor above the caption.
9306 \begin_layout Enumerate
9310 \begin_layout Enumerate
9311 Position the cursor behind the figure and insert a horizontal fill:
9313 Insert\SpecialChar menuseparator
9315 \begin_inset space ~
9318 Character\SpecialChar menuseparator
9320 \begin_inset space ~
9328 \begin_layout Enumerate
9329 Switch to \SpecialChar LaTeX
9333 \begin_inset space ~
9341 \begin_layout Enumerate
9351 Do not close the brace!
9354 \begin_layout Enumerate
9355 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
9360 \begin_inset space ~
9372 \begin_layout Standard
9373 Also, refer to the figures in the example paper.
9376 \begin_layout Subsection
9380 \begin_layout Standard
9381 For submission, the paper has to be formated in a special double-spacing
9383 For this purpose, you have to give the option
9387 to the documentclass.
9388 This must be done using the
9389 \change_deleted -712698321 1501151486
9391 \change_inserted -712698321 1501151487
9394 class options field in the
9396 Document\SpecialChar menuseparator
9400 Just enter the string
9407 \begin_layout Subsection
9411 \begin_layout Standard
9416 directory contains an example paper written with \SpecialChar LyX
9418 It is the example paper from the original macro package, translated to
9421 Use it for inspiration, and compare the original \SpecialChar LaTeX
9422 code with \SpecialChar LyX
9426 \begin_layout Section
9431 \begin_layout Standard
9437 \begin_layout Subsection
9441 \begin_layout Standard
9443 is a set of macros produced by the American Astronomical Society to
9444 facilitate electronic manuscript submission to the three journals they
9445 publish: the Astrophysical Journal (including the Letters and Supplement),
9446 the Astronomical Journal, and the Publications of the Astronomical Society
9449 has proven to be an excellent tool for generating these documents, especially
9450 given its equation, citation, and figure handling capabilities.
9452 requires version 5.0 (or higher) of these macros; preferably
9453 \change_deleted -712698321 1501152764
9455 \change_inserted -712698321 1501152766
9458 , which is the version described here, or higher.
9459 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
9460 2.09 and are fundamentally
9461 incompatible with \SpecialChar LyX
9463 The AAS\SpecialChar TeX
9464 package may be downloaded from the AAS\SpecialChar TeX
9468 \begin_layout Standard
9469 \begin_inset VSpace medskip
9475 \begin_layout Standard
9477 \begin_inset Flex URL
9480 \begin_layout Plain Layout
9482 https://aas.org/aastex/aastex-downloads
9490 \begin_layout Standard
9491 \begin_inset VSpace medskip
9497 \begin_layout Standard
9498 A complete user guide is contained in that package and you should familiarize
9499 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
9502 will not reduce the need to figure out all the AAS\SpecialChar TeX
9503 commands, it will only
9504 reduce the drudgery of typing everything in.
9505 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
9507 completely to the requirements of the journal to which you are submitting
9511 \begin_layout Subsection
9512 Starting a New Paper
9515 \begin_layout Standard
9516 I strongly suggest that you start with the AAS\SpecialChar TeX
9520 File\SpecialChar menuseparator
9527 , enter the new file name, then choose the
9530 \change_inserted -712698321 1501152130
9536 This will show the most common fields found in a manuscript.
9537 Simply overwrite the existing text (including the brackets,
9541 ) with the correct information.
9542 Many of the AAS\SpecialChar TeX
9543 commands and environments can be implemented directly in
9546 \change_deleted -712698321 1501152213
9559 , which should stick out like a sore thumb if you actually just opened the
9563 For commands such as these, the \SpecialChar LaTeX
9564 code must be entered directly and marked
9566 Such commands are referred to as \SpecialChar TeX
9567 code, or Evil Red Text.
9568 I tried to minimize the amount of \SpecialChar TeX
9569 code needed in an AAS\SpecialChar TeX
9571 \change_deleted -712698321 1501152220
9572 , but there is still a bit more required than any of us would like
9577 \begin_layout Subsection
9578 Finishing Your Paper
9581 \begin_layout Standard
9582 When the paper is finished to your satisfaction and previews/prints correctly,
9584 \begin_inset Quotes eld
9588 \begin_inset Quotes erd
9591 actions which need to be done before you submit it to the journals.
9595 \begin_layout Enumerate
9596 Export your paper as a \SpecialChar LaTeX
9599 File\SpecialChar menuseparator
9600 Export\SpecialChar menuseparator
9608 \begin_layout Enumerate
9613 file with your favorite text editor
9617 \begin_layout Enumerate
9618 remove the comment lines before the
9627 \begin_layout Enumerate
9632 usepackage...{fontenc}
9634 line if it appears (usually just after
9649 \begin_layout Enumerate
9650 remove everything between (and including) the
9662 commands, except for any commands you specifically put into the \SpecialChar LaTeX
9664 (which should appear immediately after the
9665 \begin_inset Quotes eld
9668 User specified \SpecialChar LaTeX
9670 \begin_inset Quotes erd
9681 \begin_layout Enumerate
9682 Run the resulting file through \SpecialChar LaTeX
9683 to make sure it still processes correctly.
9686 \begin_layout Enumerate
9687 Reread the journal requirements to make sure your filenames and formats
9691 \begin_layout Enumerate
9695 \begin_layout Subsection
9696 Comments On Specific Commands
9699 \begin_layout Standard
9700 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
9707 ) gives a good description of each.
9708 Thus it's probably easiest for me to go down the list as found in the guide
9709 and offer comments where necessary.
9710 So let's begin \SpecialChar ldots
9714 \begin_layout Subsubsection
9715 Things that work as expected
9718 \begin_layout Standard
9719 Because they work as you might expect, I simply list them and the section
9820 begin{thebibliography}
9828 (2.13.2), all the cite commands and their variations (2.13.2), the generic
9829 graphicx figure commands (2.14.1),
9853 (2.15.4, amongst other places),
9880 \begin_layout Standard
9881 The following style options also work correctly:
9902 Simply put them in the
9908 Layout\SpecialChar menuseparator
9914 \begin_layout Subsubsection
9915 Things that work, but require more comment
9918 \begin_layout Standard
9919 The following items work, but require a little more discussion:
9922 \begin_layout Itemize
9923 These items are reserved for use by the journal editors, but you can put
9924 them into the \SpecialChar LaTeX
9925 preamble if you feel compelled to do so:
9958 \begin_layout Itemize
9959 These items may be placed in the \SpecialChar LaTeX
9960 preamble, and are included as blanks in
9982 \begin_layout Itemize
9989 (2.3) – can only be used
9990 \begin_inset Quotes eld
9994 \begin_inset Quotes erd
9997 , not in the middle of a paragraph.
9998 Use \SpecialChar TeX
9999 code if you need to embed it.
10002 \begin_layout Itemize
10009 (2.3) – will have extra {} after it.
10010 This should not cause an error.
10013 \begin_layout Itemize
10020 (2.6) – can only be used
10021 \begin_inset Quotes eld
10025 \begin_inset Quotes erd
10028 , not in the middle of a paragraph.
10029 Use \SpecialChar TeX
10030 code if you need to embed it.
10033 \begin_layout Itemize
10040 (2.8) – can't insert a cross-reference tag, you must type the tag name by
10044 \begin_layout Itemize
10051 (2.8) – same as for
10058 \begin_layout Itemize
10065 (2.9) – will have extra {} after it.
10066 This should not cause an error.
10069 \begin_layout Itemize
10076 (2.11) – will have extra {} after it.
10077 This should not cause an error.
10080 \begin_layout Itemize
10087 (2.14.2) – you can insert an optional filename argument by placing the cursor
10088 at the beginning of the text and selecting
10090 Insert\SpecialChar menuseparator
10095 \begin_inset Quotes eld
10099 \begin_inset Quotes erd
10102 inserts an optional argument of the type needed by
10109 Hopefully it will be renamed someday.
10112 \begin_layout Itemize
10125 for the catalog ID optional parameter
10128 \begin_layout Itemize
10141 for the catalog ID optional parameter
10144 \begin_layout Subsubsection
10145 Things not implemented, use \SpecialChar TeX
10149 \begin_layout Standard
10151 \change_deleted -712698321 1501152401
10176 setcounter{equation}
10178 (2.12), Journal name abbreviations (2.13.4),
10214 (2.15.4, insert it as the first element in the lefthand cell after where
10216 Don't use any of \SpecialChar LyX
10217 's rules in the table),
10229 (2.15.5), much of Misc (2.17, except
10280 \begin_layout Subsubsection
10281 Things that cannot be implemented
10284 \begin_layout Standard
10286 at least in any meaningful sort of way, so I suggest ignoring them.
10287 They are the references environment (2.13.3), and the deluxetable environment
10289 If you really, really need to use deluxetable, I suggest editing it in
10290 a separate file with a text editor, then using
10292 Insert\SpecialChar menuseparator
10294 \begin_inset space ~
10299 to include it in your \SpecialChar LyX
10305 file to see an example of this.
10308 \begin_layout Subsection
10309 FAQs, Tips, Tricks, and Other Ruminations
10312 \begin_layout Subsubsection
10313 Getting \SpecialChar LyX
10314 and AAS\SpecialChar TeX
10318 \begin_layout Standard
10319 It can be a bit tricky to get \SpecialChar LyX
10320 to recognize a new layout and document class.
10321 When all else fails, do this:
10324 \begin_layout Enumerate
10325 Make certain that \SpecialChar LaTeX
10326 can find AAS\SpecialChar TeX
10328 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
10329 distribution into a
10330 directory completely unrelated to \SpecialChar LaTeX
10331 or AAS\SpecialChar TeX
10332 and run \SpecialChar LaTeX
10340 \begin_layout Enumerate
10345 appears in \SpecialChar LyX
10353 \begin_layout Enumerate
10356 Tools\SpecialChar menuseparator
10359 in \SpecialChar LyX
10360 , then restart \SpecialChar LyX
10364 \begin_layout Enumerate
10365 Open a regular new file, not from a template.
10366 Does AAS\SpecialChar TeX
10367 appear in the class list in
10369 Document\SpecialChar menuseparator
10375 \begin_layout Standard
10376 If you get a warning from an existing AAS\SpecialChar TeX
10377 document about not being able
10378 to find the AAS\SpecialChar TeX
10379 layout or a message about
10380 \begin_inset Quotes eld
10383 You should not mix title layouts with normal ones
10384 \begin_inset Quotes erd
10387 , things haven't been installed correctly.
10390 \begin_layout Subsubsection
10392 error processing a table
10395 \begin_layout Standard
10397 , by default, attempts to center the table caption/title.
10398 This seems to produce a bad interaction in AAS\SpecialChar TeX
10399 so you should click somewhere
10400 in the caption/title, then select
10402 Edit\SpecialChar menuseparator
10404 \begin_inset space ~
10418 This took care of it for me.
10421 \begin_layout Subsubsection
10425 \begin_layout Standard
10426 A couple of things: 1) I have noticed some funny spacing in the reference
10427 entries in the text.
10428 When you enter the bibliography item data, make sure their is
10432 space between the last author and the parenthesis setting off the year;
10436 \begin_inset space \thinspace{}
10440 \begin_inset space \space{}
10454 2) Entering the references at all is not obvious.
10455 The easiest thing is to start typing your first reference at the end of
10456 the document, then mark it as type
10461 That will put a small gray box in front of what you just typed.
10462 Click on the box to fill in the rest of the information.
10463 For new references, go to the end of an existing reference and press return.
10464 That will create a new line with its own box, etc.
10467 \begin_layout Subsubsection
10468 Including EPS files
10471 \begin_layout Standard
10472 Even though AAS\SpecialChar TeX
10473 provides its own figure commands (
10479 , for example), I much prefer \SpecialChar LaTeX
10480 's standard figure commands (with the default
10489 \begin_inset space ~
10492 commands as \SpecialChar TeX
10493 code into a Figure Float box if you desire, but I never have
10494 much luck getting the layout right.
10495 With the standard graphics, \SpecialChar LyX
10500 usepackage{graphicx}
10502 command into the \SpecialChar LaTeX
10503 preamble and handle the figures in the standard \SpecialChar LaTeX2e
10505 interspersing the figures in the text.
10506 I believe ApJ accepts figures exactly this way now; AJ might still use
10508 \begin_inset Quotes eld
10511 stack everything at the end
10512 \begin_inset Quotes erd
10518 \begin_layout Subsubsection
10519 Things I could have done, but didn't
10522 \begin_layout Standard
10524 \begin_inset Quotes eld
10528 \begin_inset Quotes erd
10531 things I could have implemented, but chose not to.
10532 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
10534 even though it is double-spaced in the paper manuscript.
10535 Also, I chose not to make separate layouts for the preprint and preprint2
10537 Since I assume you will spend most of your time in the plain manuscript
10538 mode anyway, I decided not to chew up more disk space with this.
10542 \begin_layout Subsection
10546 \begin_layout Standard
10547 Your mileage may vary.
10548 I've now had papers published by both ApJ and AJ that have had 98% of the
10549 effort done in \SpecialChar LyX
10550 ; the last 2% was the \SpecialChar LaTeX
10551 post-processing and a few cleanups.
10552 I have had no trouble with the submission process, and I'm sure the journals
10553 were never aware that there might be a difference.
10554 So, go forth and publish!
10557 \begin_layout Section
10558 AMS \SpecialChar LaTeX
10562 \begin_layout Standard
10572 \begin_layout Standard
10573 \begin_inset VSpace bigskip
10579 \begin_layout Standard
10581 The AMS \SpecialChar LaTeX
10582 layouts are set up to conform to suggested styles for mathematical
10583 papers to be submitted to American Mathematical Society publications.
10584 The layouts are not tailored to a specific journal, but easily can be.
10585 You should refer to the AMS documentation for specific instructions for
10586 each journal (usually it will entail only changing a single line in the
10589 That documentation is available on the Web at
10590 \begin_inset Flex URL
10593 \begin_layout Plain Layout
10601 \begin_inset Flex URL
10604 \begin_layout Plain Layout
10606 ftp://ftp.ams.org/pub/tex/amslatex/
10612 These layouts are appropriate, and useful, for any mathematical writing.
10616 \begin_layout Standard
10617 There are two basic AMS \SpecialChar LaTeX
10621 \begin_layout Itemize
10622 amsart: The standard AMS article format.
10625 \begin_layout Itemize
10626 amsbook: the standard AMS book (really, monograph) format.
10630 \begin_layout Standard
10631 The layouts themselves contain only the minimum necessary to use the AMS
10633 They do not, in particular, contain any of the `theorem' environments used
10634 for setting theorems, lemmas, and the like.
10635 These are contained, instead, in the
10636 \begin_inset Flex Code
10639 \begin_layout Plain Layout
10645 module, which is loaded by default when you select one of the AMS classes.
10646 (It can also be used with other classes and can be removed, if you would
10647 rather use something else.) Less commonly used environments are in the
10648 \begin_inset Flex Code
10651 \begin_layout Plain Layout
10652 Theorems (AMS-Extended)
10657 module, which must be loaded manually.
10660 \begin_layout Standard
10661 By default, theorems and the like are numbered consecutively throughout
10662 the document, but this may be modified by loading the module
10663 \begin_inset Flex Code
10666 \begin_layout Plain Layout
10667 Theorems (Order by Section)
10672 or, if you are using
10673 \begin_inset Flex Code
10676 \begin_layout Plain Layout
10683 \begin_inset Flex Code
10686 \begin_layout Plain Layout
10687 Theorems (Order by Chapter)
10693 These will number the results as
10694 \begin_inset Formula $n.m$
10697 , where the first number refers to the section (or chapter) and the second
10698 refers to the total number of results so far in that section (or chapter).
10699 Many environments are also available unnumbered.
10700 These are indicated by an asterisk at the end.
10701 If you happen to want
10705 unnumbered results, the module
10706 \begin_inset Flex Code
10709 \begin_layout Plain Layout
10715 provides that option.
10718 \begin_layout Standard
10719 Note that these modules do not
10723 to be used with the AMS classes.
10724 It is perfectly possible to use the
10725 \begin_inset Flex Code
10728 \begin_layout Plain Layout
10734 module, and the others mentioned, with other classes, such as
10735 \begin_inset Flex Code
10738 \begin_layout Plain Layout
10745 \begin_inset Flex Code
10748 \begin_layout Plain Layout
10755 \begin_inset Flex Code
10758 \begin_layout Plain Layout
10767 \begin_layout Subsection
10768 What these layouts provide
10771 \begin_layout Standard
10772 There is a long list of included environments provided by these layouts.
10773 In AMS-\SpecialChar LaTeX
10774 , there is, in fact, an opportunity to define an unlimited variety
10775 of `theorem' environments.
10776 However, the AMS recommends the environments that are available in \SpecialChar LyX
10781 \begin_layout Standard
10782 The following environments—as well as the standard environments, such as
10784 \begin_inset Flex Noun
10787 \begin_layout Plain Layout
10794 \begin_inset Flex Noun
10797 \begin_layout Plain Layout
10804 \begin_inset Flex Noun
10807 \begin_layout Plain Layout
10814 \begin_inset Flex Noun
10817 \begin_layout Plain Layout
10824 \begin_inset Flex Noun
10827 \begin_layout Plain Layout
10834 \begin_inset Flex Code
10837 \begin_layout Plain Layout
10844 \begin_inset Flex Code
10847 \begin_layout Plain Layout
10856 \begin_layout Description
10857 Address This should be the author's permanent address.
10860 \begin_layout Description
10862 \begin_inset space ~
10865 Address This should be the author's temporary address at the time of submission,
10866 if different from the Address.
10869 \begin_layout Description
10870 Email Author's e-mail address
10873 \begin_layout Description
10874 URL Author's Web address, if desired.
10877 \begin_layout Description
10878 Keywords Key words or phrases used to identify specific topics discussed
10882 \begin_layout Description
10883 Subjectclass These refer to the AMS Subject Classifications, published and
10886 Mathematical Reviews
10889 These are also available online at the AMS cites listed above.
10892 \begin_layout Description
10896 \begin_layout Description
10900 \begin_layout Description
10904 \begin_layout Standard
10905 The following environments are provided by both the
10906 \begin_inset Flex Code
10909 \begin_layout Plain Layout
10916 \begin_inset Flex Code
10919 \begin_layout Plain Layout
10925 modules, in the latter case in both starred (unnumbered) and unstarred
10926 (numbered) versions.
10927 These same environments are provided only in the starred versions by the
10929 \begin_inset Flex Code
10932 \begin_layout Plain Layout
10941 \begin_layout Theorem
10942 This is typically used for the statements of major results.
10946 \begin_layout Corollary*
10947 This is used for statements which follow fairly directly from previous statement
10949 Again, these can be major results.
10953 \begin_layout Lemma
10954 These are smaller results needed to prove other statements.
10957 \begin_layout Proposition
10958 These are less major results which (hopefully) add to the general theory
10962 \begin_layout Conjecture
10963 These are statements provided without justification, which the author does
10964 not know how to prove, but which seem to be true (to the author, at least).
10967 \begin_layout Definition*
10968 Guess what this is for.
10969 The font is different for this environment than for the previous ones.
10973 \begin_layout Example*
10974 Used for examples illustrating proven results.
10977 \begin_layout Problem
10978 It's not really known what this is for.
10979 You should figure it out.
10982 \begin_layout Exercise*
10983 Write a description for this one.
10986 \begin_layout Remark
10987 This environment is also a type of theorem, usually a lesser sort of observation.
10990 \begin_layout Claim*
10991 Often used in the course of giving a proof of a larger result.
10995 Generally, these are used to break up long arguments, using specific instances
11001 The numbering scheme for cases is on its own, not together with other numbered
11006 \begin_layout Proof
11007 At the end of this environment, a QED symbol (usually a square, but it can
11008 vary with different styles) is placed.
11009 If you want to have other environments within this one—for example, Case
11010 environments—and have the QED symbol appear only after them, then the other
11011 environments need to be nested within the proof environment.
11014 Nesting Environments
11020 for information on nesting.
11023 \begin_layout Standard
11024 And these environments are provided by
11025 \begin_inset Flex Code
11028 \begin_layout Plain Layout
11029 Theorems (AMS-Extended)
11037 \begin_layout Criterion*
11038 A required condition.
11041 \begin_layout Algorithm*
11042 A general procedure to be used.
11045 \begin_layout Axiom*
11046 This is a property or statement taken as true within the system being discussed.
11049 \begin_layout Condition*
11050 Sometimes used to state a condition assumed within the present context of
11054 \begin_layout Note*
11055 Similar to a Remark.
11058 \begin_layout Notation*
11059 Used for the explanation of, yes, notation.
11062 \begin_layout Summary
11063 Do we really need to tell you?
11066 \begin_layout Acknowledgement*
11070 \begin_layout Conclusion*
11071 Sometimes used at the end of a long train of argument.
11075 Used in a way similar to Proposition, though perhaps lower on the scale.
11078 \begin_layout Standard
11079 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
11082 They need to be available on your system in order to use these environments.
11085 \begin_layout Section
11093 \begin_layout Standard
11099 \begin_layout Subsection
11103 \begin_layout Standard
11104 These are the layout files for some of the journals of the American Geophysical
11106 It is assumed that you have both the AGU's own class files and AGUplus
11107 installed (everything to be found at
11108 \begin_inset Flex URL
11111 \begin_layout Plain Layout
11113 http://publications.agu.org/files/2013/08/AGU-LaTeX.zip
11121 \begin_layout Subsection
11125 \begin_layout Standard
11135 They are still called this in the \SpecialChar LyX
11136 GUI, though their \SpecialChar LaTeX
11149 \begin_layout Standard
11150 Newly defined styles are
11187 These are mostly manuscript attributes and defined in the AGU class documentati
11191 \begin_layout Standard
11192 I suspect this is still badly incomplete.
11195 \begin_layout Subsection
11199 \begin_layout Standard
11216 \begin_layout Subsection
11220 \begin_layout Itemize
11223 Journal of Geophysical Research
11232 \begin_layout Standard
11233 Add your own, it isn't so hard! Look at the
11244 \begin_layout Subsection
11245 Bugs and things to remember
11248 \begin_layout Standard
11249 In order to use the new layouts, you must remember to do the following for
11253 \begin_layout Enumerate
11259 This can be done in the
11261 Layout\SpecialChar menuseparator
11266 Document\SpecialChar menuseparator
11270 (AGU articles are always in English, right? So
11274 choose a language.)
11277 \begin_layout Enumerate
11282 into the document's
11287 (Yes, this is a bug.)
11290 \begin_layout Enumerate
11291 Make sure you use the
11295 bibliography style, by entering
11299 into the second field of the Bib\SpecialChar TeX
11301 None of the standard styles will do.
11304 \begin_layout Section
11308 \begin_layout Standard
11314 \begin_layout Subsection
11318 \begin_layout Standard
11319 Broadway is for writing plays.
11320 The format is more decorative than Hollywood, and much less standardized.
11321 This format should be suitable for workshops.
11324 \begin_layout Subsection
11328 \begin_layout Standard
11329 The same as in Hollywood.
11332 \begin_layout Subsection
11336 \begin_layout Standard
11341 names as labels then cross-reference the label to insert the name.
11342 The cross-reference dialog will show the current cast of characters.
11345 \begin_layout Subsection
11346 Paper size and Margins
11349 \begin_layout Standard
11350 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
11353 \begin_layout Subsection
11357 \begin_layout Standard
11358 The following environments are available.
11359 You can use broadway.bind to get the bind keys shown at the right.
11362 \begin_layout Itemize
11366 \begin_inset Newline newline
11371 You should not have to use this, but it is here for anything that does not
11375 \begin_layout Itemize
11379 \begin_inset space \hfill{}
11383 \begin_inset Newline newline
11388 Used to describe stage setting and the action.
11389 First use of speaker names in all CAPs.
11392 \begin_layout Itemize
11396 \begin_inset space \hfill{}
11400 \begin_inset Newline newline
11405 Automatically numbered.
11406 On screen it will be arabic, but will print as Roman.
11409 \begin_layout Itemize
11413 \begin_inset space \hfill{}
11417 \begin_inset Newline newline
11427 It is just centered text.
11430 \begin_layout Itemize
11434 \begin_inset space \hfill{}
11438 \begin_inset Newline newline
11443 Not automatically numbered.
11444 You supply the number.
11445 This is because I couldn't figure out how.
11448 \begin_layout Itemize
11452 \begin_inset space \hfill{}
11456 \begin_inset Newline newline
11461 A special case of Narrative to describe the setting and action as the curtain
11465 \begin_layout Itemize
11469 \begin_inset space \hfill{}
11473 \begin_inset Newline newline
11478 The speaker's (actor's) title, centered in all CAPS.
11481 \begin_layout Itemize
11485 \begin_inset space \hfill{}
11489 \begin_inset Newline newline
11494 Instructions to the speaker.
11495 The parentheses are automatically inserted.
11496 The ( will appear on screen, but both will be in the printed play.
11497 This environment is only used within
11504 \begin_layout Itemize
11508 \begin_inset space \hfill{}
11512 \begin_inset Newline newline
11517 What the Speaker says.
11520 \begin_layout Itemize
11524 \begin_inset space \hfill{}
11528 \begin_inset Newline newline
11533 The curtain comes down.
11536 \begin_layout Itemize
11540 \begin_inset space \hfill{}
11546 \begin_layout Itemize
11550 \begin_inset space \hfill{}
11556 \begin_layout Itemize
11560 \begin_inset space \hfill{}
11566 \begin_layout Standard
11570 \begin_layout Section
11574 \begin_layout Standard
11579 can be used to type letters according to German conventions.
11580 A template file is included in
11582 .../lyx/share/templates
11584 for you to use as a starting point.
11587 \begin_layout Section
11595 \begin_layout Standard
11601 \begin_layout Subsection
11605 \begin_layout Standard
11606 This is the layout file for the European Geophysical Society journals.
11611 can be downloaded from the web site of the EGS under
11612 \begin_inset Flex URL
11615 \begin_layout Plain Layout
11625 \begin_layout Subsection
11629 \begin_layout Standard
11632 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
11640 The current layout file is unfortunately very unmodular and would benefit
11641 from using the various
11648 \begin_layout Section
11652 \begin_layout Standard
11653 See the \SpecialChar LyX
11659 It contains all infos you need.
11662 \begin_layout Section
11665 Foil\SpecialChar TeX
11669 \begin_inset CommandInset label
11678 \begin_layout Standard
11684 \begin_layout Subsection
11688 \begin_layout Standard
11689 This section describes how to use \SpecialChar LyX
11690 to make slides for overhead projectors.
11691 There are two document classes that can do this: the default slides class
11694 Foil\SpecialChar TeX
11698 This section documents the latter.
11701 \begin_layout Standard
11702 I'm going to say this again, nice and clear, so that there's no misunderstanding
11706 \begin_layout Standard
11707 \begin_inset VSpace bigskip
11713 \begin_layout Standard
11717 This section documents the class
11718 \begin_inset Quotes eld
11726 \begin_inset Quotes erd
11734 \begin_layout Standard
11735 \begin_inset VSpace bigskip
11741 \begin_layout Standard
11742 If you're looking for the documentation for
11743 \begin_inset Quotes eld
11751 \begin_inset Quotes erd
11754 , check out section
11755 \begin_inset space ~
11759 \begin_inset CommandInset ref
11761 reference "sec:slitex"
11766 If your machine doesn't have the
11774 installed, you'll probably have to use the default
11778 class, which isn't quite as good as
11783 \begin_layout Standard
11788 class is designed for use with version
11789 \begin_inset space ~
11797 class file which is now an integral part of \SpecialChar LaTeX2e
11801 \begin_layout Subsection
11805 \begin_layout Standard
11806 Obviously, to use this document class, you need to select
11817 \begin_inset space ~
11823 There are some settings in the
11826 \begin_inset space ~
11831 dialog that you should know about that are specific to this class:
11834 \begin_layout Itemize
11835 Don't change the options
11846 \begin_inset space ~
11852 They're ignored by the
11859 \begin_layout Itemize
11860 The default font size is 20
11861 \begin_inset space \thinspace{}
11864 pt with the other options being 17
11865 \begin_inset space \thinspace{}
11869 \begin_inset space \thinspace{}
11873 \begin_inset space \thinspace{}
11879 \begin_layout Itemize
11880 The default font is
11888 but all math equations are still typeset in the usual roman font.
11891 \begin_layout Itemize
11894 Foil\SpecialChar TeX
11897 supports A4 and Letter paper sizes as well as a special size for working
11899 \begin_inset space \thinspace{}
11903 It doesn't support A5, B5, legal or executive paper sizes.
11906 \begin_layout Itemize
11907 Don't bother changing the
11911 settings because they are ignored anyway.
11912 All floats appear where they are defined in the text.
11915 \begin_layout Itemize
11920 setting behaves a bit differently for this class.
11923 Foil\SpecialChar TeX
11926 provides extensive footer and header capabilities including a user-defined
11929 \begin_inset space ~
11933 \begin_inset CommandInset ref
11935 reference "sec:foilfoot"
11940 The title page is treated differently to all other pages in the document
11949 has the logo centered at the bottom of the page (if one is defined).
11950 The possible page style choices and what they do are as follows:
11954 \begin_layout Labeling
11955 \labelwidthstring MMMMMMM
11962 The final output contains no page numbers, or other headers or footers
11963 (except footnotes of course).
11967 \begin_layout Labeling
11968 \labelwidthstring MMMMMMM
11975 The final output contains page numbers centered at the bottom of the page.
11976 No other headings or footers (other than footnotes).
11979 \begin_layout Labeling
11980 \labelwidthstring MMMMMMM
11985 Page numbers in lower right corner.
11986 Additional headers and footers are also shown.
11987 This is also the default.
11990 \begin_layout Labeling
11991 \labelwidthstring MMMMMMM
11996 Gives you access to the
12000 package although its use with
12002 Foil\SpecialChar TeX
12005 is discouraged by the writer of the
12007 Foil\SpecialChar TeX
12010 package because of some potential page layout clashes.
12014 \begin_layout Subsubsection
12018 \begin_layout Standard
12019 The following options may be used in the extra class options in the
12021 Document\SpecialChar menuseparator
12027 \begin_layout Labeling
12028 \labelwidthstring MMMMMMx
12033 This sets up the page layout for 7.33
12034 \begin_inset space \thinspace{}
12038 \begin_inset space \thinspace{}
12041 in paper, which is about the same aspect ratio as a 35
12042 \begin_inset space \thinspace{}
12045 mm slide, making it a bit easier to work with this medium.
12048 \begin_layout Labeling
12049 \labelwidthstring MMMMMMx
12054 Places a rule across the page below the header on every page except the
12058 \begin_layout Labeling
12059 \labelwidthstring MMMMMMx
12064 Places a rule across the page above the footer on every page except the
12068 \begin_layout Labeling
12069 \labelwidthstring MMMMMMx
12074 This is automatically set each time you create a new
12081 Foil\SpecialChar TeX
12084 to use the dvips driver to rotate those pages that are set as landscape
12088 \begin_layout Labeling
12089 \labelwidthstring MMMMMMx
12094 Simply changes the page dimensions to those of a landscape page but doesn't
12096 Thus if you use this option you need to use an external program to rotate
12097 each page or feed your paper through your printer as landscape.
12098 Note that this option effectively reverses the roles of the
12106 environments (don't worry these are described in the next section).
12109 \begin_layout Labeling
12110 \labelwidthstring MMMMMMx
12115 Equation numbers on the left.
12118 \begin_layout Labeling
12119 \labelwidthstring MMMMMMx
12124 Flush-left equations.
12127 \begin_layout Subsection
12128 Supported Environments
12131 \begin_layout Standard
12132 Most of the environments commonly supported in other classes are also supported
12138 There are several additional environments provided by
12140 Foil\SpecialChar TeX
12143 as well as a couple added by \SpecialChar LyX
12145 The following environments are shared with other classes:
12148 \begin_layout Standard
12149 \begin_inset Flex Multiple Columns
12152 \begin_layout Itemize
12158 \begin_layout Itemize
12164 \begin_layout Itemize
12170 \begin_layout Itemize
12176 \begin_layout Itemize
12182 \begin_layout Itemize
12189 \begin_layout Itemize
12195 \begin_layout Itemize
12201 \begin_layout Itemize
12207 \begin_layout Itemize
12211 \change_deleted -712698321 1501158884
12215 \begin_layout Itemize
12221 \begin_layout Itemize
12227 \begin_layout Itemize
12233 \begin_layout Itemize
12239 \begin_layout Itemize
12245 \begin_layout Itemize
12251 \begin_layout Itemize
12253 \change_deleted -712698321 1501158888
12261 \begin_layout Itemize
12263 \change_deleted -712698321 1501158891
12276 \begin_layout Standard
12277 That is, all the major environments apart from the sectioning environments.
12278 Since foils are essentially self-contained sections, with a title and body,
12281 Foil\SpecialChar TeX
12284 provides specific commands for starting new foils and these are:
12287 \begin_layout Itemize
12293 \begin_layout Itemize
12299 \begin_layout Standard
12301 also provides slightly modified versions of these two environments called:
12304 \begin_layout Itemize
12310 \begin_layout Itemize
12313 ShortRotatefoilhead
12316 \begin_layout Standard
12317 and the differences will be explained in the next section.
12320 \begin_layout Standard
12321 Since foils are often used in presenting ideas or new theorems and such
12324 Foil\SpecialChar TeX
12327 also provides a comprehensive box of goodies for presenting them:
12330 \begin_layout Standard
12331 \begin_inset Flex Multiple Columns
12334 \begin_layout Itemize
12340 \begin_layout Itemize
12346 \begin_layout Itemize
12352 \begin_layout Itemize
12358 \begin_layout Itemize
12364 \begin_layout Itemize
12370 \begin_layout Itemize
12376 \begin_layout Itemize
12382 \begin_layout Itemize
12388 \begin_layout Itemize
12394 \begin_layout Itemize
12405 \begin_layout Standard
12406 The starred versions are unnumbered while the unstarred versions are numbered.
12407 There are also two list environments added by \SpecialChar LyX
12411 \begin_layout Itemize
12417 \begin_layout Itemize
12423 \begin_layout Standard
12426 Foil\SpecialChar TeX
12429 provides some powerful header and footer capabilities that are best set
12430 in the preamble although they may be set at any point in a document.
12431 If you want to change these settings in your document the best place to
12432 do so is at the very top of a foil, i.
12433 \begin_inset space \thinspace{}
12439 \begin_inset space \space{}
12444 straight after the foilhead.
12447 \begin_layout Standard
12448 For this purpose, the following command styles are provided [
12455 \begin_layout Standard
12456 \begin_inset Flex Multiple Columns
12459 \begin_layout Itemize
12463 \begin_inset space ~
12469 \begin_layout Itemize
12475 \begin_layout Itemize
12479 \begin_inset space ~
12485 \begin_layout Itemize
12489 \begin_inset space ~
12495 \begin_layout Itemize
12499 \begin_inset space ~
12506 \begin_layout Plain Layout
12507 \begin_inset space ~
12519 \begin_layout Standard
12520 There are also a few commands provided by
12522 Foil\SpecialChar TeX
12525 that aren't directly supported by \SpecialChar LyX
12526 but I'll tell you what they do and how
12527 to use them in section
12528 \begin_inset space ~
12532 \begin_inset CommandInset ref
12534 reference "sec:unsuppfoils"
12541 \begin_layout Subsection
12542 Building a Set of Foils
12545 \begin_layout Standard
12546 This section will give a simple introduction to using the different environments
12547 to build a set of foils.
12548 If you want to see an example set of foils, take a look at the
12552 file you find in \SpecialChar LyX
12560 \begin_layout Subsubsection
12561 Give It a Title Page
12564 \begin_layout Standard
12565 Unlike other classes that provide
12585 creates the title on a page of its own.
12586 If you leave out the
12590 environment \SpecialChar LaTeX
12591 will substitute the current date (every time you regenerate
12595 \begin_layout Subsubsection
12599 \begin_layout Standard
12600 As I mentioned earlier, there are four ways of starting a new foil.
12601 For portrait foils you should use
12610 The difference between these two environments is the amount of space between
12611 the title of the foil (the foilhead) and the body of the foil.
12614 \begin_layout Standard
12615 Landscape foils are generated using the
12621 ShortRotatefoilhead
12624 Again the only difference is the spacing between foilhead and body.
12625 Both of the short versions have 0.5
12626 \begin_inset space ~
12629 inches less separation between the foilhead and the body.
12633 \begin_layout Standard
12634 One problem with the support for landscape foils is the requirement that
12635 you have to use the
12639 driver to generate the PostScript output otherwise the foils won't be rotated.
12640 It is possible to get landscape foils even if you haven't got the
12644 driver provided you can feed your foils sideways through your printer ;-)
12647 \begin_layout Subsubsection
12648 Theorems, Lemmas, Proofs and more
12651 \begin_layout Standard
12653 \change_deleted -712698321 1501160146
12654 Due to a small bug in \SpecialChar LyX
12656 \change_inserted -712698321 1501160146
12659 ou can't have two of the same type of these environments directly following
12662 \change_inserted -712698321 1501160182
12663 If you use a normal paragraph break,
12664 \change_deleted -712698321 1501160188
12665 They must be separated by something.
12668 , you will just be extending the previous environment as if you had merged
12669 the two environments together.
12671 \change_deleted -712698321 1501160194
12672 So, how do you get around this problem? The simplest option is to insert
12673 some text between the two environments or add a
12678 environment between the two with just a
12679 \begin_inset Quotes eld
12687 \begin_inset Quotes erd
12691 This will force \SpecialChar LyX
12692 to produce two separate environments and hence the correct
12695 An example is provided in the example file included with the \SpecialChar LyX
12697 Remember, this problem only occurs if you are trying to place two of the
12698 same type of theorem-like environments one directly after the other.
12700 \change_inserted -712698321 1501160255
12701 Rather than that, you need to insert a so-called separator.
12702 Please refer to the section entitled
12715 \begin_layout Subsubsection
12719 \begin_layout Standard
12720 You get all the commonly supported list styles found in other classes as
12721 well as two new ones.
12722 I'll only describe the new ones here.
12723 If you want to find out more about the other list environments check out
12729 If you intend to use itemized lists you might also want to read about the
12733 \begin_inset space ~
12737 \begin_inset space ~
12742 dialog described above in section
12743 \begin_inset space ~
12747 \begin_inset CommandInset ref
12749 reference "sec:bullet"
12756 \begin_layout Standard
12757 The two new list styles,
12765 , are designed to make it easier for you to create lists of do's and don'ts
12766 or right and wrong by providing dedicated environments that use a tick
12767 or a cross as the label of the list.
12768 These lists are in fact dedicated variants of the
12773 They do however require that you have the
12777 packages installed.
12780 \begin_layout Subsubsection
12784 \begin_layout Standard
12787 Foil\SpecialChar TeX
12790 redefines the floating tables and figures so that they appear exactly where
12791 they are in the text rather than pushing them to the top of the page or
12792 to some user specified location.
12793 In fact if you change the float placement settings they are simply ignored.
12796 \begin_layout Subsubsection
12797 Page Headers and Footers
12798 \begin_inset CommandInset label
12800 name "sec:foilfoot"
12807 \begin_layout Standard
12811 \begin_inset space ~
12820 are two commands used to control the left-footer text string.
12821 The first is meant to allow you to include a graphic logo on your foils
12823 \begin_inset Quotes eld
12828 Foil\SpecialChar TeX
12832 \begin_inset Quotes erd
12836 While the second is meant to provide a classification for the audience,
12840 \begin_inset space \thinspace{}
12846 \begin_inset space \space{}
12850 It is empty by default.
12853 \begin_layout Standard
12854 The remaining page corners can be filled by
12857 \begin_inset space ~
12862 (which defaults to page numbers),
12865 \begin_inset space ~
12873 \begin_inset space ~
12881 \begin_layout Subsection
12884 Foil\SpecialChar TeX
12888 \begin_inset CommandInset label
12890 name "sec:unsuppfoils"
12897 \begin_layout Standard
12898 All the commands mentioned below need to be set in a
12908 within another environment.
12911 \begin_layout Subsubsection
12915 \begin_layout Standard
12916 All lengths are adjusted using the
12939 should be replaced by the name given to the length you want to change and
12944 is the length value.
12945 All lengths should be specified in units of length such as inches (
12957 ) or relative to some document or font-based length such as
12967 \begin_layout Standard
12968 It's possible to change the spacing between a foilhead and the body of the
12969 foil by adjusting the length specified by
12976 For example, to make
12981 \begin_inset space \space{}
12984 in closer to their bodies put the following in the preamble:
12990 foilheadskip}{-0.5in}
12993 \begin_layout Standard
12994 The spacings around floats can be adjusted by setting these lengths:
12997 \begin_layout Labeling
12998 \labelwidthstring MMMMMMMMMMM
13005 Separation between the text and the top of the float
13008 \begin_layout Labeling
13009 \labelwidthstring MMMMMMMMMMM
13016 Separation between the float and the caption
13019 \begin_layout Labeling
13020 \labelwidthstring MMMMMMMMMMM
13027 Separation between the caption and the following text
13030 \begin_layout Labeling
13031 \labelwidthstring MMMMMMMMMMM
13038 You can make the captions narrower than the surrounding text by adjusting
13040 Best done relative to
13049 \begin_layout Standard
13050 There are also several title page related lengths that you may find useful
13051 if you have a long title or several authors:
13054 \begin_layout Labeling
13055 \labelwidthstring MMMMMMMMMMM
13062 Separation from headers to
13067 \begin_layout Labeling
13068 \labelwidthstring MMMMMMMMMMM
13086 \begin_layout Labeling
13087 \labelwidthstring MMMMMMMMMMM
13101 \begin_layout Labeling
13102 \labelwidthstring MMMMMMMMMMM
13118 \begin_layout Labeling
13119 \labelwidthstring MMMMMMMMMMM
13135 \begin_layout Standard
13136 The last length related command affects all the list environments.
13147 a list environment then all the vertical spacing between the list items
13149 Note that this is a command not a length so it doesn't require
13155 like the stuff mentioned above.
13158 \begin_layout Subsubsection
13159 Headers and Footers
13162 \begin_layout Standard
13175 commands control whether the logo in the
13179 definition appear on a given page.
13186 in the preamble then none of the foils will have the logo on them.
13187 If you don't want the logo on a particular page place the
13193 directly after the foilhead of that page and the
13199 directly after the next foilhead.
13202 \begin_layout Standard
13203 If you decide to use the
13207 page style setting in the
13210 \begin_inset space ~
13215 dialog you should probably add
13225 to your preamble so headers and footers on landscape pages are correctly
13226 placed when rotated.
13227 This is due to some clashes between the page layouts provided by the
13238 \begin_layout Section
13239 Hollywood (Hollywood spec scripts)
13242 \begin_layout Standard
13248 \begin_layout Subsection
13252 \begin_layout Standard
13253 Getting the format of a Hollywood script right is a
13254 \begin_inset Quotes eld
13258 \begin_inset Quotes erd
13261 It is designed to make the readers focus on content and to be easy and
13262 familiar for the actors to read.
13263 Each page of a script should be one minute of film.
13264 Nothing goes in a script that you cannot see or hear on screen.
13265 The courier 12 pt font should be used throughout.
13269 \begin_layout Subsection
13273 \begin_layout Standard
13274 Speakers' lines should NEVER break in mid-sentence.
13275 If a speaker's lines continue over a page break, repeat the
13279 title followed by (Cont'd).
13282 \begin_layout Subsection
13286 \begin_layout Standard
13291 names as labels then cross-reference the label to insert the name.
13292 The cross-reference dialog will show the current cast of characters.
13293 You can use this to insert the speaker name in narratives also.
13296 \begin_layout Subsection
13297 Paper size and Margins
13300 \begin_layout Standard
13301 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
13304 \begin_layout Subsection
13308 \begin_layout Standard
13309 The following environments are available.
13310 You can use hollywood.bind to get the bind keys shown at the right.
13313 \begin_layout Itemize
13317 \begin_inset Newline newline
13322 Used where nothing else works.
13326 \begin_layout Itemize
13332 \begin_inset space \hfill{}
13340 \begin_inset Newline newline
13343 Usually followed by something like
13344 \begin_inset Quotes eld
13347 on Sally waking up.
13348 \begin_inset Quotes erd
13354 \begin_layout Itemize
13358 \begin_inset space \hfill{}
13362 \begin_inset Newline newline
13367 Introduces a new INTERIOR camera set-up.
13368 Always followed by DAY or NIGHT, or something similar to define the lighting
13370 Everthing on this line in CAPS.
13373 \begin_layout Itemize
13377 \begin_inset space \hfill{}
13381 \begin_inset Newline newline
13386 Introduces a new EXTERIOR camera set-up.
13387 Everthing on this line in CAPS.
13390 \begin_layout Itemize
13394 \begin_inset space \hfill{}
13398 \begin_inset Newline newline
13403 The character speaking.
13406 \begin_layout Itemize
13410 \begin_inset space \hfill{}
13414 \begin_inset Newline newline
13419 Instructions to the speaker.
13420 The () are automatically inserted
13421 \change_deleted -712698321 1501161286
13422 , but only the ( will show in \SpecialChar LyX
13424 Both will be printed
13429 \begin_layout Itemize
13433 \begin_inset space \hfill{}
13437 \begin_inset Newline newline
13449 \begin_layout Itemize
13453 \begin_inset space \hfill{}
13457 \begin_inset Newline newline
13462 Camera movement instruction.
13464 \begin_inset space \thinspace{}
13468 \begin_inset space \space{}
13474 \begin_layout Itemize
13478 \begin_inset space \hfill{}
13484 \begin_layout Itemize
13488 \begin_inset space \hfill{}
13494 \begin_layout Itemize
13498 \begin_inset space \hfill{}
13504 \begin_layout Itemize
13508 \begin_inset space \hfill{}
13514 \begin_layout Subsection
13518 \begin_layout Itemize
13522 \begin_layout Itemize
13526 \begin_layout Itemize
13528 \begin_inset space \thinspace{}
13535 \begin_layout Itemize
13540 \begin_layout Itemize
13541 PAN — camera movement
13544 \begin_layout Itemize
13545 INSERT — cut to close-up of
13548 \begin_layout Section
13552 \begin_layout Standard
13555 Panayotis Papasotiriou
13558 \begin_layout Subsection
13562 \begin_layout Standard
13563 The ijmpc package is a set of macros that facilitates electronic manuscript
13566 International Journal of Modern Physics C
13569 Similarly, the ijmpd package is for creating manuscripts to be submitted
13572 International Journal of Modern Physics D
13575 Both journals are published by World Scientific.
13576 The corresponding document classes are named
13585 These files, together with instructions for the authors, can be downloaded
13587 \begin_inset Flex URL
13590 \begin_layout Plain Layout
13592 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
13598 \begin_inset Flex URL
13601 \begin_layout Plain Layout
13603 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
13609 Both packages are modified versions of the standard
13610 \begin_inset Quotes eld
13614 \begin_inset Quotes erd
13617 package, and they are almost (but not exactly) identical.
13618 Most of their features are supported by \SpecialChar LyX
13620 I have used \SpecialChar LyX
13621 successfully to write articles submitted to both journals
13622 without any problem.
13625 \begin_layout Subsection
13629 \begin_layout Standard
13630 As usual, the easiest way to write a paper is to start with a template.
13633 File\SpecialChar menuseparator
13649 This will give an (almost) empty document that includes the most common
13650 fields found in a manuscript.
13651 Simply overwrite the existing text (including the brackets,
13656 You should keep in mind the following remarks.
13659 \begin_layout Enumerate
13661 won't let you change the font size and the page style of the document,
13662 because such modifications are not allowed by both packages.
13665 \begin_layout Enumerate
13666 The language of the document should not be changed.
13667 Before previewing your paper, be sure that the babel package is not used.
13668 To do this, click on
13669 \change_inserted -712698321 1501082726
13673 arg "dialog-show document"
13679 \change_deleted -712698321 1501082743
13684 \SpecialChar menuseparator
13686 \change_deleted -712698321 1501082747
13688 \change_inserted -712698321 1501082748
13694 \change_deleted -712698321 1501082762
13703 checkbox in the language settings, and click on
13711 , if you wish to make this change permanent)
13712 \change_inserted -712698321 1501082770
13714 \begin_inset Quotes eld
13718 \begin_inset Quotes erd
13730 \begin_layout Enumerate
13732 \begin_inset Quotes eld
13736 \begin_inset Quotes erd
13739 style must be used to define keywords.
13742 \begin_layout Enumerate
13743 The ijmpc package provides a style named
13744 \begin_inset Quotes eld
13747 Classification Codes
13748 \begin_inset Quotes erd
13751 , which can be used to define classification codes, such as PACS numbers.
13752 Note that this facility is not supported by the ijmpd package.
13755 \begin_layout Enumerate
13756 Several new environments are available:
13757 \begin_inset Quotes eld
13761 \begin_inset Quotes erd
13765 \begin_inset Quotes eld
13769 \begin_inset Quotes erd
13773 \begin_inset Quotes eld
13777 \begin_inset Quotes erd
13781 \begin_inset Quotes eld
13785 \begin_inset Quotes erd
13789 \begin_inset Quotes eld
13793 \begin_inset Quotes erd
13797 \begin_inset Quotes eld
13801 \begin_inset Quotes erd
13805 \begin_inset Quotes eld
13809 \begin_inset Quotes erd
13813 \begin_inset Quotes eld
13817 \begin_inset Quotes erd
13821 \begin_inset Quotes eld
13825 \begin_inset Quotes erd
13829 \begin_inset Quotes eld
13833 \begin_inset Quotes erd
13837 \begin_inset Quotes eld
13841 \begin_inset Quotes erd
13845 \begin_inset Quotes eld
13849 \begin_inset Quotes erd
13853 \begin_inset Quotes eld
13857 \begin_inset Quotes erd
13861 \begin_inset Quotes eld
13865 \begin_inset Quotes erd
13869 Their use is more or less obvious.
13871 supports all these environments; it will use the proper label, text style,
13872 and numbering scheme for each of them.
13875 \begin_layout Enumerate
13876 Both packages use basic citations; the natbib package should not be used.
13877 In \SpecialChar LyX
13878 , citation references are shown as usual; in the output, citations are
13879 shown as superscripts.
13880 If you want to use a citation as normal text, you should use the
13885 \begin_inset space \thinspace{}
13889 \begin_inset space \space{}
13893 \begin_inset Quotes eld
13897 \begin_inset space \space{}
13907 \begin_inset Quotes erd
13913 \begin_layout Enumerate
13915 \begin_inset Quotes eld
13919 \begin_inset Quotes erd
13922 section in both packages.
13923 To put acknowledgments, just use the
13924 \begin_inset Quotes eld
13928 \begin_inset Quotes erd
13934 \begin_layout Enumerate
13935 Appendices may be added to the paper,
13939 the Acknowledgments and
13945 provides a special environment, called
13946 \begin_inset Quotes eld
13950 \begin_inset Quotes erd
13953 which marks the beginning of the appendices.
13954 This environment should be left blank; it just sends a \SpecialChar LaTeX
13955 command, but nothing
13957 In \SpecialChar LyX
13959 \begin_inset Quotes eld
13963 \begin_inset Quotes erd
13966 is printed with blue letters, as a signal that all sections after that
13967 point are appendices.
13968 To write an appendix, use the
13969 \begin_inset Quotes eld
13973 \begin_inset Quotes erd
13978 will number each appendix with capital letters, as required by both journals.
13980 \begin_inset Quotes eld
13984 \begin_inset Quotes erd
13991 be present before the first appendix; if not, all appendices will be numbered
13992 as normal sections in the output.
13995 \begin_layout Enumerate
13996 The ijmpc and the ijmpd packages use the
14000 command to implement table captions.
14001 As a result, a table created by \SpecialChar LyX
14002 is printed correctly, but its caption
14004 However, you can use some \SpecialChar TeX
14005 code to overcome this problem, so that captions
14006 are printed as expected.
14007 To do so, create a float table as usual, remove the caption, and replace
14008 it with the \SpecialChar TeX
14019 (sic); you must also the \SpecialChar TeX
14024 immediately after the tabular material.
14025 Study the example table included in the template files to see how this
14026 trick is implemented.
14027 Alternatively, If you need table captions, you should implement the whole
14032 file, then include this file to the \SpecialChar LyX
14035 Insert\SpecialChar menuseparator
14036 File\SpecialChar menuseparator
14038 \begin_inset space ~
14044 Details on how to create a table float can be found in the files
14052 , included in the corresponding packages.
14055 \begin_layout Subsection
14056 Preparing a paper for submission
14059 \begin_layout Standard
14060 Before you submit your paper you must export the \SpecialChar LyX
14061 document as a \SpecialChar LaTeX
14064 File\SpecialChar menuseparator
14065 Export\SpecialChar menuseparator
14073 \begin_layout Plain Layout
14074 Actually you have the choice between \SpecialChar LaTeX
14075 (plain) and pdflatex.
14076 If you intend to use pdflatex to prepare the paper, you should use the
14077 pdflatex option so that included graphics are converted to PDF format,
14078 ready for use by pdflatex.
14083 , then make the following changes to the resulting
14090 \begin_layout Enumerate
14091 Remove the comment lines before the
14100 \begin_layout Enumerate
14101 Remove everything between (and including) the
14113 commands, except for any commands you specifically put into the \SpecialChar LaTeX
14117 \begin_layout Standard
14122 file should be saved and processed through \SpecialChar LaTeX
14123 as many times as necessary.
14124 You may also want to check the resulting
14131 \begin_layout Subsection
14133 \change_deleted -712698321 1501082212
14134 Use of \SpecialChar TeX
14138 \begin_layout Standard
14140 \change_deleted -712698321 1501082212
14141 The use of \SpecialChar TeX
14142 code is reduced to two commands, which must be placed at the
14143 top of the document.
14144 If you started writing your paper by using the
14152 template, the \SpecialChar TeX
14153 code needed is already in its place; you usually don't need
14155 You may only modify the first \SpecialChar TeX
14156 code to specify the information printed
14157 to the top of odd and even pages (authors' names and short paper's title,
14159 This \SpecialChar TeX
14160 code must have the form
14164 markboth{Authors' Names}{Short Paper's Title}
14171 \begin_layout Section
14175 \begin_layout Standard
14181 \begin_layout Subsection
14185 \begin_layout Standard
14186 The iopart package provides a document class to create electronic manuscript
14187 submission to the journals published by the Institute of Physics.
14188 Instructions for the authors how to create a paper using the iopart class
14189 can be downloaded together with the iopart package from the site
14190 \begin_inset Flex URL
14193 \begin_layout Plain Layout
14195 ftp://ftp.iop.org/pub/journals/latex2e
14203 \begin_layout Subsection
14207 \begin_layout Standard
14208 The easiest way to write a paper is to start with the
14209 \change_deleted -712698321 1501162201
14211 \change_inserted -712698321 1501162202
14219 \change_deleted -712698321 1501162208
14220 in \SpecialChar LyX
14221 's examples files folder
14222 \change_inserted -712698321 1501162222
14225 File\SpecialChar menuseparator
14226 New From Template\SpecialChar ldots
14228 \change_deleted -712698321 1501162219
14235 \change_deleted -712698321 1501162234
14236 Open this file, save it under a new name, and start writing.
14240 \change_deleted -712698321 1501162238
14242 \change_inserted -712698321 1501162239
14245 explains how to use the special text environments.
14246 Here are the most important advices:
14249 \begin_layout Itemize
14250 To be able to compile your document to a PDF, PS, or DVI, ensure that the
14252 \change_deleted -712698321 1501162254
14255 Use AMS math package
14257 in the document settings under
14262 \change_inserted -712698321 1501162277
14263 no AMS packages are loaded in
14265 Document\SpecialChar menuseparator
14266 Settings\SpecialChar menuseparator
14274 \begin_layout Itemize
14277 The title environment defines the kind of your paper.
14278 So use one of the following environments for the title:
14282 \begin_layout Itemize
14291 \begin_layout Itemize
14300 \begin_layout Itemize
14306 for a Topical review
14309 \begin_layout Itemize
14318 \begin_layout Itemize
14327 \begin_layout Itemize
14333 for a Paper (same as Title)
14336 \begin_layout Itemize
14342 for a Preliminary communication
14345 \begin_layout Itemize
14351 for a Rapid communication
14354 \begin_layout Itemize
14360 for a Letter to the editor
14364 \begin_layout Itemize
14367 All title environments except of
14371 can have an optional short title.
14374 \begin_layout Itemize
14375 There is a general title environment
14379 which is not directly supported by
14380 \change_deleted -712698321 1501162663
14385 This can be used as \SpecialChar TeX
14386 code when your document doesn't fit into one of the
14390 \begin_layout Standard
14391 For more informations like hints for special table and formula formatting,
14392 look at the IOP author guidelines.
14395 \begin_layout Section
14399 \begin_layout Standard
14402 Panayotis Papasotiriou
14405 \begin_layout Subsection
14409 \begin_layout Standard
14410 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
14411 that facilitates electronic manuscript submission to the journals they
14413 Most known of them (at least in my domain of interest) are
14415 Astrophysics and Space Science
14421 , but there are many others (see a complete list at
14422 \begin_inset Flex URL
14425 \begin_layout Plain Layout
14427 http://www.wkap.nl/jrnllist.htm/JRNLHOME
14433 The Kluwer package may be downloaded from the site
14434 \begin_inset Flex URL
14437 \begin_layout Plain Layout
14439 http://www.wkap.nl/kaphtml.htm/STYLEFILES
14445 A complete user guide is contained in that package (but it can also be
14446 downloaded separately).
14449 \begin_layout Standard
14451 supports many features of the package but not everything.
14452 However, the \SpecialChar TeX
14453 code needed is reduced to some
14454 \begin_inset Quotes eld
14458 \begin_inset Quotes erd
14461 commands of the package (see
14462 \begin_inset space ~
14466 \begin_inset CommandInset ref
14468 reference "subsec:kluwer_peculiarities"
14473 I have recently used \SpecialChar LyX
14474 to write an article submitted to the
14476 Astrophysics and Space Science
14478 without any problem.
14481 \begin_layout Subsection
14485 \begin_layout Standard
14486 The easiest way to write a paper is to start with the Kluwer template file.
14489 File\SpecialChar menuseparator
14501 This will give an (almost) empty document that includes the most common
14502 fields found in a manuscript and a short description of their use.
14503 As in most templates, simply overwrite the existing text (including the
14508 ) with the correct information.
14511 \begin_layout Subsection
14512 Preparing a paper for submission
14515 \begin_layout Standard
14516 As in the AAS\SpecialChar TeX
14517 package, before you submit your paper to a journal you must
14519 \begin_inset Quotes eld
14523 \begin_inset Quotes erd
14529 \begin_layout Enumerate
14530 Export your paper as a \SpecialChar LaTeX
14532 To do this, click on
14534 File\SpecialChar menuseparator
14535 Export\SpecialChar menuseparator
14543 \begin_layout Enumerate
14548 file with a text editor and make the following changes
14552 \begin_layout Enumerate
14553 remove the comment lines before the
14562 \begin_layout Enumerate
14563 remove everything between (and including) the
14575 commands, except for any commands you specifically put into the \SpecialChar LaTeX
14579 \begin_layout Standard
14588 \begin_layout Enumerate
14593 file through \SpecialChar LaTeX
14594 as many times as necessary (usually up to three).
14597 \begin_layout Enumerate
14603 \begin_inset space \thinspace{}
14607 \begin_inset space \space{}
14614 , and check if everything is OK (it should, if you didn't make any mistake).
14617 \begin_layout Subsection
14618 \begin_inset Quotes eld
14622 \begin_inset Quotes erd
14625 of the Kluwer package
14626 \begin_inset CommandInset label
14628 name "subsec:kluwer_peculiarities"
14635 \begin_layout Standard
14636 The Kluwer package has the following
14637 \begin_inset Quotes eld
14641 \begin_inset Quotes erd
14647 \begin_layout Enumerate
14648 It is possible to write multiple articles in the same \SpecialChar LaTeX
14653 \begin_layout Plain Layout
14654 I can't imagine any good reason to do this.
14660 Each article must be included in the environment
14661 \begin_inset Quotes eld
14665 \begin_inset Quotes erd
14669 Unfortunately, this environment cannot be omitted, even if you write just
14671 Therefore, each article starts with the command
14677 and, obviously, ends with the command
14684 Although this can be implemented in \SpecialChar LyX
14685 , I didn't included it, since it looks
14686 ugly and can confuse the novice user.
14687 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
14690 \begin_inset Quotes eld
14695 \begin_inset Quotes erd
14701 \begin_layout Enumerate
14702 Information given at the beginning of the article (i.
14703 \begin_inset space \thinspace{}
14707 \begin_inset space \space{}
14710 title, subtitle, author, institution, running title, running author, abstract
14711 and keywords) must be included in an environment called
14712 \begin_inset Quotes eld
14716 \begin_inset Quotes erd
14720 This is not implemented in \SpecialChar LyX
14721 , so you must enter title, subtitle etc.
14722 \begin_inset space ~
14725 between two \SpecialChar TeX
14741 \begin_layout Enumerate
14742 According to the user manual, the label of each bibliography item must be
14766 \begin_layout Standard
14771 template takes care of all these
14772 \begin_inset Quotes eld
14776 \begin_inset Quotes erd
14780 If you start a new paper using this template you don't need to do anything
14785 \begin_layout Enumerate
14786 don't delete the \SpecialChar TeX
14787 code included in the template, and
14790 \begin_layout Enumerate
14791 copy the example bibliography item included in the template and modify it
14792 as necessary to enter new bibliography items.
14795 \begin_layout Section
14799 \begin_layout Standard
14805 \begin_layout Subsection
14809 \begin_layout Standard
14810 The \SpecialChar LyX
14813 article (koma-script)
14817 report (koma-script)
14835 correspond to the \SpecialChar LaTeX
14853 \begin_inset space ~
14856 of the Koma-Script family.
14857 They are replacements for the standard document classes
14873 , resp., and fit better to European typography conventions in a number of
14877 \begin_layout Itemize
14878 Standard character size is 11pt in
14880 article (koma-script)
14884 report (koma-script)
14892 letter (koma-script)
14897 \begin_layout Itemize
14898 Headings, labels of the description environment, and a number of elements
14901 letter (koma-script)
14903 document class are set in a bold sans serif font.
14907 \begin_layout Plain Layout
14908 There is a big difference between the bold sans serif old cm fonts and new
14909 ec fonts, especially in the appearance of headings.
14910 In comparison, the ec bold sans serif fonts look a bit thin.
14911 Here the \SpecialChar LaTeX
14920 helps to produce the
14921 \begin_inset Quotes eld
14925 \begin_inset Quotes erd
14928 appearance when using the ec fonts.
14933 The numbering of chapter headings is made in the same way as the numbering
14934 of section headings, that is without the extra line
14935 \begin_inset Quotes eld
14938 Chapter\SpecialChar ldots
14940 \begin_inset Quotes erd
14944 In addition, the appearance of the headings can be modified by using a
14945 number of options (in \SpecialChar LyX
14946 to be entered in the field
14949 \begin_inset space ~
14956 Layout\SpecialChar menuseparator
14963 \begin_layout Itemize
14964 The main means in the Koma-Script document classes to design the type area
14973 (in \SpecialChar LyX
14974 to be entered in the extra class options field in the dialog
14976 Document\SpecialChar menuseparator
14980 They make a clearer modification of page margins possible as do the options
14983 Document\SpecialChar menuseparator
14990 \begin_layout Itemize
14991 The \SpecialChar LaTeX
14992 document classes of the Koma-Script family define a number of additional
14994 Those part of it which makes sense in \SpecialChar LyX
14995 is implemented in corresponding
14999 \begin_layout Standard
15000 Detailed descriptions of the \SpecialChar LaTeX
15001 document classes of the Koma-Script family
15002 can be found in the Koma-Script documentation
15013 \begin_layout Subsection
15014 article (koma-script), report (koma-script), and book (koma-script)
15017 \begin_layout Standard
15018 The document classes
15020 article (koma-script)
15024 report (koma-script)
15034 are implemented in the layout files
15047 They contain all the paragraph types of the corresponding standard document
15060 , resp., partly modified, with the exception of the \SpecialChar LyX
15065 -type, which is replaced by the new
15069 -type having the same functionality.
15074 -Type there is a number of new paragraph types added.
15081 letter (koma-script)
15086 \begin_layout Itemize
15095 : are equivalents to
15103 , resp., additionally inserting an entry in the table of contents.
15112 are not contained in
15114 article (koma-script)
15119 \begin_layout Itemize
15128 : behave exactly as
15136 , resp., additionally clearing running heads.
15141 is not contained in
15143 article (koma-script)
15149 \begin_layout Plain Layout
15162 report (koma-script)
15164 , but since this is identical to
15168 , is has not been implemented in \SpecialChar LyX
15177 \begin_layout Itemize
15182 : generates a heading directly above the following paragraph in the standard
15183 character size without affecting the structure of the document.
15186 \begin_layout Itemize
15195 are special captions which respect the different space settings needed
15196 for captions placed above or below an element (if you follow strict typographic
15197 rules, you might want to place table captions always above the table).
15198 You can also use the class option
15202 , which will switch
15215 You need at least Koma-Script version 2.8q to use this.
15218 \begin_layout Itemize
15223 : can be used to set a bonmot, e.
15224 \begin_inset space \thinspace{}
15228 \begin_inset space \space{}
15231 at the beginning of a chapter.
15232 If you use the optional argument (
15234 Insert\SpecialChar menuseparator
15236 \change_deleted -712698321 1501163301
15238 \begin_inset space ~
15242 \change_inserted -712698321 1501163306
15244 \begin_inset space ~
15251 ), you can insert the dictum's author there.
15252 Dictum and author are separated by a line.
15253 You need at least Koma-Script version 2.8q to use this.
15258 is not contained in
15260 article (koma-script)
15265 \begin_layout Standard
15266 The following types, together with the standard types
15278 , form the title area of the document.
15279 They must be entered ahead of the first
15280 \begin_inset Quotes eld
15284 \begin_inset Quotes erd
15291 \begin_layout Plain Layout
15292 The corresponding \SpecialChar LaTeX
15293 commands must appear before the
15304 When such a type is used more than once, the latter usage overwrites the
15305 former one, that means, for every type only the latest usage is valid.
15306 The order of the different types however has, like
15318 , no effect on the appearance of the produced document.
15321 \begin_layout Itemize
15326 : produces a centered paragraph above the ordinary title (
15338 ) for the subject of the document.
15341 \begin_layout Itemize
15346 : produces a centered paragraph below the ordinary title (
15358 ) for the publishers' name.
15361 \begin_layout Itemize
15368 report (koma-script)
15374 produces a centered paragraph on its own page behind the title page, or
15377 article (koma-script)
15379 produces a centered paragraph below the ordinary title (
15395 ) for a dedication.
15398 \begin_layout Itemize
15403 : produces a left aligned paragraph above the ordinary title (
15419 ) for a document`s head.
15422 \begin_layout Itemize
15427 : produces in a double-sided print in
15429 report (koma-script)
15435 a left-aligned paragraph at the top of the title page`s back or has no
15436 effect in a single-sided print or in
15438 article (koma-script)
15443 \begin_layout Itemize
15448 : produces in a double-sided print in
15450 report (koma-script)
15456 a left-aligned paragraph at the bottom of the title page`s back or has
15457 no effect in a single-sided print or in
15459 article (koma-script)
15464 \begin_layout Itemize
15469 : produces a special
15470 \begin_inset Quotes eld
15474 \begin_inset Quotes erd
15477 page ahead of the actual document containing a paragraph without special
15481 \begin_layout Standard
15482 The layout files for the document classes
15484 article (koma-script)
15488 report (koma-script)
15494 do include the file
15499 This is thought of as a place to define your own types.
15504 in your personal layout directory and edit the file!
15507 \begin_layout Subsection
15508 letter (koma-script)
15511 \begin_layout Description
15513 \change_inserted -712698321 1501163945
15514 Note: This section discusses the obsolete
15516 KOMA-Script-Letter (v.
15517 \begin_inset space ~
15522 , which is not even included anymore in recent KOMA releases.
15523 Please refer to the next section for the current KOMA-Script-Letter class
15525 \begin_inset space ~
15531 \begin_layout Standard
15535 letter (koma-script)
15537 is implemented in the layout file
15542 It contains all the paragraph types of the corresponding standard document
15547 , partly modified, with the exception of the \SpecialChar LyX
15561 type, which is replaced by the new
15566 In addition, it contains, in contrast to the standard document class, the
15585 Furthermore, there are a number of new letter specific types.
15588 \begin_layout Standard
15589 The appearance of the letter produced by this document class can be controlled
15590 by a number of \SpecialChar LaTeX
15591 commands, which you can put in the \SpecialChar LaTeX
15596 \begin_layout Plain Layout
15597 For example, the standard appearance of the letter`s heading, consisting
15598 of name and address, is quite self-willed.
15600 \begin_inset Quotes eld
15604 \begin_inset Quotes erd
15607 heading is produced by the following \SpecialChar LaTeX
15608 commands in the preamble:
15611 \begin_layout LyX-Code
15621 \begin_layout LyX-Code
15637 \begin_layout LyX-Code
15647 \begin_layout LyX-Code
15667 A detailed German description of such \SpecialChar LaTeX
15668 commands can be found in the Koma-Script
15674 With it, the letter's author can produce his personal letter layout.
15677 \begin_layout Standard
15686 define the beginning of the letter and must be used in every letter.
15687 To emphasize them in the \SpecialChar LyX
15688 document class, they are marked with the letter
15698 \begin_inset space ~
15701 in the left margin.
15702 It is possible to write any number of letters in one file.
15707 type produces a new letter using the same addressee and a
15711 type produces a new addressee.
15728 are ordinary paragraph types and can also be used several times in one
15729 and the same letter.
15732 \begin_layout Itemize
15737 : produces a paragraph for the addressee and implicitly defines the beginning
15741 \begin_layout Itemize
15746 : produces a paragraph for the form of address and implicitly produces a
15750 \begin_layout Itemize
15755 : produces a paragraph for a close.
15758 \begin_layout Itemize
15763 : produces a paragraph for a postscript.
15766 \begin_layout Itemize
15771 : produces a paragraph for a distribution list.
15774 \begin_layout Itemize
15779 : produces a paragraph for enclosures.
15782 \begin_layout Standard
15823 are input types provided with a label to enter information, which will
15824 be processed by the document class.
15828 \begin_layout Plain Layout
15829 It could be seen as a matter of inconsequence, that the types
15837 described above are not such input types as well.
15838 Because of the special meaning of those types, however, I have implemented
15839 them as ordinary paragraph types with a one letter mark in the left margin.
15840 Moreover, it would affect my feeling of symmetry, if the
15848 type had such a serious different appearance.
15853 The types must be used ahead of the corresponding
15860 \begin_layout Standard
15861 An implementation of these types in a WYSIWYG fashion does not seem to make
15862 sense, because the real appearance of the produced letter does not only
15863 depend on the usage of the particular type, but also on other factors.
15864 For example, a signature entered in the
15868 type will in the standard behavior appear in the produced letter only,
15869 when in the same letter also a
15874 The entered value of the
15878 type will in the standard behavior not appear in the produced letter at
15880 The possibility to design the letter`s heading freely is already indicated
15881 in a footnote above.
15884 \begin_layout Standard
15885 The input types can also be used as empty paragraphs.
15886 This makes sense e.
15887 \begin_inset space \thinspace{}
15891 \begin_inset space \space{}
15903 type is not used at all, in the standard behavior the value of the
15907 type is used as signature, whereas if an empty
15911 type is used, no signature value is defined.
15914 \begin_layout Standard
15915 By using the input types it is possible to write a letter template, containing
15916 filled input types with your personal dates (name, address, etc.) and empty
15917 input types for other dates you want to enter.
15920 \begin_layout Itemize
15925 : sender's name, in the standard behavior appears as a centered paragraph
15926 in small caps in the letter`s heading.
15929 \begin_layout Itemize
15934 : sender's signature, in the standard behavior appears below the
15943 type is used, the value of the
15947 type appears instead.
15950 \begin_layout Itemize
15955 : sender's address, in the standard behavior appears in a centered paragraph
15956 in the letter`s heading below the sender's name.
15959 \begin_layout Itemize
15964 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
15975 \begin_layout Itemize
15980 : place of the letter`s making.
15983 \begin_layout Itemize
15988 : date of the letter`s making.
15997 , in the standard behavior, produce the place and the date in a right-aligned
15998 line below the addressee's field.
16003 type is used, neither place nor date appear, independent of the value of
16013 type is used, the date of the letter `s production is used.
16016 \begin_layout Itemize
16021 : sender`s back address, in the standard behavior appears above the addressee's
16022 field in a small sans serif font.
16025 \begin_layout Itemize
16030 : special mail information, in the standard behavior appears underlined
16031 above the addressee's field below the back address.
16034 \begin_layout Itemize
16039 : additional information, in the standard behavior appears on right side
16040 below the addressee`s field.
16043 \begin_layout Itemize
16048 : the letter's title, in the standard behavior appears in a big, bold, sans
16049 serif font above the subject.
16052 \begin_layout Itemize
16057 : the letter's subject, in the standard behavior appears in a bold font
16065 \begin_layout Standard
16086 produce a business letter like line above the
16090 line containing the fields
16091 \begin_inset Quotes eld
16095 \begin_inset Quotes erd
16099 \begin_inset Quotes eld
16103 \begin_inset Quotes erd
16107 \begin_inset Quotes eld
16111 \begin_inset Quotes erd
16115 \begin_inset Quotes eld
16119 \begin_inset Quotes erd
16123 \begin_inset Quotes eld
16127 \begin_inset Quotes erd
16131 \begin_inset Quotes eld
16135 \begin_inset Quotes erd
16139 For the date field, the value of the
16145 \begin_inset Quotes eld
16148 business letter types
16149 \begin_inset Quotes erd
16152 is used, the value of the
16156 type however does not appear, but only the \SpecialChar LaTeX
16164 The ordinary output of place and date in a right-aligned line below the
16165 addressee`s field is suppressed.
16166 The types are implemented as input types provided with a label and must
16167 be used ahead of the corresponding
16174 \begin_layout Itemize
16182 \begin_layout Itemize
16190 \begin_layout Itemize
16198 \begin_layout Itemize
16206 \begin_layout Itemize
16214 \begin_layout Subsection
16215 The new letter class: letter (koma-script v.2)
16218 \begin_layout Standard
16224 \begin_layout Standard
16225 \begin_inset VSpace medskip
16231 \begin_layout Standard
16233 Koma-Script version 2.8 has introduced a new letter class
16237 which supersedes the now unsupported
16242 It has — on the \SpecialChar LaTeX
16243 side — a completely new interface and is not compatible
16244 with the old class.
16245 Therefore, \SpecialChar LyX
16246 supports both, though it is recommended you use the new class.
16249 \begin_layout Standard
16250 This class covers the same functionality as
16252 letter (koma-script),
16255 The basic items are
16259 (receiver's address, same as
16263 in the old layout),
16276 will start a new letter (i.
16277 \begin_inset space \thinspace{}
16281 \begin_inset space \space{}
16284 you can write several letters per document).
16285 New elements are sender's
16301 and the possibility to use a
16307 Insert\SpecialChar menuseparator
16313 \begin_layout Standard
16314 The biggest improvement is, though, that the letter's layout is configurable
16315 to meet almost any needs.
16316 This can be done via the preamble or with a special style file (Letter
16317 Class Option, extension
16321 ), that will be read in as a class option.
16325 \begin_layout Plain Layout
16326 The KOMA package comes with some default
16331 There is, for instance, a
16335 file that follows german typesetting rules, or a
16339 that provides the default layout of the old
16344 The latter can be loaded with the class option
16350 Layout\SpecialChar menuseparator
16351 Document\SpecialChar menuseparator
16363 template that is included in \SpecialChar LyX
16365 A detailed description is to be found in the Koma-Script documentation
16373 \begin_layout Subsection
16377 \begin_layout Standard
16378 Visualizing the Koma-Script document classes in \SpecialChar LyX
16379 , the \SpecialChar LyX
16380 internals cause some
16384 \begin_layout Itemize
16385 The chapter number of a
16389 type appears on a line of its own above the chapter heading instead of
16390 appearing in the same line ahead of it.
16391 The cause for that is the \SpecialChar LyX
16392 internal behavior for the labeltype
16396 in the layout file.
16399 \begin_layout Itemize
16400 The headings of the types
16408 are only put in the
16409 \begin_inset Quotes eld
16413 \begin_inset Quotes erd
16417 table of contents, but not in the \SpecialChar LyX
16418 table of contents (
16420 Document\SpecialChar menuseparator
16422 \begin_inset space ~
16426 \begin_inset space ~
16434 \begin_layout Itemize
16435 The paragraphs in a
16439 document class appear in a skip separation mode, not indented.
16440 This is the standard behavior, no special \SpecialChar LaTeX
16441 commands are needed for that.
16444 Document\SpecialChar menuseparator
16447 dialog the corresponding radio button indicates
16456 value always has the effect that extra \SpecialChar LaTeX
16457 commands are inserted in the document
16458 to produce the gap, which is not what is wanted in this case.
16461 \begin_layout Section
16465 \begin_layout Standard
16471 \begin_layout Subsection
16475 \begin_layout Standard
16476 Memoir is a very powerful and constantly evolving class.
16477 It has been designed with regard to fictional and non-fictional literature.
16478 Its aim is to let the user have maximum control over the typesetting of
16480 Memoir is based on the standard book class, but it can also emulate the
16481 article class (see below).
16484 \begin_layout Standard
16485 Peter Wilson, the developer of Memoir, is known as the author of lots of
16486 useful packages in the \SpecialChar LaTeX
16488 Most of them have been merged with Memoir.
16489 Therefore, it is much easier to layout the table of contents, appendices,
16490 chapter designs and such.
16492 , though, does not support all of these goodies natively.
16493 Some of them might be added to forthcoming releases
16497 \begin_layout Plain Layout
16498 You are invited to send suggestions to
16499 \begin_inset Flex URL
16502 \begin_layout Plain Layout
16504 lyx-devel@lists.lyx.org
16514 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
16516 Of course you can still use all features with the help of some native \SpecialChar LaTeX
16518 commands (\SpecialChar TeX
16523 \begin_layout Plain Layout
16528 \begin_layout Plain Layout
16538 \begin_inset space ~
16542 \begin_inset CommandInset ref
16544 reference "sec:Inserting-TeX-Code"
16554 In this section, we can only list those features that are natively supported
16555 by \SpecialChar LyX
16557 For detailed descriptions (and for the rest of features) we recommend you
16558 have a look at the detailed manual of the Memoir class
16562 \begin_layout Plain Layout
16567 \begin_layout Plain Layout
16577 \begin_inset Flex URL
16580 \begin_layout Plain Layout
16582 CTAN:/macros/latex/memoir/memman.pdf
16592 , which is not only a user guide for the class, but also both a comprehensive
16593 description on good typesetting and a superb example for good typesetting
16597 \begin_layout Subsection
16598 Basic features and restrictions
16601 \begin_layout Standard
16602 Memoir supports basically all features of the standard book classes.
16603 There are, however, some differences, as follows:
16606 \begin_layout Description
16608 \begin_inset space ~
16611 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
16614 \begin_layout Description
16616 \begin_inset space ~
16619 style: The fancy page style is not supported, due to a command clash between
16620 Memoir and the fancyhdr package (they both define a command with the same
16621 name, which confuses \SpecialChar LaTeX
16623 Instead, Memoir comes with a number of its own page styles (see
16624 \change_deleted -712698321 1501165256
16627 Layout\SpecialChar menuseparator
16630 Document\SpecialChar menuseparator
16632 \change_inserted -712698321 1501165264
16633 Settings\SpecialChar menuseparator
16637 \begin_inset space ~
16643 If you want to use these for the chapter pages, you have to use the command
16650 in the main text or in preamble (e.
16651 \begin_inset space \thinspace{}
16655 \begin_inset space \space{}
16662 chapterstyle{companion}
16667 \begin_layout Description
16668 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
16669 optional argument in the standard classes.
16670 With this, you can specify an alternative version of the title for the
16671 table of contents and the headers (for instance, if the title is too long).
16672 In \SpecialChar LyX
16673 , you can do this via
16675 Insert\SpecialChar menuseparator
16677 \begin_inset space ~
16682 at the beginning of a chapter/section.
16683 Memoir features a second optional argument and thus separates the table
16684 of contents from the header.
16685 You can define three variants of a title with this: one for the main text,
16686 one for the table of contents, and one for the headers.
16688 \change_deleted -712698321 1501165686
16689 Simply insert two optional arguments if you need this feature, the first
16690 one containing the short title for the Table of Contents, the second one
16691 containing an alternative short title for the headers
16692 \change_inserted -712698321 1501165708
16694 makes these available in form of specific
16707 \begin_layout Description
16708 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
16709 of contents, the list of figures and the list of table start a new page
16711 Memoir does not follow this route.
16712 You have to insert a page break yourself, if you want to have one.
16715 \begin_layout Description
16716 Titlepage: For some unknown reason, Memoir uses pagination on the title
16717 page (in the standard classes, title pages are
16718 \begin_inset Quotes eld
16722 \begin_inset Quotes erd
16726 If you want an empty title page, type
16730 aliaspagestyle{title}{empty}
16735 \begin_layout Description
16736 Article: With the class option
16741 \change_deleted -712698321 1501165976
16744 Layout\SpecialChar menuseparator
16747 Document\SpecialChar menuseparator
16749 \change_inserted -712698321 1501165986
16750 Settings\SpecialChar menuseparator
16751 Class Settings\SpecialChar menuseparator
16753 \change_deleted -712698321 1501165988
16755 \change_inserted -712698321 1501165989
16759 \begin_inset space ~
16764 ), you can emulate article style.
16765 That is, counters (footnotes, figures, tables etc.) will not be reset on
16766 new chapters, chapters don't start a new page (but are—in contrary to
16767 \begin_inset Quotes eld
16771 \begin_inset Quotes erd
16774 article classes—still allowed), parts, though, use their own page, as in
16778 \begin_layout Description
16779 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
16780 font commands, which have been used in the old \SpecialChar LaTeX
16782 \begin_inset space \thinspace{}
16786 \begin_inset space \space{}
16802 It produces an error and stops \SpecialChar LaTeX
16803 whenever such a command appears.
16808 reallows the commands and spits out warnings instead (which does at least
16809 not stop \SpecialChar LaTeX
16811 Since a lot of packages and particularly Bib\SpecialChar TeX
16812 style files are still using
16813 those commands, we have decided to use this option by default.
16816 \begin_layout Subsection
16820 \begin_layout Standard
16821 We will only describe the features supported by \SpecialChar LyX
16822 (which is not much currently).
16823 Please consult the Memoir manual
16827 \begin_layout Plain Layout
16832 \begin_layout Plain Layout
16842 \begin_inset Flex URL
16845 \begin_layout Plain Layout
16847 CTAN:/macros/latex/memoir/memman.pdf
16860 \begin_layout Description
16861 Abstract: You may wonder why an abstract is an extra feature.
16862 Well, it is in book class.
16863 Usually books don't have abstracts.
16864 Memoir, however, has.
16865 You can use it wherever and how often you like.
16868 \begin_layout Description
16869 Chapterprecis: You may know this older typesetting style: The contents of
16870 a chapter are summarized below the title and also in the table of contents
16872 \begin_inset space \thinspace{}
16876 \begin_inset space \space{}
16881 Our hero arrives in Troia; he loses some friends; he finds others
16884 Chapterprecis does exactly this.
16885 It is therefore only sensible below a chapter.
16888 \begin_layout Description
16889 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
16890 The epigraph environment provides an elegant way of typesetting such a
16892 The motto itself (text) and its
16893 \change_inserted -712698321 1501166968
16896 author (source) are divided by a short line.
16898 \change_deleted -712698321 1501166972
16899 Unfortunately, we have to fool \SpecialChar LyX
16900 a bit here again, since the environment
16901 needs two arguments (text and source).
16902 In this case, we have to use curly brackets (in \SpecialChar TeX
16903 mode) between the two
16914 <author of the slogan>
16915 \change_inserted -712698321 1501166996
16918 The author (source) can be inserted via
16920 Insert\SpecialChar menuseparator
16929 \begin_layout Description
16930 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
16931 complex figurative poems).
16933 can only support a few of them.
16934 One is poemtitle, which is a centered title for poems, which will also
16935 be added to the table of contents (verse is the standard environment for
16937 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
16939 because they have to be nested inside regular verse environments, which
16940 is not possible with \SpecialChar LyX
16944 \begin_layout Description
16945 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
16948 \begin_layout Section
16949 Article (mwart), book (mwbk) and report (mwrep)
16950 \begin_inset Argument status
16953 \begin_layout Plain Layout
16966 \begin_layout Standard
16972 \begin_layout Standard
16973 The \SpecialChar LyX
16990 correspond to the \SpecialChar LaTeX
17004 They are replacements for the standard document classes
17016 , resp., and fit better to Polish typography conventions in a number of points.
17020 \begin_layout Standard
17024 \begin_layout Itemize
17025 Unnumbered titles (with star, e.
17026 \begin_inset space \thinspace{}
17030 \begin_inset space \space{}
17037 ) are added into table of contents,
17040 \begin_layout Itemize
17041 Additional page styles:
17045 \begin_layout Description
17046 uheadings header with separated lines,
17049 \begin_layout Description
17050 myheadings custom header, contents headers via commands:
17065 \begin_layout Description
17066 myuheadings custom header with separated lines,
17069 \begin_layout Description
17070 outer page number is placed on outer side of page
17074 \begin_layout Itemize
17079 \begin_layout Description
17080 rmheadings serif titles — default,
17083 \begin_layout Description
17084 sfheadings sansserif titles,
17087 \begin_layout Description
17088 authortitle on title page first placed is author next title — default,
17091 \begin_layout Description
17092 titleauthor on title page first placed is title next author,
17095 \begin_layout Description
17096 withmarginpar reserve place on page for margins.
17100 \begin_layout Section
17104 \begin_layout Standard
17109 provides an alternative to the standard
17114 It provides similar functionality, but you might prefer this layout with
17115 sans serif sections, headings, and more.
17118 \begin_layout Section
17119 Rev\SpecialChar TeX
17123 \begin_layout Standard
17129 \begin_layout Standard
17130 \begin_inset VSpace bigskip
17136 \begin_layout Standard
17141 \begin_inset space ~
17146 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
17148 \begin_inset Formula $\beta$
17151 release of May, 1999) class.
17154 \begin_layout Standard
17160 textclass, which works with Rev\SpecialChar TeX
17162 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
17164 That means that it doesn't interact very well with \SpecialChar LyX
17165 , which requires \SpecialChar LaTeX2e
17167 it has been kludged to work.
17168 Since Rev\SpecialChar TeX
17169 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
17174 Rev\SpecialChar TeX
17176 \begin_inset space ~
17181 textclass should also be pretty easy to use.
17184 \begin_layout Standard
17185 These documents are supposed to be used in
17189 to the Rev\SpecialChar TeX
17190 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
17192 and assume you'll know what to put in the preamble if necessary.
17195 \begin_layout Subsection
17199 \begin_layout Standard
17200 All you need to do is install Rev\SpecialChar TeX
17201 4, as described in the package's README
17203 The package can be found at The Rev\SpecialChar TeX
17205 \begin_inset Flex URL
17208 \begin_layout Plain Layout
17210 http://publish.aps.org/revtex4/
17216 Install it somewhere that \SpecialChar LaTeX
17218 Test it by trying to \SpecialChar LaTeX
17219 a short Rev\SpecialChar TeX
17220 4 document in some random directory (i.
17221 \begin_inset space \thinspace{}
17225 \begin_inset space \space{}
17228 not the directory where you installed the class file.) Then, if you reconfigure
17230 , it will find the class file and let you use the Rev\SpecialChar TeX
17234 \begin_layout Standard
17235 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
17244 \begin_inset space ~
17249 template, found in the templates directory.
17252 \begin_layout Subsection
17256 \begin_layout Standard
17257 Optional arguments to
17264 \begin_inset Quotes eld
17268 \begin_inset Quotes erd
17272 \begin_inset Quotes eld
17276 \begin_inset Quotes erd
17282 \begin_inset space ~
17290 \begin_inset space ~
17296 Remember that in Rev\SpecialChar TeX
17297 , at least one optional argument is required!
17300 \begin_layout Standard
17301 Other preamble matter, like
17308 \begin_inset space ~
17315 \begin_inset space ~
17320 dialog, also as usual.
17323 \begin_layout Subsection
17327 \begin_layout Standard
17328 The layouts basically correspond to the commands in Rev\SpecialChar TeX
17330 For example, the Email layout corresponds to
17337 Note that (at least as of Rev\SpecialChar TeX
17346 layouts are exactly equivalent, so you shouldn't need to use both.
17350 \begin_layout Plain Layout
17351 In case you're curious, both were included so that
17355 would be able to translate both
17375 \begin_layout Subsection
17379 \begin_layout Standard
17380 There are a couple of important unique aspects of Rev\SpecialChar TeX
17381 4 which might cause
17382 bugs that will be even more confusing in \SpecialChar LyX
17386 \begin_layout Standard
17387 In Rev\SpecialChar TeX
17405 The \SpecialChar LyX
17406 equivalent is that there is a separate Thanks layout.
17411 write footnotes in the
17415 layout, or weird things may happen.
17416 See the Rev\SpecialChar TeX
17417 4 documentation for more details.
17420 \begin_layout Standard
17424 \begin_inset space ~
17432 \begin_inset space ~
17441 layouts must be placed
17449 layout and the corresponding
17466 , the \SpecialChar LaTeX
17470 \begin_layout Subsection
17472 \change_deleted -712698321 1501168252
17476 \begin_layout Standard
17478 \change_deleted -712698321 1501168252
17479 The main problem with this layout is that you can't use the optional arguments
17480 to layouts like Email and Title.
17481 (The problem is not unique to this layout; you can't use optional arguments
17482 to the Section layouts either.) This means that after you export that file
17483 to \SpecialChar LaTeX
17484 (which you'll need to do eventually to send it in to APS), you'll need
17485 to edit the \SpecialChar LaTeX
17486 file with a text editor to add the optional arguments to set,
17488 \begin_inset space \thinspace{}
17492 \begin_inset space \space{}
17495 the running title for the page headers.
17496 Lacking these layouts makes the
17502 (and the equivalent
17508 ) useless, so the corresponding layouts don't exist, and will have to be
17513 \begin_layout Plain Layout
17518 actually, \SpecialChar LyX
17519 1.3.0 supports some forms of optional arguments, but this layout
17520 has not been updated yet to take advantage of it.
17530 \begin_layout Section
17531 Springer Journals (
17538 \begin_layout Standard
17544 \begin_layout Subsection
17548 \begin_layout Standard
17549 These are the layout files for some of the journal formats used by Springer
17550 Verlag and listed on
17551 \begin_inset Flex URL
17554 \begin_layout Plain Layout
17556 http://www.springer.de/author/tex/help-journals.html
17561 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
17563 It is a modular system: the things common to all journals are implemented
17568 , which journal-specific layout files (such as, e.
17569 \begin_inset space \thinspace{}
17573 \begin_inset space \space{}
17580 for Journal of Geodesy) can include.
17583 \begin_layout Standard
17584 This means that implementing support for any other Springer journal on this
17585 list is as simple as writing your own
17593 file following the outline given in
17601 \begin_layout Standard
17602 It is reasonably well tested only for the Journal of Geodesy.
17611 come with the standard \SpecialChar LyX
17613 Install the relevant class file (downloaded from Springer) in a proper
17614 directory, reconfigure \SpecialChar LaTeX
17615 (in the te\SpecialChar TeX
17620 , as root if necessary — doesn't \SpecialChar LyX
17621 take care of this?), reconfigure \SpecialChar LyX
17626 \begin_layout Subsection
17630 \begin_layout Standard
17631 A large number of theorem-like styles —
17643 \begin_layout Standard
17646 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
17647 _Title, Author_Running, Institute,
17648 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
17651 See the Springer class file documentation for details.
17654 \begin_layout Subsection
17658 \begin_layout Itemize
17670 \begin_layout Itemize
17673 Probability Theory and Related Fields
17679 — Jean-Marc Lasgouttes
17682 \begin_layout Standard
17683 Add your own, it isn't so hard!
17686 \begin_layout Subsection
17690 \begin_layout Standard
17691 These files are partly based on the older
17695 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
17697 file from Springer.
17702 layout, are now defunct.
17703 Jean-Marc Lasgouttes helped out big in making me find my way around the
17705 layout file mechanism.
17708 \begin_layout Subsection
17712 \begin_layout Standard
17714 But probably less than in the old hacked-\SpecialChar LaTeX
17722 \begin_layout Standard
17724 \change_deleted -712698321 1501168901
17726 \begin_inset space \thinspace{}
17729 g.: does not display the number for theorem-like layouts, just #.
17734 \begin_layout Section
17737 Sli\SpecialChar TeX
17741 \begin_inset CommandInset label
17750 \begin_layout Standard
17758 \begin_layout Subsection
17762 \begin_layout Standard
17763 This section describes how to use \SpecialChar LyX
17764 to make slides for overhead projectors.
17765 There are two document classes that can do this: the default slides class
17768 Foil\SpecialChar TeX
17772 This section documents the former.
17775 \begin_layout Standard
17776 I'm going to say this again, nice and clear, so that there's no misunderstanding
17780 \begin_layout Standard
17781 \begin_inset VSpace bigskip
17787 \begin_layout Standard
17791 This section documents the class
17792 \begin_inset Quotes eld
17800 \begin_inset Quotes erd
17808 \begin_layout Standard
17809 \begin_inset VSpace bigskip
17815 \begin_layout Standard
17816 If you're looking for the documentation for
17817 \begin_inset Quotes eld
17822 slides (Foil\SpecialChar TeX
17826 \begin_inset Quotes erd
17829 , check out section
17830 \begin_inset space ~
17834 \begin_inset CommandInset ref
17836 reference "sec:foiltex"
17846 \begin_inset Quotes eld
17851 slides (Foil\SpecialChar TeX
17855 \begin_inset Quotes erd
17858 ] is actually somewhat better than the default
17866 \begin_layout Plain Layout
17868 or so I've been told repeatedly by its advocates.
17869 Having never used it, I have no idea if this claim is true or not.
17874 which this section documents.
17877 \begin_layout Standard
17878 This class is the \SpecialChar LaTeX2e
17879 improvement of the old
17881 Sli\SpecialChar TeX
17885 Every \SpecialChar LaTeX2e
17886 distribution includes this class [which I'll just refer to as
17887 \begin_inset Quotes eld
17895 \begin_inset Quotes erd
17898 from now on], so you're bound to have it.
17899 As I noted earlier, there are other classes, such as
17903 , which also produce slides for overhead projectors and do a better job
17905 However, there are some things which
17909 can do which the others can't, such as generate overlays.
17910 Read on to learn more!
17913 \begin_layout Subsection
17915 \begin_inset CommandInset label
17917 name "sec:slidesetup"
17924 \begin_layout Standard
17925 Obviously, to use this document class, you need to select
17926 \begin_inset Quotes eld
17934 \begin_inset Quotes erd
17937 from the class list in the
17939 Document\SpecialChar menuseparator
17943 There are some other special things you should know about this class:
17946 \begin_layout Itemize
17947 Don't bother changing the options
17952 They're not supported by the
17959 \begin_layout Itemize
17963 \begin_inset space ~
17968 behaves a bit differently for this class.
17969 The possible choices and what they do are as follows:
17973 \begin_layout Description
17978 The final output contains page numbers in the lower right corner.
17981 \begin_layout Description
17990 , but also prints out any time markers you've put in.
17991 This is the default.
17994 \begin_layout Description
17999 The final output contains no page numbers, time markers, or alignment markers.
18003 \begin_layout Itemize
18008 class has an extra option:
18014 \begin_inset Quotes eld
18022 \begin_inset Quotes erd
18025 in the extra class options.
18029 \begin_layout Standard
18030 Using this options allows you to add time markers to
18036 \begin_inset space ~
18040 \begin_inset CommandInset ref
18042 reference "sec:slideNote"
18050 \begin_layout Standard
18051 You can also use the template file
18052 \begin_inset Quotes eld
18060 \begin_inset Quotes erd
18063 to automatically set up a document to use the
18069 File\SpecialChar menuseparator
18071 \begin_inset space ~
18075 \begin_inset space ~
18080 to open your new document].
18081 The template file also contains some examples of the special paragraph
18082 environments used by this class.
18083 I'll describe those next.
18086 \begin_layout Subsection
18087 Paragraph Environments
18090 \begin_layout Subsubsection
18091 Supported Environments
18094 \begin_layout Standard
18095 The first thing you'll notice when you start up a new
18099 document is the font size and type: it's the equivalent of the size
18100 \begin_inset Quotes eld
18108 \begin_inset Quotes erd
18114 \begin_inset space ~
18120 This is also what's used in the output.
18122 \begin_inset Quotes eld
18126 \begin_inset Quotes erd
18129 to remind you that this is a slide.
18130 Your final slides will use a larger font; ergo, you'll have less space.
18131 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
18134 \begin_layout Standard
18135 The next thing that becomes obvious is the changes to the paragraph environment
18136 pull-down box [at the far-left end of the toolbar].
18137 Most of the paragraph environments you're used to seeing are missing.
18138 There are also five new ones.
18143 class itself only supports certain paragraph environments:
18146 \begin_layout Itemize
18152 \begin_layout Itemize
18158 \begin_layout Itemize
18164 \begin_layout Itemize
18170 \begin_layout Itemize
18176 \begin_layout Itemize
18182 \begin_layout Itemize
18188 \begin_layout Itemize
18194 \begin_layout Itemize
18200 \begin_layout Itemize
18207 \begin_layout Itemize
18209 \change_deleted -712698321 1501169265
18217 \begin_layout Standard
18218 All of the other standard environments, including the section-heading environmen
18219 ts, aren't used in the
18226 \begin_layout Standard
18227 On the other hand, you'll notice the following new environments:
18230 \begin_layout Itemize
18236 \begin_layout Itemize
18242 \begin_layout Itemize
18248 \begin_layout Itemize
18254 \begin_layout Itemize
18260 \begin_layout Standard
18261 These five are kind of quirky, due to a
18262 \begin_inset Quotes eld
18266 \begin_inset Quotes erd
18269 in \SpecialChar LyX
18271 You see, \SpecialChar LyX
18272 doesn't permit you to nest any other paragraph environment into
18273 an empty environment.
18274 Now, that's fine and dandy, but it means that you wouldn't be able to start
18275 a slide with anything except plain text.
18276 To deal with this, I've performed a little
18277 \begin_inset Quotes eld
18282 \begin_inset Quotes erd
18288 \begin_layout Subsubsection
18289 Quirks of the New Environments
18290 \begin_inset CommandInset label
18292 name "sec:slideQuirk"
18299 \begin_layout Standard
18300 All five of the new paragraph environments are somewhat quirky due to inherent
18301 limitiations in the current version of \SpecialChar LyX
18303 As I just mentioned, \SpecialChar LyX
18304 forbids environments that begin with another environment.
18305 To get around this, the
18309 environment isn't a paragraph environment as described in the
18317 \begin_layout Standard
18318 You should consider
18331 \begin_inset Quotes eld
18334 pseudo-environments.
18335 \begin_inset Quotes erd
18338 They look like a section heading or a
18339 \begin_inset Quotes eld
18347 \begin_inset Quotes erd
18350 but really begin a [and, if necessary, end the previous] paragraph environment.
18360 \begin_inset Quotes eld
18364 \begin_inset Quotes erd
18367 These two perform some action.
18370 \begin_layout Standard
18371 A common feature of all five environments,
18391 , is a rather long-ish label.
18392 The text following this label — ordinarily the contents of the paragraph
18393 environment — is utterly irrelevant for
18415 completely ignores it.
18416 In fact, you can leave these five environments completely empty.
18420 \begin_layout Standard
18425 to put any text after the rather long-ish label, you might want to.
18426 This could be a short description of the contents of the
18431 In that case, enter your descriptive comment and hit
18435 as you normally would.
18438 \begin_layout Standard
18439 If, on the other hand, you don't want to enter any descriptive text, you'll
18440 hit another \SpecialChar LyX
18443 , like nature, abhors a vacuum, and will not let you start a new paragraph
18444 environment until you put something in the old one.
18448 \begin_layout Itemize
18449 Start entering the text that will
18477 \begin_layout Itemize
18478 Now move to the beginning of that paragraph.
18482 \begin_layout Itemize
18491 \begin_layout Itemize
18492 Finally, change this new, empty paragraph to a
18516 \begin_layout Standard
18517 Some future version of \SpecialChar LyX
18518 will, hopefully, resolve this quirkiness\SpecialChar ldots
18522 \begin_layout Subsection
18523 Making a Presentation with
18536 \begin_layout Subsubsection
18544 \begin_layout Standard
18545 If you're expecting this section to teach you how to actually make a presentatio
18546 n, you'll be sorely disappointed.
18547 Naturally, I'll describe all of the ways the
18551 class can assist you in preparing the materials for a presentation.
18552 Filling in the contents, however, is up to you.
18557 the \SpecialChar LyX
18561 \begin_layout Standard
18566 environment [in the manner described in section
18567 \begin_inset space ~
18571 \begin_inset CommandInset ref
18573 reference "sec:slideQuirk"
18577 ] tells \SpecialChar LyX
18578 to begin a new slide [duh].
18579 The label for this environment/
18580 \begin_inset Quotes erd
18584 \begin_inset Quotes erd
18588 \begin_inset Quotes eld
18592 \begin_inset Quotes erd
18595 in cool blue, followed by the label,
18596 \begin_inset Quotes eld
18600 \begin_inset Quotes erd
18604 Any text or paragraph environments that follow this one go on the new slide.
18608 \begin_layout Standard
18609 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
18611 (this can be specified in the
18616 In fact, you'll want to, once you finish entering the contents of one slide.
18617 If you've entered more text than can physically fit on a slide, the extra
18618 overflows onto a new slide.
18619 I don't recommend doing this, however, since the overflow slide won't have
18620 any page number on it.
18621 Furthermore, it may interfere with any
18625 you've made to accompany the oversized
18632 \begin_layout Standard
18641 environments work the same way as the
18646 They both create an
18647 \begin_inset Quotes eld
18651 \begin_inset Quotes erd
18654 followed by a label [
18655 \begin_inset Quotes eld
18659 \begin_inset Quotes erd
18663 \begin_inset Quotes eld
18667 \begin_inset Quotes erd
18671 The color is a stunning magenta instead of blue, and the
18672 \begin_inset Quotes eld
18676 \begin_inset Quotes erd
18679 will look different, in style and in length.
18680 The label fonts of all three also differ from one another.
18683 \begin_layout Standard
18688 , if the contents of a
18696 exceed the physical size of a slide or sheet of paper, the extra will overflow
18698 Again, you should avoid this.
18699 It defeats the whole purpose of
18710 \begin_layout Subsubsection
18720 \begin_layout Standard
18725 is a slide that sits atop another slide.
18726 Perhaps you wish to discuss a figure on the main
18730 before displaying the text associated with it.
18731 One way to accomplish this is tape a flap of dark paper over the part of
18736 you want to display later.
18737 This method fails, however, if you wish to overlap one graph with another,
18739 You would then have to fumble while speaking to align the two separate,
18744 s to align the two graphs.
18749 environment in both cases makes life much easier.
18752 \begin_layout Standard
18757 receives the page number of its
18758 \begin_inset Quotes eld
18762 \begin_inset Quotes erd
18770 \begin_inset Quotes eld
18778 \begin_inset Quotes erd
18785 \begin_layout Plain Layout
18786 Presumably, mutliple
18791 \begin_inset Quotes eld
18799 \begin_inset Quotes erd
18803 \begin_inset Quotes eld
18811 \begin_inset Quotes erd
18815 \begin_inset Quotes eld
18823 \begin_inset Quotes erd
18827 \begin_inset space ~
18830 appended to the page number of the parent
18840 Clearly, you want the contents of both the
18848 to each fit on a single physical slide! You should probably consider an
18854 \begin_inset Quotes eld
18858 \begin_inset Quotes erd
18866 Indeed, the \SpecialChar LyX
18871 class provides a visual cue for this: the label at the start of an
18875 is shorter than that at the start of a
18880 Lastly, when you generate printable output, you'll find alignment markers
18881 in all four corners of both the
18885 page and its parent
18890 These will assist you in lining up the two physical slides.
18893 \begin_layout Standard
18894 The major problem in overlaying two slides is aligning the contents of the
18895 two transparencies.
18896 How much space should you leave for that graph on the second slide? Worse
18897 still, what if you want a graph and a sentence on second slide, but there
18898 is text on the main transparency that goes in between them? You could try
18899 and insert vertical space of the right size.
18900 The better way is to use
18911 \begin_layout Standard
18912 As their names imply,
18920 are two command-like paragraph environments that make all subsequent text
18921 invisible and visible, respectively.
18923 \begin_inset space ~
18927 \begin_inset CommandInset ref
18929 reference "sec:slideQuirk"
18933 that you don't place anything
18937 these two environments, however.
18942 , it inserts a centered, sky-blue label into the page reading
18943 \begin_inset Quotes eld
18946 <Invisible Text Follows>
18947 \begin_inset Quotes erd
18951 For paragraphs following this label, the parts of the
18959 ; it doesn't matter which] where they would be contain instead blank space.
18963 \begin_layout Standard
18968 , the corresponding centered label is
18969 \begin_inset Quotes eld
18972 <Visible Text Follows>
18973 \begin_inset Quotes erd
18977 Paragraphs following this label behave normally.
18978 Note that the beginning of a new
18990 automatically shuts off an
18995 It's therefore not necessary to use
19006 \begin_layout Standard
19007 By now, it should be obvious how to create overlay transparencies using
19008 the proper combination of
19027 \begin_layout Enumerate
19032 , including everything that will appear on it, whether on the main slide
19040 \begin_layout Enumerate
19041 Before each figure or paragraph that will appear only on the
19050 If necessary, insert a
19054 environment after the
19061 \begin_layout Enumerate
19066 immediately following the
19073 \begin_layout Enumerate
19074 Copy the contents of this
19085 \begin_layout Enumerate
19090 , change all of the
19101 \begin_layout Standard
19103 You've just made an
19110 \begin_layout Standard
19111 There's one problem with the way I've designed the \SpecialChar LyX
19116 class: you can't make text in the middle of a paragraph invisible, nor
19117 make text in the middle of an invisible paragraph visible again.
19118 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
19123 \begin_layout Plain Layout
19124 The commands of interest are:
19127 \begin_layout Itemize
19132 invisible \SpecialChar ldots
19136 \begin_layout Itemize
19141 visible \SpecialChar ldots
19145 \begin_layout Plain Layout
19147 and need to be marked as \SpecialChar TeX
19150 \begin_inset Quotes eld
19154 \begin_inset Quotes erd
19157 you wish to change goes in between the brackets [and after the
19170 If you don't know how to mark text as \SpecialChar TeX
19171 , see the appropriate section of
19184 \begin_layout Subsubsection
19194 \begin_inset CommandInset label
19196 name "sec:slideNote"
19203 \begin_layout Standard
19212 is associated with a
19213 \begin_inset Quotes eld
19217 \begin_inset Quotes erd
19225 Here, too, the \SpecialChar LyX
19230 class provides visual cues.
19235 is shorter than that of a
19239 [yet longer than that of an
19243 ] and, like the label of an
19247 is shockingly magenta.
19248 Additionally, the printed
19252 has the page number of its
19253 \begin_inset Quotes eld
19257 \begin_inset Quotes erd
19265 \begin_inset Quotes eld
19273 \begin_inset Quotes erd
19277 \begin_inset Quotes eld
19285 \begin_inset Quotes erd
19289 \begin_inset Quotes eld
19297 \begin_inset Quotes erd
19301 You can have multiple
19305 s associated with a single
19317 , you'll probably want to break up long
19321 s so that they fit on a single sheet of paper.
19324 \begin_layout Standard
19329 is obvious: it contains anything additional you might want to say about
19335 It could also be used as a sheet of reminders for a particular
19340 In the case of the latter, you might want to make use of time markers.
19341 Currently, the \SpecialChar LyX
19347 \begin_inset Quotes eld
19351 \begin_inset Quotes erd
19354 support for time markers, a
19356 Sli\SpecialChar TeX
19360 So, you'll have to resort to using the \SpecialChar LaTeX
19364 \begin_layout Standard
19365 To use time markers, you'll need to specify the extra class option
19366 \begin_inset Quotes eld
19374 \begin_inset Quotes erd
19378 \begin_inset space ~
19382 \begin_inset CommandInset ref
19384 reference "sec:slidesetup"
19389 This option turns on timing marks, which will appear in the lower-left-hand
19395 To set what appears in the time marker, you use the \SpecialChar LaTeX
19397 \begin_inset Quotes eld
19407 \begin_inset Quotes erd
19411 \begin_inset Quotes eld
19421 \begin_inset Quotes erd
19425 The arguments of both commands are time measured in seconds.
19427 \begin_inset Quotes eld
19437 \begin_inset Quotes erd
19440 sets the time marker to a given time.
19442 \begin_inset Quotes eld
19452 \begin_inset Quotes erd
19455 increments the time marker by the specified amount.
19456 Using time markers and
19460 s in this fashion, you can remind yourself how much time to spend on a particula
19468 \begin_layout Standard
19469 There's one last feature to describe.
19470 Clearly, you'd like to print out all of your
19478 s on transparencies while printing all of your
19495 with which it is associated.
19496 What's a person to do?
19499 \begin_layout Standard
19500 Luckily, there are two \SpecialChar LaTeX
19501 commands that allow you to select what to print
19503 Both must be placed into the preamble of your document.
19505 \begin_inset Quotes eld
19517 \begin_inset Quotes erd
19520 will cause the output to contain only the
19529 Correspondingly, the command
19530 \begin_inset Quotes eld
19542 \begin_inset Quotes erd
19545 prevents the output of anything but
19550 I'd advise placing both commands in the preamble and initially comment
19552 You can then preview your entire presentation as you write.
19553 When you're done writing, you can then uncomment one of the two to select
19554 what you want to print.
19555 I like to uncomment
19556 \begin_inset Quotes eld
19568 \begin_inset Quotes erd
19571 , print to a file with
19572 \begin_inset Quotes eld
19580 \begin_inset Quotes erd
19583 in its name, comment it back out, then uncomment
19584 \begin_inset Quotes eld
19596 \begin_inset Quotes erd
19600 \begin_inset Quotes eld
19608 \begin_inset Quotes erd
19612 I can then send either file to a printer, loading transparencies or plain
19613 paper as appropriate.
19616 \begin_layout Standard
19617 You can also provide other arguments to the
19618 \begin_inset Quotes eld
19628 \begin_inset Quotes erd
19632 \begin_inset Quotes eld
19642 \begin_inset Quotes erd
19646 See a good \SpecialChar LaTeX
19650 \begin_layout Subsection
19655 Class Template File
19658 \begin_layout Standard
19659 I have also provided a template file,
19660 \begin_inset Quotes eld
19668 \begin_inset Quotes erd
19676 To use it, begin your new presentation with
19678 File\SpecialChar menuseparator
19680 \begin_inset space ~
19684 \begin_inset space ~
19690 Your new \SpecialChar LyX
19691 presentation file will contain an example
19712 additionally contain an example of the use of
19721 Lastly, the preamble will contain:
19724 \begin_layout LyX-Code
19725 % Uncomment to print out only slides and overlays
19728 \begin_layout LyX-Code
19732 \begin_layout LyX-Code
19738 \begin_inset Newline newline
19744 \begin_layout LyX-Code
19745 % Uncomment to print out only notes
19748 \begin_layout LyX-Code
19752 \begin_layout LyX-Code
19760 \begin_layout Standard
19761 One final thing: I created this class to support the \SpecialChar LaTeX2e
19763 \begin_inset Quotes eld
19768 Sli\SpecialChar TeX
19772 \begin_inset Quotes erd
19775 class, one of the built-in \SpecialChar LaTeX2e
19777 Neither I nor the rest of the \SpecialChar LyX
19778 Team endorse or oppose the use of this built-in
19780 It's here if you want it or need it.
19781 There exist other \SpecialChar LaTeX2e
19782 classes for creating presentations, such as the
19787 \begin_inset space ~
19791 \begin_inset CommandInset ref
19793 reference "sec:foiltex"
19798 \begin_inset Quotes eld
19806 \begin_inset Quotes erd
19809 package [present on some \SpecialChar TeX
19811 The latter is not yet supported under \SpecialChar LyX
19816 \begin_layout Plain Layout
19817 Perhaps you can take on the task\SpecialChar ldots
19823 I know nothing about these other classes.
19824 Try them out to see what sort of alternative they provide.
19827 \begin_layout Chapter
19829 Features needing Extra Software
19832 \begin_layout Section
19833 Checking \SpecialChar TeX
19837 \begin_layout Standard
19843 \begin_layout Subsection
19847 \begin_layout Standard
19856 \begin_layout Plain Layout
19861 is not yet available when you are using the \SpecialChar LaTeX
19862 distribution MiK\SpecialChar TeX
19868 , you'll find in the
19875 \begin_inset space ~
19886 \begin_inset Newline newline
19890 \begin_inset CommandInset href
19892 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
19900 \begin_layout Standard
19903 Chk\SpecialChar TeX
19906 package is a program that was written by
19907 \begin_inset Flex Noun
19910 \begin_layout Plain Layout
19912 \begin_inset space ~
19920 in frustration because some constructs in \SpecialChar LaTeX
19921 are sometimes non-intuitive,
19922 and easy to forget.
19923 The program runs over your \SpecialChar LaTeX
19924 file, checks the integrity of the file, and
19925 flags some common errors.
19926 In other technical words, it is
19930 for \SpecialChar LaTeX
19934 \begin_layout Standard
19935 Well, what is a syntax checker doing in \SpecialChar LyX
19936 which is supposed to produce correct
19938 anyways? The answer is simple: Just as
19942 not only checks the
19946 of C programs, but also does
19950 checks for type-errors,
19952 Chk\SpecialChar TeX
19955 catches some common
19959 errors, in addition to the syntactical ones.
19962 Chk\SpecialChar TeX
19965 is capable of detecting several common errors, such as
19968 \begin_layout Itemize
19969 Ellipsis detection:
19970 \begin_inset Newline newline
19973 Use \SpecialChar ldots
19977 \begin_layout Itemize
19978 No space in front of/after parenthesis:
19979 \begin_inset Newline newline
19985 \begin_layout Itemize
19986 Enforcement of normal space after common abbreviations:
19987 \begin_inset Newline newline
19991 \begin_inset space \thinspace{}
19995 \begin_inset space \space{}
19998 is too wide spacing.
20001 \begin_layout Itemize
20002 Enforcement of end-of-sentence space when the last sentence ends with a
20004 \begin_inset Newline newline
20008 And this is wrong spacing.
20011 \begin_layout Itemize
20012 Space in front of labels and similar commands:
20013 \begin_inset Newline newline
20016 The label should stick right up to the text to avoid falling to a wrong
20019 \begin_inset CommandInset label
20029 \begin_layout Plain Layout
20030 This footnote is in danger of falling off to a wrong page
20035 The label is separated too much.
20038 \begin_layout Itemize
20039 Space in front of references, instead of hard spaces:
20040 \begin_inset Newline newline
20043 If you have bad luck, the text will break right between the referenced text
20044 and reference number, and that's a pity.
20046 \begin_inset CommandInset ref
20048 reference "sec:chktex"
20055 \begin_layout Itemize
20057 \begin_inset Quotes eld
20061 \begin_inset Quotes erd
20065 \begin_inset Formula $\times$
20069 \begin_inset Newline newline
20072 2x2 looks cheap compared to
20073 \begin_inset Formula $2\times2$
20079 \begin_layout Standard
20080 and more \SpecialChar ldots
20081 It is an invaluable tool when you are
20082 \begin_inset Quotes eld
20086 \begin_inset Quotes erd
20089 your document before printing, and you should run it right after the obligatory
20090 spelling check, and before you go fine tuning the typesetting.
20093 \begin_layout Subsection
20097 \begin_layout Standard
20098 If you have the program installed, usage is as simple as choosing
20100 Tools\SpecialChar menuseparator
20102 \begin_inset space ~
20108 This will make \SpecialChar LyX
20109 generate a \SpecialChar LaTeX
20110 file of your document, start
20112 Chk\SpecialChar TeX
20115 to check it, and then make \SpecialChar LyX
20117 \begin_inset Quotes eld
20121 \begin_inset Quotes erd
20124 with the warnings from
20126 Chk\SpecialChar TeX
20129 , if there were any.
20130 The warnings will be placed close to the point of the mistake, and you
20131 can quickly find them by using the
20133 Navigate\SpecialChar menuseparator
20136 menu item, or the shortcut key
20145 Open the error boxes by clicking on them with the mouse, or use the shortcut
20154 bindings, or the corresponding
20163 Read the warning and correct the mistake, if it is a mistake.
20164 If you have trouble understanding what the warning is about, you can safely
20166 Remember that there is a hidden layer between the document on screen and
20167 the technical details in invoking
20169 Chk\SpecialChar TeX
20172 , and this gap can make some warnings seem arcane or just plain silly.
20175 \begin_layout Standard
20176 This document is an excellent testing bed for the feature, and it should
20177 provide quite a few warnings for you to fiddle with.
20178 Since computers are only so smart, expect most of the warnings to be false
20182 \begin_layout Subsection
20183 How to fine tune it
20186 \begin_layout Standard
20187 Sometimes, you'll find that
20189 Chk\SpecialChar TeX
20192 makes more noise than suits your mood.
20193 Then you can choose not to use it, wait until your mood changes, or try
20196 Chk\SpecialChar TeX
20199 to get better along with you.
20202 \begin_layout Standard
20205 Chk\SpecialChar TeX
20212 very configurable and extensible, you should not expect to solve all problems
20215 Chk\SpecialChar TeX
20218 in \SpecialChar LyX
20220 Since \SpecialChar LyX
20221 has to generate a somewhat special \SpecialChar LaTeX
20222 file to be able to match the
20223 line numbers from the
20225 Chk\SpecialChar TeX
20232 \begin_layout Plain Layout
20233 You can inspect the specific output from
20239 Document\SpecialChar menuseparator
20242 \begin_inset space ~
20256 to the internal document structure, some of the warnings will not appear
20258 There are two things you can do about this:
20261 \begin_layout Itemize
20264 Chk\SpecialChar TeX
20267 invocation command line in
20268 \begin_inset Flex Noun
20271 \begin_layout Plain Layout
20272 Tools\SpecialChar menuseparator
20273 Preferences\SpecialChar menuseparator
20274 Output\SpecialChar menuseparator
20275 LaTeX\SpecialChar menuseparator
20283 Chk\SpecialChar TeX
20286 installation configuration file (usually with the file
20291 See below to learn what warnings can be enabled and disabled on the command
20295 \begin_layout Itemize
20296 Export your document as a raw \SpecialChar LaTeX
20299 File\SpecialChar menuseparator
20300 Export\SpecialChar menuseparator
20309 Invoked in this way, it can be a hassle to find the corresponding place
20310 in the document inside \SpecialChar LyX
20311 , but with a little patience, you should be able
20315 \begin_layout Standard
20316 Here follows the warning messages that can be enabled and disabled in
20325 to disable a warning, and
20329 to enable a warning.
20330 The emphasized entries are disabled by default, because the default is
20333 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
20338 \begin_layout Standard
20339 Notice that you should only use the options that enable and disable warnings,
20340 because \SpecialChar LyX
20341 relies on some of the other command line parameters to be set
20342 in a specific way to have a chance to communicate with
20349 \begin_layout Enumerate
20353 Command terminated with space.
20356 \begin_layout Enumerate
20359 Non-breaking space (
20360 \begin_inset Quotes eld
20368 \begin_inset Quotes erd
20371 ) should have been used.
20374 \begin_layout Enumerate
20378 You should enclose the previous parenthesis with
20379 \begin_inset Quotes eld
20387 \begin_inset Quotes erd
20393 \begin_layout Enumerate
20396 Italic correction (
20397 \begin_inset Quotes eld
20407 \begin_inset Quotes erd
20410 ) found in non-italic buffer.
20413 \begin_layout Enumerate
20416 Italic correction (
20417 \begin_inset Quotes eld
20427 \begin_inset Quotes erd
20430 ) found more than once.
20433 \begin_layout Enumerate
20437 No italic correction (
20438 \begin_inset Quotes eld
20448 \begin_inset Quotes erd
20454 \begin_layout Enumerate
20458 \begin_inset Quotes eld
20466 \begin_inset Quotes erd
20470 \begin_inset Quotes eld
20478 \begin_inset Quotes erd
20484 \begin_layout Enumerate
20487 Wrong length of dash may have been used.
20490 \begin_layout Enumerate
20494 \begin_inset Quotes eld
20502 \begin_inset Quotes erd
20506 \begin_inset Quotes eld
20514 \begin_inset Quotes erd
20520 \begin_layout Enumerate
20524 \begin_inset Quotes eld
20532 \begin_inset Quotes erd
20538 \begin_layout Enumerate
20542 \begin_inset Quotes eld
20550 \begin_inset Quotes erd
20553 to achieve an ellipsis.
20556 \begin_layout Enumerate
20559 Inter-word spacing (
20560 \begin_inset Quotes eld
20570 \begin_inset Quotes eld
20573 ) should perhaps be used.
20576 \begin_layout Enumerate
20579 Inter-sentence spacing (
20580 \begin_inset Quotes eld
20590 \begin_inset Quotes erd
20593 ) should perhaps be used.
20596 \begin_layout Enumerate
20599 Could not find argument for command.
20602 \begin_layout Enumerate
20606 \begin_inset Quotes eld
20614 \begin_inset Quotes erd
20620 \begin_layout Enumerate
20623 Math mode still on at end of \SpecialChar LaTeX
20627 \begin_layout Enumerate
20631 \begin_inset Quotes eld
20639 \begin_inset Quotes erd
20642 doesn't match the number of
20643 \begin_inset Quotes eld
20651 \begin_inset Quotes erd
20657 \begin_layout Enumerate
20660 You should use either
20663 \begin_inset Quotes eld
20671 \begin_inset Quotes erd
20676 as an alternative to
20677 \begin_inset Quotes eld
20685 \begin_inset Quotes erd
20691 \begin_layout Enumerate
20698 " (ASCII 39) instead of "
20705 \begin_layout Enumerate
20708 User-specified pattern found.
20711 \begin_layout Enumerate
20714 This command might not be intended.
20717 \begin_layout Enumerate
20724 \begin_layout Enumerate
20742 \begin_layout Enumerate
20745 Delete this space to maintain correct page references.
20748 \begin_layout Enumerate
20752 You might wish to put this between a pair of
20753 \begin_inset Quotes eld
20761 \begin_inset Quotes erd
20767 \begin_layout Enumerate
20770 You ought to remove spaces in front of punctuation.
20773 \begin_layout Enumerate
20776 Could not execute \SpecialChar LaTeX
20780 \begin_layout Enumerate
20789 in front of small punctuation.
20792 \begin_layout Enumerate
20800 may look prettier here.
20803 \begin_layout Enumerate
20807 Multiple spaces detected in output.
20810 \begin_layout Enumerate
20813 This text may be ignored.
20816 \begin_layout Enumerate
20822 \begin_inset Quotes eld
20827 to begin quotation, not
20834 \begin_layout Enumerate
20841 to end quotation, not
20844 \begin_inset Quotes eld
20852 \begin_layout Enumerate
20858 \begin_layout Enumerate
20861 You should perhaps use
20862 \begin_inset Quotes eld
20870 \begin_inset Quotes erd
20876 \begin_layout Enumerate
20879 You should put a space in front of/after parenthesis.
20882 \begin_layout Enumerate
20885 You should avoid spaces in front of/after parenthesis.
20888 \begin_layout Enumerate
20892 You should not use punctuation in front of/after quotes.
20895 \begin_layout Enumerate
20898 Double space found.
20901 \begin_layout Enumerate
20904 You should put punctuation outside inner/inside display math mode.
20907 \begin_layout Enumerate
20910 You ought to not use primitive \SpecialChar TeX
20911 in \SpecialChar LaTeX
20915 \begin_layout Enumerate
20918 You should remove spaces in front of
20919 \begin_inset Quotes eld
20927 \begin_inset Quotes erd
20933 \begin_layout Enumerate
20936 \begin_inset Quotes eld
20944 \begin_inset Quotes erd
20947 is normally not followed by
20948 \begin_inset Quotes eld
20956 \begin_inset Quotes erd
20962 \begin_layout Standard
20963 In later versions of \SpecialChar LyX
20964 , we hope to provide a more complete interface to this
20965 tool (and it's smaller cousin
20969 ) to exploit the full power of it.
20970 But it's not exactly useless as it is now: go try it on one of your existing
20971 documents of a certain length and be surprised.
20974 \begin_layout Section
20975 Version Control in \SpecialChar LyX
20979 \begin_layout Standard
20982 Lars Gullik Bjønnes
20989 \begin_layout Subsection
20993 \begin_layout Standard
20995 supports some of the most basic RCS/CVS/SVN/GIT commands.
20996 If you need something a bit more sophisticated you will have to do that
20997 manually in a terminal.
21000 \begin_layout Standard
21001 Also note that CVS support is not as good as subversion support so we advise
21003 A good place to start learning Subversion is SVN Book
21007 \begin_layout Plain Layout
21008 \begin_inset CommandInset href
21010 target "http://svnbook.red-bean.com/"
21021 In the case of RCS you should read
21022 \begin_inset Quotes eld
21026 \begin_inset Quotes erd
21029 (a man file, read it with
21034 This file describes all the basic features of RCS.
21035 You should especially notice the comment about a RCS directory, and the
21036 notion of a master RCS file (the file ending in
21043 \begin_layout Standard
21044 Before you begin to use the version control features in \SpecialChar LyX
21046 familiar with RCS/CVS/SVN/GIT usage.
21047 The implementation in \SpecialChar LyX
21048 assumes a recent version of the GNU RCS or CVS/SVN
21049 package — no guarantees are made for older versions.
21050 Most of the log messages are not currently displayed after operations —
21051 you can check them in the Messages pane if unsure.
21052 Regular users of version control will appreciate VC toolbar, which can
21055 View\SpecialChar menuseparator
21056 Toolbars\SpecialChar menuseparator
21058 \begin_inset space ~
21066 \begin_layout Standard
21067 For introducing your own external commands consult vc-command in the manual
21068 of \SpecialChar LyX
21072 \begin_layout Standard
21073 It is strongly recommended to store documents in uncompressed format if
21074 using version control (uncheck
21076 Document\SpecialChar menuseparator
21079 if it is checked): Uncompressed LyX documents are text files and therefore
21080 for merging two different versions by version control systems.
21081 Compressed LyX documents are binary files, which cannot be merged by version
21085 \begin_layout Subsection
21086 RCS commands in \SpecialChar LyX
21090 \begin_layout Standard
21091 The following sections describe the RCS commands supported by \SpecialChar LyX
21093 You can find them in the
21095 File\SpecialChar menuseparator
21097 \begin_inset space ~
21104 was tested against RCS 5.7/5.8.
21107 \begin_layout Subsubsection
21113 \begin_layout Standard
21114 If your document is not under revision control, this is the only item shown
21116 And if it is under revision control, the
21120 item is not visible.
21124 \begin_layout Standard
21125 This command registers your document with RCS (unless you are under the
21126 directory managed by CVS)\SpecialChar endofsentence
21127 You are asked interactively to supply an initial
21128 description of the document.
21129 The document is now set in Read-Only mode and you have to
21132 \begin_inset space ~
21136 \begin_inset space ~
21140 \begin_inset space ~
21145 , before making any changes to it.
21146 A document under revision control has a
21147 \begin_inset Quotes eld
21150 [RCS:<version> <locker>]
21151 \begin_inset Quotes erd
21154 item tagged to the filename in the minibuffer.
21157 \begin_layout Standard
21158 RCS command that is run:
21160 ci -q -u -i -t-"<initial description>" <file-name>
21163 \begin_layout Standard
21168 to understand the switches.
21172 \begin_layout Subsubsection
21178 \begin_layout Standard
21179 When you are finished editing a file, you check in your changes.
21180 When you do this, you are asked for a description of the changes.
21181 This is stored in the history log.
21182 The version number is bumped, your changes are applied to the master RCS
21183 file, the document is unlocked and set to Read-Only mode.
21186 \begin_layout Standard
21189 ci -q -u -m"<description>" <file-name>
21192 \begin_layout Subsubsection
21198 \begin_layout Standard
21199 By doing this you lock the document so that only you can edit it.
21200 This will also make the document Read-Write only for you.
21201 You will usually continue editing for a while and when you are finished
21202 you check in your changes.
21203 The status line is changed to reflect that you have locked the file.
21206 \begin_layout Standard
21209 co -q -l <file-name>
21212 \begin_layout Subsubsection
21215 Revert To Repository Version
21218 \begin_layout Standard
21219 This will discard all changes made to the document since the last check
21221 You get a warning before changes are discarded.
21224 \begin_layout Standard
21227 co -f -u<version> <file-name>
21230 \begin_layout Subsubsection
21236 \begin_layout Standard
21237 This will create a copy of the current document.
21238 Since RCS does not support copy operations natively, the version history
21239 is not preserved, and the copy is added as a new file.
21240 It requires a clean document without any changes since the last checkin.
21241 You are asked for a file name and a description of the copy operation.
21242 After that the copy is created, both locally and in the repository.
21243 If the parent directories of the copied and original document differ, all
21244 relative paths of included files of the copy are adjusted (like in
21246 File\SpecialChar menuseparator
21251 Finally, the copy is loaded instead of the original document.
21254 \begin_layout Labeling
21255 \labelwidthstring 00.00.0000
21257 \begin_inset space ~
21261 \begin_inset space ~
21265 \begin_inset Newline newline
21269 \begin_inset Flex Code
21272 \begin_layout Plain Layout
21275 \begin_inset Quotes eld
21279 \begin_inset Quotes erd
21288 \begin_inset Flex Code
21291 \begin_layout Plain Layout
21294 \begin_inset Quotes eld
21298 \begin_inset Quotes erd
21307 \begin_inset Newline newline
21311 \begin_inset Flex Code
21314 \begin_layout Plain Layout
21318 \begin_inset Quotes eld
21322 \begin_inset Quotes erd
21333 \begin_layout Subsubsection
21339 \begin_layout Standard
21340 This makes as if the last check in never happened.
21341 No changes are made to the document loaded into \SpecialChar LyX
21342 , but the last version
21343 is removed from the master RCS file.
21346 \begin_layout Standard
21349 rcs -o<version> <file-name>
21352 \begin_layout Subsubsection
21358 \begin_layout Standard
21359 This shows the complete history of the RCS document.
21364 is shown in a browser.
21372 \begin_layout Subsubsection
21376 \begin_layout Standard
21378 supports RCS version number, author name, date and time of last commit.
21379 All those are extracted from
21381 rlog -r <file-name>
21385 \begin_inset CommandInset ref
21387 reference "subsec:VCS-Revision-Information"
21394 \begin_layout Subsection
21395 CVS commands in \SpecialChar LyX
21399 \begin_layout Standard
21400 A subset of CVS operations is supported by \SpecialChar LyX
21402 You can find the commands in the
21404 File\SpecialChar menuseparator
21406 \begin_inset space ~
21412 The version control system SVN is more powerful, so please use it instead
21413 of CVS if possible.
21416 \begin_layout Subsubsection
21422 \begin_layout Standard
21423 If you start from scratch with CVS you have to create your repository and
21424 checkout the working copy with external tools.
21425 If you're using a client-server setup you may need to login before doing
21426 the first repository checkout.
21429 \begin_layout Standard
21430 If your documents are under revision control and others are using the same
21431 repository problems arise when different changes to the same document at
21432 the same location happen.
21433 Standard CVS repositories don't operate with a file locking mechanism.
21434 This may be surprising, but conflicts only occur if people disagree on
21435 the proper content of the same part of a document.
21436 So, if co-workers are used to communicate regularly, these conflicts occur
21438 If they don't communicate they have a fundamental problem anyway.
21439 Nevertheless some people like to work with so called
21440 \begin_inset Quotes eld
21444 \begin_inset Quotes erd
21448 If they do so the working copy of all files is readonly when checked out
21449 first and the user starts editing after using a special command to make
21450 the working copy writable.
21451 When the changes are checked in the working copy returns to readonly state.
21452 With \SpecialChar LyX
21453 one has to edit the
21454 \begin_inset Flex Code
21457 \begin_layout Plain Layout
21463 file and add the line
21464 \begin_inset Flex Code
21467 \begin_layout Plain Layout
21473 to work with reserved checkouts.
21474 The benefit is the possibility to see who is using a writable copy of some
21476 It's not guaranteed only one user makes a copy writable.
21479 \begin_layout Standard
21481 tries to guess if you're using reserved or non-reserved checkouts.
21482 If your working copy is readonly or it is writable and an additional copy
21483 of your document exists in the CVS/Base sub-directory a reserved otherwise
21484 a non-reserved checkout is assumed.
21485 When a reserved checkout is detected you have to use
21486 \begin_inset Flex Noun
21489 \begin_layout Plain Layout
21495 to make your working copy writable if it's readonly.
21497 \begin_inset Flex Noun
21500 \begin_layout Plain Layout
21506 operation is possible and that makes your working copy readonly again after
21507 transferring your changes to the repository.
21510 \begin_layout Standard
21511 More information about CVS can be found here
21512 \begin_inset Flex URL
21515 \begin_layout Plain Layout
21517 http://www.nongnu.org/cvs
21523 \begin_inset Flex URL
21526 \begin_layout Plain Layout
21528 http://ximbiot.com/cvs
21536 \begin_layout Standard
21541 to understand the sub-commands and the switches mentioned below.
21544 \begin_layout Subsubsection
21550 \begin_layout Standard
21551 If your document is not under revision control, this is the only item shown
21553 And if it is under revision control, the
21557 item is not visible.
21561 \begin_layout Standard
21562 This command registers in CVS your document
21563 \begin_inset Flex Strong
21566 \begin_layout Plain Layout
21574 in the case you have already the documents directory under CVS control
21580 This means you have to create or checkout the archive by yourself using
21582 (In case you forget that step \SpecialChar LyX
21583 registers the document with RCS.)
21586 \begin_layout Standard
21587 Then you are asked interactively to supply an initial description of the
21589 Don't forget that registered file is not yet checked in.
21592 \begin_layout Standard
21593 CVS command that is run:
21595 cvs -q add -m"<entered message>" "<file-name>"
21598 \begin_layout Standard
21603 above and for all other CVS commands is an abbreviation for
21604 \begin_inset Quotes eld
21607 change the current working directory to file location and use the file name
21608 without path component as argument
21609 \begin_inset Quotes erd
21615 \begin_layout Subsubsection
21621 \begin_layout Standard
21622 When you are finished editing a file, you commit your changes.
21623 When you do this and you had changed the document, you are asked for a
21624 description of the changes.
21625 After that changes are written to the repository.
21626 In case you didn't change the document and a reserved checkout is detected
21627 the reservation made on
21628 \begin_inset Flex Noun
21631 \begin_layout Plain Layout
21640 \begin_layout Labeling
21641 \labelwidthstring 00.00.0000
21643 \begin_inset space ~
21647 \begin_inset space ~
21651 \begin_inset Newline newline
21655 \begin_inset Flex Code
21658 \begin_layout Plain Layout
21661 -q commit -m"<description>" "<file-name>"
21667 \begin_inset Newline newline
21671 \begin_inset Flex Code
21674 \begin_layout Plain Layout
21685 \begin_layout Subsubsection
21691 \begin_layout Standard
21692 When you are sharing a repository with others, you may have to incorporate
21693 their changes into your working copy.
21696 \begin_layout Standard
21699 cvs -q update "<file-name>"
21702 \begin_layout Standard
21703 If a readonly checkout is detected the working copy is made writable and
21707 \begin_layout Standard
21710 cvs -q edit "<file-name>"
21713 \begin_layout Subsubsection
21716 Revert To Repository Version
21719 \begin_layout Standard
21720 This will discard all changes made to the document since the last check
21722 You get a warning before changes are discarded.
21723 Firstly the file is deleted, secondly CVS update command is run.
21726 \begin_layout Standard
21729 cvs -q update "<file-name>"
21732 \begin_layout Standard
21733 If a reserved checkout is detected and the working copy has no changes only
21734 the reservation is undone.
21737 \begin_layout Standard
21740 cvs -q unedit "<file-name>"
21743 \begin_layout Subsubsection
21749 \begin_layout Standard
21750 This will create a copy of the current document.
21751 Since CVS does not support copy operations natively, the version history
21752 is not preserved, and the copy is added as a new file.
21753 It requires a clean document without any changes since the last checkin.
21754 You are asked for a file name and a description of the copy operation.
21755 After that the copy is created, both locally and in the repository.
21756 If the parent directories of the copied and original document differ, all
21757 relative paths of included files of the copy are adjusted (like in
21759 File\SpecialChar menuseparator
21764 Finally, the copy is loaded instead of the original document.
21767 \begin_layout Labeling
21768 \labelwidthstring 00.00.0000
21770 \begin_inset space ~
21774 \begin_inset space ~
21778 \begin_inset Newline newline
21782 \begin_inset Flex Code
21785 \begin_layout Plain Layout
21788 \begin_inset Quotes eld
21792 \begin_inset Quotes erd
21801 \begin_inset Flex Code
21804 \begin_layout Plain Layout
21807 \begin_inset Quotes eld
21811 \begin_inset Quotes erd
21820 \begin_inset Newline newline
21824 \begin_inset Flex Code
21827 \begin_layout Plain Layout
21831 \begin_inset Quotes eld
21835 \begin_inset Quotes erd
21846 \begin_layout Subsubsection
21852 \begin_layout Standard
21853 This will rename the current document.
21854 Since CVS does not support rename operations natively, the version history
21855 is not preserved, the renamed document is added as a new file, and the
21856 original document is deleted.
21857 It requires a clean document without any changes since the last checkin.
21858 You are asked for a file name and a description of the rename operation.
21859 After that the document is renamed, both locally and in the repository.
21860 If the parent directories of the new and old file names differ, all relative
21861 paths of included files are adjusted (like in
21863 File\SpecialChar menuseparator
21868 Finally, the document is reloaded using the new name.
21871 \begin_layout Labeling
21872 \labelwidthstring 00.00.0000
21874 \begin_inset space ~
21878 \begin_inset space ~
21882 \begin_inset Newline newline
21886 \begin_inset Flex Code
21889 \begin_layout Plain Layout
21892 \begin_inset Quotes eld
21896 \begin_inset Quotes erd
21905 \begin_inset Flex Code
21908 \begin_layout Plain Layout
21911 \begin_inset Quotes eld
21915 \begin_inset Quotes erd
21924 \begin_inset Newline newline
21928 \begin_inset Flex Code
21931 \begin_layout Plain Layout
21935 \begin_inset Quotes eld
21939 \begin_inset Quotes erd
21948 \begin_inset Newline newline
21952 \begin_inset Flex Code
21955 \begin_layout Plain Layout
21959 \begin_inset Quotes eld
21963 \begin_inset Quotes erd
21974 \begin_layout Subsubsection
21975 Update of the local directory checkout from repository
21978 \begin_layout Standard
21979 Once your documents gets more complex, containing sub-documents and pictures,
21981 \begin_inset Flex Code
21984 \begin_layout Plain Layout
21990 files and so on using version control becomes more complicated.
21992 supports updating the whole tree in which resides the document.
21993 This become especially useful once you cooperate with people which neither
21994 have detailed knowledge about CVS usage nor they have ambition to commit
21995 additional material to the repository.
21996 You have to organize the files structure so that all external files are
21997 in the same directory or subdirectories of the document.
21998 It's good practice anyway to store multipart documents in an extra directory.
22001 \begin_layout Standard
22003 \begin_inset Flex Code
22006 \begin_layout Plain Layout
22007 Update local directory from repository
22012 command updates the whole directory.
22013 If local changes are detected user is warned before update starts.
22014 In case of merge conflicts both versions of the conflicting document parts
22015 are placed in the final document.
22016 You have to review and correct the result of the merge.
22017 You'll find the conflicts enclosed in pairs of
22018 \begin_inset Flex Code
22021 \begin_layout Plain Layout
22028 \begin_inset Flex Code
22031 \begin_layout Plain Layout
22038 \begin_inset Flex Code
22041 \begin_layout Plain Layout
22048 The first part is your version as before the update operation with the
22049 document name prepended.
22050 The second one is the repository version with the version number after
22052 \begin_inset Flex Code
22055 \begin_layout Plain Layout
22064 \begin_layout Labeling
22065 \labelwidthstring 00.00.0000
22067 \begin_inset space ~
22071 \begin_inset space ~
22075 \begin_inset Newline newline
22079 \begin_inset Flex Code
22082 \begin_layout Plain Layout
22090 (Ask if changes are detected.)
22091 \begin_inset Newline newline
22095 \begin_inset Flex Code
22098 \begin_layout Plain Layout
22099 cd $path; cvs -q update
22109 \begin_layout Standard
22111 \begin_inset Flex Code
22114 \begin_layout Plain Layout
22120 stands for the path to the document.
22123 \begin_layout Subsubsection
22129 \begin_layout Standard
22130 This shows the complete history of the CVS document.
22133 cvs log "<file-name>"
22135 is shown in a browser.
22138 \begin_layout Subsubsection
22142 \begin_layout Standard
22144 supports CVS version number, author name, date and time of last commit.
22145 All those are extracted from
22147 cvs log -r <file-name>
22151 \begin_inset CommandInset ref
22153 reference "subsec:VCS-Revision-Information"
22160 \begin_layout Subsection
22161 SVN commands in \SpecialChar LyX
22165 \begin_layout Standard
22166 SVN is now partially supported by \SpecialChar LyX
22168 You can find the commands in the
22170 File\SpecialChar menuseparator
22172 \begin_inset space ~
22178 Please note that if you use password protected access to repository via
22179 ssh, you will be asked in terminal window.
22181 was tested against SVN 1.5, 1.6, 1.7 and 1.8
22185 \begin_layout Plain Layout
22186 Most of the commands will work with 1.4 too, see
22187 \begin_inset CommandInset ref
22189 reference "subsec:SVN-Repo-Update"
22194 There seems to be currently unresolved permissions problem under SVN 1.8
22195 with reverting changes when file is locked.
22203 \begin_layout Subsubsection
22209 \begin_layout Standard
22210 If your document is not under revision control, this is the only item shown
22212 And if it is under revision control, the
22216 item is not visible.
22219 \begin_layout Standard
22220 This command registers in SVN your document ONLY in case you have already
22221 the documents directory under SVN control (in particular
22226 This means you have to checkout the archive by yourself.
22229 \begin_layout Standard
22230 Then you are asked interactively to supply an initial description of the
22232 Don't forget that registered file is not yet commited.
22235 \begin_layout Standard
22236 SVN command that is run:
22239 \begin_inset Quotes eld
22243 \begin_inset Quotes erd
22249 \begin_layout Standard
22254 to understand the switches.
22257 \begin_layout Subsubsection
22263 \begin_layout Standard
22264 When you are finished editing a file, you commit your changes.
22265 When you do this, you are asked for a description of the changes.
22266 After that changes are commited.
22269 \begin_layout Standard
22274 \begin_layout Plain Layout
22275 In case locking is not enabled.
22277 \begin_inset CommandInset ref
22279 reference "subsec:SVN-File-Locking"
22290 svn commit -q -m"<description>" <file-name>
22293 \begin_layout Subsubsection
22299 \begin_layout Standard
22300 Updates the changes of this file from the repository.
22301 Be sure you understand SVN merging and conflicts resolving before using
22302 this function, because all conflicts has to be resolved manually by you!
22305 \begin_layout Standard
22310 \begin_layout Plain Layout
22318 svn update --non-interactive
22319 \begin_inset Quotes eld
22323 \begin_inset Quotes erd
22329 \begin_layout Subsubsection
22332 Revert To Repository Version
22335 \begin_layout Standard
22336 This will discard all changes made to the document since the last check
22338 You get a warning before changes are discarded.
22341 \begin_layout Standard
22345 \begin_inset Quotes eld
22349 \begin_inset Quotes erd
22355 \begin_layout Subsubsection
22361 \begin_layout Standard
22362 This will create a copy of the current document including the version history.
22363 It requires a clean document without any changes since the last checkin.
22364 You are asked for a file name and a description of the copy operation.
22365 After that the copy is created, both locally and in the repository.
22366 If the parent directories of the copied and original document differ, all
22367 relative paths of included files of the copy are adjusted (like in
22369 File\SpecialChar menuseparator
22374 Finally, the copy is loaded instead of the original document.
22377 \begin_layout Labeling
22378 \labelwidthstring 00.00.0000
22380 \begin_inset space ~
22384 \begin_inset space ~
22388 \begin_inset Newline newline
22392 \begin_inset Flex Code
22395 \begin_layout Plain Layout
22399 \begin_inset Quotes eld
22403 \begin_inset Quotes erd
22407 \begin_inset Quotes eld
22411 \begin_inset Quotes erd
22420 \begin_inset Newline newline
22424 \begin_inset Flex Code
22427 \begin_layout Plain Layout
22436 \begin_layout Subsubsection
22442 \begin_layout Standard
22443 This will rename the current document including the version history.
22444 It requires a clean document without any changes since the last checkin.
22445 You are asked for a file name and a description of the rename operation.
22446 After that the document is renamed, both locally and in the repository.
22447 If the parent directories of the new and old file names differ, all relative
22448 paths of included files are adjusted (like in
22450 File\SpecialChar menuseparator
22455 Finally, the document is reloaded using the new name.
22458 \begin_layout Labeling
22459 \labelwidthstring 00.00.0000
22461 \begin_inset space ~
22465 \begin_inset space ~
22469 \begin_inset Newline newline
22473 \begin_inset Flex Code
22476 \begin_layout Plain Layout
22480 \begin_inset Quotes eld
22484 \begin_inset Quotes erd
22488 \begin_inset Quotes eld
22492 \begin_inset Quotes erd
22501 \begin_inset Newline newline
22505 \begin_inset Flex Code
22508 \begin_layout Plain Layout
22517 \begin_layout Subsubsection
22518 \begin_inset CommandInset label
22520 name "subsec:SVN-Repo-Update"
22524 Update of the local directory checkout from repository
22528 \begin_layout Plain Layout
22529 Note that this command will work only with subversion
22530 \begin_inset Formula $\geqq1.5$
22541 \begin_layout Standard
22542 All the commands above have one shortcomming - they deal with the current
22544 Once your document contains pictures, includes external
22545 \begin_inset Flex Code
22548 \begin_layout Plain Layout
22554 files and so on administration becomes more complicated.
22556 now supports updating the whole tree in which resides the document
22560 \begin_layout Plain Layout
22561 One need to organize the files structure so that all external files are
22562 in the same directory or subdirectories of the document.
22569 This become especially useful once you cooperate with people which neither
22570 know about subversion management nor they have ambition to commit additional
22571 material to the repository.
22575 \begin_layout Standard
22576 \begin_inset Flex Code
22579 \begin_layout Plain Layout
22580 Update local directory from repository
22585 command updates the whole directory and in case of merge conflicts local
22586 version of the files are left, so no unintended data loss occurs.
22587 If local changes are detected user is warned before update starts.
22590 \begin_layout Labeling
22591 \labelwidthstring 00.00.0000
22593 \begin_inset space ~
22597 \begin_inset space ~
22601 \begin_inset Newline newline
22605 \begin_inset Flex Code
22608 \begin_layout Plain Layout
22614 (Ask if changes are detected.)
22615 \begin_inset Newline newline
22619 \begin_inset Flex Code
22622 \begin_layout Plain Layout
22623 svn update –accept mine-full $path
22631 \begin_layout Standard
22633 \begin_inset Flex Code
22636 \begin_layout Plain Layout
22642 stands for the path to the document.
22645 \begin_layout Subsubsection
22651 \begin_layout Standard
22652 This shows the complete history of the SVN document.
22656 \begin_inset Quotes eld
22660 \begin_inset Quotes erd
22665 is shown in a browser.
22668 \begin_layout Subsubsection
22670 \begin_inset CommandInset label
22672 name "subsec:SVN-File-Locking"
22679 \begin_layout Standard
22680 The file exchange through various revision control systems brings the problem
22681 of merge conflicts in case two different users try to edit the same (parts
22683 When such a conflict happens it needs manual resolving and one reasonable
22684 alternative is to provide some kind of locking mechanism, which guarantees
22685 that only one user is allowed to edit file at the given time.
22688 \begin_layout Standard
22689 SVN has two such mechanisms to provide mutual exclusivity for file access
22690 - locks and automatic setting of write permissions (see sec.
22692 \begin_inset CommandInset ref
22694 reference "subsec:Automatical-Locking-Property"
22699 \begin_inset Flex Code
22702 \begin_layout Plain Layout
22712 \begin_layout Plain Layout
22713 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
22719 If this property is detected for a given document \SpecialChar LyX
22720 starts to use SVN locks
22721 for document editing automatically and the whole check-in/out mechanism
22722 switches to the same regimen as for RCS.
22723 This in particular means there are two different modes of file use in \SpecialChar LyX
22727 \begin_layout Itemize
22729 The loaded file is in the read-only mode.
22730 For editing on needs to check-out.
22735 consists of updating from the repository and gaining write lock.
22736 If the lock is not possible to obtain, we remain in unlocked state.
22739 \begin_layout Itemize
22741 The loaded file is in the 'normal' edit mode.
22742 No other user is allowed to edit the file.
22747 consists of commiting changes and releasing write-lock.
22748 If no changes have been made to the document, no commit will be produced
22752 \begin_layout Plain Layout
22753 Don't be puzzled by the fact that you will be asked for commit message anyway.
22758 and only the write-lock will be released.
22761 \begin_layout Standard
22765 \begin_layout Labeling
22766 \labelwidthstring 00.00.0000
22769 svn commit -q -m"<description>" "<file-name>"
22770 \begin_inset Newline newline
22773 svn unlock "<file-name>"
22776 \begin_layout Labeling
22777 \labelwidthstring 00.00.0000
22780 svn update "<file-name>"
22781 \begin_inset Newline newline
22784 svn lock "<file-name>"
22787 \begin_layout Subsubsection
22790 \begin_inset CommandInset label
22792 name "subsec:Automatical-Locking-Property"
22798 Automatic Locking Property
22801 \begin_layout Standard
22802 The above mentioned automatic setting of write permissions of the .lyx file
22805 File\SpecialChar menuseparator
22807 \begin_inset space ~
22810 Control\SpecialChar menuseparator
22811 Toggle locking property
22814 This command is active only when the file is not locked on the svn server
22816 you need to check-out before proceeding).
22819 \begin_layout Labeling
22820 \labelwidthstring 00.00.0000
22822 \begin_inset space ~
22828 \begin_layout Labeling
22829 \labelwidthstring 00.00.0000
22832 svn propset svn:needs-lock ON "<file-name>"
22835 \begin_layout Labeling
22836 \labelwidthstring 00.00.0000
22839 svn propdel svn:needs-lock "<file-name>"
22842 \begin_layout Subsubsection
22843 \begin_inset CommandInset label
22845 name "subsec:VCS-Revision-Information"
22849 Revision Information in Documents
22852 \begin_layout Standard
22853 There are more possibilities how to activate revision information in our
22857 \begin_layout Itemize
22863 \begin_layout Itemize
22864 tree revision information (
22865 \begin_inset Flex Code
22868 \begin_layout Plain Layout
22875 The result is the output of the
22876 \begin_inset Flex Code
22879 \begin_layout Plain Layout
22885 command, the following table gives you an idea, how to read the results.
22888 \begin_layout Standard
22890 \begin_inset Tabular
22891 <lyxtabular version="3" rows="6" columns="2">
22892 <features tabularvalignment="middle">
22893 <column alignment="center" valignment="top">
22894 <column alignment="center" valignment="top">
22896 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
22899 \begin_layout Plain Layout
22905 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
22908 \begin_layout Plain Layout
22916 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22919 \begin_layout Plain Layout
22925 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22928 \begin_layout Plain Layout
22929 mixed revision working copy
22936 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22939 \begin_layout Plain Layout
22945 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22948 \begin_layout Plain Layout
22949 modified working copy
22956 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22959 \begin_layout Plain Layout
22965 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22968 \begin_layout Plain Layout
22969 switched working copy
22976 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22979 \begin_layout Plain Layout
22985 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22988 \begin_layout Plain Layout
22989 partial working copy, from a sparse checkout
22996 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
22999 \begin_layout Plain Layout
23005 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
23008 \begin_layout Plain Layout
23009 mixed revision, modified, switched working copy
23022 \begin_layout Itemize
23023 file revision information.
23024 The result comes from parsing the output of
23025 \begin_inset Flex Code
23028 \begin_layout Plain Layout
23030 \begin_inset space ~
23034 \begin_inset space ~
23038 \begin_inset space ~
23047 Supported flags are:
23051 \begin_layout Itemize
23052 version number of the last commit (
23053 \begin_inset Flex Code
23056 \begin_layout Plain Layout
23065 \begin_layout Itemize
23066 author of the last commit (
23067 \begin_inset Flex Code
23070 \begin_layout Plain Layout
23079 \begin_layout Itemize
23080 date of the last commit (
23081 \begin_inset Flex Code
23084 \begin_layout Plain Layout
23093 \begin_layout Itemize
23094 time of the last commit (
23095 \begin_inset Flex Code
23098 \begin_layout Plain Layout
23108 \begin_layout Standard
23109 You can obtain this info via InsetInfo (e.g.
23111 \begin_inset Flex Code
23114 \begin_layout Plain Layout
23115 info-insert buffer vcs-date
23121 The information will be available only when you have the file stored under
23122 svn managment (i.e.
23124 \begin_inset Flex Code
23127 \begin_layout Plain Layout
23133 directory is available with your document).
23137 \begin_layout Itemize
23138 Another—a hacking one—possibility is to use svn keywords
23142 \begin_layout Plain Layout
23143 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
23149 In short – you set file keywords property (e.g.
23152 svn propset svn:keywords 'Rev' file.lyx
23154 ) and then paste keyword \SpecialChar TeX
23159 \begin_layout Plain Layout
23160 This is an easy way how to ensure that \SpecialChar LyX
23161 won't break the line in the middle
23167 tag in your document (e.g.
23172 \begin_layout Plain Layout
23180 This way svn client will automatically substitute revision number (e.g.
23185 \begin_layout Plain Layout
23192 ) after each update and commit.
23193 There are more problems with this approach.
23194 Firstly, the '$' character is used in \SpecialChar TeX
23195 world for math equations, so any
23196 occurence of math formula
23197 \begin_inset Formula $Rev$
23201 \begin_inset Formula $Rev:59$
23204 in your \SpecialChar LyX
23206 Similarly for other keywords like Id, Date, Author, etc.
23207 Secondly svn output is dependent on your locales, so its very easy that
23208 svn would produce some problematic strings once Date is used.
23209 Thirdly you get the whole 'Rev: 59' string in your document instead of
23211 Until subversion implements user's custom keywords it will be hard to use
23212 this approach reliably or let \SpecialChar LyX
23213 to support it directly.
23216 \begin_layout Subsection
23217 SVN and Windows Environment
23220 \begin_layout Quote
23221 My inclination is to say that if the user cannot figure out the command
23222 line operations on their own fairly quickly, they would be well advised
23223 to use TortoiseSVN.
23229 \begin_layout Subsubsection
23233 \begin_layout Standard
23234 In addition to installing \SpecialChar LyX
23235 , and having access to a Subversion repository,
23236 the user will need to install the Subversion client program.
23237 A Windows installer for the client program is available from
23238 \begin_inset CommandInset href
23241 target "http://www.collab.net/nonav/downloads/subversion/"
23247 The user may also want to install
23248 \begin_inset CommandInset href
23251 target "http://tortoisesvn.tigris.org/"
23256 , which integrates Subversion operations into the context (rightclick) menu
23257 of Windows Explorer.
23258 Operations done outside \SpecialChar LyX
23259 will typically be more convenient using the Explorer
23261 Note that TortoiseSVN is not a replacement for the client program, which
23262 is what \SpecialChar LyX
23266 \begin_layout Subsubsection
23267 Bringing a document under Subversion control
23270 \begin_layout Standard
23271 Before a \SpecialChar LyX
23272 document can be brought under version control in Subversion, its
23273 parent directory needs to be under version control.
23274 If the document is being added to a project already in the repository,
23275 this is accomplished by checking the project out to the directory where
23276 the new document will be placed.
23277 If the project itself is not yet under version control (for instance, if
23278 this document starts a new project), the directory must be imported into
23280 This is done outside \SpecialChar LyX
23282 Both import and checkout are easily accomplished from the Explorer context
23283 menu using TortoiseSVN, or alternatively can be done using the command
23284 line client at a DOS prompt.
23285 The procedure for importing the project using TortoiseSVN is described
23286 below, assuming an existing repository and a new project being started
23294 For information on using the Subversion client program, run
23301 \begin_layout Enumerate
23308 in Windows Explorer, right click it, and select
23310 TortoiseSVN\SpecialChar menuseparator
23314 If necessary, adjust the URL for the repository, then click OK.
23317 \begin_layout Enumerate
23318 Right click the level of the repository under which you want to place the
23319 new project folder (typically the top level) and click
23323 Supply a name for the project folder and click OK.
23324 Add a message for the log file if desired, then click OK again.
23325 The new project folder should appear in the repository.
23326 Finally, click OK again to exit the repository browser.
23329 \begin_layout Enumerate
23330 Once again right click
23336 , this time selecting SVN Checkout\SpecialChar ldots
23337 Select the URL of the project folder
23338 you just created in the repository, and set the checkout directory to
23346 You will be warned about a non-empty folder; click OK to proceed.
23347 You should now have a
23358 \begin_layout Enumerate
23359 Create or open your document in \SpecialChar LyX
23362 File\SpecialChar menuseparator
23364 \begin_inset space ~
23367 Control\SpecialChar menuseparator
23371 Add a log message and click OK to commit the document to version control.
23374 \begin_layout Standard
23375 From this point onward, you should have full functionality in the
23377 File\SpecialChar menuseparator
23379 \begin_inset space ~
23385 You also have the option of checking the document in and out, viewing its
23387 using the TortoiseSVN context menu in Windows Explorer or the Subversion
23388 client program from a command prompt.
23391 \begin_layout Subsubsection
23392 SSH tunnel used with SVN under Windows
23395 \begin_layout Standard
23396 Compared with Linux setting up an svn client to communicate over ssh under
23397 Windows is a rather troublesome task.
23398 We will at least offer some hints how to setup the client side but prior
23399 knowledge about ssh and the Windows command line is needed, also be prepared
23400 for a great deal of frustration\SpecialChar ldots
23404 \begin_layout Enumerate
23405 Get an svn client for windows, as described in the previous sections.
23406 When it is a fresh install run some svn command (e.g.
23408 \begin_inset Flex Code
23411 \begin_layout Plain Layout
23417 ) to create config files, which you will need to change later on.
23420 \begin_layout Enumerate
23421 Choose an ssh client for Windows.
23422 There are several possibilities, we will use the one from Putty tools
23426 \begin_layout Plain Layout
23427 \begin_inset Flex URL
23430 \begin_layout Plain Layout
23432 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
23443 You will need to set the connection up so that the client doesn't ask for
23444 any password from you.
23445 To keep things easy we will use only keys without any additional password
23450 \begin_layout Enumerate
23452 \begin_inset Flex Code
23455 \begin_layout Plain Layout
23462 Save your private .ppk key file and put the public one on the server side.
23463 If the SVN server runs on Linux, note that the format of the public key
23464 is not compatible with Linux openssh and you will need to direcly copy-paste
23467 Public key for pasting into OpenSSH authorized_keys file
23469 :” edit field into the server's
23470 \begin_inset Flex Code
23473 \begin_layout Plain Layout
23474 ~/.ssh/authorized_keys
23480 \begin_inset Flex Code
23483 \begin_layout Plain Layout
23492 \begin_layout Enumerate
23494 \begin_inset Flex Code
23497 \begin_layout Plain Layout
23504 In the SVN config file
23508 \begin_layout Plain Layout
23509 Exact path depends on Windows version, usually somewhere around
23510 \begin_inset Flex Code
23513 \begin_layout Plain Layout
23516 Documents and Settings
23530 \begin_inset Flex Code
23533 \begin_layout Plain Layout
23548 , section [tunnels], setup ssh command, e.g.
23550 \begin_inset Flex Code
23553 \begin_layout Plain Layout
23554 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
23563 \begin_layout Plain Layout
23564 It will usually take a lot of time to get exact command right and it depends
23566 For example do not have some remote server saved as a default session in
23568 If things fail, try to connect via plink without SVN first.
23577 \begin_layout Enumerate
23578 Checkout the SVN archive, e.
23579 \begin_inset space \thinspace{}
23583 \begin_inset Newline newline
23587 \begin_inset Flex Code
23590 \begin_layout Plain Layout
23591 svn co svn+ssh://user@server/repository_path
23599 \begin_layout Subsubsection
23600 End-of-Line Conversions
23603 \begin_layout Standard
23604 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
23606 use different line endings inside the .lyx files.
23607 This is not a problem as far as \SpecialChar LyX
23608 functionality is concerned, but the commit
23609 diffs will be huge and merge-conflicts prone.
23610 Fortunately SVN itself knows
23614 \begin_layout Plain Layout
23615 \begin_inset Flex URL
23618 \begin_layout Plain Layout
23620 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
23630 how to deal with CR/LF problems when switching .lyx files to the
23631 \begin_inset Flex Code
23634 \begin_layout Plain Layout
23644 \begin_layout Plain Layout
23646 \begin_inset Flex Code
23649 \begin_layout Plain Layout
23650 svn propset svn:eol-style native FILE_NAME
23663 \begin_layout Subsection
23664 GIT commands in \SpecialChar LyX
23668 \begin_layout Standard
23669 A minimal subset of GIT commands is now supported by \SpecialChar LyX
23671 You can find the commands in the
23673 File\SpecialChar menuseparator
23675 \begin_inset space ~
23681 Please note that if you use password protected access to repository via
23682 ssh, you will be asked in terminal window.
23684 was tested against GIT 1.7.
23688 \begin_layout Plain Layout
23689 Windows users please note that you need to ensure that git is on the path.
23690 This can be set from within \SpecialChar LyX
23693 Tools\SpecialChar menuseparator
23694 Preferences\SpecialChar menuseparator
23695 Paths\SpecialChar menuseparator
23706 \begin_layout Standard
23707 One big difference of GIT and the other supported version control systems
23708 is the distributed nature of GIT: With traditional version control systems
23709 there is one central server which hosts the repository.
23710 Users commit their changes to the server, and get updates made by other
23712 With GIT, users commit to a local repository.
23713 The local repository can be synchronized with one or more remote repositories
23715 \begin_inset Flex Code
23718 \begin_layout Plain Layout
23725 \begin_inset Flex Code
23728 \begin_layout Plain Layout
23736 does not interact in any way with remote GIT repositories.
23737 It works exclusively with the local repository in a very similar way as
23738 with a central CVS or SVN repository.
23739 If you use remote GIT repositories you need to do the
23740 \begin_inset Flex Code
23743 \begin_layout Plain Layout
23750 \begin_inset Flex Code
23753 \begin_layout Plain Layout
23759 operations with your favourite GIT client.
23762 \begin_layout Subsubsection
23768 \begin_layout Standard
23769 If your document is not under revision control, this is the only item shown
23771 And if it is under revision control, the
23775 item is not visible.
23778 \begin_layout Standard
23779 This command registers in GIT your document ONLY in case you have already
23780 the documents directory under GIT control (in particular
23785 This means you have to checkout the archive by yourself.
23788 \begin_layout Standard
23789 Then you are asked interactively to supply an initial description of the
23791 Don't forget that registered file is not yet commited.
23794 \begin_layout Standard
23795 GIT command that is run:
23798 \begin_inset Quotes eld
23802 \begin_inset Quotes erd
23808 \begin_layout Standard
23813 to understand the switches.
23816 \begin_layout Subsubsection
23822 \begin_layout Standard
23823 When you are finished editing a file, you commit your changes.
23824 When you do this, you are asked for a description of the changes.
23825 After that changes are commited.
23828 \begin_layout Standard
23831 git commit -q -m"<description>" <file-name>
23834 \begin_layout Subsubsection
23837 Revert To Repository Version
23840 \begin_layout Standard
23841 This will discard all changes made to the document since the last check
23843 You get a warning before changes are discarded.
23846 \begin_layout Standard
23850 \begin_inset Quotes eld
23854 \begin_inset Quotes erd
23860 \begin_layout Subsubsection
23866 \begin_layout Standard
23867 This will rename the current document including the version history.
23868 It requires a clean document without any changes since the last checkin.
23869 You are asked for a file name and a description of the rename operation.
23870 After that the document is renamed, both locally and in the repository.
23871 If the parent directories of the new and old file names differ, all relative
23872 paths of included files are adjusted (like in
23874 File\SpecialChar menuseparator
23879 Finally, the document is reloaded using the new name.
23882 \begin_layout Labeling
23883 \labelwidthstring 00.00.0000
23885 \begin_inset space ~
23889 \begin_inset space ~
23893 \begin_inset Newline newline
23897 \begin_inset Flex Code
23900 \begin_layout Plain Layout
23904 \begin_inset Quotes eld
23908 \begin_inset Quotes erd
23912 \begin_inset Quotes eld
23916 \begin_inset Quotes erd
23925 \begin_inset Newline newline
23929 \begin_inset Flex Code
23932 \begin_layout Plain Layout
23941 \begin_layout Subsubsection
23947 \begin_layout Standard
23948 This shows the complete history of the GIT document.
23952 \begin_inset Quotes eld
23956 \begin_inset Quotes erd
23961 is shown in a browser.
23964 \begin_layout Subsubsection
23968 \begin_layout Standard
23970 supports GIT hash number of the last commit to the file, author name, date
23971 and time of last commit.
23972 All those are extracted from
23974 git log -n 1 --pretty=format:%H%n%an%n%ai
23977 Tree version information is obtained via
23979 git describe --abbrev --dirty --long
23983 \begin_inset CommandInset ref
23985 reference "subsec:VCS-Revision-Information"
23992 \begin_layout Subsection
23996 \begin_layout Standard
23997 With the recent addition of the vc-command function \SpecialChar LyX
23998 power users are allowed
23999 to create their own commands for revision control.
24002 \begin_layout Standard
24003 As an example you can see how two TortoiseSVN commands could be integrated
24007 \begin_layout Description
24009 \begin_inset Flex Code
24012 \begin_layout Plain Layout
24013 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
24021 \begin_layout Description
24023 \begin_inset Flex Code
24026 \begin_layout Plain Layout
24027 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
24035 \begin_layout Subsection
24036 Version control and Document comparison
24039 \begin_layout Standard
24040 One of the typical uses of version control is to inspect the changes between
24041 revisions, usually by creating
24042 \begin_inset Flex Code
24045 \begin_layout Plain Layout
24052 While this is useful for plain text files, it is much less useful in the
24053 case of \SpecialChar LyX
24054 files, which have more a complicated structure.
24055 Hence we provide binding to the Document comparison feature.
24056 There are two ways of calling this feature - either by direct call of
24057 \begin_inset Flex Code
24060 \begin_layout Plain Layout
24067 function (for details see \SpecialChar LyX
24068 functions manual) or by icon/menu item
24069 \begin_inset Flex Noun
24072 \begin_layout Plain Layout
24073 Compare with older revision...
24079 One can either compare two chosen revisions of the document or he can simply
24080 compare the current version of edited text with older revisions (where
24082 \begin_inset Flex Noun
24085 \begin_layout Plain Layout
24091 ' revisions back means comparison of the edited file with last commited
24096 \begin_layout Standard
24097 This feature is supported for SVN and RCS though due to the more complicated
24098 versioning scheme of RCS there is a constraint – when addressing the revisions
24099 in dialog, numbers always point to the last number in RCS revision number,
24102 We don't currently support GIT addressing of revisions, one can just compare
24103 edited document with its revision X steps backs, where X is addressed as
24107 \begin_layout Section
24108 Literate Programming
24111 \begin_layout Standard
24116 (kayvan@sylvan.com)
24120 original documentation written by
24122 Edmar Wienskoski Jr.
24125 (edmar-w-jr@technologist.com)
24128 \begin_layout Subsection
24132 \begin_layout Standard
24133 The main purpose of this documentation is to show you how to use \SpecialChar LyX
24135 programming, where it is assumed that you are familiar with this programming
24136 technique, and know what
24137 \begin_inset Quotes eld
24141 \begin_inset Quotes erd
24145 \begin_inset Quotes eld
24149 \begin_inset Quotes erd
24153 If that is not the case, please follow the web links provided in the following
24155 There is a lot of good documentation out there covering old development
24156 history to the latest tools tips.
24159 \begin_layout Standard
24160 It is also assumed that you are familiar with \SpecialChar LyX
24161 itself to a point that you
24162 are comfortable changing your \SpecialChar LyX
24163 preferences, and X resources file.
24164 If that is not the case please refer to other \SpecialChar LyX
24165 documentation to cover your
24169 \begin_layout Subsection
24170 Literate Programming
24173 \begin_layout Standard
24174 From the Literate Programming FAQ:
24177 \begin_layout Quotation
24178 Literate programming is the combination of documentation and source together
24179 in a fashion suited for reading by human beings.
24180 In fact, literate programs should be enjoyable reading, even inviting!
24181 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
24182 and documentation in a single file.
24183 Literate programming tools then parse the file to produce either readable
24184 documentation or compilable source.
24185 The WEB style of literate programming was created by D.
24186 \begin_inset space \thinspace{}
24190 Knuth during the development of his \SpecialChar TeX
24191 typesetting software.
24195 \begin_layout Standard
24196 Another excerpt says:
24199 \begin_layout Quotation
24202 How is literate programming different from verbose commenting?
24205 \begin_layout Quotation
24206 There are three distinguishing characteristics.
24207 In order of importance, they are:
24211 \begin_layout Itemize
24212 flexible order of elaboration
24215 \begin_layout Itemize
24216 automatic support for browsing
24219 \begin_layout Itemize
24220 typeset documentation, especially diagrams and mathematics
24224 \begin_layout Standard
24225 Now that I sparked your curiosity, take a look in the references.
24228 \begin_layout Subsubsection
24232 \begin_layout Standard
24233 The complete Literate Programming FAQ can be found at:
24236 \begin_layout Quote
24237 Literate Programming FAQ
24238 \begin_inset Flex URL
24241 \begin_layout Plain Layout
24243 http://www.literateprogramming.com/lpfaq.pdf
24251 \begin_layout Standard
24252 The FAQ lists 23 (twenty three!) different literate programming tools.
24253 Where some are specialized or
24254 \begin_inset Quotes eld
24258 \begin_inset Quotes erd
24261 for particular programming languages, while other have general scope.
24266 for my own use for several reasons:
24269 \begin_layout Itemize
24270 It can generate the documentation either in \SpecialChar LaTeX
24274 \begin_layout Itemize
24275 It has a open architecture, i.
24276 \begin_inset space \thinspace{}
24280 \begin_inset space \space{}
24283 it is easy to plug in new filters and to perform special processing that
24288 \begin_layout Itemize
24289 There is a good selection of filters available already (the HTML is one
24293 \begin_layout Itemize
24297 \begin_layout Standard
24298 The Noweb web page can be found at:
24301 \begin_layout Quote
24303 \begin_inset Flex URL
24306 \begin_layout Plain Layout
24308 http://www.cs.virginia.edu/~nr/noweb/
24316 \begin_layout Standard
24317 Starting from there you can reach many other interesting links and even
24318 some literate program examples.
24321 \begin_layout Subsection
24323 and Literate Programming with Noweb
24326 \begin_layout Standard
24327 The \SpecialChar LyX
24328 support for Literate Programming is provided by using the generic \SpecialChar LyX
24330 converters mechanism.
24331 This support is provided in a
24332 \begin_inset Quotes eld
24336 \begin_inset Quotes erd
24340 \begin_inset space \thinspace{}
24344 \begin_inset space \space{}
24347 you will be able to use this new \SpecialChar LyX
24348 feature with some other literate programming
24349 tool of your choice by just changing your \SpecialChar LyX
24353 \begin_layout Subsubsection
24354 Generating documents and code (weaving and tangling)
24357 \begin_layout Paragraph
24358 Using the noweb module
24361 \begin_layout Standard
24362 If you have installed Noweb and \SpecialChar LyX
24363 successfully, whenever you open a new document,
24364 after you have chosen its document class, use the Document->Settings menu
24366 \begin_inset Quotes eld
24370 \begin_inset Quotes erd
24374 If Noweb is correctly installed, when you click on the
24375 \begin_inset Quotes eld
24379 \begin_inset Quotes erd
24382 link, you will see the
24383 \begin_inset Quotes eld
24387 \begin_inset Quotes erd
24390 module in the available list and you can add it to your document.
24393 \begin_layout Paragraph
24397 \begin_layout Standard
24399 enables you to write code with a layout named
24400 \begin_inset Flex Noun
24403 \begin_layout Plain Layout
24410 Noweb delimits chunks like this:
24413 \begin_layout LyX-Code
24417 \begin_layout LyX-Code
24421 \begin_layout LyX-Code
24425 \begin_layout LyX-Code
24429 \begin_layout LyX-Code
24433 \begin_layout Standard
24434 The problem is that whatever is written in between the << and the
24438 must be taken literally, i.
24439 \begin_inset space \thinspace{}
24443 \begin_inset space \space{}
24447 should be prevented from making any special interpretation of what has
24449 This is also handled by
24450 \begin_inset Flex Noun
24453 \begin_layout Plain Layout
24459 , that works like a normal paragraph but has a free spacing capability.
24462 \begin_layout Standard
24463 As a special note, you can also use the
24464 \begin_inset Quotes eld
24468 \begin_inset Quotes erd
24471 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
24475 \begin_layout LyX-Code
24479 \begin_layout LyX-Code
24480 def some_function(args):
24483 \begin_layout LyX-Code
24484 "This is the doc string for this function."
24487 \begin_layout LyX-Code
24488 print "My args: ", args
24491 \begin_layout LyX-Code
24492 @ %def some_function
24495 \begin_layout Standard
24496 For an example of this usage and the resulting cross-reference output, look
24497 at the Literate python program in
24499 LIBDIR/examples/listerrors.lyx
24501 which should make this all clear.
24504 \begin_layout Paragraph
24505 Generating the documentation
24508 \begin_layout Standard
24509 At this point you already have a new document file with a proper document
24510 class, and with some code and text on it.
24511 How do I print it? The answer is simple, you select
24513 View\SpecialChar menuseparator
24517 Just like you would do for a plain document.
24518 No special procedure is required.
24521 \begin_layout Standard
24522 To help orientate you, I will now explain what happens inside \SpecialChar LyX
24526 \begin_layout Enumerate
24529 Update\SpecialChar menuseparator
24532 menu option is chosen, a \SpecialChar LaTeX
24538 \begin_layout Standard
24539 If the document is of any literate class the generated file will be named
24540 with an extension name defined by the
24541 \begin_inset Quotes eld
24545 \begin_inset Quotes erd
24548 format (defined in the Preferences panel), otherwise the file will have
24557 \begin_layout Enumerate
24558 Note that the only difference so far is in the name of the file, no special
24559 processing is required by \SpecialChar LyX
24561 Given that you formatted the code using the
24562 \begin_inset Flex Noun
24565 \begin_layout Plain Layout
24571 layout that, by itself, takes care of the business.
24574 \begin_layout Enumerate
24575 If the document is of any literate class \SpecialChar LyX
24576 will then use the internal \SpecialChar LyX
24578 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
24583 \begin_layout Plain Layout
24584 The converters are defined in the
24586 Tools\SpecialChar menuseparator
24590 \begin_inset Quotes eld
24594 \begin_inset Quotes erd
24606 manual for general information about converters.
24611 to generate the \SpecialChar LaTeX
24616 \begin_layout Standard
24617 Otherwise it will just skip this step.
24621 \begin_layout Enumerate
24622 Finally, \SpecialChar LaTeX
24623 is invoked and the regular post processing continues as in a plain
24627 \begin_layout Standard
24628 Independence from a particular
24629 \begin_inset Quotes eld
24633 \begin_inset Quotes erd
24636 is easily achieved by changing the commands that are run by the various
24640 \begin_layout Paragraph
24641 Generating the code
24644 \begin_layout Standard
24645 When the build menu option is chosen or the corresponding button in the
24646 toolbar is pressed, a \SpecialChar LaTeX
24647 file is generated just like step 1 above.
24648 Next, \SpecialChar LyX
24654 This converter needs to be defined by the user and is not installed by
24655 default, though the Program format is.
24656 This converter (like any other converter) will have two parts:
24659 \begin_layout Enumerate
24660 The converter program itself.
24661 This program performs the conversion from the one format to the other (in
24662 this case, from the Noweb format to the Program pseudo-format).
24665 \begin_layout Enumerate
24666 The error log parser.
24667 This is a program whose sole purpose is to rewrite error messages in a
24668 format that \SpecialChar LyX
24670 This makes it possible for \SpecialChar LyX
24671 to place error boxes in the right places in
24675 \begin_layout Standard
24676 The first part, the
24677 \begin_inset Quotes eld
24681 \begin_inset Quotes erd
24684 setting, should be set to
24685 \begin_inset Newline newline
24689 \begin_inset Quotes eld
24697 \begin_inset Quotes erd
24701 \begin_inset Newline newline
24704 This basically means that \SpecialChar LyX
24706 \begin_inset Quotes eld
24710 \begin_inset Quotes erd
24713 (a program or script) with the name of the Noweb file (normally a file
24714 in the \SpecialChar LyX
24715 temp directory) and the directory path of the original \SpecialChar LyX
24720 \begin_layout Standard
24721 This is an implementation of
24722 \begin_inset Quotes eld
24726 \begin_inset Quotes erd
24729 that you can place in a directory on your path:
24732 \begin_layout Standard
24733 \begin_inset VSpace defskip
24739 \begin_layout Standard
24740 \begin_inset Newpage pagebreak
24746 \begin_layout Standard
24752 \begin_layout Standard
24758 \begin_layout Standard
24761 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
24764 \begin_layout Standard
24765 \begin_inset VSpace defskip
24771 \begin_layout Standard
24772 The next part of the converter setting is the
24773 \begin_inset Quotes eld
24777 \begin_inset Quotes erd
24780 which is to be set to
24781 \begin_inset Newline newline
24785 \begin_inset Quotes eld
24790 parselog=$$s/scripts/listerrors
24793 \begin_inset Quotes erd
24797 \begin_inset Newline newline
24800 This will run any errors that are generated by the
24801 \begin_inset Quotes eld
24805 \begin_inset Quotes erd
24808 process through the
24809 \begin_inset Quotes eld
24813 \begin_inset Quotes erd
24819 \begin_layout Standard
24820 The build will normally take place in \SpecialChar LyX
24821 's temporary directory, so the files
24822 produced by the conversion will be in that directory.
24824 will copy out what it regards as the `main' file, but the
24828 conversion may produce several files, and so most of these would then be
24829 deleted when \SpecialChar LyX
24831 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
24832 the build-script chunk can place the generated files in that location.
24835 \begin_layout Paragraph
24836 Build instructions in the document
24839 \begin_layout Standard
24840 The last piece of the integration between \SpecialChar LyX
24842 \begin_inset Quotes eld
24846 \begin_inset Quotes erd
24850 Generally, the instructions for building your program should be embedded
24851 in a chunk of its own.
24853 \begin_inset Quotes eld
24857 \begin_inset Quotes erd
24860 above uses the notangle command to look for this chunk (called
24861 \begin_inset Quotes eld
24865 \begin_inset Quotes erd
24868 ) and runs its contents through
24869 \begin_inset Quotes eld
24873 \begin_inset Quotes erd
24879 \begin_layout Standard
24880 Typically, such a chunk would look something like this:
24883 \begin_layout LyX-Code
24887 \begin_layout LyX-Code
24889 \begin_inset Newline newline
24892 if [ -z "${NOWEB_SOURCE}" ]
24893 \begin_inset Newline newline
24899 \begin_layout LyX-Code
24900 NOWEB_SOURCE=myfile.nw
24901 \begin_inset Newline newline
24905 \begin_inset Newline newline
24909 code to extract files ...
24910 use NOWEB_OUTPUT_DIR here ...]
24911 \begin_inset Newline newline
24915 code to compile files ...]
24916 \begin_inset Newline newline
24922 \begin_layout Standard
24925 LIBDIR/examples/listerrors.lyx
24929 LIBDIR/examples/Literate.lyx
24931 which implement two versions of the
24932 \begin_inset Quotes eld
24936 \begin_inset Quotes erd
24939 program for some illustrations of how all of these pieces go together or
24942 LIBDIR/examples/noweb2lyx.lyx.
24945 Interestingly, these three files show off the language-indepence of the
24947 literate programming support since they are written in Python, C and Perl
24951 \begin_layout Subsubsection
24952 Configuring \SpecialChar LyX
24956 \begin_layout Standard
24957 All the Literate Programming support is configured by the
24959 Tools\SpecialChar menuseparator
24963 \begin_inset Quotes eld
24967 \begin_inset Quotes erd
24971 The important parts are:
24974 \begin_layout Description
24976 \begin_inset space ~
24980 \begin_inset Quotes eld
24984 \begin_inset Quotes erd
24988 \begin_inset space ~
24991 format Set up via the File Formats tab, this is where the Noweb-specific
25001 , the file extension is set to
25006 This tells \SpecialChar LyX
25007 to create a file with a
25011 extension in the first step of the conversion process.
25014 \begin_layout Description
25016 \begin_inset space ~
25024 \begin_inset space ~
25027 format This is an empty format whose sole purpose is to be the endpoint
25028 of a conversion (which then allows us to set up a converter for it).
25031 \begin_layout Description
25041 This converter performs the
25042 \begin_inset Quotes eld
25046 \begin_inset Quotes erd
25049 of the literate document.
25050 For Noweb, it is set to
25051 \begin_inset Quotes eld
25056 noweave -delay -index $$i > $$o
25059 \begin_inset Quotes erd
25065 \begin_layout Description
25075 \begin_inset Quotes eld
25079 \begin_inset Quotes erd
25083 As stated above, the Converter is set to
25084 \begin_inset Quotes eld
25092 \begin_inset Quotes erd
25095 , with Flags set to
25096 \begin_inset Newline newline
25100 \begin_inset Quotes eld
25105 parselog=$$s/scripts/listerrors
25108 \begin_inset Quotes erd
25114 \begin_layout Subsubsection
25118 \begin_layout Standard
25119 There is also a new function implemented in the \SpecialChar LyX
25121 \begin_inset Quotes eld
25124 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
25128 \begin_layout Standard
25129 When debugging code with ddd/gdb, it is possible to invoke a text editor
25130 at the current execution position with a single key stroke.
25131 The default ddd configuration for that is shift-ctrl-V.
25132 It happens that you can define the editor command line invocation in ddd
25135 Edit\SpecialChar menuseparator
25136 Preferences\SpecialChar menuseparator
25139 dialog and changing the "Edit Sources" entry.
25142 \begin_layout Standard
25143 I take advantage of the newly created \SpecialChar LyX
25144 server function and this ddd feature,
25146 \begin_inset Quotes eld
25150 \begin_inset Quotes erd
25156 \begin_layout Standard
25157 \begin_inset VSpace defskip
25163 \begin_layout Standard
25166 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
25169 \begin_layout Standard
25170 \begin_inset VSpace defskip
25176 \begin_layout Standard
25177 With this, whenever you are using ddd and find a point in the program that
25178 you want to edit, you just press shift-ctrl-V (in the ddd window), and
25179 ddd will forward this information to \SpecialChar LyX
25180 through the \SpecialChar LyX
25181 server and then the
25183 window will show the same file with the cursor at the same position ddd
25185 No more guessing or long scrolling to locate a point in the program back
25189 \begin_layout Standard
25190 Note however that you must enable the \SpecialChar LyX
25191 server to get this feature working
25192 (it is disabled by default).
25193 You can enable it in
25205 ) by entering in the
25211 \begin_inset Quotes eld
25216 /home/<your-home-directory>/.lyx/lyxpipe
25219 \begin_inset Quotes erd
25225 \begin_layout Standard
25226 Read the \SpecialChar LyX
25227 server documentation in the
25229 Customization Manual
25231 for further information.
25234 \begin_layout Subsubsection
25238 \begin_layout Standard
25239 There are six new buttons that can be added to your \SpecialChar LyX
25241 Five of these buttons are short cuts to layout styles:
25264 The last one is a short cut to the
25265 \begin_inset Quotes eld
25269 \begin_inset Quotes erd
25276 \begin_layout Standard
25278 has a range of buttons that are available for tool bar customization.
25279 In my toolbar I like to combine the six short cuts above with two more:
25284 \SpecialChar menuseparator
25289 \SpecialChar menuseparator
25296 Document\SpecialChar menuseparator
25297 View\SpecialChar menuseparator
25301 Here is how it looks like:
25304 \begin_layout LyX-Code
25308 \begin_layout LyX-Code
25312 \begin_layout LyX-Code
25313 Icon "layout Standard"
25316 \begin_layout LyX-Code
25317 Icon "layout Section"
25320 \begin_layout LyX-Code
25321 Icon "layout \SpecialChar LaTeX
25325 \begin_layout LyX-Code
25326 Icon "layout \SpecialChar LyX
25330 \begin_layout LyX-Code
25331 Icon "layout Chunk"
25334 \begin_layout LyX-Code
25338 \begin_layout LyX-Code
25342 \begin_layout LyX-Code
25343 Icon "buffer-typeset"
25346 \begin_layout LyX-Code
25347 Icon "build-program"
25350 \begin_layout LyX-Code
25354 \begin_layout LyX-Code
25358 \begin_layout LyX-Code
25362 \begin_layout LyX-Code
25366 \begin_layout LyX-Code
25370 \begin_layout Subsubsection
25371 Colors customization
25374 \begin_layout Standard
25375 There are a number of colors in \SpecialChar LyX
25376 that can be customized in
25381 One of the things that bothers people is the \SpecialChar LaTeX
25383 The default color is red, since the chunks uses \SpecialChar LaTeX
25384 font, and there is a lot
25385 of chunks in literate documents, you may get tired of seeing everything
25387 You can change it by going to the tabs
25396 \begin_layout Standard
25397 The next thing is the visible presence of the newline character in the screen.
25398 You can choose the color of this particular character and make it blend
25400 I recommend you choosing a color that is close to the background but not
25401 equal, that way you still can see it is there, but it is not bothering
25405 \begin_layout Subsection
25410 \begin_layout Standard
25419 is documented in the
25423 example file and in the Sweave manual (menu
25425 Help\SpecialChar menuseparator
25431 \begin_layout Chapter
25435 \begin_layout Standard
25436 You can do everything with \SpecialChar LyX
25437 that you can do with \SpecialChar LaTeX
25439 However, \SpecialChar LyX
25440 cannot support every \SpecialChar LaTeX
25442 But you can always use \SpecialChar TeX
25444 This chapter shows you some more special things you might want to use.
25445 For other special things you can do with figures, tables, floats, boxes
25446 and notes, have a look at the
25449 \begin_inset space ~
25457 \begin_layout Section
25458 Multiple Text Columns
25461 \begin_layout Standard
25462 This feature is independent of the option
25464 Two-column document
25466 in the document settings under
25471 If you want to have 2
25472 \begin_inset space ~
25475 columns for the whole document, it is recommended to use the
25477 Two-column document
25480 For all other cases use this feature.
25483 \begin_layout Standard
25484 To use multiple text columns in your document, you have to load the module
25491 Document\SpecialChar menuseparator
25492 Settings\SpecialChar menuseparator
25495 ) and must have the \SpecialChar LaTeX
25503 \begin_layout Standard
25504 Footnotes within multiple columns will be placed at the bottom of the page
25505 and not under each column.
25506 Within the different columns you can use everything, with the limitation
25507 that for floats you need to use the float option
25514 \begin_layout Subsection
25518 \begin_layout Standard
25519 If you want to have 2
25520 \begin_inset space ~
25523 columns in your text, insert a multicolumn inset via the menu
25525 Insert\SpecialChar menuseparator
25527 \begin_inset space ~
25530 Insets\SpecialChar menuseparator
25532 \begin_inset space ~
25537 where the columns should start.
25538 Write all text that should be printed in 2
25539 \begin_inset space ~
25542 columns into this inset.
25545 \begin_layout Standard
25546 Here is an example:
25549 \begin_layout Standard
25551 \begin_inset Flex Multiple Columns
25554 \begin_layout Plain Layout
25559 The Adventure of the Empty House
25562 \begin_inset Newline newline
25565 by Sir Arthur Conan Doyle
25568 \begin_layout Plain Layout
25571 It was in the spring of the year 1894 that all London was interested, and
25572 the fashionable world dismayed, by the murder of the Honourable Ronald
25573 Adair under most unusual and inexplicable circumstances.
25574 The public has already learned those particulars of the crime which came
25575 out in the police investigation, but a good deal was suppressed upon that
25576 occasion, since the case for the prosecution was so overwhelmingly strong
25577 that it was not necessary to bring forward all the facts.
25578 Only now, at the end of nearly ten years, am I allowed to supply those
25579 missing links which make up the whole of that remarkable chain.
25580 The crime was of interest in itself, but that interest was as nothing to
25581 me compared to the inconceivable sequel, which afforded me the greatest
25582 shock and surprise of any event in my adventurous life.
25583 Even now, after this long interval, I find myself thrilling as I think
25584 of it, and feeling once more that sudden flood of joy, amazement, and increduli
25585 ty which utterly submerged my mind.
25586 Let me say to that public, which has shown some interest in those glimpses
25587 which I have occasionally given them of the thoughts and actions of a very
25588 remarkable man, that they are not to blame me if I have not shared my knowledge
25589 with them, for I should have considered it my first duty to do so, had
25590 I not been barred by a positive prohibition from his own lips, which was
25591 only withdrawn upon the third of last month.
25599 \begin_layout Standard
25600 To get 3 or more columns, set the cursor into the multicolumn inset and
25603 Insert\SpecialChar menuseparator
25605 \begin_inset space ~
25609 \begin_inset space ~
25615 The number of the desired columns is written into that inset (for 3
25616 \begin_inset space ~
25620 \begin_inset Quotes eld
25624 \begin_inset Quotes erd
25628 \begin_inset Newline newline
25631 Here is an example with 3
25632 \begin_inset space ~
25638 \begin_layout Standard
25639 \begin_inset Flex Multiple Columns
25642 \begin_layout Plain Layout
25645 \begin_inset Argument 1
25648 \begin_layout Plain Layout
25654 It can be imagined that my close intimacy with Sherlock Holmes had interested
25655 me deeply in crime, and that after his disappearance I never failed to
25656 read with care the various problems which came before the public.
25657 And I even attempted, more than once, for my own private satisfaction,
25658 to employ his methods in their solution, though with indifferent success.
25659 There was none, however, which appealed to me like this tragedy of Ronald
25661 As I read the evidence at the inquest, which led up to a verdict of willful
25662 murder against some person or persons unknown, I realized more clearly
25663 than I had ever done the loss which the community had sustained by the
25664 death of Sherlock Holmes.
25665 There were points about this strange business which would, I was sure,
25666 have specially appealed to him, and the efforts of the police would have
25667 been supplemented, or more probably anticipated, by the trained observation
25668 and the alert mind of the first criminal agent in Europe.
25669 All day, as I drove upon my round, I turned over the case in my mind and
25670 found no explanation which appeared to me to be adequate.
25671 At the risk of telling a twice-told tale, I will recapitulate the facts
25672 as they were known to the public at the conclusion of the inquest.
25680 \begin_layout Standard
25681 You can have up to 10
25682 \begin_inset space ~
25685 columns if you want to, but that might not be very pleasant for the readers
25689 \begin_layout Standard
25690 \begin_inset Newpage newpage
25696 \begin_layout Subsection
25697 Columns inside Columns
25700 \begin_layout Standard
25701 You can also have columns inside columns:
25704 \begin_layout Standard
25705 \begin_inset Flex Multiple Columns
25708 \begin_layout Plain Layout
25711 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
25712 at that time governor of one of the Australian colonies.
25713 Adair's mother had returned from Australia to undergo the operation for
25714 cataract, and she, her son Ronald, and her daughter Hilda were living together
25718 \begin_layout Plain Layout
25719 \begin_inset Flex Multiple Columns
25722 \begin_layout Plain Layout
25725 The youth moved in the best society–had, so far as was known, no enemies
25726 and no particular vices.
25727 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
25728 had been broken off by mutual consent some months before, and there was
25729 no sign that it had left any very profound feeling behind it.
25730 For the rest {sic} the man's life moved in a narrow and conventional circle,
25731 for his habits were quiet and his nature unemotional.
25732 Yet it was upon this easy-going young aristocrat that death came, in most
25733 strange and unexpected form, between the hours of ten and eleven-twenty
25734 on the night of March 30, 1894.
25742 \begin_layout Plain Layout
25745 Ronald Adair was fond of cards–playing continually, but never for such stakes
25747 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
25748 It was shown that, after dinner on the day of his death, he had played
25749 a rubber of whist at the latter club.
25750 He had also played there in the afternoon.
25755 The evidence of those who had played with him– Mr.
25756 Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
25757 and that there was a fairly equal fall of the cards.
25758 Adair might have lost five pounds, but not more.
25759 His fortune was a considerable one, and such a loss could not in any way
25761 He had played nearly every day at one club or other, but he was a cautious
25762 player, and usually rose a winner.
25763 It came out in evidence that, in partnership with Colonel Moran, he had
25764 actually won as much as four hundred and twenty pounds in a sitting, some
25765 weeks before, from Godfrey Milner and Lord Balmoral.
25766 So much for his recent history as it came out at the inquest.
25774 \begin_layout Subsection
25778 \begin_layout Standard
25779 The examples in this section show some more special features of multiple
25783 \begin_layout Standard
25784 For more features of multiple columns, have a look at the documentation
25785 of the \SpecialChar LaTeX
25791 \begin_inset CommandInset citation
25801 \begin_layout Subsubsection
25805 \begin_layout Standard
25806 To add a preface text for multiple columns, set the cursor into the multicolumn
25807 inset and use the menu
25809 Insert\SpecialChar menuseparator
25813 Write your preface text into that inset.
25814 \begin_inset Newline newline
25817 This is an example with some preface text:
25820 \begin_layout Standard
25821 \begin_inset VSpace bigskip
25827 \begin_layout Standard
25828 \begin_inset Flex Multiple Columns
25831 \begin_layout Plain Layout
25832 \begin_inset Argument 2
25835 \begin_layout Plain Layout
25836 And the story continues and continues and continues and continues\SpecialChar ldots
25844 On the evening of the crime, he returned from the club exactly at ten.
25845 His mother and sister were out spending the evening with a relation.
25846 The servant deposed that she heard him enter the front room on the second
25847 floor, generally used as his sitting-room.
25848 She had lit a fire there, and as it smoked she had opened the window.
25849 No sound was heard from the room until eleven-twenty, the hour of the return
25850 of Lady Maynooth and her daughter.
25851 Desiring to say good-night, she attempted to enter her son's room.
25852 The door was locked on the inside, and no answer could be got to their
25853 cries and knocking.
25854 Help was obtained, and the door forced.
25855 The unfortunate young man was found lying near the table.
25856 His head had been horribly mutilated by an expanding revolver bullet, but
25857 no weapon of any sort was to be found in the room.
25865 \begin_layout Standard
25866 You can also use a section heading as the preface if you use a section command
25867 as \SpecialChar TeX
25869 For example the command
25872 \begin_layout Standard
25877 subsection{subsection title}
25880 \begin_layout Standard
25881 creates a subsection.
25882 In this example the preface is a subsubsection:
25885 \begin_layout Standard
25886 \begin_inset Flex Multiple Columns
25889 \begin_layout Plain Layout
25890 \begin_inset Argument 2
25893 \begin_layout Plain Layout
25897 \begin_layout Plain Layout
25906 This is a subsubsection heading as a preface
25910 \begin_layout Plain Layout
25924 A minute examination of the circumstances served only to make the case more
25926 In the first place, no reason could be given why the young man should have
25927 fastened the door upon the inside.
25928 There was the possibility that the murderer had done this, and had afterwards
25929 escaped by the window.
25930 The drop was at least twenty feet, however, and a bed of crocuses in full
25932 Neither the flowers nor the earth showed any sign of having been disturbed,
25933 nor were there any marks upon the narrow strip of grass which separated
25934 the house from the road.
25935 Apparently, therefore, it was the young man himself who had fastened the
25937 But how did he come by his death? No one could have climbed up to the window
25938 without leaving traces.
25939 Suppose a man had fired through the window, he would indeed be a remarkable
25940 shot who could with a revolver inflict so deadly a wound.
25941 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
25942 a hundred yards of the house.
25943 No one had heard a shot.
25951 \begin_layout Standard
25952 If there is less vertical space than 6
25953 \begin_inset space ~
25956 text lines is left on the page at the beginning of the multiple columns,
25957 a page break will be inserted before the multiple columns.
25958 Depending on the number of lines of the preface text, you might want to
25960 This is done by setting the cursor into the mulitcolumn inset behind the
25961 preface (if there is any) and using the menu
25963 Insert\SpecialChar menuseparator
25965 \begin_inset space ~
25969 \begin_inset space ~
25973 \begin_inset space ~
25979 Insert into that inset the amount of space like e.
25980 \begin_inset space \thinspace{}
25984 \begin_inset space \space{}
25988 \begin_inset Quotes eld
25992 \begin_inset Quotes erd
25996 \begin_inset Newline newline
25999 In this example the space is set to 7
26000 \begin_inset space ~
26003 text lines by using
26004 \begin_inset Quotes eld
26010 \begin_inset Quotes erd
26019 needs to be inserted as \SpecialChar TeX
26023 \begin_layout Standard
26024 \begin_inset Flex Multiple Columns
26027 \begin_layout Plain Layout
26028 \begin_inset Argument 3
26031 \begin_layout Plain Layout
26036 \begin_layout Plain Layout
26052 On the evening of the crime, he returned from the club exactly at ten.
26053 His mother and sister were out spending the evening with a relation.
26054 The servant deposed that she heard him enter the front room on the second
26055 floor, generally used as his sitting-room.
26056 She had lit a fire there, and as it smoked she had opened the window.
26057 No sound was heard from the room until eleven-twenty, the hour of the return
26058 of Lady Maynooth and her daughter.
26059 Desiring to say good-night, she attempted to enter her son's room.
26060 The door was locked on the inside, and no answer could be got to their
26061 cries and knocking.
26062 Help was obtained, and the door forced.
26063 The unfortunate young man was found lying near the table.
26064 His head had been horribly mutilated by an expanding revolver bullet, but
26065 no weapon of any sort was to be found in the room.
26073 \begin_layout Subsubsection
26077 \begin_layout Standard
26078 The amount of space before and after multiple columns can be changed by
26079 changing the length
26086 For example the command
26089 \begin_layout Standard
26099 \begin_layout Standard
26100 in \SpecialChar TeX
26101 Code changes its value to 3
26102 \begin_inset space \thinspace{}
26106 The change must be made before the multiple columns' start.
26107 The predefined value is 13
26108 \begin_inset space \thinspace{}
26114 \begin_layout Standard
26122 \begin_inset space \thinspace{}
26128 \begin_layout Standard
26132 \begin_layout Plain Layout
26138 multicolsep}{2.5cm}
26146 \begin_layout Standard
26147 \begin_inset Flex Multiple Columns
26150 \begin_layout Plain Layout
26153 All day I turned these facts over in my mind, endeavouring to hit upon some
26154 theory which could reconcile them all, and to find that line of least resistanc
26155 e which my poor friend had declared to be the starting-point of every investigat
26157 I confess that I made little progress.
26158 In the evening I strolled across the Park, and found myself about six o'clock
26159 at the Oxford Street end of Park Lane.
26160 A group of loafers upon the pavements, all staring up at a particular window,
26161 directed me to the house which I had come to see.
26162 A tall, thin man with coloured glasses, whom I strongly suspected of being
26163 a plain-clothes detective, was pointing out some theory of his own, while
26164 the others crowded round to listen to what he said.
26165 I got as near him as I could, but his observations seemed to me to be absurd,
26166 so I withdrew again in some disgust.
26167 As I did so I struck against an elderly, deformed man, who had been behind
26168 me, and I knocked down several books which he was carrying.
26176 \begin_layout Standard
26177 \begin_inset Note Greyedout
26180 \begin_layout Plain Layout
26185 The values you set with
26191 will be used for all following multiple columns until you change them again.
26199 \begin_layout Standard
26203 \begin_layout Plain Layout
26215 \begin_inset Note Note
26218 \begin_layout Plain Layout
26219 go back to the default
26227 \begin_layout Standard
26228 \begin_inset Newpage newpage
26234 \begin_layout Subsubsection
26238 \begin_layout Standard
26239 A column break can be forced by inserting the command
26245 as \SpecialChar TeX
26246 Code to that position in the text where the column should be broken.
26247 Note that this leads in most cases to whitespace in the text.
26248 \begin_inset Newline newline
26251 Here is an example:
26254 \begin_layout Standard
26255 \begin_inset Flex Multiple Columns
26258 \begin_layout Plain Layout
26261 \begin_inset Quotes eld
26264 You're surprised to see me, sir,
26265 \begin_inset Quotes erd
26268 said he, in a strange, croaking voice.
26271 \begin_layout Plain Layout
26274 I acknowledged that I was.
26277 \begin_layout Plain Layout
26280 \begin_inset Quotes eld
26283 Well, I've a conscience, sir, and when I chanced to see you go into this
26284 house, as I came hobbling after you, I thought to myself, I'll just step
26285 in and see that kind gentleman, and tell him that if I was a bit gruff
26286 in my manner there was not any harm meant, and that I am much obliged to
26287 him for picking up my books.
26288 \begin_inset Quotes erd
26294 \begin_layout Plain Layout
26297 \begin_inset Quotes eld
26300 You make too much of a trifle,
26301 \begin_inset Quotes erd
26306 \begin_inset Quotes eld
26309 May I ask how you knew who I was?
26310 \begin_inset Quotes erd
26313 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
26317 \begin_layout Plain Layout
26329 \begin_layout Plain Layout
26332 \begin_inset Quotes eld
26335 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
26336 you'll find my little bookshop at the corner of Church Street, and very
26337 happy to see you, I am sure.
26338 Maybe you collect yourself, sir.
26342 \begin_inset space ~
26355 –a bargain, every one of them.
26356 With five volumes you could just fill that gap on that second shelf.
26357 It looks untidy, does it not, sir?
26358 \begin_inset Quotes erd
26369 \begin_layout Subsubsection
26373 \begin_layout Standard
26374 The width of the columns is automatically calculated, but you can modify
26375 the space between the columns.
26376 This is done by changing the length
26383 Its predefined value is 10
26384 \begin_inset space \thinspace{}
26388 Here is an example where
26395 \begin_inset space \thinspace{}
26401 \begin_layout Standard
26405 \begin_layout Plain Layout
26419 \begin_layout Standard
26420 \begin_inset Flex Multiple Columns
26423 \begin_layout Plain Layout
26426 My observations of No.
26427 \begin_inset space \space{}
26430 427 Park Lane did little to clear up the problem in which I was interested.
26431 The house was separated from the street by a low wall and railing, the
26432 whole not more than five feet high.
26433 It was perfectly easy, therefore, for anyone to get into the garden, but
26434 the window was entirely inaccessible, since there was no water pipe or
26435 anything which could help the most active man to climb it.
26436 More puzzled than ever, I retraced my steps to Kensington.
26437 I had not been in my study five minutes when the maid entered to say that
26438 a person desired to see me.
26439 To my astonishment it was none other than my strange old book collector,
26440 his sharp, wizened face peering out from a frame of white hair, and his
26441 precious volumes, a dozen of them at least, wedged under his right arm.
26449 \begin_layout Standard
26453 \begin_layout Plain Layout
26465 \begin_inset Note Note
26468 \begin_layout Plain Layout
26469 go back to the default
26477 \begin_layout Subsubsection
26481 \begin_layout Standard
26482 Between the columns a rule with a width of the length
26489 If this rule width is set to 0
26490 \begin_inset space \thinspace{}
26493 pt (this is the default), the rule is suppressed.
26494 In the following example the rule is 2
26495 \begin_inset space \thinspace{}
26501 \begin_layout Standard
26505 \begin_layout Plain Layout
26511 columnseprule}{2pt}
26519 \begin_layout Standard
26520 \begin_inset Flex Multiple Columns
26523 \begin_layout Plain Layout
26526 \begin_inset Quotes eld
26529 You're surprised to see me, sir,
26530 \begin_inset Quotes erd
26533 said he, in a strange, croaking voice.
26536 \begin_layout Plain Layout
26539 I acknowledged that I was.
26542 \begin_layout Plain Layout
26545 \begin_inset Quotes eld
26548 Well, I've a conscience, sir, and when I chanced to see you go into this
26549 house, as I came hobbling after you, I thought to myself, I'll just step
26550 in and see that kind gentleman, and tell him that if I was a bit gruff
26551 in my manner there was not any harm meant, and that I am much obliged to
26552 him for picking up my books.
26553 \begin_inset Quotes erd
26559 \begin_layout Plain Layout
26562 \begin_inset Quotes eld
26565 You make too much of a trifle,
26566 \begin_inset Quotes erd
26571 \begin_inset Quotes eld
26574 May I ask how you knew who I was?
26575 \begin_inset Quotes erd
26581 \begin_layout Plain Layout
26584 \begin_inset Quotes eld
26587 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
26588 you'll find my little bookshop at the corner of Church Street, and very
26589 happy to see you, I am sure.
26590 Maybe you collect yourself, sir.
26594 \begin_inset space ~
26607 –a bargain, every one of them.
26608 With five volumes you could just fill that gap on that second shelf.
26609 It looks untidy, does it not, sir?
26610 \begin_inset Quotes erd
26621 \begin_layout Standard
26622 \begin_inset VSpace defskip
26628 \begin_layout Standard
26629 The rule can be colored by redefining the command
26636 This is done by inserting the command
26637 \begin_inset Newline newline
26646 columnseprulecolor}{
26651 \begin_inset Newline newline
26654 as \SpecialChar TeX
26655 Code before the multicolumn inset.
26660 in this command by a color of your choice.
26661 You can use all pre- and self-defined colors.
26669 \begin_inset space ~
26674 for more information about pre- and self-defined colors.
26675 To go back to the default color insert the command
26676 \begin_inset Newline newline
26685 columnseprulecolor}{
26690 \begin_inset Newline newline
26693 Here is the example with a cyan rule and 1
26694 \begin_inset space \thinspace{}
26697 cm column separation:
26700 \begin_layout Standard
26704 \begin_layout Plain Layout
26713 \begin_layout Plain Layout
26719 columnseprulecolor}{
26729 \begin_layout Standard
26730 \begin_inset Flex Multiple Columns
26733 \begin_layout Plain Layout
26736 \begin_inset Quotes eld
26739 You're surprised to see me, sir,
26740 \begin_inset Quotes erd
26743 said he, in a strange, croaking voice.
26746 \begin_layout Plain Layout
26749 I acknowledged that I was.
26752 \begin_layout Plain Layout
26755 \begin_inset Quotes eld
26758 Well, I've a conscience, sir, and when I chanced to see you go into this
26759 house, as I came hobbling after you, I thought to myself, I'll just step
26760 in and see that kind gentleman, and tell him that if I was a bit gruff
26761 in my manner there was not any harm meant, and that I am much obliged to
26762 him for picking up my books.
26763 \begin_inset Quotes erd
26769 \begin_layout Plain Layout
26772 \begin_inset Quotes eld
26775 You make too much of a trifle,
26776 \begin_inset Quotes erd
26781 \begin_inset Quotes eld
26784 May I ask how you knew who I was?
26785 \begin_inset Quotes erd
26791 \begin_layout Plain Layout
26794 \begin_inset Quotes eld
26797 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
26798 you'll find my little bookshop at the corner of Church Street, and very
26799 happy to see you, I am sure.
26800 Maybe you collect yourself, sir.
26804 \begin_inset space ~
26817 –a bargain, every one of them.
26818 With five volumes you could just fill that gap on that second shelf.
26819 It looks untidy, does it not, sir?
26820 \begin_inset Quotes erd
26831 \begin_layout Standard
26835 \begin_layout Plain Layout
26841 columnseprule}{0pt}
26844 \begin_layout Plain Layout
26850 columnseprulecolor}{
26858 \begin_inset Note Note
26861 \begin_layout Plain Layout
26862 go back to the default
26870 \begin_layout Section
26871 Non-standard Paragraph Shapes
26874 \begin_layout Standard
26877 as well as any other text processor uses by default rectangular paragraphs.
26878 For special cases like for example posters, invitation cards or poems you
26879 can modify the paragraph shape to one of your choice.
26880 This can be done by using the \SpecialChar LaTeX
26885 which is loaded by using in the document settings the module
26887 Custom paragraph shapes
26892 \begin_layout Subsection
26896 \begin_layout Standard
26901 provides the following shapes:
26904 \begin_layout Standard
26905 \begin_inset Tabular
26906 <lyxtabular version="3" rows="13" columns="3">
26907 <features booktabs="true" islongtable="true" longtabularalignment="center">
26908 <column alignment="center" valignment="middle" width="16col%">
26909 <column alignment="center" valignment="middle" width="40col%">
26910 <column alignment="center" valignment="middle" width="35col%">
26911 <row endhead="true">
26912 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26915 \begin_layout Plain Layout
26921 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26924 \begin_layout Plain Layout
26930 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26933 \begin_layout Plain Layout
26941 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26944 \begin_layout Plain Layout
26950 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26953 \begin_layout Plain Layout
26954 Circle with circular hole (in the size of a CD/DVD)
26959 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26962 \begin_layout Plain Layout
26963 Cannot be scaled, take care there is not too much text
26970 <cell alignment="center" valignment="top" topline="true" usebox="none">
26973 \begin_layout Plain Layout
26979 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26982 \begin_layout Plain Layout
26988 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26991 \begin_layout Plain Layout
26992 Fragile, calculation might fail
26999 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
27002 \begin_layout Plain Layout
27008 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
27011 \begin_layout Plain Layout
27012 Rhomboid (symbolizing a
27013 \begin_inset Quotes eld
27017 \begin_inset Quotes erd
27025 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
27028 \begin_layout Plain Layout
27036 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
27039 \begin_layout Plain Layout
27045 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
27048 \begin_layout Plain Layout
27054 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
27057 \begin_layout Plain Layout
27065 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
27068 \begin_layout Plain Layout
27074 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
27077 \begin_layout Plain Layout
27083 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
27086 \begin_layout Plain Layout
27094 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
27097 \begin_layout Plain Layout
27103 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
27106 \begin_layout Plain Layout
27107 Nut for bolt (hexagon with circular hole)
27112 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
27115 \begin_layout Plain Layout
27123 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
27126 \begin_layout Plain Layout
27132 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
27135 \begin_layout Plain Layout
27141 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
27144 \begin_layout Plain Layout
27152 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
27155 \begin_layout Plain Layout
27161 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
27164 \begin_layout Plain Layout
27170 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
27173 \begin_layout Plain Layout
27181 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
27184 \begin_layout Plain Layout
27190 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
27193 \begin_layout Plain Layout
27199 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
27202 \begin_layout Plain Layout
27210 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
27213 \begin_layout Plain Layout
27219 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
27222 \begin_layout Plain Layout
27223 Normal/reversed rain drop
27228 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
27231 \begin_layout Plain Layout
27232 Fragile, calculation might fail
27239 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
27242 \begin_layout Plain Layout
27249 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
27252 \begin_layout Plain Layout
27253 The \SpecialChar TeX
27259 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
27262 \begin_layout Plain Layout
27270 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
27273 \begin_layout Plain Layout
27275 \begin_inset Newline newline
27283 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
27286 \begin_layout Plain Layout
27287 Triangles in different orientations
27292 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
27295 \begin_layout Plain Layout
27309 \begin_layout Standard
27310 To use a shape for your paragraph, simply select it in \SpecialChar LyX
27312 for environments in the toolbar.
27315 \begin_layout Standard
27316 \begin_inset Newpage newpage
27322 \begin_layout Standard
27323 Here is an example paragraph in the shape of a nut:
27326 \begin_layout Standard
27327 \begin_inset VSpace bigskip
27336 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
27337 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
27339 At vero eos et accusam et justo duo dolores et ea rebum.
27340 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
27342 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
27343 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
27347 \begin_layout Standard
27348 \begin_inset VSpace bigskip
27354 \begin_layout Standard
27355 \begin_inset Note Greyedout
27358 \begin_layout Plain Layout
27363 : shapepar paragraphs cannot run over a page break.
27371 \begin_layout Standard
27372 \begin_inset VSpace bigskip
27378 \begin_layout Standard
27383 takes care that the shape will always be preserved, no matter how much
27384 text is in the paragraph.
27385 Therefore the paragraph size changes with the amount of contained text.
27386 This can lead to paragraph sizes exceeding the page margins.
27387 To demonstrate the size scaling, here is the same example paragraph but
27388 with twice as much text:
27391 \begin_layout Standard
27392 \begin_inset Newpage newpage
27401 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
27402 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
27404 At vero eos et accusam et justo duo dolores et ea rebum.
27405 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
27407 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
27408 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
27410 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
27411 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
27413 At vero eos et accusam et justo duo dolores et ea rebum.
27414 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
27416 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
27417 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
27421 \begin_layout Standard
27422 \begin_inset VSpace bigskip
27428 \begin_layout Standard
27429 An exception is the shape
27434 It cannot be scaled because it must fit the size of a CD/DVD.
27435 Therefore the amount of text that fits into the shape is limited.
27436 \begin_inset Newline newline
27447 shape are fragile, meaning that the calculation of their size can fail,
27448 depending on the amount of text.
27449 You will then get the \SpecialChar LaTeX
27451 \begin_inset Quotes eld
27454 Arithmetic overflow
27455 \begin_inset Quotes erd
27459 In this case one can try to remove or add some text; if nothing works one
27460 has to use another shape.
27463 \begin_layout Standard
27464 \begin_inset VSpace bigskip
27470 \begin_layout Standard
27471 For shapes with tips you will maybe see that \SpecialChar LaTeX
27472 's hyphenation routine fails
27473 for text in the tips.
27474 Therefore it is often necessary to add hyphenation points
27479 arg "specialchar-insert hyphenation"
27484 ) to the corresponding text parts.
27487 \begin_layout Standard
27488 \begin_inset VSpace bigskip
27494 \begin_layout Standard
27495 Shapepar paragraphs are either always centered or placed on the page so
27496 that their left border touches the left page margin.
27497 You can therefore not use the paragraph dialog to align such paragraphs.
27498 A solution is to put the paragraph into a minipage or parbox and align
27500 The problem is hereby to find the right width for the box.
27501 Because if it is too wide and you center the box, the paragraph is not
27502 centered too because it sticks at the left side of the box.
27503 So you might have to play a bit with the width until it fits.
27504 Here are two heart-shaped paragraphs, the first one is not aligned, the
27505 second one is right-aligned:
27508 \begin_layout Standard
27509 \begin_inset Newpage newpage
27515 \begin_layout Heart
27519 Lo\SpecialChar softhyphen
27520 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
27521 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
27523 At vero eos et accusam et justo duo dolores et ea rebum.
27524 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
27528 \begin_layout Standard
27529 \begin_inset VSpace bigskip
27535 \begin_layout Standard
27538 \begin_inset Box Frameless
27548 height_special "totalheight"
27553 backgroundcolor "none"
27556 \begin_layout Heart
27560 Lo\SpecialChar softhyphen
27561 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
27562 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
27564 At vero eos et accusam et justo duo dolores et ea rebum.
27565 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
27574 \begin_layout Subsection
27578 \begin_layout Standard
27579 You can define any shape you want.
27580 Doing this manually is a lot of work because every coordinate must be specified.
27581 But there is a way to let the computer calculate the coordinates:
27584 \begin_layout Enumerate
27585 Install the program
27586 \begin_inset CommandInset href
27589 target "http://www.ctan.org/tex-archive/graphics/jpgfdraw"
27597 \begin_layout Enumerate
27604 TeX/LaTeX\SpecialChar menuseparator
27605 Settings\SpecialChar menuseparator
27608 and select the font size you are using in your document.
27609 For example this document uses the size 12
27610 \begin_inset space \thinspace{}
27616 \begin_layout Enumerate
27620 \begin_layout Enumerate
27623 TeX/LaTeX\SpecialChar menuseparator
27626 to export the shape to coordinates.
27627 In the appearing dialog use either the outline of your shape for the coordinate
27628 s or the path itself.
27632 \begin_layout Plain Layout
27633 For more information see
27634 \begin_inset CommandInset href
27636 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
27649 \begin_layout Standard
27650 The coordinates are written into a \SpecialChar TeX
27652 To use it for your \SpecialChar LyX
27656 \begin_layout Enumerate
27657 Place the cursor before the first character of your paragraph (or into a
27661 \begin_layout Enumerate
27662 Open in \SpecialChar LyX
27665 Insert\SpecialChar menuseparator
27666 File\SpecialChar menuseparator
27668 \begin_inset space ~
27673 , select the file and use
27682 \begin_layout Standard
27683 \begin_inset VSpace defskip
27689 \begin_layout Standard
27690 \begin_inset Note Greyedout
27693 \begin_layout Plain Layout
27698 : The changed shape only applies to the current paragraph; everything is
27699 reset to normal for the next paragraph.
27700 Therefore the shape definition file must be input into every paragraph
27701 with the desired shape.
27709 \begin_layout Standard
27710 \begin_inset VSpace bigskip
27716 \begin_layout Standard
27717 Here is an example:
27720 \begin_layout Standard
27721 \begin_inset VSpace bigskip
27727 \begin_layout Standard
27728 \begin_inset CommandInset include
27730 filename "SpecialParagraphShape.tex"
27736 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
27737 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
27739 At vero eos et accusam et justo duo dolores et ea rebum.
27740 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
27742 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
27743 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
27747 \begin_layout Standard
27748 \begin_inset VSpace bigskip
27754 \begin_layout Standard
27759 to draw complexer shapes in
27763 you can draw the shape in a program of your choice and import the resulting
27769 Then you only need to draw a line or spline along the outline of the image.
27772 \begin_layout Standard
27773 \begin_inset VSpace bigskip
27779 \begin_layout Standard
27782 Custom paragraph shapes
27784 also provides the two commands
27792 which can be used to define custom shapes coordinate by coordinate.
27796 \begin_layout Plain Layout
27797 These commands are internally used for all shapes described here.
27802 For information how these styles are used and about further customization
27803 possibilities, have a look at the documentation of the package
27808 \begin_inset CommandInset citation
27818 \begin_layout Bibliography
27819 \begin_inset CommandInset bibitem
27820 LatexCommand bibitem
27826 Documentation of the \SpecialChar LaTeX
27828 \begin_inset CommandInset href
27831 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
27839 \begin_layout Bibliography
27840 \begin_inset CommandInset bibitem
27841 LatexCommand bibitem
27847 Documentation of the \SpecialChar LaTeX
27849 \begin_inset CommandInset href
27852 target "http://mirrors.ctan.org/macros/latex/contrib/shapepar/shapepar.pdf"