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
6304 \change_inserted -712698321 1501232552
6306 \begin_inset CommandInset label
6308 name "sec:Starting-the-Server"
6317 \begin_layout Standard
6318 The \SpecialChar LyX
6319 server works through the use of a pair of named pipes.
6320 These are usually located in
6321 \begin_inset Flex Code
6324 \begin_layout Plain Layout
6330 , (except on Windows, where
6334 named pipes are special objects located in
6335 \begin_inset Flex Code
6338 \begin_layout Plain Layout
6350 ) and have the names
6351 \begin_inset Quotes eld
6355 \begin_inset Flex Code
6358 \begin_layout Plain Layout
6365 \begin_inset Quotes erd
6369 \begin_inset Quotes eld
6373 \begin_inset Flex Code
6376 \begin_layout Plain Layout
6383 \begin_inset Quotes erd
6387 External programs write into
6388 \begin_inset Flex Code
6391 \begin_layout Plain Layout
6397 and read back data from
6398 \begin_inset Flex Code
6401 \begin_layout Plain Layout
6408 The stem of the pipe names can be defined in the
6409 \begin_inset Flex Noun
6412 \begin_layout Plain Layout
6413 Tools\SpecialChar menuseparator
6420 \begin_inset Flex Code
6423 \begin_layout Plain Layout
6424 "/home/myhome/lyxpipe"
6430 \begin_inset Flex Code
6433 \begin_layout Plain Layout
6447 on Windows (where any working path instead of lyxpipe can be used, for
6449 \begin_inset Flex Code
6452 \begin_layout Plain Layout
6475 configure this manually in order for the server to start.
6478 \begin_layout Standard
6481 \begin_inset Flex Code
6484 \begin_layout Plain Layout
6491 \begin_inset Flex Code
6494 \begin_layout Plain Layout
6500 ' to create the pipes.
6501 If one of the pipes already exists, \SpecialChar LyX
6502 will assume that another \SpecialChar LyX
6504 is already running and will not start the server.
6505 On POSIX (Unix like) systems, if for some other reason, an unused
6506 \begin_inset Quotes eld
6510 \begin_inset Quotes erd
6513 pipe is left in existence when \SpecialChar LyX
6514 closes, then \SpecialChar LyX
6515 will try to delete it.
6516 If this fails for some reason, you will need to delete the pipes manually
6517 and then restart \SpecialChar LyX
6519 On Windows, pipes are deleted by the OS on program termination or crash,
6521 \begin_inset Quotes eld
6525 \begin_inset Quotes erd
6528 pipes should not be possible.
6531 \begin_layout Standard
6532 To have several \SpecialChar LyX
6533 processes with servers at the same time, you have to use
6534 different configurations, perhaps by using separate user directories, each
6536 \begin_inset Flex Code
6539 \begin_layout Plain Layout
6545 file, for each process.
6548 \begin_layout Standard
6549 If you are developing a client program, you might find it useful to enable
6550 debugging information from the \SpecialChar LyX
6552 Do this by starting \SpecialChar LyX
6554 \begin_inset Flex Code
6557 \begin_layout Plain Layout
6566 \begin_layout Standard
6567 You can find a complete example client written in C++ in the source distribution
6569 \begin_inset Flex Code
6572 \begin_layout Plain Layout
6573 development/lyxserver/server_monitor.cpp
6581 \begin_layout Standard
6582 Another useful tool is the command-line based client found in
6583 \begin_inset Flex Code
6586 \begin_layout Plain Layout
6587 src/client/lyxclient
6595 \begin_layout Section
6596 Normal communication
6599 \begin_layout Standard
6600 To issue a \SpecialChar LyX
6601 call, the client writes a line of ASCII text into the input
6603 This line has the following format:
6620 \begin_layout Description
6621 clientname is a name that the client can choose arbitrarily.
6622 Its only use is that \SpecialChar LyX
6623 will echo it if it sends an answer—so a client can
6624 dispatch results from different requesters.
6627 \begin_layout Description
6628 function is the function you want \SpecialChar LyX
6630 It is the same as the commands you'd use in the minibuffer.
6633 \begin_layout Description
6634 argument is an optional argument which is meaningful only to some functions
6636 \begin_inset Quotes eld
6640 \begin_inset Quotes erd
6643 LFUN will insert the argument as text at the cursor position).
6646 \begin_layout Standard
6647 The answer from \SpecialChar LyX
6648 will arrive in the output pipe and be of the form
6665 \begin_layout Standard
6674 are just echoed from the command request, while
6678 is more or less useful information filled according to how the command
6679 execution worked out.
6680 Some commands, such as
6681 \begin_inset Quotes eld
6685 \begin_inset Quotes erd
6688 , will return information about the internal state of \SpecialChar LyX
6690 return an empty data-response.
6691 This means that the command execution went fine.
6694 \begin_layout Standard
6695 In case of errors, the response from \SpecialChar LyX
6713 \begin_layout Standard
6718 should contain an explanation of why the command failed.
6721 \begin_layout Standard
6725 \begin_layout LyX-Code
6726 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
6727 \begin_inset Newline newline
6730 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
6731 \begin_inset Newline newline
6734 read a <~/.lyxpipe.out
6735 \begin_inset Newline newline
6741 \begin_layout Subsection
6742 AppleScript (Mac OS X)
6745 \begin_layout Standard
6746 Since \SpecialChar LyX
6747 2.1, \SpecialChar LyX
6748 supports basic interactions with AppleScript for normal communicatio
6749 n through the command run.
6750 This command takes a direct argument (the
6754 to perform) and an optional argument.
6755 It either returns the output of the function or triggers an error with
6756 the error message and code.
6759 \begin_layout Standard
6763 \begin_layout LyX-Code
6764 tell application "\SpecialChar LyX
6768 \begin_layout LyX-Code
6772 \begin_layout LyX-Code
6773 -- Stores the current file name into f
6776 \begin_layout LyX-Code
6777 set f to (run "server-get-filename" with argument "")
6780 \begin_layout LyX-Code
6781 on error the error_message number the error_number
6784 \begin_layout LyX-Code
6785 display dialog "Error: " & the error_number & ".
6789 \begin_layout LyX-Code
6790 & the error_message buttons {"OK"} default button 1
6793 \begin_layout LyX-Code
6797 \begin_layout LyX-Code
6801 \begin_layout Section
6805 \begin_layout Standard
6807 can notify clients of events going on asynchronously.
6808 Currently it will only do this if the user binds a key sequence with the
6810 \begin_inset Quotes eld
6814 \begin_inset Quotes erd
6818 The format of the string \SpecialChar LyX
6819 sends is as follows:
6823 \begin_inset Flex Code
6826 \begin_layout Plain Layout
6837 \begin_layout Standard
6842 is the printed representation of the key sequence that was actually typed
6846 \begin_layout Standard
6847 This mechanism can be used to extend \SpecialChar LyX
6848 's command set and implement macros.
6849 Bind some key sequence to
6850 \begin_inset Quotes eld
6854 \begin_inset Quotes erd
6858 Then start a client that listens on the output pipe, dispatches the command
6859 according to the sequence, and starts a function that may use \SpecialChar LyX
6862 requests to issue a command or a series of commands to \SpecialChar LyX
6866 \begin_layout Section
6867 The simple \SpecialChar LyX
6871 \begin_layout Standard
6873 implements a simple protocol that can be used for session management.
6874 All messages are of the form
6887 \begin_layout Standard
6893 \begin_inset Quotes eld
6897 \begin_inset Quotes erd
6901 \begin_inset Quotes eld
6905 \begin_inset Quotes erd
6910 \begin_inset Quotes eld
6914 \begin_inset Quotes erd
6917 is received from a client, \SpecialChar LyX
6918 will report back to inform the client that
6919 it's listening to it's messages, while
6920 \begin_inset Quotes eld
6924 \begin_inset Quotes erd
6927 sent from \SpecialChar LyX
6928 will inform clients that \SpecialChar LyX
6932 \begin_layout Section
6933 Reverse DVI/PDF search
6936 \begin_layout Standard
6937 Some DVI/PDF viewers
6941 \begin_layout Plain Layout
6942 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
6943 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
6952 facility (also called
6957 This means that you can tell \SpecialChar LyX
6958 to put the cursor to a specific line in the
6959 document by clicking at the respective position in the DVI/PDF output.
6960 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
6962 This is done via the \SpecialChar LyX
6963 server either by using the named pipe (
6967 ), or the UNIX domain socket (
6971 ) that \SpecialChar LyX
6972 creates in its temporary directory (this is the way the
6973 \begin_inset Flex Code
6976 \begin_layout Plain Layout
6982 program communicates with \SpecialChar LyX
6984 In some cases, you need a helper script that mediates between the viewer
6985 and \SpecialChar LyX
6986 , in others, the viewer can communicate with \SpecialChar LyX
6988 This depends on the selected viewer and on your operating system.
6989 The same applies to the way viewers need to be configured and the way the
6990 reverse search is actually performed.
6991 In what follows, we will thus describe how to setup reverse search for
6993 Before we turn to this, though, we will explain what needs to be done generally
6994 to enable reverse search in the DVI/PDF output.
6997 \begin_layout Subsection
6999 \begin_inset CommandInset label
7001 name "subsec:rev-search"
7008 \begin_layout Standard
7009 In most cases \SpecialChar LyX
7010 will do the work for you by
7011 \change_inserted -712698321 1500975045
7012 pressing the following button in the toolbar:
7015 arg "buffer-toggle-output-sync"
7019 Alternatively, you can also enable the feature by checking
7021 Synchronize with Output
7024 \begin_inset Flex Noun
7027 \begin_layout Plain Layout
7029 \change_inserted -712698321 1500975071
7030 Document\SpecialChar menuseparator
7031 Settings\SpecialChar menuseparator
7038 \change_deleted -712698321 1500974764
7040 \begin_inset Flex Noun
7043 \begin_layout Plain Layout
7044 Synchronize with Output
7050 \begin_inset Flex Noun
7053 \begin_layout Plain Layout
7054 Document\SpecialChar menuseparator
7055 Settings\SpecialChar menuseparator
7064 In such a case \SpecialChar LyX
7065 will automatically insert the necessary Sync\SpecialChar TeX
7067 PDF) or load the srcltx package (for DVI) respectively.
7068 This option can be easily reached also on
7069 \begin_inset Flex Code
7072 \begin_layout Plain Layout
7081 \begin_layout Standard
7082 If you need a different setting, you can select or input a custom macro
7083 from the drop down box just below
7084 \begin_inset Flex Noun
7087 \begin_layout Plain Layout
7088 Document\SpecialChar menuseparator
7089 Settings\SpecialChar menuseparator
7090 Output\SpecialChar menuseparator
7091 Synchronize with Output
7099 \begin_layout Standard
7100 Note that the method
7101 \begin_inset Flex Code
7104 \begin_layout Plain Layout
7112 enables gzip compression.
7113 If your viewer does not support it, you should instead use
7114 \begin_inset Flex Code
7117 \begin_layout Plain Layout
7128 \begin_layout Standard
7129 Please also note that including the
7130 \begin_inset Flex Code
7133 \begin_layout Plain Layout
7140 \begin_inset Flex Code
7143 \begin_layout Plain Layout
7149 sometimes has an undesired impact on the typesetting.
7150 Thus, you should switch output synchronization off for the final typesetting
7152 \begin_inset Flex Code
7155 \begin_layout Plain Layout
7162 \begin_inset Flex Code
7165 \begin_layout Plain Layout
7175 \begin_layout Standard
7176 In case you need some more special settings that are not covered by the
7177 automatic settings, read the next section about how to set up output synchroniz
7179 If the automatic setup suits your needs, you can readily jump to section
7180 \begin_inset space ~
7184 \begin_inset CommandInset ref
7186 reference "subsec:configuring-viewers"
7190 , where the necessary configuration steps in your viewer – needed both with
7191 the automatic and the manual setup – are described.
7194 \begin_layout Subsection
7198 \begin_layout Standard
7200 provides several different methods for reverse search.
7201 Some are built-in in the
7202 \begin_inset Flex Code
7205 \begin_layout Plain Layout
7211 program, some are provided by external packages.
7212 Your choice depends on whether your \SpecialChar LaTeX
7213 distribution already provides a given
7214 method (the built-in methods are rather new) and whether your viewer can
7216 The available methods are described in the following.
7219 \begin_layout Subsubsection*
7220 Built-in DVI-search via src-specials (DVI only)
7223 \begin_layout Standard
7224 This method provides the DVI file with the necessary information for reverse
7226 It is available in \SpecialChar LaTeX
7227 since quite some time (any somewhat recent \SpecialChar LaTeX
7229 should include it), and it works reliably.
7230 To enable it, change the
7231 \begin_inset Flex Noun
7234 \begin_layout Plain Layout
7245 \begin_inset Flex Noun
7248 \begin_layout Plain Layout
7259 \begin_inset Flex Noun
7262 \begin_layout Plain Layout
7263 Preferences\SpecialChar menuseparator
7264 File Handling\SpecialChar menuseparator
7271 \begin_inset Flex Code
7274 \begin_layout Plain Layout
7275 latex -src-specials $$i
7281 If this doesn't work, check if your \SpecialChar TeX
7282 engine needs different options (the
7283 syntax might differ in some distributions).
7286 \begin_layout Subsubsection*
7287 External Packages (PDFSync and scrltx)
7290 \begin_layout Standard
7299 provide reverse search facility for PDF output (via pdflatex) and DVI output,
7301 In order to enable it, load the packages in the \SpecialChar LyX
7305 \begin_layout Itemize
7306 \begin_inset Flex Code
7309 \begin_layout Plain Layout
7317 for reverse PDF search,
7320 \begin_layout Itemize
7321 \begin_inset Flex Code
7324 \begin_layout Plain Layout
7327 usepackage[active]{srcltx}
7332 for reverse DVI search.
7335 \begin_layout Standard
7336 If you want to be able to perform both DVI and PDF reverse searches, you
7337 can also insert in the preamble the following lines
7340 \begin_layout LyX-Code
7344 \begin_inset Newline newline
7350 \begin_inset Newline newline
7356 \begin_inset Newline newline
7362 \begin_inset Newline newline
7367 usepackage[active]{srcltx}
7368 \begin_inset Newline newline
7376 \begin_layout Standard
7377 This way, you can preview the file as either DVI or PDF (pdflatex) and the
7378 right package will be used.
7381 \begin_layout Standard
7382 Note that PDFSync might affect the output layout of your document.
7383 It is therefore advised to disable PDFsync for final documents.
7386 \begin_layout Subsubsection*
7387 Built-in reverse search via Sync\SpecialChar TeX
7391 \begin_layout Standard
7393 \begin_inset Flex Code
7396 \begin_layout Plain Layout
7402 have built-in support for both PDF and DVI reverse search.
7405 Sync\SpecialChar TeX
7408 facility is basically the result of the integration of the PDFSync package
7409 to the pdftex program and its merge with the
7414 You need at least \SpecialChar TeX
7415 Live 2008 or a recent Mik\SpecialChar TeX
7416 distribution in order to use
7421 \begin_layout Plain Layout
7422 For some reason, Mik\SpecialChar TeX
7423 does not understand/obey the command \SpecialChar LyX
7425 the preamble when you check the "Enable Forward/Reverse Search" button
7426 in the toolbar and does not generate the necessary info.
7429 \begin_layout Plain Layout
7430 The generation of the required info can be forced by changing the converter
7432 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
7433 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
7434 the -synctex=1 switch).
7439 Also note that only a few PDF viewers (
7440 \change_inserted -712698321 1500977288
7443 Okular and Qpdfview on Unix, Skim on the Mac, SumatraPDF on Windows
7444 \change_inserted -712698321 1500977299
7445 ; see the next section for details
7447 ) already provide Sync\SpecialChar TeX
7451 \begin_layout Standard
7452 To enable Sync\SpecialChar TeX
7453 for DVI output, change the
7454 \begin_inset Flex Noun
7457 \begin_layout Plain Layout
7468 \begin_inset Flex Noun
7471 \begin_layout Plain Layout
7482 \begin_inset Flex Noun
7485 \begin_layout Plain Layout
7486 Preferences\SpecialChar menuseparator
7487 File Handling\SpecialChar menuseparator
7494 \begin_inset Flex Code
7497 \begin_layout Plain Layout
7498 latex -synctex=1 $$i
7503 , and for PDF output, change the
7504 \begin_inset Flex Noun
7507 \begin_layout Plain Layout
7512 (pdflatex) -> PDF (pdflatex)
7518 \change_deleted -712698321 1500977453
7522 \begin_inset Flex Code
7525 \begin_layout Plain Layout
7526 pdflatex -synctex=1 $$i
7533 \change_inserted -712698321 1500977740
7534 Should your viewer not be considered in the following description, or in
7535 case of missing success, please
7536 \change_deleted -712698321 1500977741
7538 \change_inserted -712698321 1500977744
7541 heck the documentation of your viewer whether the viewer needs to be configured
7542 for the use with Sync\SpecialChar TeX
7547 \begin_layout Plain Layout
7548 Note that the option
7549 \begin_inset Flex Code
7552 \begin_layout Plain Layout
7558 option enables gzip compression.
7559 If your viewer does not support it, you should instead use
7560 \begin_inset Flex Code
7563 \begin_layout Plain Layout
7577 \begin_layout Subsection
7578 Configuring and using specific viewers
7579 \begin_inset CommandInset label
7581 name "subsec:configuring-viewers"
7588 \begin_layout Subsubsection*
7589 Xdvi (all platforms)
7592 \begin_layout Standard
7594 \begin_inset Flex Code
7597 \begin_layout Plain Layout
7603 , you don't need to do anything else for performing a reverse DVI search,
7605 already provides the necessary hooks for automatically using the
7606 \begin_inset Flex Code
7609 \begin_layout Plain Layout
7616 Just setup your document as described above (reverse search is triggered
7617 by Ctrl-click or Alt-click on Mac OSX, respectively).
7620 \begin_layout Standard
7621 However, if for whatever reason you want to use the named pipe instead of
7622 the socket for communicating with \SpecialChar LyX
7623 , simply change the DVI viewer in
7624 \begin_inset Flex Noun
7627 \begin_layout Plain Layout
7628 Preferences\SpecialChar menuseparator
7629 File Handling\SpecialChar menuseparator
7639 \begin_layout Plain Layout
7640 On Mac OSX you have to use
7641 \begin_inset Flex Code
7644 \begin_layout Plain Layout
7645 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
7656 \begin_inset Flex Code
7659 \begin_layout Plain Layout
7660 xdvi -editor "lyxeditor.sh %f %l"
7666 \begin_inset Flex Code
7669 \begin_layout Plain Layout
7675 is a suitable script.
7676 For example, a minimal shell script is the following one:
7679 \begin_layout LyX-Code
7681 \begin_inset Newline newline
7684 LYXPIPE="/path/to/lyxpipe"
7685 \begin_inset Newline newline
7688 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
7689 \begin_inset Newline newline
7692 echo "$COMMAND" > "${LYXPIPE}".in || exit
7693 \begin_inset Newline newline
7696 read TMP < "${LYXPIPE}".out || exit
7699 \begin_layout Standard
7701 \begin_inset Flex Code
7704 \begin_layout Plain Layout
7710 is the LyXServer pipe path specified in
7711 \begin_inset Flex Noun
7714 \begin_layout Plain Layout
7715 Preferences\SpecialChar menuseparator
7725 \begin_layout Plain Layout
7727 \begin_inset Flex Code
7730 \begin_layout Plain Layout
7736 folder of a source distribution you can find a
7737 \begin_inset Flex Code
7740 \begin_layout Plain Layout
7746 script which is able to locate the
7750 based on your preferences.
7758 \begin_layout Subsubsection*
7762 \begin_layout Standard
7764 \begin_inset Flex Code
7767 \begin_layout Plain Layout
7768 /Applications/MacDviX_Folder/calleditor.script
7773 , add the following lines:
7776 \begin_layout LyX-Code
7777 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
7778 \begin_inset Newline newline
7784 \begin_layout Standard
7785 Modify the lines accordingly if you install \SpecialChar LyX
7786 somewhere else than in the
7787 Applications folder.
7790 \begin_layout Standard
7791 Reverse search is triggered by Alt-click (OPTION-click).
7794 \begin_layout Subsubsection*
7798 \begin_layout Standard
7800 \begin_inset Flex Code
7803 \begin_layout Plain Layout
7804 open -a Skim.app $$i
7809 to the viewer setting in
7810 \begin_inset Flex Noun
7813 \begin_layout Plain Layout
7814 Preferences\SpecialChar menuseparator
7815 File Handling\SpecialChar menuseparator
7816 File formats\SpecialChar menuseparator
7823 \begin_inset Flex Noun
7826 \begin_layout Plain Layout
7827 Skim\SpecialChar menuseparator
7828 Preferences\SpecialChar menuseparator
7835 \begin_inset Flex Noun
7838 \begin_layout Plain Layout
7844 preset and enter command
7845 \begin_inset Flex Noun
7848 \begin_layout Plain Layout
7849 /Applications/\SpecialChar LyX
7850 .app/Contents/MacOS/lyxeditor
7858 \begin_layout Standard
7859 Reverse search is triggered by COMMAND-SHIFT-click
7862 \begin_layout Subsubsection*
7866 \begin_layout Standard
7867 Reverse search with evince does not work out of the box, but it can be achieved
7868 by means of some third party helper scripts.
7870 \begin_inset CommandInset href
7872 target "http://wiki.lyx.org/LyX/SyncTeX"
7880 \begin_layout Subsubsection*
7884 \begin_layout Standard
7886 \begin_inset Flex Noun
7889 \begin_layout Plain Layout
7890 Settings\SpecialChar menuseparator
7891 Configure Okular\SpecialChar menuseparator
7898 \change_inserted -712698321 1500981642
7900 \change_deleted -712698321 1500981641
7904 \change_deleted -712698321 1500981634
7906 \begin_inset Quotes eld
7910 \change_inserted -712698321 1500981635
7914 \begin_inset Quotes erd
7918 \change_inserted -712698321 1500981659
7920 This inserts the appropriate
7921 \change_deleted -712698321 1500981663
7925 \change_inserted -712698321 1500981665
7929 \begin_inset Flex Code
7932 \begin_layout Plain Layout
7939 \change_inserted -712698321 1500981668
7945 \begin_layout Standard
7946 Reverse search is triggered by SHIFT-click.
7949 \begin_layout Subsubsection*
7953 \begin_layout Standard
7954 Qpdfview supports Sync\SpecialChar TeX
7955 since version 0.3.5.
7957 \begin_inset Flex Noun
7960 \begin_layout Plain Layout
7961 Edit\SpecialChar menuseparator
7962 Settings\SpecialChar menuseparator
7968 , click on the input field of the
7969 \begin_inset Quotes eld
7973 \begin_inset Quotes erd
7976 item and add the command
7977 \begin_inset Flex Code
7980 \begin_layout Plain Layout
7989 \begin_layout Standard
7990 Reverse search is triggered by double-click or, in more recent versions,
7994 \begin_layout Subsubsection*
7998 \begin_layout Standard
7999 Launch yap, choose its
8000 \begin_inset Flex Noun
8003 \begin_layout Plain Layout
8004 View\SpecialChar menuseparator
8011 \begin_inset Quotes eld
8015 \begin_inset Quotes erd
8020 \begin_inset Quotes eld
8023 New\SpecialChar ldots
8025 \begin_inset Quotes erd
8028 button and, in the window that opens, enter
8029 \begin_inset Quotes eld
8034 \begin_inset Quotes erd
8037 (or any other name you like) in the
8038 \begin_inset Quotes eld
8042 \begin_inset Quotes erd
8046 Now click on the button labeled
8047 \begin_inset Quotes eld
8052 \begin_inset Quotes erd
8055 to open a file dialog and navigate to the directory containing the batch
8057 \begin_inset Flex Code
8060 \begin_layout Plain Layout
8068 \begin_inset Flex Code
8071 \begin_layout Plain Layout
8077 and then specify the program arguments as
8078 \begin_inset Flex Code
8081 \begin_layout Plain Layout
8089 \begin_inset Flex Code
8092 \begin_layout Plain Layout
8098 wrapper is used for communicating with \SpecialChar LyX
8106 \begin_layout LyX-Code
8108 \begin_inset Newline newline
8111 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
8120 \begin_inset Newline newline
8134 \begin_layout Standard
8135 Make sure that the \SpecialChar LyX
8136 Server pipe path you specified in \SpecialChar LyX
8138 \begin_inset Flex Code
8141 \begin_layout Plain Layout
8155 , otherwise change the
8156 \begin_inset Flex Code
8159 \begin_layout Plain Layout
8165 wrapper accordingly.
8168 \begin_layout Standard
8169 In yap, reverse search is triggered by double-click.
8172 \begin_layout Subsubsection*
8173 SumatraPDF (Windows)
8176 \begin_layout Standard
8177 In order to use SumatraPDF for inverse search, enter
8178 \begin_inset Flex Code
8181 \begin_layout Plain Layout
8182 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
8187 in the viewer setting in
8188 \begin_inset Flex Noun
8191 \begin_layout Plain Layout
8192 Preferences\SpecialChar menuseparator
8193 File Handling\SpecialChar menuseparator
8194 File formats\SpecialChar menuseparator
8201 \begin_inset Flex Code
8204 \begin_layout Plain Layout
8210 is the previous wrapper.
8211 If SumatraPDF.exe is not in your command PATH, use its full file name.
8214 \begin_layout Standard
8215 Reverse search is triggered by double-click.
8218 \begin_layout Subsubsection*
8222 \begin_layout Standard
8223 First of all, make sure that yap is your default DVI viewer in the Windows
8224 environment, then launch it, choose its
8225 \begin_inset Flex Noun
8228 \begin_layout Plain Layout
8229 View\SpecialChar menuseparator
8236 \begin_inset Quotes eld
8240 \begin_inset Quotes erd
8245 \begin_inset Quotes eld
8248 New\SpecialChar ldots
8250 \begin_inset Quotes erd
8253 button and, in the window that opens, enter
8254 \begin_inset Quotes eld
8259 \begin_inset Quotes erd
8262 (or any other name you like) in the
8263 \begin_inset Quotes eld
8267 \begin_inset Quotes erd
8271 Now click on the button labeled
8272 \begin_inset Quotes eld
8277 \begin_inset Quotes erd
8280 to open a file dialog and navigate to the directory containing the
8281 \begin_inset Flex Code
8284 \begin_layout Plain Layout
8290 program (which is installed by default on Cygwin along with the \SpecialChar LyX
8293 \begin_inset Flex Code
8296 \begin_layout Plain Layout
8302 and then specify the program arguments as
8303 \begin_inset Flex Code
8306 \begin_layout Plain Layout
8313 In this way, you will be using the
8317 for communicating with \SpecialChar LyX
8319 If, for whatever reason, you want to use the
8324 \begin_inset Flex Code
8327 \begin_layout Plain Layout
8333 option and be sure to specify the \SpecialChar LyX
8334 Server pipe path in the \SpecialChar LyX
8338 \begin_layout Standard
8339 In yap, reverse search is triggered by double-click.
8342 \begin_layout Subsubsection*
8346 \begin_layout Standard
8347 In order to use SumatraPDF for inverse search, enter
8348 \begin_inset Flex Code
8351 \begin_layout Plain Layout
8352 SumatraPDF -inverse-search "lyxeditor -g %f %l"
8357 in the viewer setting in
8358 \begin_inset Flex Noun
8361 \begin_layout Plain Layout
8362 Preferences\SpecialChar menuseparator
8363 File Handling\SpecialChar menuseparator
8364 File formats\SpecialChar menuseparator
8371 If SumatraPDF.exe is not in your command PATH, use its full posix path.
8373 \begin_inset Flex Code
8376 \begin_layout Plain Layout
8382 enables communication via the
8388 \begin_inset Flex Code
8391 \begin_layout Plain Layout
8397 option if you want to use the
8401 , and be sure to specify the \SpecialChar LyX
8402 Server pipe path in the \SpecialChar LyX
8406 \begin_layout Standard
8407 Reverse search is triggered by double-click.
8410 \begin_layout Section
8414 \begin_layout Standard
8415 Forward search is, as the name implies, in a sense the
8416 \begin_inset Quotes eld
8420 \begin_inset Quotes erd
8424 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
8426 If forward search is set up (as described in what follows), you can put
8427 the cursor anywhere in your \SpecialChar LyX
8429 \begin_inset Flex Noun
8432 \begin_layout Plain Layout
8433 Navigate\SpecialChar menuseparator
8440 \begin_inset Flex Noun
8443 \begin_layout Plain Layout
8449 in the context menu via right mouse click), and then the viewer will jump
8450 to that position as well.
8451 This implies, of course, that your viewer supports this function.
8454 \begin_layout Standard
8455 To make forward search possible, you first need to provide the generated
8456 output PDF/DVI file with additional information about the \SpecialChar TeX
8458 This can be done via the methods described in the section
8459 \begin_inset CommandInset ref
8461 reference "subsec:rev-search"
8468 \begin_layout Standard
8469 Additionally, you need to configure \SpecialChar LyX
8470 for using your viewers in
8471 \begin_inset Flex Noun
8474 \begin_layout Plain Layout
8475 Tools\SpecialChar menuseparator
8476 Preferences\SpecialChar menuseparator
8477 Output\SpecialChar menuseparator
8484 We provide a range of tested configurations for some viewers, which you
8485 can select from the drop down list.
8486 If none of these configurations suits you, you have to find out and enter
8487 a suitable configuration yourself.
8488 The definition syntax uses the following placeholders:
8491 \begin_layout Itemize
8493 \begin_inset Flex Code
8496 \begin_layout Plain Layout
8505 \begin_layout Itemize
8507 \begin_inset Flex Code
8510 \begin_layout Plain Layout
8516 : name of the (temporary) exported .tex file (without path)
8519 \begin_layout Itemize
8521 \begin_inset Flex Code
8524 \begin_layout Plain Layout
8530 : name of the (temporary) exported .tex file (including path)
8533 \begin_layout Itemize
8535 \begin_inset Flex Code
8538 \begin_layout Plain Layout
8544 : name of the exported output file (either dvi or pdf, depending on which
8545 one exists in the temporary directory)
8548 \begin_layout Standard
8549 Note that only some of the viewers provide full and usable forward search
8550 functionality out of the box, among them yap, xdvi, okular
8554 \begin_layout Plain Layout
8555 You might want to set
8556 \begin_inset Flex Code
8559 \begin_layout Plain Layout
8566 \begin_inset Flex Noun
8569 \begin_layout Plain Layout
8570 Tools\SpecialChar menuseparator
8571 Preferences\SpecialChar menuseparator
8572 File Handling\SpecialChar menuseparator
8574 \begin_inset space ~
8587 , qpdfview, and SumatraPDF
8591 \begin_layout Plain Layout
8592 SumatraPDF can also use DDE commands through the external program CMCDDE
8594 \begin_inset CommandInset href
8596 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
8607 Others, such as evince
8611 \begin_layout Plain Layout
8612 Forward search with evince can be achieved by means of third party helper
8615 \begin_inset CommandInset href
8617 target "http://wiki.lyx.org/LyX/SyncTeX"
8627 , require some extra tools in order to use forward search.
8628 While many of the widespread PDF viewers (most notably Adobe Reader) do
8629 not support forward search at all, some other viewers – e.
8630 \begin_inset space \thinspace{}
8634 xpdf – allow at least to reload the document and jump to a specific page
8635 of the file, so you can at least navigate
8636 \begin_inset Quotes eld
8640 \begin_inset Quotes erd
8644 This latter functionality is provided by an external call of synctex (see
8645 the predefined example configurations).
8649 \begin_layout Standard
8650 Forward search works both with DVI and PDF output.
8652 simply checks which preview format you have used before (i.
8653 \begin_inset space \thinspace{}
8656 e., which format is already there in the temporary directory) and chooses
8657 the appropriate configuration for the respective format.
8660 \begin_layout Chapter
8661 Special Document Classes
8664 \begin_layout Section
8668 \begin_layout Standard
8674 \begin_layout Subsection
8678 \begin_layout Standard
8679 This section describes how \SpecialChar LyX
8680 can be used to write articles for submission
8681 to the scientific journal
8683 Astronomy and Astrophysics
8686 \begin_inset Flex URL
8689 \begin_layout Plain Layout
8691 http://www.edpsciences.fr/aa/
8696 ) using Version 5.01 of the document class
8701 This package can be downloaded from the ftp site
8704 \begin_layout Standard
8705 \begin_inset VSpace medskip
8711 \begin_layout Standard
8713 \begin_inset Flex URL
8716 \begin_layout Plain Layout
8718 ftp://ftp.edpsciences.org/pub/aa/readme.html
8726 \begin_layout Standard
8727 \begin_inset VSpace medskip
8733 \begin_layout Standard
8734 A manual comes together with that package, and this text is not meant to
8735 replace the original manual but is merely a short guide in how to realize
8736 the correct form of your paper.
8740 \begin_layout Standard
8741 Please note that the publisher of the journal was changed from Springer
8742 to EDP Sciences starting January 1, 2001.
8743 That change involved also some slight changes to the style files, namely
8744 the removal of the thesaurus command.
8745 The \SpecialChar LyX
8746 class aa supports the newest version of these style files, V 5.01.
8747 If you have an older version installed, please upgrade.
8748 For compatibility, the old (version 4) layout has been kept as
8753 Please refer to the comments in
8756 Dir/layouts/aapaper.layout
8761 \begin_layout Subsection
8765 \begin_layout Standard
8766 It is recommended you start from the example template distributed with \SpecialChar LyX
8768 If you are not using a template, note the following settings:
8771 \begin_layout Itemize
8778 Document\SpecialChar menuseparator
8781 dialog (OK, that one was obvious).
8784 \begin_layout Itemize
8785 Don't change the option
8788 \begin_inset space ~
8798 The whole layout is done by the macros, you shouldn't change anything.
8801 \begin_layout Subsection
8805 \begin_layout Standard
8806 First thing to enter is the header information.
8807 It consists of seven entries, of which some are optional.
8811 \begin_layout Itemize
8819 \begin_layout Itemize
8827 \begin_layout Itemize
8835 \begin_layout Itemize
8843 \begin_layout Itemize
8848 : [optional] if more than one author: whom to contact for offprint requests.
8851 \begin_layout Itemize
8856 : [optional] mail address for contacts.
8859 \begin_layout Itemize
8867 Received: <date>; Accepted <date>
8870 \begin_layout Standard
8871 There is no need to issue the
8877 command, this is done automatically by \SpecialChar LyX
8878 when the header is finished.
8879 Although the order of the single header entries doesn't matter it is advised
8880 to keep the above sequence, just to get the best optics and meets the layout
8881 of the real document.
8884 \begin_layout Standard
8885 If you want to place footnotes in the header block, e.
8886 \begin_inset space \thinspace{}
8890 \begin_inset space \space{}
8893 to state your present address, just use the standard footnote via the menu
8896 Insert\SpecialChar menuseparator
8901 will automagically use the term
8908 \change_inserted -712698321 1501150851
8912 \begin_layout Standard
8914 \change_inserted -712698321 1501150892
8917 Edit\SpecialChar menuseparator
8920 , you'll find two insets which are relevant for the titling:
8923 \begin_layout Itemize
8925 \change_inserted -712698321 1501150936
8932 to mark corresponding author\SpecialChar breakableslash
8934 The institutes are numbered sequentially as they appear in the
8938 field, so you have to put a marker to each author.
8941 \begin_layout Itemize
8943 \change_inserted -712698321 1501150947
8948 to supply an email address for fast contact.
8953 \begin_layout Standard
8954 In addition to these topics, the macros use
8955 \change_deleted -712698321 1501150958
8957 \change_inserted -712698321 1501150961
8960 additional \SpecialChar LaTeX
8962 \change_deleted -712698321 1501150963
8966 \change_deleted -712698321 1501150967
8968 \change_inserted -712698321 1501150967
8971 no counterpart in \SpecialChar LyX
8975 \begin_layout Itemize
8982 to separate different names for more than one author and institute, respectivel
8986 \begin_layout Itemize
8988 \change_deleted -712698321 1501150911
8995 to mark corresponding author/institute pairs.
8996 The institutes are numbered sequentially as they appear in the
9000 field, so you have to put a marker to each author.
9003 \begin_layout Itemize
9005 \change_deleted -712698321 1501150911
9012 to supply an email address for fast contact.
9017 \begin_layout Standard
9019 \change_deleted -712698321 1501150972
9021 \change_inserted -712698321 1501150972
9024 he appropriate command has to be entered in \SpecialChar LyX
9025 and marked as \SpecialChar LaTeX
9031 \begin_layout Subsection
9035 \begin_layout Standard
9036 The abstract should immediately follow the header block.
9037 With version 5 the abstract environment was changed to a command, and there
9038 is now a resctriction to only one paragraph.
9039 In addition, it should contain an entry with the keywords.
9041 \change_deleted -712698321 1501151111
9042 not yet implemented for \SpecialChar LyX
9043 , therefore you have to enter the \SpecialChar LaTeX
9050 by hand and mark it as \SpecialChar LaTeX
9052 \change_inserted -712698321 1501151122
9053 done via the paragraph style
9060 Refer to the example paper.
9063 \begin_layout Subsection
9064 Supported environments
9067 \begin_layout Standard
9068 The A&A paper layout supports the following environments for structuring
9072 \begin_layout Itemize
9078 \begin_layout Itemize
9084 \begin_layout Itemize
9090 \begin_layout Itemize
9096 \begin_layout Itemize
9102 \begin_layout Itemize
9108 \begin_layout Itemize
9114 \begin_layout Itemize
9120 \begin_layout Itemize
9126 \begin_layout Itemize
9132 \begin_layout Itemize
9138 \begin_layout Itemize
9145 \begin_layout Subsection
9146 Commands not supported by \SpecialChar LyX
9150 \begin_layout Standard
9151 Some commands are not yet supported by the
9155 layout for \SpecialChar LyX
9157 Some have already been mentioned.
9158 For the sake of completeness, they are listed all together here:
9161 \begin_layout Itemize
9169 \begin_layout Itemize
9171 \change_deleted -712698321 1501151229
9181 \begin_layout Itemize
9183 \change_deleted -712698321 1501151308
9193 \begin_layout Itemize
9201 \begin_layout Itemize
9203 \change_deleted -712698321 1501151231
9211 \begin_layout Itemize
9213 \change_deleted -712698321 1501151231
9223 \begin_layout Itemize
9231 \begin_layout Itemize
9239 \begin_layout Standard
9240 If you want to use any of these commands, you have to enter them yourself.
9243 Do not forget to mark them as \SpecialChar LaTeX
9247 \begin_layout Subsection
9248 Figure and Table Floats
9251 \begin_layout Standard
9253 provides support for the necessary float environments
9255 figure, figure*, table
9261 , therefore we won't tell much about it here.
9265 \begin_inset space ~
9271 Just remember that tables should be left-aligned.
9272 For that, select the table and change the alignment in
9274 Edit\SpecialChar menuseparator
9276 \begin_inset space ~
9282 \begin_layout Standard
9283 There is only one special thing: the figures with caption besides the figure.
9284 To create such a figure, you have to do the following:
9287 \begin_layout Enumerate
9288 Create a wide figure float:
9290 Insert\SpecialChar menuseparator
9291 Float\SpecialChar menuseparator
9294 , then right click in the figure and select
9297 \begin_inset space ~
9305 \begin_layout Enumerate
9306 Enter your caption text.
9309 \begin_layout Enumerate
9314 to move the cursor above the caption.
9317 \begin_layout Enumerate
9321 \begin_layout Enumerate
9322 Position the cursor behind the figure and insert a horizontal fill:
9324 Insert\SpecialChar menuseparator
9326 \begin_inset space ~
9329 Character\SpecialChar menuseparator
9331 \begin_inset space ~
9339 \begin_layout Enumerate
9340 Switch to \SpecialChar LaTeX
9344 \begin_inset space ~
9352 \begin_layout Enumerate
9362 Do not close the brace!
9365 \begin_layout Enumerate
9366 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
9371 \begin_inset space ~
9383 \begin_layout Standard
9384 Also, refer to the figures in the example paper.
9387 \begin_layout Subsection
9391 \begin_layout Standard
9392 For submission, the paper has to be formated in a special double-spacing
9394 For this purpose, you have to give the option
9398 to the documentclass.
9399 This must be done using the
9400 \change_deleted -712698321 1501151486
9402 \change_inserted -712698321 1501151487
9405 class options field in the
9407 Document\SpecialChar menuseparator
9411 Just enter the string
9418 \begin_layout Subsection
9422 \begin_layout Standard
9427 directory contains an example paper written with \SpecialChar LyX
9429 It is the example paper from the original macro package, translated to
9432 Use it for inspiration, and compare the original \SpecialChar LaTeX
9433 code with \SpecialChar LyX
9437 \begin_layout Section
9442 \begin_layout Standard
9448 \begin_layout Subsection
9452 \begin_layout Standard
9454 is a set of macros produced by the American Astronomical Society to
9455 facilitate electronic manuscript submission to the three journals they
9456 publish: the Astrophysical Journal (including the Letters and Supplement),
9457 the Astronomical Journal, and the Publications of the Astronomical Society
9460 has proven to be an excellent tool for generating these documents, especially
9461 given its equation, citation, and figure handling capabilities.
9463 requires version 5.0 (or higher) of these macros; preferably
9464 \change_deleted -712698321 1501152764
9466 \change_inserted -712698321 1501152766
9469 , which is the version described here, or higher.
9470 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
9471 2.09 and are fundamentally
9472 incompatible with \SpecialChar LyX
9474 The AAS\SpecialChar TeX
9475 package may be downloaded from the AAS\SpecialChar TeX
9479 \begin_layout Standard
9480 \begin_inset VSpace medskip
9486 \begin_layout Standard
9488 \begin_inset Flex URL
9491 \begin_layout Plain Layout
9493 https://aas.org/aastex/aastex-downloads
9501 \begin_layout Standard
9502 \begin_inset VSpace medskip
9508 \begin_layout Standard
9509 A complete user guide is contained in that package and you should familiarize
9510 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
9513 will not reduce the need to figure out all the AAS\SpecialChar TeX
9514 commands, it will only
9515 reduce the drudgery of typing everything in.
9516 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
9518 completely to the requirements of the journal to which you are submitting
9522 \begin_layout Subsection
9523 Starting a New Paper
9526 \begin_layout Standard
9527 I strongly suggest that you start with the AAS\SpecialChar TeX
9531 File\SpecialChar menuseparator
9538 , enter the new file name, then choose the
9541 \change_inserted -712698321 1501152130
9547 This will show the most common fields found in a manuscript.
9548 Simply overwrite the existing text (including the brackets,
9552 ) with the correct information.
9553 Many of the AAS\SpecialChar TeX
9554 commands and environments can be implemented directly in
9557 \change_deleted -712698321 1501152213
9570 , which should stick out like a sore thumb if you actually just opened the
9574 For commands such as these, the \SpecialChar LaTeX
9575 code must be entered directly and marked
9577 Such commands are referred to as \SpecialChar TeX
9578 code, or Evil Red Text.
9579 I tried to minimize the amount of \SpecialChar TeX
9580 code needed in an AAS\SpecialChar TeX
9582 \change_deleted -712698321 1501152220
9583 , but there is still a bit more required than any of us would like
9588 \begin_layout Subsection
9589 Finishing Your Paper
9592 \begin_layout Standard
9593 When the paper is finished to your satisfaction and previews/prints correctly,
9595 \begin_inset Quotes eld
9599 \begin_inset Quotes erd
9602 actions which need to be done before you submit it to the journals.
9606 \begin_layout Enumerate
9607 Export your paper as a \SpecialChar LaTeX
9610 File\SpecialChar menuseparator
9611 Export\SpecialChar menuseparator
9619 \begin_layout Enumerate
9624 file with your favorite text editor
9628 \begin_layout Enumerate
9629 remove the comment lines before the
9638 \begin_layout Enumerate
9643 usepackage...{fontenc}
9645 line if it appears (usually just after
9660 \begin_layout Enumerate
9661 remove everything between (and including) the
9673 commands, except for any commands you specifically put into the \SpecialChar LaTeX
9675 (which should appear immediately after the
9676 \begin_inset Quotes eld
9679 User specified \SpecialChar LaTeX
9681 \begin_inset Quotes erd
9692 \begin_layout Enumerate
9693 Run the resulting file through \SpecialChar LaTeX
9694 to make sure it still processes correctly.
9697 \begin_layout Enumerate
9698 Reread the journal requirements to make sure your filenames and formats
9702 \begin_layout Enumerate
9706 \begin_layout Subsection
9707 Comments On Specific Commands
9710 \begin_layout Standard
9711 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
9718 ) gives a good description of each.
9719 Thus it's probably easiest for me to go down the list as found in the guide
9720 and offer comments where necessary.
9721 So let's begin \SpecialChar ldots
9725 \begin_layout Subsubsection
9726 Things that work as expected
9729 \begin_layout Standard
9730 Because they work as you might expect, I simply list them and the section
9831 begin{thebibliography}
9839 (2.13.2), all the cite commands and their variations (2.13.2), the generic
9840 graphicx figure commands (2.14.1),
9864 (2.15.4, amongst other places),
9891 \begin_layout Standard
9892 The following style options also work correctly:
9913 Simply put them in the
9919 Layout\SpecialChar menuseparator
9925 \begin_layout Subsubsection
9926 Things that work, but require more comment
9929 \begin_layout Standard
9930 The following items work, but require a little more discussion:
9933 \begin_layout Itemize
9934 These items are reserved for use by the journal editors, but you can put
9935 them into the \SpecialChar LaTeX
9936 preamble if you feel compelled to do so:
9969 \begin_layout Itemize
9970 These items may be placed in the \SpecialChar LaTeX
9971 preamble, and are included as blanks in
9993 \begin_layout Itemize
10000 (2.3) – can only be used
10001 \begin_inset Quotes eld
10005 \begin_inset Quotes erd
10008 , not in the middle of a paragraph.
10009 Use \SpecialChar TeX
10010 code if you need to embed it.
10013 \begin_layout Itemize
10020 (2.3) – will have extra {} after it.
10021 This should not cause an error.
10024 \begin_layout Itemize
10031 (2.6) – can only be used
10032 \begin_inset Quotes eld
10036 \begin_inset Quotes erd
10039 , not in the middle of a paragraph.
10040 Use \SpecialChar TeX
10041 code if you need to embed it.
10044 \begin_layout Itemize
10051 (2.8) – can't insert a cross-reference tag, you must type the tag name by
10055 \begin_layout Itemize
10062 (2.8) – same as for
10069 \begin_layout Itemize
10076 (2.9) – will have extra {} after it.
10077 This should not cause an error.
10080 \begin_layout Itemize
10087 (2.11) – will have extra {} after it.
10088 This should not cause an error.
10091 \begin_layout Itemize
10098 (2.14.2) – you can insert an optional filename argument by placing the cursor
10099 at the beginning of the text and selecting
10101 Insert\SpecialChar menuseparator
10106 \begin_inset Quotes eld
10110 \begin_inset Quotes erd
10113 inserts an optional argument of the type needed by
10120 Hopefully it will be renamed someday.
10123 \begin_layout Itemize
10136 for the catalog ID optional parameter
10139 \begin_layout Itemize
10152 for the catalog ID optional parameter
10155 \begin_layout Subsubsection
10156 Things not implemented, use \SpecialChar TeX
10160 \begin_layout Standard
10162 \change_deleted -712698321 1501152401
10187 setcounter{equation}
10189 (2.12), Journal name abbreviations (2.13.4),
10225 (2.15.4, insert it as the first element in the lefthand cell after where
10227 Don't use any of \SpecialChar LyX
10228 's rules in the table),
10240 (2.15.5), much of Misc (2.17, except
10291 \begin_layout Subsubsection
10292 Things that cannot be implemented
10295 \begin_layout Standard
10297 at least in any meaningful sort of way, so I suggest ignoring them.
10298 They are the references environment (2.13.3), and the deluxetable environment
10300 If you really, really need to use deluxetable, I suggest editing it in
10301 a separate file with a text editor, then using
10303 Insert\SpecialChar menuseparator
10305 \begin_inset space ~
10310 to include it in your \SpecialChar LyX
10316 file to see an example of this.
10319 \begin_layout Subsection
10320 FAQs, Tips, Tricks, and Other Ruminations
10323 \begin_layout Subsubsection
10324 Getting \SpecialChar LyX
10325 and AAS\SpecialChar TeX
10329 \begin_layout Standard
10330 It can be a bit tricky to get \SpecialChar LyX
10331 to recognize a new layout and document class.
10332 When all else fails, do this:
10335 \begin_layout Enumerate
10336 Make certain that \SpecialChar LaTeX
10337 can find AAS\SpecialChar TeX
10339 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
10340 distribution into a
10341 directory completely unrelated to \SpecialChar LaTeX
10342 or AAS\SpecialChar TeX
10343 and run \SpecialChar LaTeX
10351 \begin_layout Enumerate
10356 appears in \SpecialChar LyX
10364 \begin_layout Enumerate
10367 Tools\SpecialChar menuseparator
10370 in \SpecialChar LyX
10371 , then restart \SpecialChar LyX
10375 \begin_layout Enumerate
10376 Open a regular new file, not from a template.
10377 Does AAS\SpecialChar TeX
10378 appear in the class list in
10380 Document\SpecialChar menuseparator
10386 \begin_layout Standard
10387 If you get a warning from an existing AAS\SpecialChar TeX
10388 document about not being able
10389 to find the AAS\SpecialChar TeX
10390 layout or a message about
10391 \begin_inset Quotes eld
10394 You should not mix title layouts with normal ones
10395 \begin_inset Quotes erd
10398 , things haven't been installed correctly.
10401 \begin_layout Subsubsection
10403 error processing a table
10406 \begin_layout Standard
10408 , by default, attempts to center the table caption/title.
10409 This seems to produce a bad interaction in AAS\SpecialChar TeX
10410 so you should click somewhere
10411 in the caption/title, then select
10413 Edit\SpecialChar menuseparator
10415 \begin_inset space ~
10429 This took care of it for me.
10432 \begin_layout Subsubsection
10436 \begin_layout Standard
10437 A couple of things: 1) I have noticed some funny spacing in the reference
10438 entries in the text.
10439 When you enter the bibliography item data, make sure their is
10443 space between the last author and the parenthesis setting off the year;
10447 \begin_inset space \thinspace{}
10451 \begin_inset space \space{}
10465 2) Entering the references at all is not obvious.
10466 The easiest thing is to start typing your first reference at the end of
10467 the document, then mark it as type
10472 That will put a small gray box in front of what you just typed.
10473 Click on the box to fill in the rest of the information.
10474 For new references, go to the end of an existing reference and press return.
10475 That will create a new line with its own box, etc.
10478 \begin_layout Subsubsection
10479 Including EPS files
10482 \begin_layout Standard
10483 Even though AAS\SpecialChar TeX
10484 provides its own figure commands (
10490 , for example), I much prefer \SpecialChar LaTeX
10491 's standard figure commands (with the default
10500 \begin_inset space ~
10503 commands as \SpecialChar TeX
10504 code into a Figure Float box if you desire, but I never have
10505 much luck getting the layout right.
10506 With the standard graphics, \SpecialChar LyX
10511 usepackage{graphicx}
10513 command into the \SpecialChar LaTeX
10514 preamble and handle the figures in the standard \SpecialChar LaTeX2e
10516 interspersing the figures in the text.
10517 I believe ApJ accepts figures exactly this way now; AJ might still use
10519 \begin_inset Quotes eld
10522 stack everything at the end
10523 \begin_inset Quotes erd
10529 \begin_layout Subsubsection
10530 Things I could have done, but didn't
10533 \begin_layout Standard
10535 \begin_inset Quotes eld
10539 \begin_inset Quotes erd
10542 things I could have implemented, but chose not to.
10543 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
10545 even though it is double-spaced in the paper manuscript.
10546 Also, I chose not to make separate layouts for the preprint and preprint2
10548 Since I assume you will spend most of your time in the plain manuscript
10549 mode anyway, I decided not to chew up more disk space with this.
10553 \begin_layout Subsection
10557 \begin_layout Standard
10558 Your mileage may vary.
10559 I've now had papers published by both ApJ and AJ that have had 98% of the
10560 effort done in \SpecialChar LyX
10561 ; the last 2% was the \SpecialChar LaTeX
10562 post-processing and a few cleanups.
10563 I have had no trouble with the submission process, and I'm sure the journals
10564 were never aware that there might be a difference.
10565 So, go forth and publish!
10568 \begin_layout Section
10569 AMS \SpecialChar LaTeX
10573 \begin_layout Standard
10583 \begin_layout Standard
10584 \begin_inset VSpace bigskip
10590 \begin_layout Standard
10592 The AMS \SpecialChar LaTeX
10593 layouts are set up to conform to suggested styles for mathematical
10594 papers to be submitted to American Mathematical Society publications.
10595 The layouts are not tailored to a specific journal, but easily can be.
10596 You should refer to the AMS documentation for specific instructions for
10597 each journal (usually it will entail only changing a single line in the
10600 That documentation is available on the Web at
10601 \begin_inset Flex URL
10604 \begin_layout Plain Layout
10612 \begin_inset Flex URL
10615 \begin_layout Plain Layout
10617 ftp://ftp.ams.org/pub/tex/amslatex/
10623 These layouts are appropriate, and useful, for any mathematical writing.
10627 \begin_layout Standard
10628 There are two basic AMS \SpecialChar LaTeX
10632 \begin_layout Itemize
10633 amsart: The standard AMS article format.
10636 \begin_layout Itemize
10637 amsbook: the standard AMS book (really, monograph) format.
10641 \begin_layout Standard
10642 The layouts themselves contain only the minimum necessary to use the AMS
10644 They do not, in particular, contain any of the `theorem' environments used
10645 for setting theorems, lemmas, and the like.
10646 These are contained, instead, in the
10647 \begin_inset Flex Code
10650 \begin_layout Plain Layout
10656 module, which is loaded by default when you select one of the AMS classes.
10657 (It can also be used with other classes and can be removed, if you would
10658 rather use something else.) Less commonly used environments are in the
10659 \begin_inset Flex Code
10662 \begin_layout Plain Layout
10663 Theorems (AMS-Extended)
10668 module, which must be loaded manually.
10671 \begin_layout Standard
10672 By default, theorems and the like are numbered consecutively throughout
10673 the document, but this may be modified by loading the module
10674 \begin_inset Flex Code
10677 \begin_layout Plain Layout
10678 Theorems (Order by Section)
10683 or, if you are using
10684 \begin_inset Flex Code
10687 \begin_layout Plain Layout
10694 \begin_inset Flex Code
10697 \begin_layout Plain Layout
10698 Theorems (Order by Chapter)
10704 These will number the results as
10705 \begin_inset Formula $n.m$
10708 , where the first number refers to the section (or chapter) and the second
10709 refers to the total number of results so far in that section (or chapter).
10710 Many environments are also available unnumbered.
10711 These are indicated by an asterisk at the end.
10712 If you happen to want
10716 unnumbered results, the module
10717 \begin_inset Flex Code
10720 \begin_layout Plain Layout
10726 provides that option.
10729 \begin_layout Standard
10730 Note that these modules do not
10734 to be used with the AMS classes.
10735 It is perfectly possible to use the
10736 \begin_inset Flex Code
10739 \begin_layout Plain Layout
10745 module, and the others mentioned, with other classes, such as
10746 \begin_inset Flex Code
10749 \begin_layout Plain Layout
10756 \begin_inset Flex Code
10759 \begin_layout Plain Layout
10766 \begin_inset Flex Code
10769 \begin_layout Plain Layout
10778 \begin_layout Subsection
10779 What these layouts provide
10782 \begin_layout Standard
10783 There is a long list of included environments provided by these layouts.
10784 In AMS-\SpecialChar LaTeX
10785 , there is, in fact, an opportunity to define an unlimited variety
10786 of `theorem' environments.
10787 However, the AMS recommends the environments that are available in \SpecialChar LyX
10792 \begin_layout Standard
10793 The following environments—as well as the standard environments, such as
10795 \begin_inset Flex Noun
10798 \begin_layout Plain Layout
10805 \begin_inset Flex Noun
10808 \begin_layout Plain Layout
10815 \begin_inset Flex Noun
10818 \begin_layout Plain Layout
10825 \begin_inset Flex Noun
10828 \begin_layout Plain Layout
10835 \begin_inset Flex Noun
10838 \begin_layout Plain Layout
10845 \begin_inset Flex Code
10848 \begin_layout Plain Layout
10855 \begin_inset Flex Code
10858 \begin_layout Plain Layout
10867 \begin_layout Description
10868 Address This should be the author's permanent address.
10871 \begin_layout Description
10873 \begin_inset space ~
10876 Address This should be the author's temporary address at the time of submission,
10877 if different from the Address.
10880 \begin_layout Description
10881 Email Author's e-mail address
10884 \begin_layout Description
10885 URL Author's Web address, if desired.
10888 \begin_layout Description
10889 Keywords Key words or phrases used to identify specific topics discussed
10893 \begin_layout Description
10894 Subjectclass These refer to the AMS Subject Classifications, published and
10897 Mathematical Reviews
10900 These are also available online at the AMS cites listed above.
10903 \begin_layout Description
10907 \begin_layout Description
10911 \begin_layout Description
10915 \begin_layout Standard
10916 The following environments are provided by both the
10917 \begin_inset Flex Code
10920 \begin_layout Plain Layout
10927 \begin_inset Flex Code
10930 \begin_layout Plain Layout
10936 modules, in the latter case in both starred (unnumbered) and unstarred
10937 (numbered) versions.
10938 These same environments are provided only in the starred versions by the
10940 \begin_inset Flex Code
10943 \begin_layout Plain Layout
10952 \begin_layout Theorem
10953 This is typically used for the statements of major results.
10957 \begin_layout Corollary*
10958 This is used for statements which follow fairly directly from previous statement
10960 Again, these can be major results.
10964 \begin_layout Lemma
10965 These are smaller results needed to prove other statements.
10968 \begin_layout Proposition
10969 These are less major results which (hopefully) add to the general theory
10973 \begin_layout Conjecture
10974 These are statements provided without justification, which the author does
10975 not know how to prove, but which seem to be true (to the author, at least).
10978 \begin_layout Definition*
10979 Guess what this is for.
10980 The font is different for this environment than for the previous ones.
10984 \begin_layout Example*
10985 Used for examples illustrating proven results.
10988 \begin_layout Problem
10989 It's not really known what this is for.
10990 You should figure it out.
10993 \begin_layout Exercise*
10994 Write a description for this one.
10997 \begin_layout Remark
10998 This environment is also a type of theorem, usually a lesser sort of observation.
11001 \begin_layout Claim*
11002 Often used in the course of giving a proof of a larger result.
11006 Generally, these are used to break up long arguments, using specific instances
11012 The numbering scheme for cases is on its own, not together with other numbered
11017 \begin_layout Proof
11018 At the end of this environment, a QED symbol (usually a square, but it can
11019 vary with different styles) is placed.
11020 If you want to have other environments within this one—for example, Case
11021 environments—and have the QED symbol appear only after them, then the other
11022 environments need to be nested within the proof environment.
11025 Nesting Environments
11031 for information on nesting.
11034 \begin_layout Standard
11035 And these environments are provided by
11036 \begin_inset Flex Code
11039 \begin_layout Plain Layout
11040 Theorems (AMS-Extended)
11048 \begin_layout Criterion*
11049 A required condition.
11052 \begin_layout Algorithm*
11053 A general procedure to be used.
11056 \begin_layout Axiom*
11057 This is a property or statement taken as true within the system being discussed.
11060 \begin_layout Condition*
11061 Sometimes used to state a condition assumed within the present context of
11065 \begin_layout Note*
11066 Similar to a Remark.
11069 \begin_layout Notation*
11070 Used for the explanation of, yes, notation.
11073 \begin_layout Summary
11074 Do we really need to tell you?
11077 \begin_layout Acknowledgement*
11081 \begin_layout Conclusion*
11082 Sometimes used at the end of a long train of argument.
11086 Used in a way similar to Proposition, though perhaps lower on the scale.
11089 \begin_layout Standard
11090 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
11093 They need to be available on your system in order to use these environments.
11096 \begin_layout Section
11104 \begin_layout Standard
11110 \begin_layout Subsection
11114 \begin_layout Standard
11115 These are the layout files for some of the journals of the American Geophysical
11117 It is assumed that you have both the AGU's own class files and AGUplus
11118 installed (everything to be found at
11119 \begin_inset Flex URL
11122 \begin_layout Plain Layout
11124 http://publications.agu.org/files/2013/08/AGU-LaTeX.zip
11132 \begin_layout Subsection
11136 \begin_layout Standard
11146 They are still called this in the \SpecialChar LyX
11147 GUI, though their \SpecialChar LaTeX
11160 \begin_layout Standard
11161 Newly defined styles are
11198 These are mostly manuscript attributes and defined in the AGU class documentati
11202 \begin_layout Standard
11203 I suspect this is still badly incomplete.
11206 \begin_layout Subsection
11210 \begin_layout Standard
11227 \begin_layout Subsection
11231 \begin_layout Itemize
11234 Journal of Geophysical Research
11243 \begin_layout Standard
11244 Add your own, it isn't so hard! Look at the
11255 \begin_layout Subsection
11256 Bugs and things to remember
11259 \begin_layout Standard
11260 In order to use the new layouts, you must remember to do the following for
11264 \begin_layout Enumerate
11270 This can be done in the
11272 Layout\SpecialChar menuseparator
11277 Document\SpecialChar menuseparator
11281 (AGU articles are always in English, right? So
11285 choose a language.)
11288 \begin_layout Enumerate
11293 into the document's
11298 (Yes, this is a bug.)
11301 \begin_layout Enumerate
11302 Make sure you use the
11306 bibliography style, by entering
11310 into the second field of the Bib\SpecialChar TeX
11312 None of the standard styles will do.
11315 \begin_layout Section
11319 \begin_layout Standard
11325 \begin_layout Subsection
11329 \begin_layout Standard
11330 Broadway is for writing plays.
11331 The format is more decorative than Hollywood, and much less standardized.
11332 This format should be suitable for workshops.
11335 \begin_layout Subsection
11339 \begin_layout Standard
11340 The same as in Hollywood.
11343 \begin_layout Subsection
11347 \begin_layout Standard
11352 names as labels then cross-reference the label to insert the name.
11353 The cross-reference dialog will show the current cast of characters.
11356 \begin_layout Subsection
11357 Paper size and Margins
11360 \begin_layout Standard
11361 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
11364 \begin_layout Subsection
11368 \begin_layout Standard
11369 The following environments are available.
11370 You can use broadway.bind to get the bind keys shown at the right.
11373 \begin_layout Itemize
11377 \begin_inset Newline newline
11382 You should not have to use this, but it is here for anything that does not
11386 \begin_layout Itemize
11390 \begin_inset space \hfill{}
11394 \begin_inset Newline newline
11399 Used to describe stage setting and the action.
11400 First use of speaker names in all CAPs.
11403 \begin_layout Itemize
11407 \begin_inset space \hfill{}
11411 \begin_inset Newline newline
11416 Automatically numbered.
11417 On screen it will be arabic, but will print as Roman.
11420 \begin_layout Itemize
11424 \begin_inset space \hfill{}
11428 \begin_inset Newline newline
11438 It is just centered text.
11441 \begin_layout Itemize
11445 \begin_inset space \hfill{}
11449 \begin_inset Newline newline
11454 Not automatically numbered.
11455 You supply the number.
11456 This is because I couldn't figure out how.
11459 \begin_layout Itemize
11463 \begin_inset space \hfill{}
11467 \begin_inset Newline newline
11472 A special case of Narrative to describe the setting and action as the curtain
11476 \begin_layout Itemize
11480 \begin_inset space \hfill{}
11484 \begin_inset Newline newline
11489 The speaker's (actor's) title, centered in all CAPS.
11492 \begin_layout Itemize
11496 \begin_inset space \hfill{}
11500 \begin_inset Newline newline
11505 Instructions to the speaker.
11506 The parentheses are automatically inserted.
11507 The ( will appear on screen, but both will be in the printed play.
11508 This environment is only used within
11515 \begin_layout Itemize
11519 \begin_inset space \hfill{}
11523 \begin_inset Newline newline
11528 What the Speaker says.
11531 \begin_layout Itemize
11535 \begin_inset space \hfill{}
11539 \begin_inset Newline newline
11544 The curtain comes down.
11547 \begin_layout Itemize
11551 \begin_inset space \hfill{}
11557 \begin_layout Itemize
11561 \begin_inset space \hfill{}
11567 \begin_layout Itemize
11571 \begin_inset space \hfill{}
11577 \begin_layout Standard
11581 \begin_layout Section
11585 \begin_layout Standard
11590 can be used to type letters according to German conventions.
11591 A template file is included in
11593 .../lyx/share/templates
11595 for you to use as a starting point.
11598 \begin_layout Section
11606 \begin_layout Standard
11612 \begin_layout Subsection
11616 \begin_layout Standard
11617 This is the layout file for the European Geophysical Society journals.
11622 can be downloaded from the web site of the EGS under
11623 \begin_inset Flex URL
11626 \begin_layout Plain Layout
11636 \begin_layout Subsection
11640 \begin_layout Standard
11643 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
11651 The current layout file is unfortunately very unmodular and would benefit
11652 from using the various
11659 \begin_layout Section
11663 \begin_layout Standard
11664 See the \SpecialChar LyX
11670 It contains all infos you need.
11673 \begin_layout Section
11676 Foil\SpecialChar TeX
11680 \begin_inset CommandInset label
11689 \begin_layout Standard
11695 \begin_layout Subsection
11699 \begin_layout Standard
11700 This section describes how to use \SpecialChar LyX
11701 to make slides for overhead projectors.
11702 There are two document classes that can do this: the default slides class
11705 Foil\SpecialChar TeX
11709 This section documents the latter.
11712 \begin_layout Standard
11713 I'm going to say this again, nice and clear, so that there's no misunderstanding
11717 \begin_layout Standard
11718 \begin_inset VSpace bigskip
11724 \begin_layout Standard
11728 This section documents the class
11729 \begin_inset Quotes eld
11737 \begin_inset Quotes erd
11745 \begin_layout Standard
11746 \begin_inset VSpace bigskip
11752 \begin_layout Standard
11753 If you're looking for the documentation for
11754 \begin_inset Quotes eld
11762 \begin_inset Quotes erd
11765 , check out section
11766 \begin_inset space ~
11770 \begin_inset CommandInset ref
11772 reference "sec:slitex"
11777 If your machine doesn't have the
11785 installed, you'll probably have to use the default
11789 class, which isn't quite as good as
11794 \begin_layout Standard
11799 class is designed for use with version
11800 \begin_inset space ~
11808 class file which is now an integral part of \SpecialChar LaTeX2e
11812 \begin_layout Subsection
11816 \begin_layout Standard
11817 Obviously, to use this document class, you need to select
11828 \begin_inset space ~
11834 There are some settings in the
11837 \begin_inset space ~
11842 dialog that you should know about that are specific to this class:
11845 \begin_layout Itemize
11846 Don't change the options
11857 \begin_inset space ~
11863 They're ignored by the
11870 \begin_layout Itemize
11871 The default font size is 20
11872 \begin_inset space \thinspace{}
11875 pt with the other options being 17
11876 \begin_inset space \thinspace{}
11880 \begin_inset space \thinspace{}
11884 \begin_inset space \thinspace{}
11890 \begin_layout Itemize
11891 The default font is
11899 but all math equations are still typeset in the usual roman font.
11902 \begin_layout Itemize
11905 Foil\SpecialChar TeX
11908 supports A4 and Letter paper sizes as well as a special size for working
11910 \begin_inset space \thinspace{}
11914 It doesn't support A5, B5, legal or executive paper sizes.
11917 \begin_layout Itemize
11918 Don't bother changing the
11922 settings because they are ignored anyway.
11923 All floats appear where they are defined in the text.
11926 \begin_layout Itemize
11931 setting behaves a bit differently for this class.
11934 Foil\SpecialChar TeX
11937 provides extensive footer and header capabilities including a user-defined
11940 \begin_inset space ~
11944 \begin_inset CommandInset ref
11946 reference "sec:foilfoot"
11951 The title page is treated differently to all other pages in the document
11960 has the logo centered at the bottom of the page (if one is defined).
11961 The possible page style choices and what they do are as follows:
11965 \begin_layout Labeling
11966 \labelwidthstring MMMMMMM
11973 The final output contains no page numbers, or other headers or footers
11974 (except footnotes of course).
11978 \begin_layout Labeling
11979 \labelwidthstring MMMMMMM
11986 The final output contains page numbers centered at the bottom of the page.
11987 No other headings or footers (other than footnotes).
11990 \begin_layout Labeling
11991 \labelwidthstring MMMMMMM
11996 Page numbers in lower right corner.
11997 Additional headers and footers are also shown.
11998 This is also the default.
12001 \begin_layout Labeling
12002 \labelwidthstring MMMMMMM
12007 Gives you access to the
12011 package although its use with
12013 Foil\SpecialChar TeX
12016 is discouraged by the writer of the
12018 Foil\SpecialChar TeX
12021 package because of some potential page layout clashes.
12025 \begin_layout Subsubsection
12029 \begin_layout Standard
12030 The following options may be used in the extra class options in the
12032 Document\SpecialChar menuseparator
12038 \begin_layout Labeling
12039 \labelwidthstring MMMMMMx
12044 This sets up the page layout for 7.33
12045 \begin_inset space \thinspace{}
12049 \begin_inset space \thinspace{}
12052 in paper, which is about the same aspect ratio as a 35
12053 \begin_inset space \thinspace{}
12056 mm slide, making it a bit easier to work with this medium.
12059 \begin_layout Labeling
12060 \labelwidthstring MMMMMMx
12065 Places a rule across the page below the header on every page except the
12069 \begin_layout Labeling
12070 \labelwidthstring MMMMMMx
12075 Places a rule across the page above the footer on every page except the
12079 \begin_layout Labeling
12080 \labelwidthstring MMMMMMx
12085 This is automatically set each time you create a new
12092 Foil\SpecialChar TeX
12095 to use the dvips driver to rotate those pages that are set as landscape
12099 \begin_layout Labeling
12100 \labelwidthstring MMMMMMx
12105 Simply changes the page dimensions to those of a landscape page but doesn't
12107 Thus if you use this option you need to use an external program to rotate
12108 each page or feed your paper through your printer as landscape.
12109 Note that this option effectively reverses the roles of the
12117 environments (don't worry these are described in the next section).
12120 \begin_layout Labeling
12121 \labelwidthstring MMMMMMx
12126 Equation numbers on the left.
12129 \begin_layout Labeling
12130 \labelwidthstring MMMMMMx
12135 Flush-left equations.
12138 \begin_layout Subsection
12139 Supported Environments
12142 \begin_layout Standard
12143 Most of the environments commonly supported in other classes are also supported
12149 There are several additional environments provided by
12151 Foil\SpecialChar TeX
12154 as well as a couple added by \SpecialChar LyX
12156 The following environments are shared with other classes:
12159 \begin_layout Standard
12160 \begin_inset Flex Multiple Columns
12163 \begin_layout Itemize
12169 \begin_layout Itemize
12175 \begin_layout Itemize
12181 \begin_layout Itemize
12187 \begin_layout Itemize
12193 \begin_layout Itemize
12200 \begin_layout Itemize
12206 \begin_layout Itemize
12212 \begin_layout Itemize
12218 \begin_layout Itemize
12222 \change_deleted -712698321 1501158884
12226 \begin_layout Itemize
12232 \begin_layout Itemize
12238 \begin_layout Itemize
12244 \begin_layout Itemize
12250 \begin_layout Itemize
12256 \begin_layout Itemize
12262 \begin_layout Itemize
12264 \change_deleted -712698321 1501158888
12272 \begin_layout Itemize
12274 \change_deleted -712698321 1501158891
12287 \begin_layout Standard
12288 That is, all the major environments apart from the sectioning environments.
12289 Since foils are essentially self-contained sections, with a title and body,
12292 Foil\SpecialChar TeX
12295 provides specific commands for starting new foils and these are:
12298 \begin_layout Itemize
12304 \begin_layout Itemize
12310 \begin_layout Standard
12312 also provides slightly modified versions of these two environments called:
12315 \begin_layout Itemize
12321 \begin_layout Itemize
12324 ShortRotatefoilhead
12327 \begin_layout Standard
12328 and the differences will be explained in the next section.
12331 \begin_layout Standard
12332 Since foils are often used in presenting ideas or new theorems and such
12335 Foil\SpecialChar TeX
12338 also provides a comprehensive box of goodies for presenting them:
12341 \begin_layout Standard
12342 \begin_inset Flex Multiple Columns
12345 \begin_layout Itemize
12351 \begin_layout Itemize
12357 \begin_layout Itemize
12363 \begin_layout Itemize
12369 \begin_layout Itemize
12375 \begin_layout Itemize
12381 \begin_layout Itemize
12387 \begin_layout Itemize
12393 \begin_layout Itemize
12399 \begin_layout Itemize
12405 \begin_layout Itemize
12416 \begin_layout Standard
12417 The starred versions are unnumbered while the unstarred versions are numbered.
12418 There are also two list environments added by \SpecialChar LyX
12422 \begin_layout Itemize
12428 \begin_layout Itemize
12434 \begin_layout Standard
12437 Foil\SpecialChar TeX
12440 provides some powerful header and footer capabilities that are best set
12441 in the preamble although they may be set at any point in a document.
12442 If you want to change these settings in your document the best place to
12443 do so is at the very top of a foil, i.
12444 \begin_inset space \thinspace{}
12450 \begin_inset space \space{}
12455 straight after the foilhead.
12458 \begin_layout Standard
12459 For this purpose, the following command styles are provided [
12466 \begin_layout Standard
12467 \begin_inset Flex Multiple Columns
12470 \begin_layout Itemize
12474 \begin_inset space ~
12480 \begin_layout Itemize
12486 \begin_layout Itemize
12490 \begin_inset space ~
12496 \begin_layout Itemize
12500 \begin_inset space ~
12506 \begin_layout Itemize
12510 \begin_inset space ~
12517 \begin_layout Plain Layout
12518 \begin_inset space ~
12530 \begin_layout Standard
12531 There are also a few commands provided by
12533 Foil\SpecialChar TeX
12536 that aren't directly supported by \SpecialChar LyX
12537 but I'll tell you what they do and how
12538 to use them in section
12539 \begin_inset space ~
12543 \begin_inset CommandInset ref
12545 reference "sec:unsuppfoils"
12552 \begin_layout Subsection
12553 Building a Set of Foils
12556 \begin_layout Standard
12557 This section will give a simple introduction to using the different environments
12558 to build a set of foils.
12559 If you want to see an example set of foils, take a look at the
12563 file you find in \SpecialChar LyX
12571 \begin_layout Subsubsection
12572 Give It a Title Page
12575 \begin_layout Standard
12576 Unlike other classes that provide
12596 creates the title on a page of its own.
12597 If you leave out the
12601 environment \SpecialChar LaTeX
12602 will substitute the current date (every time you regenerate
12606 \begin_layout Subsubsection
12610 \begin_layout Standard
12611 As I mentioned earlier, there are four ways of starting a new foil.
12612 For portrait foils you should use
12621 The difference between these two environments is the amount of space between
12622 the title of the foil (the foilhead) and the body of the foil.
12625 \begin_layout Standard
12626 Landscape foils are generated using the
12632 ShortRotatefoilhead
12635 Again the only difference is the spacing between foilhead and body.
12636 Both of the short versions have 0.5
12637 \begin_inset space ~
12640 inches less separation between the foilhead and the body.
12644 \begin_layout Standard
12645 One problem with the support for landscape foils is the requirement that
12646 you have to use the
12650 driver to generate the PostScript output otherwise the foils won't be rotated.
12651 It is possible to get landscape foils even if you haven't got the
12655 driver provided you can feed your foils sideways through your printer ;-)
12658 \begin_layout Subsubsection
12659 Theorems, Lemmas, Proofs and more
12662 \begin_layout Standard
12664 \change_deleted -712698321 1501160146
12665 Due to a small bug in \SpecialChar LyX
12667 \change_inserted -712698321 1501160146
12670 ou can't have two of the same type of these environments directly following
12673 \change_inserted -712698321 1501160182
12674 If you use a normal paragraph break,
12675 \change_deleted -712698321 1501160188
12676 They must be separated by something.
12679 , you will just be extending the previous environment as if you had merged
12680 the two environments together.
12682 \change_deleted -712698321 1501160194
12683 So, how do you get around this problem? The simplest option is to insert
12684 some text between the two environments or add a
12689 environment between the two with just a
12690 \begin_inset Quotes eld
12698 \begin_inset Quotes erd
12702 This will force \SpecialChar LyX
12703 to produce two separate environments and hence the correct
12706 An example is provided in the example file included with the \SpecialChar LyX
12708 Remember, this problem only occurs if you are trying to place two of the
12709 same type of theorem-like environments one directly after the other.
12711 \change_inserted -712698321 1501160255
12712 Rather than that, you need to insert a so-called separator.
12713 Please refer to the section entitled
12726 \begin_layout Subsubsection
12730 \begin_layout Standard
12731 You get all the commonly supported list styles found in other classes as
12732 well as two new ones.
12733 I'll only describe the new ones here.
12734 If you want to find out more about the other list environments check out
12740 If you intend to use itemized lists you might also want to read about the
12744 \begin_inset space ~
12748 \begin_inset space ~
12753 dialog described above in section
12754 \begin_inset space ~
12758 \begin_inset CommandInset ref
12760 reference "sec:bullet"
12767 \begin_layout Standard
12768 The two new list styles,
12776 , are designed to make it easier for you to create lists of do's and don'ts
12777 or right and wrong by providing dedicated environments that use a tick
12778 or a cross as the label of the list.
12779 These lists are in fact dedicated variants of the
12784 They do however require that you have the
12788 packages installed.
12791 \begin_layout Subsubsection
12795 \begin_layout Standard
12798 Foil\SpecialChar TeX
12801 redefines the floating tables and figures so that they appear exactly where
12802 they are in the text rather than pushing them to the top of the page or
12803 to some user specified location.
12804 In fact if you change the float placement settings they are simply ignored.
12807 \begin_layout Subsubsection
12808 Page Headers and Footers
12809 \begin_inset CommandInset label
12811 name "sec:foilfoot"
12818 \begin_layout Standard
12822 \begin_inset space ~
12831 are two commands used to control the left-footer text string.
12832 The first is meant to allow you to include a graphic logo on your foils
12834 \begin_inset Quotes eld
12839 Foil\SpecialChar TeX
12843 \begin_inset Quotes erd
12847 While the second is meant to provide a classification for the audience,
12851 \begin_inset space \thinspace{}
12857 \begin_inset space \space{}
12861 It is empty by default.
12864 \begin_layout Standard
12865 The remaining page corners can be filled by
12868 \begin_inset space ~
12873 (which defaults to page numbers),
12876 \begin_inset space ~
12884 \begin_inset space ~
12892 \begin_layout Subsection
12895 Foil\SpecialChar TeX
12899 \begin_inset CommandInset label
12901 name "sec:unsuppfoils"
12908 \begin_layout Standard
12909 All the commands mentioned below need to be set in a
12919 within another environment.
12922 \begin_layout Subsubsection
12926 \begin_layout Standard
12927 All lengths are adjusted using the
12950 should be replaced by the name given to the length you want to change and
12955 is the length value.
12956 All lengths should be specified in units of length such as inches (
12968 ) or relative to some document or font-based length such as
12978 \begin_layout Standard
12979 It's possible to change the spacing between a foilhead and the body of the
12980 foil by adjusting the length specified by
12987 For example, to make
12992 \begin_inset space \space{}
12995 in closer to their bodies put the following in the preamble:
13001 foilheadskip}{-0.5in}
13004 \begin_layout Standard
13005 The spacings around floats can be adjusted by setting these lengths:
13008 \begin_layout Labeling
13009 \labelwidthstring MMMMMMMMMMM
13016 Separation between the text and the top of the float
13019 \begin_layout Labeling
13020 \labelwidthstring MMMMMMMMMMM
13027 Separation between the float and the caption
13030 \begin_layout Labeling
13031 \labelwidthstring MMMMMMMMMMM
13038 Separation between the caption and the following text
13041 \begin_layout Labeling
13042 \labelwidthstring MMMMMMMMMMM
13049 You can make the captions narrower than the surrounding text by adjusting
13051 Best done relative to
13060 \begin_layout Standard
13061 There are also several title page related lengths that you may find useful
13062 if you have a long title or several authors:
13065 \begin_layout Labeling
13066 \labelwidthstring MMMMMMMMMMM
13073 Separation from headers to
13078 \begin_layout Labeling
13079 \labelwidthstring MMMMMMMMMMM
13097 \begin_layout Labeling
13098 \labelwidthstring MMMMMMMMMMM
13112 \begin_layout Labeling
13113 \labelwidthstring MMMMMMMMMMM
13129 \begin_layout Labeling
13130 \labelwidthstring MMMMMMMMMMM
13146 \begin_layout Standard
13147 The last length related command affects all the list environments.
13158 a list environment then all the vertical spacing between the list items
13160 Note that this is a command not a length so it doesn't require
13166 like the stuff mentioned above.
13169 \begin_layout Subsubsection
13170 Headers and Footers
13173 \begin_layout Standard
13186 commands control whether the logo in the
13190 definition appear on a given page.
13197 in the preamble then none of the foils will have the logo on them.
13198 If you don't want the logo on a particular page place the
13204 directly after the foilhead of that page and the
13210 directly after the next foilhead.
13213 \begin_layout Standard
13214 If you decide to use the
13218 page style setting in the
13221 \begin_inset space ~
13226 dialog you should probably add
13236 to your preamble so headers and footers on landscape pages are correctly
13237 placed when rotated.
13238 This is due to some clashes between the page layouts provided by the
13249 \begin_layout Section
13250 Hollywood (Hollywood spec scripts)
13253 \begin_layout Standard
13259 \begin_layout Subsection
13263 \begin_layout Standard
13264 Getting the format of a Hollywood script right is a
13265 \begin_inset Quotes eld
13269 \begin_inset Quotes erd
13272 It is designed to make the readers focus on content and to be easy and
13273 familiar for the actors to read.
13274 Each page of a script should be one minute of film.
13275 Nothing goes in a script that you cannot see or hear on screen.
13276 The courier 12 pt font should be used throughout.
13280 \begin_layout Subsection
13284 \begin_layout Standard
13285 Speakers' lines should NEVER break in mid-sentence.
13286 If a speaker's lines continue over a page break, repeat the
13290 title followed by (Cont'd).
13293 \begin_layout Subsection
13297 \begin_layout Standard
13302 names as labels then cross-reference the label to insert the name.
13303 The cross-reference dialog will show the current cast of characters.
13304 You can use this to insert the speaker name in narratives also.
13307 \begin_layout Subsection
13308 Paper size and Margins
13311 \begin_layout Standard
13312 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
13315 \begin_layout Subsection
13319 \begin_layout Standard
13320 The following environments are available.
13321 You can use hollywood.bind to get the bind keys shown at the right.
13324 \begin_layout Itemize
13328 \begin_inset Newline newline
13333 Used where nothing else works.
13337 \begin_layout Itemize
13343 \begin_inset space \hfill{}
13351 \begin_inset Newline newline
13354 Usually followed by something like
13355 \begin_inset Quotes eld
13358 on Sally waking up.
13359 \begin_inset Quotes erd
13365 \begin_layout Itemize
13369 \begin_inset space \hfill{}
13373 \begin_inset Newline newline
13378 Introduces a new INTERIOR camera set-up.
13379 Always followed by DAY or NIGHT, or something similar to define the lighting
13381 Everthing on this line in CAPS.
13384 \begin_layout Itemize
13388 \begin_inset space \hfill{}
13392 \begin_inset Newline newline
13397 Introduces a new EXTERIOR camera set-up.
13398 Everthing on this line in CAPS.
13401 \begin_layout Itemize
13405 \begin_inset space \hfill{}
13409 \begin_inset Newline newline
13414 The character speaking.
13417 \begin_layout Itemize
13421 \begin_inset space \hfill{}
13425 \begin_inset Newline newline
13430 Instructions to the speaker.
13431 The () are automatically inserted
13432 \change_deleted -712698321 1501161286
13433 , but only the ( will show in \SpecialChar LyX
13435 Both will be printed
13440 \begin_layout Itemize
13444 \begin_inset space \hfill{}
13448 \begin_inset Newline newline
13460 \begin_layout Itemize
13464 \begin_inset space \hfill{}
13468 \begin_inset Newline newline
13473 Camera movement instruction.
13475 \begin_inset space \thinspace{}
13479 \begin_inset space \space{}
13485 \begin_layout Itemize
13489 \begin_inset space \hfill{}
13495 \begin_layout Itemize
13499 \begin_inset space \hfill{}
13505 \begin_layout Itemize
13509 \begin_inset space \hfill{}
13515 \begin_layout Itemize
13519 \begin_inset space \hfill{}
13525 \begin_layout Subsection
13529 \begin_layout Itemize
13533 \begin_layout Itemize
13537 \begin_layout Itemize
13539 \begin_inset space \thinspace{}
13546 \begin_layout Itemize
13551 \begin_layout Itemize
13552 PAN — camera movement
13555 \begin_layout Itemize
13556 INSERT — cut to close-up of
13559 \begin_layout Section
13563 \begin_layout Standard
13566 Panayotis Papasotiriou
13569 \begin_layout Subsection
13573 \begin_layout Standard
13574 The ijmpc package is a set of macros that facilitates electronic manuscript
13577 International Journal of Modern Physics C
13580 Similarly, the ijmpd package is for creating manuscripts to be submitted
13583 International Journal of Modern Physics D
13586 Both journals are published by World Scientific.
13587 The corresponding document classes are named
13596 These files, together with instructions for the authors, can be downloaded
13598 \begin_inset Flex URL
13601 \begin_layout Plain Layout
13603 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
13609 \begin_inset Flex URL
13612 \begin_layout Plain Layout
13614 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
13620 Both packages are modified versions of the standard
13621 \begin_inset Quotes eld
13625 \begin_inset Quotes erd
13628 package, and they are almost (but not exactly) identical.
13629 Most of their features are supported by \SpecialChar LyX
13631 I have used \SpecialChar LyX
13632 successfully to write articles submitted to both journals
13633 without any problem.
13636 \begin_layout Subsection
13640 \begin_layout Standard
13641 As usual, the easiest way to write a paper is to start with a template.
13644 File\SpecialChar menuseparator
13660 This will give an (almost) empty document that includes the most common
13661 fields found in a manuscript.
13662 Simply overwrite the existing text (including the brackets,
13667 You should keep in mind the following remarks.
13670 \begin_layout Enumerate
13672 won't let you change the font size and the page style of the document,
13673 because such modifications are not allowed by both packages.
13676 \begin_layout Enumerate
13677 The language of the document should not be changed.
13678 Before previewing your paper, be sure that the babel package is not used.
13679 To do this, click on
13680 \change_inserted -712698321 1501082726
13684 arg "dialog-show document"
13690 \change_deleted -712698321 1501082743
13695 \SpecialChar menuseparator
13697 \change_deleted -712698321 1501082747
13699 \change_inserted -712698321 1501082748
13705 \change_deleted -712698321 1501082762
13714 checkbox in the language settings, and click on
13722 , if you wish to make this change permanent)
13723 \change_inserted -712698321 1501082770
13725 \begin_inset Quotes eld
13729 \begin_inset Quotes erd
13741 \begin_layout Enumerate
13743 \begin_inset Quotes eld
13747 \begin_inset Quotes erd
13750 style must be used to define keywords.
13753 \begin_layout Enumerate
13754 The ijmpc package provides a style named
13755 \begin_inset Quotes eld
13758 Classification Codes
13759 \begin_inset Quotes erd
13762 , which can be used to define classification codes, such as PACS numbers.
13763 Note that this facility is not supported by the ijmpd package.
13766 \begin_layout Enumerate
13767 Several new environments are available:
13768 \begin_inset Quotes eld
13772 \begin_inset Quotes erd
13776 \begin_inset Quotes eld
13780 \begin_inset Quotes erd
13784 \begin_inset Quotes eld
13788 \begin_inset Quotes erd
13792 \begin_inset Quotes eld
13796 \begin_inset Quotes erd
13800 \begin_inset Quotes eld
13804 \begin_inset Quotes erd
13808 \begin_inset Quotes eld
13812 \begin_inset Quotes erd
13816 \begin_inset Quotes eld
13820 \begin_inset Quotes erd
13824 \begin_inset Quotes eld
13828 \begin_inset Quotes erd
13832 \begin_inset Quotes eld
13836 \begin_inset Quotes erd
13840 \begin_inset Quotes eld
13844 \begin_inset Quotes erd
13848 \begin_inset Quotes eld
13852 \begin_inset Quotes erd
13856 \begin_inset Quotes eld
13860 \begin_inset Quotes erd
13864 \begin_inset Quotes eld
13868 \begin_inset Quotes erd
13872 \begin_inset Quotes eld
13876 \begin_inset Quotes erd
13880 Their use is more or less obvious.
13882 supports all these environments; it will use the proper label, text style,
13883 and numbering scheme for each of them.
13886 \begin_layout Enumerate
13887 Both packages use basic citations; the natbib package should not be used.
13888 In \SpecialChar LyX
13889 , citation references are shown as usual; in the output, citations are
13890 shown as superscripts.
13891 If you want to use a citation as normal text, you should use the
13896 \begin_inset space \thinspace{}
13900 \begin_inset space \space{}
13904 \begin_inset Quotes eld
13908 \begin_inset space \space{}
13918 \begin_inset Quotes erd
13924 \begin_layout Enumerate
13926 \begin_inset Quotes eld
13930 \begin_inset Quotes erd
13933 section in both packages.
13934 To put acknowledgments, just use the
13935 \begin_inset Quotes eld
13939 \begin_inset Quotes erd
13945 \begin_layout Enumerate
13946 Appendices may be added to the paper,
13950 the Acknowledgments and
13956 provides a special environment, called
13957 \begin_inset Quotes eld
13961 \begin_inset Quotes erd
13964 which marks the beginning of the appendices.
13965 This environment should be left blank; it just sends a \SpecialChar LaTeX
13966 command, but nothing
13968 In \SpecialChar LyX
13970 \begin_inset Quotes eld
13974 \begin_inset Quotes erd
13977 is printed with blue letters, as a signal that all sections after that
13978 point are appendices.
13979 To write an appendix, use the
13980 \begin_inset Quotes eld
13984 \begin_inset Quotes erd
13989 will number each appendix with capital letters, as required by both journals.
13991 \begin_inset Quotes eld
13995 \begin_inset Quotes erd
14002 be present before the first appendix; if not, all appendices will be numbered
14003 as normal sections in the output.
14006 \begin_layout Enumerate
14007 The ijmpc and the ijmpd packages use the
14011 command to implement table captions.
14012 As a result, a table created by \SpecialChar LyX
14013 is printed correctly, but its caption
14015 However, you can use some \SpecialChar TeX
14016 code to overcome this problem, so that captions
14017 are printed as expected.
14018 To do so, create a float table as usual, remove the caption, and replace
14019 it with the \SpecialChar TeX
14030 (sic); you must also the \SpecialChar TeX
14035 immediately after the tabular material.
14036 Study the example table included in the template files to see how this
14037 trick is implemented.
14038 Alternatively, If you need table captions, you should implement the whole
14043 file, then include this file to the \SpecialChar LyX
14046 Insert\SpecialChar menuseparator
14047 File\SpecialChar menuseparator
14049 \begin_inset space ~
14055 Details on how to create a table float can be found in the files
14063 , included in the corresponding packages.
14066 \begin_layout Subsection
14067 Preparing a paper for submission
14070 \begin_layout Standard
14071 Before you submit your paper you must export the \SpecialChar LyX
14072 document as a \SpecialChar LaTeX
14075 File\SpecialChar menuseparator
14076 Export\SpecialChar menuseparator
14084 \begin_layout Plain Layout
14085 Actually you have the choice between \SpecialChar LaTeX
14086 (plain) and pdflatex.
14087 If you intend to use pdflatex to prepare the paper, you should use the
14088 pdflatex option so that included graphics are converted to PDF format,
14089 ready for use by pdflatex.
14094 , then make the following changes to the resulting
14101 \begin_layout Enumerate
14102 Remove the comment lines before the
14111 \begin_layout Enumerate
14112 Remove everything between (and including) the
14124 commands, except for any commands you specifically put into the \SpecialChar LaTeX
14128 \begin_layout Standard
14133 file should be saved and processed through \SpecialChar LaTeX
14134 as many times as necessary.
14135 You may also want to check the resulting
14142 \begin_layout Subsection
14144 \change_deleted -712698321 1501082212
14145 Use of \SpecialChar TeX
14149 \begin_layout Standard
14151 \change_deleted -712698321 1501082212
14152 The use of \SpecialChar TeX
14153 code is reduced to two commands, which must be placed at the
14154 top of the document.
14155 If you started writing your paper by using the
14163 template, the \SpecialChar TeX
14164 code needed is already in its place; you usually don't need
14166 You may only modify the first \SpecialChar TeX
14167 code to specify the information printed
14168 to the top of odd and even pages (authors' names and short paper's title,
14170 This \SpecialChar TeX
14171 code must have the form
14175 markboth{Authors' Names}{Short Paper's Title}
14182 \begin_layout Section
14186 \begin_layout Standard
14192 \begin_layout Subsection
14196 \begin_layout Standard
14197 The iopart package provides a document class to create electronic manuscript
14198 submission to the journals published by the Institute of Physics.
14199 Instructions for the authors how to create a paper using the iopart class
14200 can be downloaded together with the iopart package from the site
14201 \begin_inset Flex URL
14204 \begin_layout Plain Layout
14206 ftp://ftp.iop.org/pub/journals/latex2e
14214 \begin_layout Subsection
14218 \begin_layout Standard
14219 The easiest way to write a paper is to start with the
14220 \change_deleted -712698321 1501162201
14222 \change_inserted -712698321 1501162202
14230 \change_deleted -712698321 1501162208
14231 in \SpecialChar LyX
14232 's examples files folder
14233 \change_inserted -712698321 1501162222
14236 File\SpecialChar menuseparator
14237 New From Template\SpecialChar ldots
14239 \change_deleted -712698321 1501162219
14246 \change_deleted -712698321 1501162234
14247 Open this file, save it under a new name, and start writing.
14251 \change_deleted -712698321 1501162238
14253 \change_inserted -712698321 1501162239
14256 explains how to use the special text environments.
14257 Here are the most important advices:
14260 \begin_layout Itemize
14261 To be able to compile your document to a PDF, PS, or DVI, ensure that the
14263 \change_deleted -712698321 1501162254
14266 Use AMS math package
14268 in the document settings under
14273 \change_inserted -712698321 1501162277
14274 no AMS packages are loaded in
14276 Document\SpecialChar menuseparator
14277 Settings\SpecialChar menuseparator
14285 \begin_layout Itemize
14288 The title environment defines the kind of your paper.
14289 So use one of the following environments for the title:
14293 \begin_layout Itemize
14302 \begin_layout Itemize
14311 \begin_layout Itemize
14317 for a Topical review
14320 \begin_layout Itemize
14329 \begin_layout Itemize
14338 \begin_layout Itemize
14344 for a Paper (same as Title)
14347 \begin_layout Itemize
14353 for a Preliminary communication
14356 \begin_layout Itemize
14362 for a Rapid communication
14365 \begin_layout Itemize
14371 for a Letter to the editor
14375 \begin_layout Itemize
14378 All title environments except of
14382 can have an optional short title.
14385 \begin_layout Itemize
14386 There is a general title environment
14390 which is not directly supported by
14391 \change_deleted -712698321 1501162663
14396 This can be used as \SpecialChar TeX
14397 code when your document doesn't fit into one of the
14401 \begin_layout Standard
14402 For more informations like hints for special table and formula formatting,
14403 look at the IOP author guidelines.
14406 \begin_layout Section
14410 \begin_layout Standard
14413 Panayotis Papasotiriou
14416 \begin_layout Subsection
14420 \begin_layout Standard
14421 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
14422 that facilitates electronic manuscript submission to the journals they
14424 Most known of them (at least in my domain of interest) are
14426 Astrophysics and Space Science
14432 , but there are many others (see a complete list at
14433 \begin_inset Flex URL
14436 \begin_layout Plain Layout
14438 http://www.wkap.nl/jrnllist.htm/JRNLHOME
14444 The Kluwer package may be downloaded from the site
14445 \begin_inset Flex URL
14448 \begin_layout Plain Layout
14450 http://www.wkap.nl/kaphtml.htm/STYLEFILES
14456 A complete user guide is contained in that package (but it can also be
14457 downloaded separately).
14460 \begin_layout Standard
14462 supports many features of the package but not everything.
14463 However, the \SpecialChar TeX
14464 code needed is reduced to some
14465 \begin_inset Quotes eld
14469 \begin_inset Quotes erd
14472 commands of the package (see
14473 \begin_inset space ~
14477 \begin_inset CommandInset ref
14479 reference "subsec:kluwer_peculiarities"
14484 I have recently used \SpecialChar LyX
14485 to write an article submitted to the
14487 Astrophysics and Space Science
14489 without any problem.
14492 \begin_layout Subsection
14496 \begin_layout Standard
14497 The easiest way to write a paper is to start with the Kluwer template file.
14500 File\SpecialChar menuseparator
14512 This will give an (almost) empty document that includes the most common
14513 fields found in a manuscript and a short description of their use.
14514 As in most templates, simply overwrite the existing text (including the
14519 ) with the correct information.
14522 \begin_layout Subsection
14523 Preparing a paper for submission
14526 \begin_layout Standard
14527 As in the AAS\SpecialChar TeX
14528 package, before you submit your paper to a journal you must
14530 \begin_inset Quotes eld
14534 \begin_inset Quotes erd
14540 \begin_layout Enumerate
14541 Export your paper as a \SpecialChar LaTeX
14543 To do this, click on
14545 File\SpecialChar menuseparator
14546 Export\SpecialChar menuseparator
14554 \begin_layout Enumerate
14559 file with a text editor and make the following changes
14563 \begin_layout Enumerate
14564 remove the comment lines before the
14573 \begin_layout Enumerate
14574 remove everything between (and including) the
14586 commands, except for any commands you specifically put into the \SpecialChar LaTeX
14590 \begin_layout Standard
14599 \begin_layout Enumerate
14604 file through \SpecialChar LaTeX
14605 as many times as necessary (usually up to three).
14608 \begin_layout Enumerate
14614 \begin_inset space \thinspace{}
14618 \begin_inset space \space{}
14625 , and check if everything is OK (it should, if you didn't make any mistake).
14628 \begin_layout Subsection
14629 \begin_inset Quotes eld
14633 \begin_inset Quotes erd
14636 of the Kluwer package
14637 \begin_inset CommandInset label
14639 name "subsec:kluwer_peculiarities"
14646 \begin_layout Standard
14647 The Kluwer package has the following
14648 \begin_inset Quotes eld
14652 \begin_inset Quotes erd
14658 \begin_layout Enumerate
14659 It is possible to write multiple articles in the same \SpecialChar LaTeX
14664 \begin_layout Plain Layout
14665 I can't imagine any good reason to do this.
14671 Each article must be included in the environment
14672 \begin_inset Quotes eld
14676 \begin_inset Quotes erd
14680 Unfortunately, this environment cannot be omitted, even if you write just
14682 Therefore, each article starts with the command
14688 and, obviously, ends with the command
14695 Although this can be implemented in \SpecialChar LyX
14696 , I didn't included it, since it looks
14697 ugly and can confuse the novice user.
14698 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
14701 \begin_inset Quotes eld
14706 \begin_inset Quotes erd
14712 \begin_layout Enumerate
14713 Information given at the beginning of the article (i.
14714 \begin_inset space \thinspace{}
14718 \begin_inset space \space{}
14721 title, subtitle, author, institution, running title, running author, abstract
14722 and keywords) must be included in an environment called
14723 \begin_inset Quotes eld
14727 \begin_inset Quotes erd
14731 This is not implemented in \SpecialChar LyX
14732 , so you must enter title, subtitle etc.
14733 \begin_inset space ~
14736 between two \SpecialChar TeX
14752 \begin_layout Enumerate
14753 According to the user manual, the label of each bibliography item must be
14777 \begin_layout Standard
14782 template takes care of all these
14783 \begin_inset Quotes eld
14787 \begin_inset Quotes erd
14791 If you start a new paper using this template you don't need to do anything
14796 \begin_layout Enumerate
14797 don't delete the \SpecialChar TeX
14798 code included in the template, and
14801 \begin_layout Enumerate
14802 copy the example bibliography item included in the template and modify it
14803 as necessary to enter new bibliography items.
14806 \begin_layout Section
14810 \begin_layout Standard
14816 \begin_layout Subsection
14820 \begin_layout Standard
14821 The \SpecialChar LyX
14824 article (koma-script)
14828 report (koma-script)
14846 correspond to the \SpecialChar LaTeX
14864 \begin_inset space ~
14867 of the Koma-Script family.
14868 They are replacements for the standard document classes
14884 , resp., and fit better to European typography conventions in a number of
14888 \begin_layout Itemize
14889 Standard character size is 11pt in
14891 article (koma-script)
14895 report (koma-script)
14903 letter (koma-script)
14908 \begin_layout Itemize
14909 Headings, labels of the description environment, and a number of elements
14912 letter (koma-script)
14914 document class are set in a bold sans serif font.
14918 \begin_layout Plain Layout
14919 There is a big difference between the bold sans serif old cm fonts and new
14920 ec fonts, especially in the appearance of headings.
14921 In comparison, the ec bold sans serif fonts look a bit thin.
14922 Here the \SpecialChar LaTeX
14931 helps to produce the
14932 \begin_inset Quotes eld
14936 \begin_inset Quotes erd
14939 appearance when using the ec fonts.
14944 The numbering of chapter headings is made in the same way as the numbering
14945 of section headings, that is without the extra line
14946 \begin_inset Quotes eld
14949 Chapter\SpecialChar ldots
14951 \begin_inset Quotes erd
14955 In addition, the appearance of the headings can be modified by using a
14956 number of options (in \SpecialChar LyX
14957 to be entered in the field
14960 \begin_inset space ~
14967 Layout\SpecialChar menuseparator
14974 \begin_layout Itemize
14975 The main means in the Koma-Script document classes to design the type area
14984 (in \SpecialChar LyX
14985 to be entered in the extra class options field in the dialog
14987 Document\SpecialChar menuseparator
14991 They make a clearer modification of page margins possible as do the options
14994 Document\SpecialChar menuseparator
15001 \begin_layout Itemize
15002 The \SpecialChar LaTeX
15003 document classes of the Koma-Script family define a number of additional
15005 Those part of it which makes sense in \SpecialChar LyX
15006 is implemented in corresponding
15010 \begin_layout Standard
15011 Detailed descriptions of the \SpecialChar LaTeX
15012 document classes of the Koma-Script family
15013 can be found in the Koma-Script documentation
15024 \begin_layout Subsection
15025 article (koma-script), report (koma-script), and book (koma-script)
15028 \begin_layout Standard
15029 The document classes
15031 article (koma-script)
15035 report (koma-script)
15045 are implemented in the layout files
15058 They contain all the paragraph types of the corresponding standard document
15071 , resp., partly modified, with the exception of the \SpecialChar LyX
15076 -type, which is replaced by the new
15080 -type having the same functionality.
15085 -Type there is a number of new paragraph types added.
15092 letter (koma-script)
15097 \begin_layout Itemize
15106 : are equivalents to
15114 , resp., additionally inserting an entry in the table of contents.
15123 are not contained in
15125 article (koma-script)
15130 \begin_layout Itemize
15139 : behave exactly as
15147 , resp., additionally clearing running heads.
15152 is not contained in
15154 article (koma-script)
15160 \begin_layout Plain Layout
15173 report (koma-script)
15175 , but since this is identical to
15179 , is has not been implemented in \SpecialChar LyX
15188 \begin_layout Itemize
15193 : generates a heading directly above the following paragraph in the standard
15194 character size without affecting the structure of the document.
15197 \begin_layout Itemize
15206 are special captions which respect the different space settings needed
15207 for captions placed above or below an element (if you follow strict typographic
15208 rules, you might want to place table captions always above the table).
15209 You can also use the class option
15213 , which will switch
15226 You need at least Koma-Script version 2.8q to use this.
15229 \begin_layout Itemize
15234 : can be used to set a bonmot, e.
15235 \begin_inset space \thinspace{}
15239 \begin_inset space \space{}
15242 at the beginning of a chapter.
15243 If you use the optional argument (
15245 Insert\SpecialChar menuseparator
15247 \change_deleted -712698321 1501163301
15249 \begin_inset space ~
15253 \change_inserted -712698321 1501163306
15255 \begin_inset space ~
15262 ), you can insert the dictum's author there.
15263 Dictum and author are separated by a line.
15264 You need at least Koma-Script version 2.8q to use this.
15269 is not contained in
15271 article (koma-script)
15276 \begin_layout Standard
15277 The following types, together with the standard types
15289 , form the title area of the document.
15290 They must be entered ahead of the first
15291 \begin_inset Quotes eld
15295 \begin_inset Quotes erd
15302 \begin_layout Plain Layout
15303 The corresponding \SpecialChar LaTeX
15304 commands must appear before the
15315 When such a type is used more than once, the latter usage overwrites the
15316 former one, that means, for every type only the latest usage is valid.
15317 The order of the different types however has, like
15329 , no effect on the appearance of the produced document.
15332 \begin_layout Itemize
15337 : produces a centered paragraph above the ordinary title (
15349 ) for the subject of the document.
15352 \begin_layout Itemize
15357 : produces a centered paragraph below the ordinary title (
15369 ) for the publishers' name.
15372 \begin_layout Itemize
15379 report (koma-script)
15385 produces a centered paragraph on its own page behind the title page, or
15388 article (koma-script)
15390 produces a centered paragraph below the ordinary title (
15406 ) for a dedication.
15409 \begin_layout Itemize
15414 : produces a left aligned paragraph above the ordinary title (
15430 ) for a document`s head.
15433 \begin_layout Itemize
15438 : produces in a double-sided print in
15440 report (koma-script)
15446 a left-aligned paragraph at the top of the title page`s back or has no
15447 effect in a single-sided print or in
15449 article (koma-script)
15454 \begin_layout Itemize
15459 : produces in a double-sided print in
15461 report (koma-script)
15467 a left-aligned paragraph at the bottom of the title page`s back or has
15468 no effect in a single-sided print or in
15470 article (koma-script)
15475 \begin_layout Itemize
15480 : produces a special
15481 \begin_inset Quotes eld
15485 \begin_inset Quotes erd
15488 page ahead of the actual document containing a paragraph without special
15492 \begin_layout Standard
15493 The layout files for the document classes
15495 article (koma-script)
15499 report (koma-script)
15505 do include the file
15510 This is thought of as a place to define your own types.
15515 in your personal layout directory and edit the file!
15518 \begin_layout Subsection
15519 letter (koma-script)
15522 \begin_layout Description
15524 \change_inserted -712698321 1501163945
15525 Note: This section discusses the obsolete
15527 KOMA-Script-Letter (v.
15528 \begin_inset space ~
15533 , which is not even included anymore in recent KOMA releases.
15534 Please refer to the next section for the current KOMA-Script-Letter class
15536 \begin_inset space ~
15542 \begin_layout Standard
15546 letter (koma-script)
15548 is implemented in the layout file
15553 It contains all the paragraph types of the corresponding standard document
15558 , partly modified, with the exception of the \SpecialChar LyX
15572 type, which is replaced by the new
15577 In addition, it contains, in contrast to the standard document class, the
15596 Furthermore, there are a number of new letter specific types.
15599 \begin_layout Standard
15600 The appearance of the letter produced by this document class can be controlled
15601 by a number of \SpecialChar LaTeX
15602 commands, which you can put in the \SpecialChar LaTeX
15607 \begin_layout Plain Layout
15608 For example, the standard appearance of the letter`s heading, consisting
15609 of name and address, is quite self-willed.
15611 \begin_inset Quotes eld
15615 \begin_inset Quotes erd
15618 heading is produced by the following \SpecialChar LaTeX
15619 commands in the preamble:
15622 \begin_layout LyX-Code
15632 \begin_layout LyX-Code
15648 \begin_layout LyX-Code
15658 \begin_layout LyX-Code
15678 A detailed German description of such \SpecialChar LaTeX
15679 commands can be found in the Koma-Script
15685 With it, the letter's author can produce his personal letter layout.
15688 \begin_layout Standard
15697 define the beginning of the letter and must be used in every letter.
15698 To emphasize them in the \SpecialChar LyX
15699 document class, they are marked with the letter
15709 \begin_inset space ~
15712 in the left margin.
15713 It is possible to write any number of letters in one file.
15718 type produces a new letter using the same addressee and a
15722 type produces a new addressee.
15739 are ordinary paragraph types and can also be used several times in one
15740 and the same letter.
15743 \begin_layout Itemize
15748 : produces a paragraph for the addressee and implicitly defines the beginning
15752 \begin_layout Itemize
15757 : produces a paragraph for the form of address and implicitly produces a
15761 \begin_layout Itemize
15766 : produces a paragraph for a close.
15769 \begin_layout Itemize
15774 : produces a paragraph for a postscript.
15777 \begin_layout Itemize
15782 : produces a paragraph for a distribution list.
15785 \begin_layout Itemize
15790 : produces a paragraph for enclosures.
15793 \begin_layout Standard
15834 are input types provided with a label to enter information, which will
15835 be processed by the document class.
15839 \begin_layout Plain Layout
15840 It could be seen as a matter of inconsequence, that the types
15848 described above are not such input types as well.
15849 Because of the special meaning of those types, however, I have implemented
15850 them as ordinary paragraph types with a one letter mark in the left margin.
15851 Moreover, it would affect my feeling of symmetry, if the
15859 type had such a serious different appearance.
15864 The types must be used ahead of the corresponding
15871 \begin_layout Standard
15872 An implementation of these types in a WYSIWYG fashion does not seem to make
15873 sense, because the real appearance of the produced letter does not only
15874 depend on the usage of the particular type, but also on other factors.
15875 For example, a signature entered in the
15879 type will in the standard behavior appear in the produced letter only,
15880 when in the same letter also a
15885 The entered value of the
15889 type will in the standard behavior not appear in the produced letter at
15891 The possibility to design the letter`s heading freely is already indicated
15892 in a footnote above.
15895 \begin_layout Standard
15896 The input types can also be used as empty paragraphs.
15897 This makes sense e.
15898 \begin_inset space \thinspace{}
15902 \begin_inset space \space{}
15914 type is not used at all, in the standard behavior the value of the
15918 type is used as signature, whereas if an empty
15922 type is used, no signature value is defined.
15925 \begin_layout Standard
15926 By using the input types it is possible to write a letter template, containing
15927 filled input types with your personal dates (name, address, etc.) and empty
15928 input types for other dates you want to enter.
15931 \begin_layout Itemize
15936 : sender's name, in the standard behavior appears as a centered paragraph
15937 in small caps in the letter`s heading.
15940 \begin_layout Itemize
15945 : sender's signature, in the standard behavior appears below the
15954 type is used, the value of the
15958 type appears instead.
15961 \begin_layout Itemize
15966 : sender's address, in the standard behavior appears in a centered paragraph
15967 in the letter`s heading below the sender's name.
15970 \begin_layout Itemize
15975 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
15986 \begin_layout Itemize
15991 : place of the letter`s making.
15994 \begin_layout Itemize
15999 : date of the letter`s making.
16008 , in the standard behavior, produce the place and the date in a right-aligned
16009 line below the addressee's field.
16014 type is used, neither place nor date appear, independent of the value of
16024 type is used, the date of the letter `s production is used.
16027 \begin_layout Itemize
16032 : sender`s back address, in the standard behavior appears above the addressee's
16033 field in a small sans serif font.
16036 \begin_layout Itemize
16041 : special mail information, in the standard behavior appears underlined
16042 above the addressee's field below the back address.
16045 \begin_layout Itemize
16050 : additional information, in the standard behavior appears on right side
16051 below the addressee`s field.
16054 \begin_layout Itemize
16059 : the letter's title, in the standard behavior appears in a big, bold, sans
16060 serif font above the subject.
16063 \begin_layout Itemize
16068 : the letter's subject, in the standard behavior appears in a bold font
16076 \begin_layout Standard
16097 produce a business letter like line above the
16101 line containing the fields
16102 \begin_inset Quotes eld
16106 \begin_inset Quotes erd
16110 \begin_inset Quotes eld
16114 \begin_inset Quotes erd
16118 \begin_inset Quotes eld
16122 \begin_inset Quotes erd
16126 \begin_inset Quotes eld
16130 \begin_inset Quotes erd
16134 \begin_inset Quotes eld
16138 \begin_inset Quotes erd
16142 \begin_inset Quotes eld
16146 \begin_inset Quotes erd
16150 For the date field, the value of the
16156 \begin_inset Quotes eld
16159 business letter types
16160 \begin_inset Quotes erd
16163 is used, the value of the
16167 type however does not appear, but only the \SpecialChar LaTeX
16175 The ordinary output of place and date in a right-aligned line below the
16176 addressee`s field is suppressed.
16177 The types are implemented as input types provided with a label and must
16178 be used ahead of the corresponding
16185 \begin_layout Itemize
16193 \begin_layout Itemize
16201 \begin_layout Itemize
16209 \begin_layout Itemize
16217 \begin_layout Itemize
16225 \begin_layout Subsection
16226 The new letter class: letter (koma-script v.2)
16229 \begin_layout Standard
16235 \begin_layout Standard
16236 \begin_inset VSpace medskip
16242 \begin_layout Standard
16244 Koma-Script version 2.8 has introduced a new letter class
16248 which supersedes the now unsupported
16253 It has — on the \SpecialChar LaTeX
16254 side — a completely new interface and is not compatible
16255 with the old class.
16256 Therefore, \SpecialChar LyX
16257 supports both, though it is recommended you use the new class.
16260 \begin_layout Standard
16261 This class covers the same functionality as
16263 letter (koma-script),
16266 The basic items are
16270 (receiver's address, same as
16274 in the old layout),
16287 will start a new letter (i.
16288 \begin_inset space \thinspace{}
16292 \begin_inset space \space{}
16295 you can write several letters per document).
16296 New elements are sender's
16312 and the possibility to use a
16318 Insert\SpecialChar menuseparator
16324 \begin_layout Standard
16325 The biggest improvement is, though, that the letter's layout is configurable
16326 to meet almost any needs.
16327 This can be done via the preamble or with a special style file (Letter
16328 Class Option, extension
16332 ), that will be read in as a class option.
16336 \begin_layout Plain Layout
16337 The KOMA package comes with some default
16342 There is, for instance, a
16346 file that follows german typesetting rules, or a
16350 that provides the default layout of the old
16355 The latter can be loaded with the class option
16361 Layout\SpecialChar menuseparator
16362 Document\SpecialChar menuseparator
16374 template that is included in \SpecialChar LyX
16376 A detailed description is to be found in the Koma-Script documentation
16384 \begin_layout Subsection
16388 \begin_layout Standard
16389 Visualizing the Koma-Script document classes in \SpecialChar LyX
16390 , the \SpecialChar LyX
16391 internals cause some
16395 \begin_layout Itemize
16396 The chapter number of a
16400 type appears on a line of its own above the chapter heading instead of
16401 appearing in the same line ahead of it.
16402 The cause for that is the \SpecialChar LyX
16403 internal behavior for the labeltype
16407 in the layout file.
16410 \begin_layout Itemize
16411 The headings of the types
16419 are only put in the
16420 \begin_inset Quotes eld
16424 \begin_inset Quotes erd
16428 table of contents, but not in the \SpecialChar LyX
16429 table of contents (
16431 Document\SpecialChar menuseparator
16433 \begin_inset space ~
16437 \begin_inset space ~
16445 \begin_layout Itemize
16446 The paragraphs in a
16450 document class appear in a skip separation mode, not indented.
16451 This is the standard behavior, no special \SpecialChar LaTeX
16452 commands are needed for that.
16455 Document\SpecialChar menuseparator
16458 dialog the corresponding radio button indicates
16467 value always has the effect that extra \SpecialChar LaTeX
16468 commands are inserted in the document
16469 to produce the gap, which is not what is wanted in this case.
16472 \begin_layout Section
16476 \begin_layout Standard
16482 \begin_layout Subsection
16486 \begin_layout Standard
16487 Memoir is a very powerful and constantly evolving class.
16488 It has been designed with regard to fictional and non-fictional literature.
16489 Its aim is to let the user have maximum control over the typesetting of
16491 Memoir is based on the standard book class, but it can also emulate the
16492 article class (see below).
16495 \begin_layout Standard
16496 Peter Wilson, the developer of Memoir, is known as the author of lots of
16497 useful packages in the \SpecialChar LaTeX
16499 Most of them have been merged with Memoir.
16500 Therefore, it is much easier to layout the table of contents, appendices,
16501 chapter designs and such.
16503 , though, does not support all of these goodies natively.
16504 Some of them might be added to forthcoming releases
16508 \begin_layout Plain Layout
16509 You are invited to send suggestions to
16510 \begin_inset Flex URL
16513 \begin_layout Plain Layout
16515 lyx-devel@lists.lyx.org
16525 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
16527 Of course you can still use all features with the help of some native \SpecialChar LaTeX
16529 commands (\SpecialChar TeX
16534 \begin_layout Plain Layout
16539 \begin_layout Plain Layout
16549 \begin_inset space ~
16553 \begin_inset CommandInset ref
16555 reference "sec:Inserting-TeX-Code"
16565 In this section, we can only list those features that are natively supported
16566 by \SpecialChar LyX
16568 For detailed descriptions (and for the rest of features) we recommend you
16569 have a look at the detailed manual of the Memoir class
16573 \begin_layout Plain Layout
16578 \begin_layout Plain Layout
16588 \begin_inset Flex URL
16591 \begin_layout Plain Layout
16593 CTAN:/macros/latex/memoir/memman.pdf
16603 , which is not only a user guide for the class, but also both a comprehensive
16604 description on good typesetting and a superb example for good typesetting
16608 \begin_layout Subsection
16609 Basic features and restrictions
16612 \begin_layout Standard
16613 Memoir supports basically all features of the standard book classes.
16614 There are, however, some differences, as follows:
16617 \begin_layout Description
16619 \begin_inset space ~
16622 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
16625 \begin_layout Description
16627 \begin_inset space ~
16630 style: The fancy page style is not supported, due to a command clash between
16631 Memoir and the fancyhdr package (they both define a command with the same
16632 name, which confuses \SpecialChar LaTeX
16634 Instead, Memoir comes with a number of its own page styles (see
16635 \change_deleted -712698321 1501165256
16638 Layout\SpecialChar menuseparator
16641 Document\SpecialChar menuseparator
16643 \change_inserted -712698321 1501165264
16644 Settings\SpecialChar menuseparator
16648 \begin_inset space ~
16654 If you want to use these for the chapter pages, you have to use the command
16661 in the main text or in preamble (e.
16662 \begin_inset space \thinspace{}
16666 \begin_inset space \space{}
16673 chapterstyle{companion}
16678 \begin_layout Description
16679 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
16680 optional argument in the standard classes.
16681 With this, you can specify an alternative version of the title for the
16682 table of contents and the headers (for instance, if the title is too long).
16683 In \SpecialChar LyX
16684 , you can do this via
16686 Insert\SpecialChar menuseparator
16688 \begin_inset space ~
16693 at the beginning of a chapter/section.
16694 Memoir features a second optional argument and thus separates the table
16695 of contents from the header.
16696 You can define three variants of a title with this: one for the main text,
16697 one for the table of contents, and one for the headers.
16699 \change_deleted -712698321 1501165686
16700 Simply insert two optional arguments if you need this feature, the first
16701 one containing the short title for the Table of Contents, the second one
16702 containing an alternative short title for the headers
16703 \change_inserted -712698321 1501165708
16705 makes these available in form of specific
16718 \begin_layout Description
16719 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
16720 of contents, the list of figures and the list of table start a new page
16722 Memoir does not follow this route.
16723 You have to insert a page break yourself, if you want to have one.
16726 \begin_layout Description
16727 Titlepage: For some unknown reason, Memoir uses pagination on the title
16728 page (in the standard classes, title pages are
16729 \begin_inset Quotes eld
16733 \begin_inset Quotes erd
16737 If you want an empty title page, type
16741 aliaspagestyle{title}{empty}
16746 \begin_layout Description
16747 Article: With the class option
16752 \change_deleted -712698321 1501165976
16755 Layout\SpecialChar menuseparator
16758 Document\SpecialChar menuseparator
16760 \change_inserted -712698321 1501165986
16761 Settings\SpecialChar menuseparator
16762 Class Settings\SpecialChar menuseparator
16764 \change_deleted -712698321 1501165988
16766 \change_inserted -712698321 1501165989
16770 \begin_inset space ~
16775 ), you can emulate article style.
16776 That is, counters (footnotes, figures, tables etc.) will not be reset on
16777 new chapters, chapters don't start a new page (but are—in contrary to
16778 \begin_inset Quotes eld
16782 \begin_inset Quotes erd
16785 article classes—still allowed), parts, though, use their own page, as in
16789 \begin_layout Description
16790 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
16791 font commands, which have been used in the old \SpecialChar LaTeX
16793 \begin_inset space \thinspace{}
16797 \begin_inset space \space{}
16813 It produces an error and stops \SpecialChar LaTeX
16814 whenever such a command appears.
16819 reallows the commands and spits out warnings instead (which does at least
16820 not stop \SpecialChar LaTeX
16822 Since a lot of packages and particularly Bib\SpecialChar TeX
16823 style files are still using
16824 those commands, we have decided to use this option by default.
16827 \begin_layout Subsection
16831 \begin_layout Standard
16832 We will only describe the features supported by \SpecialChar LyX
16833 (which is not much currently).
16834 Please consult the Memoir manual
16838 \begin_layout Plain Layout
16843 \begin_layout Plain Layout
16853 \begin_inset Flex URL
16856 \begin_layout Plain Layout
16858 CTAN:/macros/latex/memoir/memman.pdf
16871 \begin_layout Description
16872 Abstract: You may wonder why an abstract is an extra feature.
16873 Well, it is in book class.
16874 Usually books don't have abstracts.
16875 Memoir, however, has.
16876 You can use it wherever and how often you like.
16879 \begin_layout Description
16880 Chapterprecis: You may know this older typesetting style: The contents of
16881 a chapter are summarized below the title and also in the table of contents
16883 \begin_inset space \thinspace{}
16887 \begin_inset space \space{}
16892 Our hero arrives in Troia; he loses some friends; he finds others
16895 Chapterprecis does exactly this.
16896 It is therefore only sensible below a chapter.
16899 \begin_layout Description
16900 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
16901 The epigraph environment provides an elegant way of typesetting such a
16903 The motto itself (text) and its
16904 \change_inserted -712698321 1501166968
16907 author (source) are divided by a short line.
16909 \change_deleted -712698321 1501166972
16910 Unfortunately, we have to fool \SpecialChar LyX
16911 a bit here again, since the environment
16912 needs two arguments (text and source).
16913 In this case, we have to use curly brackets (in \SpecialChar TeX
16914 mode) between the two
16925 <author of the slogan>
16926 \change_inserted -712698321 1501166996
16929 The author (source) can be inserted via
16931 Insert\SpecialChar menuseparator
16940 \begin_layout Description
16941 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
16942 complex figurative poems).
16944 can only support a few of them.
16945 One is poemtitle, which is a centered title for poems, which will also
16946 be added to the table of contents (verse is the standard environment for
16948 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
16950 because they have to be nested inside regular verse environments, which
16951 is not possible with \SpecialChar LyX
16955 \begin_layout Description
16956 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
16959 \begin_layout Section
16960 Article (mwart), book (mwbk) and report (mwrep)
16961 \begin_inset Argument status
16964 \begin_layout Plain Layout
16977 \begin_layout Standard
16983 \begin_layout Standard
16984 The \SpecialChar LyX
17001 correspond to the \SpecialChar LaTeX
17015 They are replacements for the standard document classes
17027 , resp., and fit better to Polish typography conventions in a number of points.
17031 \begin_layout Standard
17035 \begin_layout Itemize
17036 Unnumbered titles (with star, e.
17037 \begin_inset space \thinspace{}
17041 \begin_inset space \space{}
17048 ) are added into table of contents,
17051 \begin_layout Itemize
17052 Additional page styles:
17056 \begin_layout Description
17057 uheadings header with separated lines,
17060 \begin_layout Description
17061 myheadings custom header, contents headers via commands:
17076 \begin_layout Description
17077 myuheadings custom header with separated lines,
17080 \begin_layout Description
17081 outer page number is placed on outer side of page
17085 \begin_layout Itemize
17090 \begin_layout Description
17091 rmheadings serif titles — default,
17094 \begin_layout Description
17095 sfheadings sansserif titles,
17098 \begin_layout Description
17099 authortitle on title page first placed is author next title — default,
17102 \begin_layout Description
17103 titleauthor on title page first placed is title next author,
17106 \begin_layout Description
17107 withmarginpar reserve place on page for margins.
17111 \begin_layout Section
17115 \begin_layout Standard
17120 provides an alternative to the standard
17125 It provides similar functionality, but you might prefer this layout with
17126 sans serif sections, headings, and more.
17129 \begin_layout Section
17130 Rev\SpecialChar TeX
17134 \begin_layout Standard
17140 \begin_layout Standard
17141 \begin_inset VSpace bigskip
17147 \begin_layout Standard
17152 \begin_inset space ~
17157 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
17159 \begin_inset Formula $\beta$
17162 release of May, 1999) class.
17165 \begin_layout Standard
17171 textclass, which works with Rev\SpecialChar TeX
17173 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
17175 That means that it doesn't interact very well with \SpecialChar LyX
17176 , which requires \SpecialChar LaTeX2e
17178 it has been kludged to work.
17179 Since Rev\SpecialChar TeX
17180 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
17185 Rev\SpecialChar TeX
17187 \begin_inset space ~
17192 textclass should also be pretty easy to use.
17195 \begin_layout Standard
17196 These documents are supposed to be used in
17200 to the Rev\SpecialChar TeX
17201 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
17203 and assume you'll know what to put in the preamble if necessary.
17206 \begin_layout Subsection
17210 \begin_layout Standard
17211 All you need to do is install Rev\SpecialChar TeX
17212 4, as described in the package's README
17214 The package can be found at The Rev\SpecialChar TeX
17216 \begin_inset Flex URL
17219 \begin_layout Plain Layout
17221 http://publish.aps.org/revtex4/
17227 Install it somewhere that \SpecialChar LaTeX
17229 Test it by trying to \SpecialChar LaTeX
17230 a short Rev\SpecialChar TeX
17231 4 document in some random directory (i.
17232 \begin_inset space \thinspace{}
17236 \begin_inset space \space{}
17239 not the directory where you installed the class file.) Then, if you reconfigure
17241 , it will find the class file and let you use the Rev\SpecialChar TeX
17245 \begin_layout Standard
17246 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
17255 \begin_inset space ~
17260 template, found in the templates directory.
17263 \begin_layout Subsection
17267 \begin_layout Standard
17268 Optional arguments to
17275 \begin_inset Quotes eld
17279 \begin_inset Quotes erd
17283 \begin_inset Quotes eld
17287 \begin_inset Quotes erd
17293 \begin_inset space ~
17301 \begin_inset space ~
17307 Remember that in Rev\SpecialChar TeX
17308 , at least one optional argument is required!
17311 \begin_layout Standard
17312 Other preamble matter, like
17319 \begin_inset space ~
17326 \begin_inset space ~
17331 dialog, also as usual.
17334 \begin_layout Subsection
17338 \begin_layout Standard
17339 The layouts basically correspond to the commands in Rev\SpecialChar TeX
17341 For example, the Email layout corresponds to
17348 Note that (at least as of Rev\SpecialChar TeX
17357 layouts are exactly equivalent, so you shouldn't need to use both.
17361 \begin_layout Plain Layout
17362 In case you're curious, both were included so that
17366 would be able to translate both
17386 \begin_layout Subsection
17390 \begin_layout Standard
17391 There are a couple of important unique aspects of Rev\SpecialChar TeX
17392 4 which might cause
17393 bugs that will be even more confusing in \SpecialChar LyX
17397 \begin_layout Standard
17398 In Rev\SpecialChar TeX
17416 The \SpecialChar LyX
17417 equivalent is that there is a separate Thanks layout.
17422 write footnotes in the
17426 layout, or weird things may happen.
17427 See the Rev\SpecialChar TeX
17428 4 documentation for more details.
17431 \begin_layout Standard
17435 \begin_inset space ~
17443 \begin_inset space ~
17452 layouts must be placed
17460 layout and the corresponding
17477 , the \SpecialChar LaTeX
17481 \begin_layout Subsection
17483 \change_deleted -712698321 1501168252
17487 \begin_layout Standard
17489 \change_deleted -712698321 1501168252
17490 The main problem with this layout is that you can't use the optional arguments
17491 to layouts like Email and Title.
17492 (The problem is not unique to this layout; you can't use optional arguments
17493 to the Section layouts either.) This means that after you export that file
17494 to \SpecialChar LaTeX
17495 (which you'll need to do eventually to send it in to APS), you'll need
17496 to edit the \SpecialChar LaTeX
17497 file with a text editor to add the optional arguments to set,
17499 \begin_inset space \thinspace{}
17503 \begin_inset space \space{}
17506 the running title for the page headers.
17507 Lacking these layouts makes the
17513 (and the equivalent
17519 ) useless, so the corresponding layouts don't exist, and will have to be
17524 \begin_layout Plain Layout
17529 actually, \SpecialChar LyX
17530 1.3.0 supports some forms of optional arguments, but this layout
17531 has not been updated yet to take advantage of it.
17541 \begin_layout Section
17542 Springer Journals (
17549 \begin_layout Standard
17555 \begin_layout Subsection
17559 \begin_layout Standard
17560 These are the layout files for some of the journal formats used by Springer
17561 Verlag and listed on
17562 \begin_inset Flex URL
17565 \begin_layout Plain Layout
17567 http://www.springer.de/author/tex/help-journals.html
17572 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
17574 It is a modular system: the things common to all journals are implemented
17579 , which journal-specific layout files (such as, e.
17580 \begin_inset space \thinspace{}
17584 \begin_inset space \space{}
17591 for Journal of Geodesy) can include.
17594 \begin_layout Standard
17595 This means that implementing support for any other Springer journal on this
17596 list is as simple as writing your own
17604 file following the outline given in
17612 \begin_layout Standard
17613 It is reasonably well tested only for the Journal of Geodesy.
17622 come with the standard \SpecialChar LyX
17624 Install the relevant class file (downloaded from Springer) in a proper
17625 directory, reconfigure \SpecialChar LaTeX
17626 (in the te\SpecialChar TeX
17631 , as root if necessary — doesn't \SpecialChar LyX
17632 take care of this?), reconfigure \SpecialChar LyX
17637 \begin_layout Subsection
17641 \begin_layout Standard
17642 A large number of theorem-like styles —
17654 \begin_layout Standard
17657 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
17658 _Title, Author_Running, Institute,
17659 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
17662 See the Springer class file documentation for details.
17665 \begin_layout Subsection
17669 \begin_layout Itemize
17681 \begin_layout Itemize
17684 Probability Theory and Related Fields
17690 — Jean-Marc Lasgouttes
17693 \begin_layout Standard
17694 Add your own, it isn't so hard!
17697 \begin_layout Subsection
17701 \begin_layout Standard
17702 These files are partly based on the older
17706 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
17708 file from Springer.
17713 layout, are now defunct.
17714 Jean-Marc Lasgouttes helped out big in making me find my way around the
17716 layout file mechanism.
17719 \begin_layout Subsection
17723 \begin_layout Standard
17725 But probably less than in the old hacked-\SpecialChar LaTeX
17733 \begin_layout Standard
17735 \change_deleted -712698321 1501168901
17737 \begin_inset space \thinspace{}
17740 g.: does not display the number for theorem-like layouts, just #.
17745 \begin_layout Section
17748 Sli\SpecialChar TeX
17752 \begin_inset CommandInset label
17761 \begin_layout Standard
17769 \begin_layout Subsection
17773 \begin_layout Standard
17774 This section describes how to use \SpecialChar LyX
17775 to make slides for overhead projectors.
17776 There are two document classes that can do this: the default slides class
17779 Foil\SpecialChar TeX
17783 This section documents the former.
17786 \begin_layout Standard
17787 I'm going to say this again, nice and clear, so that there's no misunderstanding
17791 \begin_layout Standard
17792 \begin_inset VSpace bigskip
17798 \begin_layout Standard
17802 This section documents the class
17803 \begin_inset Quotes eld
17811 \begin_inset Quotes erd
17819 \begin_layout Standard
17820 \begin_inset VSpace bigskip
17826 \begin_layout Standard
17827 If you're looking for the documentation for
17828 \begin_inset Quotes eld
17833 slides (Foil\SpecialChar TeX
17837 \begin_inset Quotes erd
17840 , check out section
17841 \begin_inset space ~
17845 \begin_inset CommandInset ref
17847 reference "sec:foiltex"
17857 \begin_inset Quotes eld
17862 slides (Foil\SpecialChar TeX
17866 \begin_inset Quotes erd
17869 ] is actually somewhat better than the default
17877 \begin_layout Plain Layout
17879 or so I've been told repeatedly by its advocates.
17880 Having never used it, I have no idea if this claim is true or not.
17885 which this section documents.
17888 \begin_layout Standard
17889 This class is the \SpecialChar LaTeX2e
17890 improvement of the old
17892 Sli\SpecialChar TeX
17896 Every \SpecialChar LaTeX2e
17897 distribution includes this class [which I'll just refer to as
17898 \begin_inset Quotes eld
17906 \begin_inset Quotes erd
17909 from now on], so you're bound to have it.
17910 As I noted earlier, there are other classes, such as
17914 , which also produce slides for overhead projectors and do a better job
17916 However, there are some things which
17920 can do which the others can't, such as generate overlays.
17921 Read on to learn more!
17924 \begin_layout Subsection
17926 \begin_inset CommandInset label
17928 name "sec:slidesetup"
17935 \begin_layout Standard
17936 Obviously, to use this document class, you need to select
17937 \begin_inset Quotes eld
17945 \begin_inset Quotes erd
17948 from the class list in the
17950 Document\SpecialChar menuseparator
17954 There are some other special things you should know about this class:
17957 \begin_layout Itemize
17958 Don't bother changing the options
17963 They're not supported by the
17970 \begin_layout Itemize
17974 \begin_inset space ~
17979 behaves a bit differently for this class.
17980 The possible choices and what they do are as follows:
17984 \begin_layout Description
17989 The final output contains page numbers in the lower right corner.
17992 \begin_layout Description
18001 , but also prints out any time markers you've put in.
18002 This is the default.
18005 \begin_layout Description
18010 The final output contains no page numbers, time markers, or alignment markers.
18014 \begin_layout Itemize
18019 class has an extra option:
18025 \begin_inset Quotes eld
18033 \begin_inset Quotes erd
18036 in the extra class options.
18040 \begin_layout Standard
18041 Using this options allows you to add time markers to
18047 \begin_inset space ~
18051 \begin_inset CommandInset ref
18053 reference "sec:slideNote"
18061 \begin_layout Standard
18062 You can also use the template file
18063 \begin_inset Quotes eld
18071 \begin_inset Quotes erd
18074 to automatically set up a document to use the
18080 File\SpecialChar menuseparator
18082 \begin_inset space ~
18086 \begin_inset space ~
18091 to open your new document].
18092 The template file also contains some examples of the special paragraph
18093 environments used by this class.
18094 I'll describe those next.
18097 \begin_layout Subsection
18098 Paragraph Environments
18101 \begin_layout Subsubsection
18102 Supported Environments
18105 \begin_layout Standard
18106 The first thing you'll notice when you start up a new
18110 document is the font size and type: it's the equivalent of the size
18111 \begin_inset Quotes eld
18119 \begin_inset Quotes erd
18125 \begin_inset space ~
18131 This is also what's used in the output.
18133 \begin_inset Quotes eld
18137 \begin_inset Quotes erd
18140 to remind you that this is a slide.
18141 Your final slides will use a larger font; ergo, you'll have less space.
18142 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
18145 \begin_layout Standard
18146 The next thing that becomes obvious is the changes to the paragraph environment
18147 pull-down box [at the far-left end of the toolbar].
18148 Most of the paragraph environments you're used to seeing are missing.
18149 There are also five new ones.
18154 class itself only supports certain paragraph environments:
18157 \begin_layout Itemize
18163 \begin_layout Itemize
18169 \begin_layout Itemize
18175 \begin_layout Itemize
18181 \begin_layout Itemize
18187 \begin_layout Itemize
18193 \begin_layout Itemize
18199 \begin_layout Itemize
18205 \begin_layout Itemize
18211 \begin_layout Itemize
18218 \begin_layout Itemize
18220 \change_deleted -712698321 1501169265
18228 \begin_layout Standard
18229 All of the other standard environments, including the section-heading environmen
18230 ts, aren't used in the
18237 \begin_layout Standard
18238 On the other hand, you'll notice the following new environments:
18241 \begin_layout Itemize
18247 \begin_layout Itemize
18253 \begin_layout Itemize
18259 \begin_layout Itemize
18265 \begin_layout Itemize
18271 \begin_layout Standard
18272 These five are kind of quirky, due to a
18273 \begin_inset Quotes eld
18277 \begin_inset Quotes erd
18280 in \SpecialChar LyX
18282 You see, \SpecialChar LyX
18283 doesn't permit you to nest any other paragraph environment into
18284 an empty environment.
18285 Now, that's fine and dandy, but it means that you wouldn't be able to start
18286 a slide with anything except plain text.
18287 To deal with this, I've performed a little
18288 \begin_inset Quotes eld
18293 \begin_inset Quotes erd
18299 \begin_layout Subsubsection
18300 Quirks of the New Environments
18301 \begin_inset CommandInset label
18303 name "sec:slideQuirk"
18310 \begin_layout Standard
18311 All five of the new paragraph environments are somewhat quirky due to inherent
18312 limitiations in the current version of \SpecialChar LyX
18314 As I just mentioned, \SpecialChar LyX
18315 forbids environments that begin with another environment.
18316 To get around this, the
18320 environment isn't a paragraph environment as described in the
18328 \begin_layout Standard
18329 You should consider
18342 \begin_inset Quotes eld
18345 pseudo-environments.
18346 \begin_inset Quotes erd
18349 They look like a section heading or a
18350 \begin_inset Quotes eld
18358 \begin_inset Quotes erd
18361 but really begin a [and, if necessary, end the previous] paragraph environment.
18371 \begin_inset Quotes eld
18375 \begin_inset Quotes erd
18378 These two perform some action.
18381 \begin_layout Standard
18382 A common feature of all five environments,
18402 , is a rather long-ish label.
18403 The text following this label — ordinarily the contents of the paragraph
18404 environment — is utterly irrelevant for
18426 completely ignores it.
18427 In fact, you can leave these five environments completely empty.
18431 \begin_layout Standard
18436 to put any text after the rather long-ish label, you might want to.
18437 This could be a short description of the contents of the
18442 In that case, enter your descriptive comment and hit
18446 as you normally would.
18449 \begin_layout Standard
18450 If, on the other hand, you don't want to enter any descriptive text, you'll
18451 hit another \SpecialChar LyX
18454 , like nature, abhors a vacuum, and will not let you start a new paragraph
18455 environment until you put something in the old one.
18459 \begin_layout Itemize
18460 Start entering the text that will
18488 \begin_layout Itemize
18489 Now move to the beginning of that paragraph.
18493 \begin_layout Itemize
18502 \begin_layout Itemize
18503 Finally, change this new, empty paragraph to a
18527 \begin_layout Standard
18528 Some future version of \SpecialChar LyX
18529 will, hopefully, resolve this quirkiness\SpecialChar ldots
18533 \begin_layout Subsection
18534 Making a Presentation with
18547 \begin_layout Subsubsection
18555 \begin_layout Standard
18556 If you're expecting this section to teach you how to actually make a presentatio
18557 n, you'll be sorely disappointed.
18558 Naturally, I'll describe all of the ways the
18562 class can assist you in preparing the materials for a presentation.
18563 Filling in the contents, however, is up to you.
18568 the \SpecialChar LyX
18572 \begin_layout Standard
18577 environment [in the manner described in section
18578 \begin_inset space ~
18582 \begin_inset CommandInset ref
18584 reference "sec:slideQuirk"
18588 ] tells \SpecialChar LyX
18589 to begin a new slide [duh].
18590 The label for this environment/
18591 \begin_inset Quotes erd
18595 \begin_inset Quotes erd
18599 \begin_inset Quotes eld
18603 \begin_inset Quotes erd
18606 in cool blue, followed by the label,
18607 \begin_inset Quotes eld
18611 \begin_inset Quotes erd
18615 Any text or paragraph environments that follow this one go on the new slide.
18619 \begin_layout Standard
18620 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
18622 (this can be specified in the
18627 In fact, you'll want to, once you finish entering the contents of one slide.
18628 If you've entered more text than can physically fit on a slide, the extra
18629 overflows onto a new slide.
18630 I don't recommend doing this, however, since the overflow slide won't have
18631 any page number on it.
18632 Furthermore, it may interfere with any
18636 you've made to accompany the oversized
18643 \begin_layout Standard
18652 environments work the same way as the
18657 They both create an
18658 \begin_inset Quotes eld
18662 \begin_inset Quotes erd
18665 followed by a label [
18666 \begin_inset Quotes eld
18670 \begin_inset Quotes erd
18674 \begin_inset Quotes eld
18678 \begin_inset Quotes erd
18682 The color is a stunning magenta instead of blue, and the
18683 \begin_inset Quotes eld
18687 \begin_inset Quotes erd
18690 will look different, in style and in length.
18691 The label fonts of all three also differ from one another.
18694 \begin_layout Standard
18699 , if the contents of a
18707 exceed the physical size of a slide or sheet of paper, the extra will overflow
18709 Again, you should avoid this.
18710 It defeats the whole purpose of
18721 \begin_layout Subsubsection
18731 \begin_layout Standard
18736 is a slide that sits atop another slide.
18737 Perhaps you wish to discuss a figure on the main
18741 before displaying the text associated with it.
18742 One way to accomplish this is tape a flap of dark paper over the part of
18747 you want to display later.
18748 This method fails, however, if you wish to overlap one graph with another,
18750 You would then have to fumble while speaking to align the two separate,
18755 s to align the two graphs.
18760 environment in both cases makes life much easier.
18763 \begin_layout Standard
18768 receives the page number of its
18769 \begin_inset Quotes eld
18773 \begin_inset Quotes erd
18781 \begin_inset Quotes eld
18789 \begin_inset Quotes erd
18796 \begin_layout Plain Layout
18797 Presumably, mutliple
18802 \begin_inset Quotes eld
18810 \begin_inset Quotes erd
18814 \begin_inset Quotes eld
18822 \begin_inset Quotes erd
18826 \begin_inset Quotes eld
18834 \begin_inset Quotes erd
18838 \begin_inset space ~
18841 appended to the page number of the parent
18851 Clearly, you want the contents of both the
18859 to each fit on a single physical slide! You should probably consider an
18865 \begin_inset Quotes eld
18869 \begin_inset Quotes erd
18877 Indeed, the \SpecialChar LyX
18882 class provides a visual cue for this: the label at the start of an
18886 is shorter than that at the start of a
18891 Lastly, when you generate printable output, you'll find alignment markers
18892 in all four corners of both the
18896 page and its parent
18901 These will assist you in lining up the two physical slides.
18904 \begin_layout Standard
18905 The major problem in overlaying two slides is aligning the contents of the
18906 two transparencies.
18907 How much space should you leave for that graph on the second slide? Worse
18908 still, what if you want a graph and a sentence on second slide, but there
18909 is text on the main transparency that goes in between them? You could try
18910 and insert vertical space of the right size.
18911 The better way is to use
18922 \begin_layout Standard
18923 As their names imply,
18931 are two command-like paragraph environments that make all subsequent text
18932 invisible and visible, respectively.
18934 \begin_inset space ~
18938 \begin_inset CommandInset ref
18940 reference "sec:slideQuirk"
18944 that you don't place anything
18948 these two environments, however.
18953 , it inserts a centered, sky-blue label into the page reading
18954 \begin_inset Quotes eld
18957 <Invisible Text Follows>
18958 \begin_inset Quotes erd
18962 For paragraphs following this label, the parts of the
18970 ; it doesn't matter which] where they would be contain instead blank space.
18974 \begin_layout Standard
18979 , the corresponding centered label is
18980 \begin_inset Quotes eld
18983 <Visible Text Follows>
18984 \begin_inset Quotes erd
18988 Paragraphs following this label behave normally.
18989 Note that the beginning of a new
19001 automatically shuts off an
19006 It's therefore not necessary to use
19017 \begin_layout Standard
19018 By now, it should be obvious how to create overlay transparencies using
19019 the proper combination of
19038 \begin_layout Enumerate
19043 , including everything that will appear on it, whether on the main slide
19051 \begin_layout Enumerate
19052 Before each figure or paragraph that will appear only on the
19061 If necessary, insert a
19065 environment after the
19072 \begin_layout Enumerate
19077 immediately following the
19084 \begin_layout Enumerate
19085 Copy the contents of this
19096 \begin_layout Enumerate
19101 , change all of the
19112 \begin_layout Standard
19114 You've just made an
19121 \begin_layout Standard
19122 There's one problem with the way I've designed the \SpecialChar LyX
19127 class: you can't make text in the middle of a paragraph invisible, nor
19128 make text in the middle of an invisible paragraph visible again.
19129 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
19134 \begin_layout Plain Layout
19135 The commands of interest are:
19138 \begin_layout Itemize
19143 invisible \SpecialChar ldots
19147 \begin_layout Itemize
19152 visible \SpecialChar ldots
19156 \begin_layout Plain Layout
19158 and need to be marked as \SpecialChar TeX
19161 \begin_inset Quotes eld
19165 \begin_inset Quotes erd
19168 you wish to change goes in between the brackets [and after the
19181 If you don't know how to mark text as \SpecialChar TeX
19182 , see the appropriate section of
19195 \begin_layout Subsubsection
19205 \begin_inset CommandInset label
19207 name "sec:slideNote"
19214 \begin_layout Standard
19223 is associated with a
19224 \begin_inset Quotes eld
19228 \begin_inset Quotes erd
19236 Here, too, the \SpecialChar LyX
19241 class provides visual cues.
19246 is shorter than that of a
19250 [yet longer than that of an
19254 ] and, like the label of an
19258 is shockingly magenta.
19259 Additionally, the printed
19263 has the page number of its
19264 \begin_inset Quotes eld
19268 \begin_inset Quotes erd
19276 \begin_inset Quotes eld
19284 \begin_inset Quotes erd
19288 \begin_inset Quotes eld
19296 \begin_inset Quotes erd
19300 \begin_inset Quotes eld
19308 \begin_inset Quotes erd
19312 You can have multiple
19316 s associated with a single
19328 , you'll probably want to break up long
19332 s so that they fit on a single sheet of paper.
19335 \begin_layout Standard
19340 is obvious: it contains anything additional you might want to say about
19346 It could also be used as a sheet of reminders for a particular
19351 In the case of the latter, you might want to make use of time markers.
19352 Currently, the \SpecialChar LyX
19358 \begin_inset Quotes eld
19362 \begin_inset Quotes erd
19365 support for time markers, a
19367 Sli\SpecialChar TeX
19371 So, you'll have to resort to using the \SpecialChar LaTeX
19375 \begin_layout Standard
19376 To use time markers, you'll need to specify the extra class option
19377 \begin_inset Quotes eld
19385 \begin_inset Quotes erd
19389 \begin_inset space ~
19393 \begin_inset CommandInset ref
19395 reference "sec:slidesetup"
19400 This option turns on timing marks, which will appear in the lower-left-hand
19406 To set what appears in the time marker, you use the \SpecialChar LaTeX
19408 \begin_inset Quotes eld
19418 \begin_inset Quotes erd
19422 \begin_inset Quotes eld
19432 \begin_inset Quotes erd
19436 The arguments of both commands are time measured in seconds.
19438 \begin_inset Quotes eld
19448 \begin_inset Quotes erd
19451 sets the time marker to a given time.
19453 \begin_inset Quotes eld
19463 \begin_inset Quotes erd
19466 increments the time marker by the specified amount.
19467 Using time markers and
19471 s in this fashion, you can remind yourself how much time to spend on a particula
19479 \begin_layout Standard
19480 There's one last feature to describe.
19481 Clearly, you'd like to print out all of your
19489 s on transparencies while printing all of your
19506 with which it is associated.
19507 What's a person to do?
19510 \begin_layout Standard
19511 Luckily, there are two \SpecialChar LaTeX
19512 commands that allow you to select what to print
19514 Both must be placed into the preamble of your document.
19516 \begin_inset Quotes eld
19528 \begin_inset Quotes erd
19531 will cause the output to contain only the
19540 Correspondingly, the command
19541 \begin_inset Quotes eld
19553 \begin_inset Quotes erd
19556 prevents the output of anything but
19561 I'd advise placing both commands in the preamble and initially comment
19563 You can then preview your entire presentation as you write.
19564 When you're done writing, you can then uncomment one of the two to select
19565 what you want to print.
19566 I like to uncomment
19567 \begin_inset Quotes eld
19579 \begin_inset Quotes erd
19582 , print to a file with
19583 \begin_inset Quotes eld
19591 \begin_inset Quotes erd
19594 in its name, comment it back out, then uncomment
19595 \begin_inset Quotes eld
19607 \begin_inset Quotes erd
19611 \begin_inset Quotes eld
19619 \begin_inset Quotes erd
19623 I can then send either file to a printer, loading transparencies or plain
19624 paper as appropriate.
19627 \begin_layout Standard
19628 You can also provide other arguments to the
19629 \begin_inset Quotes eld
19639 \begin_inset Quotes erd
19643 \begin_inset Quotes eld
19653 \begin_inset Quotes erd
19657 See a good \SpecialChar LaTeX
19661 \begin_layout Subsection
19666 Class Template File
19669 \begin_layout Standard
19670 I have also provided a template file,
19671 \begin_inset Quotes eld
19679 \begin_inset Quotes erd
19687 To use it, begin your new presentation with
19689 File\SpecialChar menuseparator
19691 \begin_inset space ~
19695 \begin_inset space ~
19701 Your new \SpecialChar LyX
19702 presentation file will contain an example
19723 additionally contain an example of the use of
19732 Lastly, the preamble will contain:
19735 \begin_layout LyX-Code
19736 % Uncomment to print out only slides and overlays
19739 \begin_layout LyX-Code
19743 \begin_layout LyX-Code
19749 \begin_inset Newline newline
19755 \begin_layout LyX-Code
19756 % Uncomment to print out only notes
19759 \begin_layout LyX-Code
19763 \begin_layout LyX-Code
19771 \begin_layout Standard
19772 One final thing: I created this class to support the \SpecialChar LaTeX2e
19774 \begin_inset Quotes eld
19779 Sli\SpecialChar TeX
19783 \begin_inset Quotes erd
19786 class, one of the built-in \SpecialChar LaTeX2e
19788 Neither I nor the rest of the \SpecialChar LyX
19789 Team endorse or oppose the use of this built-in
19791 It's here if you want it or need it.
19792 There exist other \SpecialChar LaTeX2e
19793 classes for creating presentations, such as the
19798 \begin_inset space ~
19802 \begin_inset CommandInset ref
19804 reference "sec:foiltex"
19809 \begin_inset Quotes eld
19817 \begin_inset Quotes erd
19820 package [present on some \SpecialChar TeX
19822 The latter is not yet supported under \SpecialChar LyX
19827 \begin_layout Plain Layout
19828 Perhaps you can take on the task\SpecialChar ldots
19834 I know nothing about these other classes.
19835 Try them out to see what sort of alternative they provide.
19838 \begin_layout Chapter
19840 Features needing Extra Software
19843 \begin_layout Section
19844 Checking \SpecialChar TeX
19848 \begin_layout Standard
19854 \begin_layout Subsection
19858 \begin_layout Standard
19867 \begin_layout Plain Layout
19872 is not yet available when you are using the \SpecialChar LaTeX
19873 distribution MiK\SpecialChar TeX
19879 , you'll find in the
19886 \begin_inset space ~
19897 \begin_inset Newline newline
19901 \begin_inset CommandInset href
19903 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
19911 \begin_layout Standard
19914 Chk\SpecialChar TeX
19917 package is a program that was written by
19918 \begin_inset Flex Noun
19921 \begin_layout Plain Layout
19923 \begin_inset space ~
19931 in frustration because some constructs in \SpecialChar LaTeX
19932 are sometimes non-intuitive,
19933 and easy to forget.
19934 The program runs over your \SpecialChar LaTeX
19935 file, checks the integrity of the file, and
19936 flags some common errors.
19937 In other technical words, it is
19941 for \SpecialChar LaTeX
19945 \begin_layout Standard
19946 Well, what is a syntax checker doing in \SpecialChar LyX
19947 which is supposed to produce correct
19949 anyways? The answer is simple: Just as
19953 not only checks the
19957 of C programs, but also does
19961 checks for type-errors,
19963 Chk\SpecialChar TeX
19966 catches some common
19970 errors, in addition to the syntactical ones.
19973 Chk\SpecialChar TeX
19976 is capable of detecting several common errors, such as
19979 \begin_layout Itemize
19980 Ellipsis detection:
19981 \begin_inset Newline newline
19984 Use \SpecialChar ldots
19988 \begin_layout Itemize
19989 No space in front of/after parenthesis:
19990 \begin_inset Newline newline
19996 \begin_layout Itemize
19997 Enforcement of normal space after common abbreviations:
19998 \begin_inset Newline newline
20002 \begin_inset space \thinspace{}
20006 \begin_inset space \space{}
20009 is too wide spacing.
20012 \begin_layout Itemize
20013 Enforcement of end-of-sentence space when the last sentence ends with a
20015 \begin_inset Newline newline
20019 And this is wrong spacing.
20022 \begin_layout Itemize
20023 Space in front of labels and similar commands:
20024 \begin_inset Newline newline
20027 The label should stick right up to the text to avoid falling to a wrong
20030 \begin_inset CommandInset label
20040 \begin_layout Plain Layout
20041 This footnote is in danger of falling off to a wrong page
20046 The label is separated too much.
20049 \begin_layout Itemize
20050 Space in front of references, instead of hard spaces:
20051 \begin_inset Newline newline
20054 If you have bad luck, the text will break right between the referenced text
20055 and reference number, and that's a pity.
20057 \begin_inset CommandInset ref
20059 reference "sec:chktex"
20066 \begin_layout Itemize
20068 \begin_inset Quotes eld
20072 \begin_inset Quotes erd
20076 \begin_inset Formula $\times$
20080 \begin_inset Newline newline
20083 2x2 looks cheap compared to
20084 \begin_inset Formula $2\times2$
20090 \begin_layout Standard
20091 and more \SpecialChar ldots
20092 It is an invaluable tool when you are
20093 \begin_inset Quotes eld
20097 \begin_inset Quotes erd
20100 your document before printing, and you should run it right after the obligatory
20101 spelling check, and before you go fine tuning the typesetting.
20104 \begin_layout Subsection
20108 \begin_layout Standard
20109 If you have the program installed, usage is as simple as choosing
20111 Tools\SpecialChar menuseparator
20113 \begin_inset space ~
20119 This will make \SpecialChar LyX
20120 generate a \SpecialChar LaTeX
20121 file of your document, start
20123 Chk\SpecialChar TeX
20126 to check it, and then make \SpecialChar LyX
20128 \begin_inset Quotes eld
20132 \begin_inset Quotes erd
20135 with the warnings from
20137 Chk\SpecialChar TeX
20140 , if there were any.
20141 The warnings will be placed close to the point of the mistake, and you
20142 can quickly find them by using the
20144 Navigate\SpecialChar menuseparator
20147 menu item, or the shortcut key
20156 Open the error boxes by clicking on them with the mouse, or use the shortcut
20165 bindings, or the corresponding
20174 Read the warning and correct the mistake, if it is a mistake.
20175 If you have trouble understanding what the warning is about, you can safely
20177 Remember that there is a hidden layer between the document on screen and
20178 the technical details in invoking
20180 Chk\SpecialChar TeX
20183 , and this gap can make some warnings seem arcane or just plain silly.
20186 \begin_layout Standard
20187 This document is an excellent testing bed for the feature, and it should
20188 provide quite a few warnings for you to fiddle with.
20189 Since computers are only so smart, expect most of the warnings to be false
20193 \begin_layout Subsection
20194 How to fine tune it
20197 \begin_layout Standard
20198 Sometimes, you'll find that
20200 Chk\SpecialChar TeX
20203 makes more noise than suits your mood.
20204 Then you can choose not to use it, wait until your mood changes, or try
20207 Chk\SpecialChar TeX
20210 to get better along with you.
20213 \begin_layout Standard
20216 Chk\SpecialChar TeX
20223 very configurable and extensible, you should not expect to solve all problems
20226 Chk\SpecialChar TeX
20229 in \SpecialChar LyX
20231 Since \SpecialChar LyX
20232 has to generate a somewhat special \SpecialChar LaTeX
20233 file to be able to match the
20234 line numbers from the
20236 Chk\SpecialChar TeX
20243 \begin_layout Plain Layout
20244 You can inspect the specific output from
20250 Document\SpecialChar menuseparator
20253 \begin_inset space ~
20267 to the internal document structure, some of the warnings will not appear
20269 There are two things you can do about this:
20272 \begin_layout Itemize
20275 Chk\SpecialChar TeX
20278 invocation command line in
20279 \begin_inset Flex Noun
20282 \begin_layout Plain Layout
20283 Tools\SpecialChar menuseparator
20284 Preferences\SpecialChar menuseparator
20285 Output\SpecialChar menuseparator
20286 LaTeX\SpecialChar menuseparator
20294 Chk\SpecialChar TeX
20297 installation configuration file (usually with the file
20302 See below to learn what warnings can be enabled and disabled on the command
20306 \begin_layout Itemize
20307 Export your document as a raw \SpecialChar LaTeX
20310 File\SpecialChar menuseparator
20311 Export\SpecialChar menuseparator
20320 Invoked in this way, it can be a hassle to find the corresponding place
20321 in the document inside \SpecialChar LyX
20322 , but with a little patience, you should be able
20326 \begin_layout Standard
20327 Here follows the warning messages that can be enabled and disabled in
20336 to disable a warning, and
20340 to enable a warning.
20341 The emphasized entries are disabled by default, because the default is
20344 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
20349 \begin_layout Standard
20350 Notice that you should only use the options that enable and disable warnings,
20351 because \SpecialChar LyX
20352 relies on some of the other command line parameters to be set
20353 in a specific way to have a chance to communicate with
20360 \begin_layout Enumerate
20364 Command terminated with space.
20367 \begin_layout Enumerate
20370 Non-breaking space (
20371 \begin_inset Quotes eld
20379 \begin_inset Quotes erd
20382 ) should have been used.
20385 \begin_layout Enumerate
20389 You should enclose the previous parenthesis with
20390 \begin_inset Quotes eld
20398 \begin_inset Quotes erd
20404 \begin_layout Enumerate
20407 Italic correction (
20408 \begin_inset Quotes eld
20418 \begin_inset Quotes erd
20421 ) found in non-italic buffer.
20424 \begin_layout Enumerate
20427 Italic correction (
20428 \begin_inset Quotes eld
20438 \begin_inset Quotes erd
20441 ) found more than once.
20444 \begin_layout Enumerate
20448 No italic correction (
20449 \begin_inset Quotes eld
20459 \begin_inset Quotes erd
20465 \begin_layout Enumerate
20469 \begin_inset Quotes eld
20477 \begin_inset Quotes erd
20481 \begin_inset Quotes eld
20489 \begin_inset Quotes erd
20495 \begin_layout Enumerate
20498 Wrong length of dash may have been used.
20501 \begin_layout Enumerate
20505 \begin_inset Quotes eld
20513 \begin_inset Quotes erd
20517 \begin_inset Quotes eld
20525 \begin_inset Quotes erd
20531 \begin_layout Enumerate
20535 \begin_inset Quotes eld
20543 \begin_inset Quotes erd
20549 \begin_layout Enumerate
20553 \begin_inset Quotes eld
20561 \begin_inset Quotes erd
20564 to achieve an ellipsis.
20567 \begin_layout Enumerate
20570 Inter-word spacing (
20571 \begin_inset Quotes eld
20581 \begin_inset Quotes eld
20584 ) should perhaps be used.
20587 \begin_layout Enumerate
20590 Inter-sentence spacing (
20591 \begin_inset Quotes eld
20601 \begin_inset Quotes erd
20604 ) should perhaps be used.
20607 \begin_layout Enumerate
20610 Could not find argument for command.
20613 \begin_layout Enumerate
20617 \begin_inset Quotes eld
20625 \begin_inset Quotes erd
20631 \begin_layout Enumerate
20634 Math mode still on at end of \SpecialChar LaTeX
20638 \begin_layout Enumerate
20642 \begin_inset Quotes eld
20650 \begin_inset Quotes erd
20653 doesn't match the number of
20654 \begin_inset Quotes eld
20662 \begin_inset Quotes erd
20668 \begin_layout Enumerate
20671 You should use either
20674 \begin_inset Quotes eld
20682 \begin_inset Quotes erd
20687 as an alternative to
20688 \begin_inset Quotes eld
20696 \begin_inset Quotes erd
20702 \begin_layout Enumerate
20709 " (ASCII 39) instead of "
20716 \begin_layout Enumerate
20719 User-specified pattern found.
20722 \begin_layout Enumerate
20725 This command might not be intended.
20728 \begin_layout Enumerate
20735 \begin_layout Enumerate
20753 \begin_layout Enumerate
20756 Delete this space to maintain correct page references.
20759 \begin_layout Enumerate
20763 You might wish to put this between a pair of
20764 \begin_inset Quotes eld
20772 \begin_inset Quotes erd
20778 \begin_layout Enumerate
20781 You ought to remove spaces in front of punctuation.
20784 \begin_layout Enumerate
20787 Could not execute \SpecialChar LaTeX
20791 \begin_layout Enumerate
20800 in front of small punctuation.
20803 \begin_layout Enumerate
20811 may look prettier here.
20814 \begin_layout Enumerate
20818 Multiple spaces detected in output.
20821 \begin_layout Enumerate
20824 This text may be ignored.
20827 \begin_layout Enumerate
20833 \begin_inset Quotes eld
20838 to begin quotation, not
20845 \begin_layout Enumerate
20852 to end quotation, not
20855 \begin_inset Quotes eld
20863 \begin_layout Enumerate
20869 \begin_layout Enumerate
20872 You should perhaps use
20873 \begin_inset Quotes eld
20881 \begin_inset Quotes erd
20887 \begin_layout Enumerate
20890 You should put a space in front of/after parenthesis.
20893 \begin_layout Enumerate
20896 You should avoid spaces in front of/after parenthesis.
20899 \begin_layout Enumerate
20903 You should not use punctuation in front of/after quotes.
20906 \begin_layout Enumerate
20909 Double space found.
20912 \begin_layout Enumerate
20915 You should put punctuation outside inner/inside display math mode.
20918 \begin_layout Enumerate
20921 You ought to not use primitive \SpecialChar TeX
20922 in \SpecialChar LaTeX
20926 \begin_layout Enumerate
20929 You should remove spaces in front of
20930 \begin_inset Quotes eld
20938 \begin_inset Quotes erd
20944 \begin_layout Enumerate
20947 \begin_inset Quotes eld
20955 \begin_inset Quotes erd
20958 is normally not followed by
20959 \begin_inset Quotes eld
20967 \begin_inset Quotes erd
20973 \begin_layout Standard
20974 In later versions of \SpecialChar LyX
20975 , we hope to provide a more complete interface to this
20976 tool (and it's smaller cousin
20980 ) to exploit the full power of it.
20981 But it's not exactly useless as it is now: go try it on one of your existing
20982 documents of a certain length and be surprised.
20985 \begin_layout Section
20986 Version Control in \SpecialChar LyX
20990 \begin_layout Standard
20993 Lars Gullik Bjønnes
21000 \begin_layout Subsection
21004 \begin_layout Standard
21006 supports some of the most basic RCS/CVS/SVN/GIT commands.
21007 If you need something a bit more sophisticated you will have to do that
21008 manually in a terminal.
21011 \begin_layout Standard
21012 Also note that CVS support is not as good as subversion support so we advise
21014 A good place to start learning Subversion is SVN Book
21018 \begin_layout Plain Layout
21019 \begin_inset CommandInset href
21021 target "http://svnbook.red-bean.com/"
21032 In the case of RCS you should read
21033 \begin_inset Quotes eld
21037 \begin_inset Quotes erd
21040 (a man file, read it with
21045 This file describes all the basic features of RCS.
21046 You should especially notice the comment about a RCS directory, and the
21047 notion of a master RCS file (the file ending in
21054 \begin_layout Standard
21055 Before you begin to use the version control features in \SpecialChar LyX
21057 familiar with RCS/CVS/SVN/GIT usage.
21058 The implementation in \SpecialChar LyX
21059 assumes a recent version of the GNU RCS or CVS/SVN
21060 package — no guarantees are made for older versions.
21061 Most of the log messages are not currently displayed after operations —
21062 you can check them in the Messages pane if unsure.
21063 Regular users of version control will appreciate VC toolbar, which can
21066 View\SpecialChar menuseparator
21067 Toolbars\SpecialChar menuseparator
21069 \begin_inset space ~
21077 \begin_layout Standard
21078 For introducing your own external commands consult vc-command in the manual
21079 of \SpecialChar LyX
21083 \begin_layout Standard
21084 It is strongly recommended to store documents in uncompressed format if
21085 using version control (uncheck
21087 Document\SpecialChar menuseparator
21090 if it is checked): Uncompressed LyX documents are text files and therefore
21091 for merging two different versions by version control systems.
21092 Compressed LyX documents are binary files, which cannot be merged by version
21096 \begin_layout Subsection
21097 RCS commands in \SpecialChar LyX
21101 \begin_layout Standard
21102 The following sections describe the RCS commands supported by \SpecialChar LyX
21104 You can find them in the
21106 File\SpecialChar menuseparator
21108 \begin_inset space ~
21115 was tested against RCS 5.7/5.8.
21118 \begin_layout Subsubsection
21124 \begin_layout Standard
21125 If your document is not under revision control, this is the only item shown
21127 And if it is under revision control, the
21131 item is not visible.
21135 \begin_layout Standard
21136 This command registers your document with RCS (unless you are under the
21137 directory managed by CVS)\SpecialChar endofsentence
21138 You are asked interactively to supply an initial
21139 description of the document.
21140 The document is now set in Read-Only mode and you have to
21143 \begin_inset space ~
21147 \begin_inset space ~
21151 \begin_inset space ~
21156 , before making any changes to it.
21157 A document under revision control has a
21158 \begin_inset Quotes eld
21161 [RCS:<version> <locker>]
21162 \begin_inset Quotes erd
21165 item tagged to the filename in the minibuffer.
21168 \begin_layout Standard
21169 RCS command that is run:
21171 ci -q -u -i -t-"<initial description>" <file-name>
21174 \begin_layout Standard
21179 to understand the switches.
21183 \begin_layout Subsubsection
21189 \begin_layout Standard
21190 When you are finished editing a file, you check in your changes.
21191 When you do this, you are asked for a description of the changes.
21192 This is stored in the history log.
21193 The version number is bumped, your changes are applied to the master RCS
21194 file, the document is unlocked and set to Read-Only mode.
21197 \begin_layout Standard
21200 ci -q -u -m"<description>" <file-name>
21203 \begin_layout Subsubsection
21209 \begin_layout Standard
21210 By doing this you lock the document so that only you can edit it.
21211 This will also make the document Read-Write only for you.
21212 You will usually continue editing for a while and when you are finished
21213 you check in your changes.
21214 The status line is changed to reflect that you have locked the file.
21217 \begin_layout Standard
21220 co -q -l <file-name>
21223 \begin_layout Subsubsection
21226 Revert To Repository Version
21229 \begin_layout Standard
21230 This will discard all changes made to the document since the last check
21232 You get a warning before changes are discarded.
21235 \begin_layout Standard
21238 co -f -u<version> <file-name>
21241 \begin_layout Subsubsection
21247 \begin_layout Standard
21248 This will create a copy of the current document.
21249 Since RCS does not support copy operations natively, the version history
21250 is not preserved, and the copy is added as a new file.
21251 It requires a clean document without any changes since the last checkin.
21252 You are asked for a file name and a description of the copy operation.
21253 After that the copy is created, both locally and in the repository.
21254 If the parent directories of the copied and original document differ, all
21255 relative paths of included files of the copy are adjusted (like in
21257 File\SpecialChar menuseparator
21262 Finally, the copy is loaded instead of the original document.
21265 \begin_layout Labeling
21266 \labelwidthstring 00.00.0000
21268 \begin_inset space ~
21272 \begin_inset space ~
21276 \begin_inset Newline newline
21280 \begin_inset Flex Code
21283 \begin_layout Plain Layout
21286 \begin_inset Quotes eld
21290 \begin_inset Quotes erd
21299 \begin_inset Flex Code
21302 \begin_layout Plain Layout
21305 \begin_inset Quotes eld
21309 \begin_inset Quotes erd
21318 \begin_inset Newline newline
21322 \begin_inset Flex Code
21325 \begin_layout Plain Layout
21329 \begin_inset Quotes eld
21333 \begin_inset Quotes erd
21344 \begin_layout Subsubsection
21350 \begin_layout Standard
21351 This makes as if the last check in never happened.
21352 No changes are made to the document loaded into \SpecialChar LyX
21353 , but the last version
21354 is removed from the master RCS file.
21357 \begin_layout Standard
21360 rcs -o<version> <file-name>
21363 \begin_layout Subsubsection
21369 \begin_layout Standard
21370 This shows the complete history of the RCS document.
21375 is shown in a browser.
21383 \begin_layout Subsubsection
21387 \begin_layout Standard
21389 supports RCS version number, author name, date and time of last commit.
21390 All those are extracted from
21392 rlog -r <file-name>
21396 \begin_inset CommandInset ref
21398 reference "subsec:VCS-Revision-Information"
21405 \begin_layout Subsection
21406 CVS commands in \SpecialChar LyX
21410 \begin_layout Standard
21411 A subset of CVS operations is supported by \SpecialChar LyX
21413 You can find the commands in the
21415 File\SpecialChar menuseparator
21417 \begin_inset space ~
21423 The version control system SVN is more powerful, so please use it instead
21424 of CVS if possible.
21427 \begin_layout Subsubsection
21433 \begin_layout Standard
21434 If you start from scratch with CVS you have to create your repository and
21435 checkout the working copy with external tools.
21436 If you're using a client-server setup you may need to login before doing
21437 the first repository checkout.
21440 \begin_layout Standard
21441 If your documents are under revision control and others are using the same
21442 repository problems arise when different changes to the same document at
21443 the same location happen.
21444 Standard CVS repositories don't operate with a file locking mechanism.
21445 This may be surprising, but conflicts only occur if people disagree on
21446 the proper content of the same part of a document.
21447 So, if co-workers are used to communicate regularly, these conflicts occur
21449 If they don't communicate they have a fundamental problem anyway.
21450 Nevertheless some people like to work with so called
21451 \begin_inset Quotes eld
21455 \begin_inset Quotes erd
21459 If they do so the working copy of all files is readonly when checked out
21460 first and the user starts editing after using a special command to make
21461 the working copy writable.
21462 When the changes are checked in the working copy returns to readonly state.
21463 With \SpecialChar LyX
21464 one has to edit the
21465 \begin_inset Flex Code
21468 \begin_layout Plain Layout
21474 file and add the line
21475 \begin_inset Flex Code
21478 \begin_layout Plain Layout
21484 to work with reserved checkouts.
21485 The benefit is the possibility to see who is using a writable copy of some
21487 It's not guaranteed only one user makes a copy writable.
21490 \begin_layout Standard
21492 tries to guess if you're using reserved or non-reserved checkouts.
21493 If your working copy is readonly or it is writable and an additional copy
21494 of your document exists in the CVS/Base sub-directory a reserved otherwise
21495 a non-reserved checkout is assumed.
21496 When a reserved checkout is detected you have to use
21497 \begin_inset Flex Noun
21500 \begin_layout Plain Layout
21506 to make your working copy writable if it's readonly.
21508 \begin_inset Flex Noun
21511 \begin_layout Plain Layout
21517 operation is possible and that makes your working copy readonly again after
21518 transferring your changes to the repository.
21521 \begin_layout Standard
21522 More information about CVS can be found here
21523 \begin_inset Flex URL
21526 \begin_layout Plain Layout
21528 http://www.nongnu.org/cvs
21534 \begin_inset Flex URL
21537 \begin_layout Plain Layout
21539 http://ximbiot.com/cvs
21547 \begin_layout Standard
21552 to understand the sub-commands and the switches mentioned below.
21555 \begin_layout Subsubsection
21561 \begin_layout Standard
21562 If your document is not under revision control, this is the only item shown
21564 And if it is under revision control, the
21568 item is not visible.
21572 \begin_layout Standard
21573 This command registers in CVS your document
21574 \begin_inset Flex Strong
21577 \begin_layout Plain Layout
21585 in the case you have already the documents directory under CVS control
21591 This means you have to create or checkout the archive by yourself using
21593 (In case you forget that step \SpecialChar LyX
21594 registers the document with RCS.)
21597 \begin_layout Standard
21598 Then you are asked interactively to supply an initial description of the
21600 Don't forget that registered file is not yet checked in.
21603 \begin_layout Standard
21604 CVS command that is run:
21606 cvs -q add -m"<entered message>" "<file-name>"
21609 \begin_layout Standard
21614 above and for all other CVS commands is an abbreviation for
21615 \begin_inset Quotes eld
21618 change the current working directory to file location and use the file name
21619 without path component as argument
21620 \begin_inset Quotes erd
21626 \begin_layout Subsubsection
21632 \begin_layout Standard
21633 When you are finished editing a file, you commit your changes.
21634 When you do this and you had changed the document, you are asked for a
21635 description of the changes.
21636 After that changes are written to the repository.
21637 In case you didn't change the document and a reserved checkout is detected
21638 the reservation made on
21639 \begin_inset Flex Noun
21642 \begin_layout Plain Layout
21651 \begin_layout Labeling
21652 \labelwidthstring 00.00.0000
21654 \begin_inset space ~
21658 \begin_inset space ~
21662 \begin_inset Newline newline
21666 \begin_inset Flex Code
21669 \begin_layout Plain Layout
21672 -q commit -m"<description>" "<file-name>"
21678 \begin_inset Newline newline
21682 \begin_inset Flex Code
21685 \begin_layout Plain Layout
21696 \begin_layout Subsubsection
21702 \begin_layout Standard
21703 When you are sharing a repository with others, you may have to incorporate
21704 their changes into your working copy.
21707 \begin_layout Standard
21710 cvs -q update "<file-name>"
21713 \begin_layout Standard
21714 If a readonly checkout is detected the working copy is made writable and
21718 \begin_layout Standard
21721 cvs -q edit "<file-name>"
21724 \begin_layout Subsubsection
21727 Revert To Repository Version
21730 \begin_layout Standard
21731 This will discard all changes made to the document since the last check
21733 You get a warning before changes are discarded.
21734 Firstly the file is deleted, secondly CVS update command is run.
21737 \begin_layout Standard
21740 cvs -q update "<file-name>"
21743 \begin_layout Standard
21744 If a reserved checkout is detected and the working copy has no changes only
21745 the reservation is undone.
21748 \begin_layout Standard
21751 cvs -q unedit "<file-name>"
21754 \begin_layout Subsubsection
21760 \begin_layout Standard
21761 This will create a copy of the current document.
21762 Since CVS does not support copy operations natively, the version history
21763 is not preserved, and the copy is added as a new file.
21764 It requires a clean document without any changes since the last checkin.
21765 You are asked for a file name and a description of the copy operation.
21766 After that the copy is created, both locally and in the repository.
21767 If the parent directories of the copied and original document differ, all
21768 relative paths of included files of the copy are adjusted (like in
21770 File\SpecialChar menuseparator
21775 Finally, the copy is loaded instead of the original document.
21778 \begin_layout Labeling
21779 \labelwidthstring 00.00.0000
21781 \begin_inset space ~
21785 \begin_inset space ~
21789 \begin_inset Newline newline
21793 \begin_inset Flex Code
21796 \begin_layout Plain Layout
21799 \begin_inset Quotes eld
21803 \begin_inset Quotes erd
21812 \begin_inset Flex Code
21815 \begin_layout Plain Layout
21818 \begin_inset Quotes eld
21822 \begin_inset Quotes erd
21831 \begin_inset Newline newline
21835 \begin_inset Flex Code
21838 \begin_layout Plain Layout
21842 \begin_inset Quotes eld
21846 \begin_inset Quotes erd
21857 \begin_layout Subsubsection
21863 \begin_layout Standard
21864 This will rename the current document.
21865 Since CVS does not support rename operations natively, the version history
21866 is not preserved, the renamed document is added as a new file, and the
21867 original document is deleted.
21868 It requires a clean document without any changes since the last checkin.
21869 You are asked for a file name and a description of the rename operation.
21870 After that the document is renamed, both locally and in the repository.
21871 If the parent directories of the new and old file names differ, all relative
21872 paths of included files are adjusted (like in
21874 File\SpecialChar menuseparator
21879 Finally, the document is reloaded using the new name.
21882 \begin_layout Labeling
21883 \labelwidthstring 00.00.0000
21885 \begin_inset space ~
21889 \begin_inset space ~
21893 \begin_inset Newline newline
21897 \begin_inset Flex Code
21900 \begin_layout Plain Layout
21903 \begin_inset Quotes eld
21907 \begin_inset Quotes erd
21916 \begin_inset Flex Code
21919 \begin_layout Plain Layout
21922 \begin_inset Quotes eld
21926 \begin_inset Quotes erd
21935 \begin_inset Newline newline
21939 \begin_inset Flex Code
21942 \begin_layout Plain Layout
21946 \begin_inset Quotes eld
21950 \begin_inset Quotes erd
21959 \begin_inset Newline newline
21963 \begin_inset Flex Code
21966 \begin_layout Plain Layout
21970 \begin_inset Quotes eld
21974 \begin_inset Quotes erd
21985 \begin_layout Subsubsection
21986 Update of the local directory checkout from repository
21989 \begin_layout Standard
21990 Once your documents gets more complex, containing sub-documents and pictures,
21992 \begin_inset Flex Code
21995 \begin_layout Plain Layout
22001 files and so on using version control becomes more complicated.
22003 supports updating the whole tree in which resides the document.
22004 This become especially useful once you cooperate with people which neither
22005 have detailed knowledge about CVS usage nor they have ambition to commit
22006 additional material to the repository.
22007 You have to organize the files structure so that all external files are
22008 in the same directory or subdirectories of the document.
22009 It's good practice anyway to store multipart documents in an extra directory.
22012 \begin_layout Standard
22014 \begin_inset Flex Code
22017 \begin_layout Plain Layout
22018 Update local directory from repository
22023 command updates the whole directory.
22024 If local changes are detected user is warned before update starts.
22025 In case of merge conflicts both versions of the conflicting document parts
22026 are placed in the final document.
22027 You have to review and correct the result of the merge.
22028 You'll find the conflicts enclosed in pairs of
22029 \begin_inset Flex Code
22032 \begin_layout Plain Layout
22039 \begin_inset Flex Code
22042 \begin_layout Plain Layout
22049 \begin_inset Flex Code
22052 \begin_layout Plain Layout
22059 The first part is your version as before the update operation with the
22060 document name prepended.
22061 The second one is the repository version with the version number after
22063 \begin_inset Flex Code
22066 \begin_layout Plain Layout
22075 \begin_layout Labeling
22076 \labelwidthstring 00.00.0000
22078 \begin_inset space ~
22082 \begin_inset space ~
22086 \begin_inset Newline newline
22090 \begin_inset Flex Code
22093 \begin_layout Plain Layout
22101 (Ask if changes are detected.)
22102 \begin_inset Newline newline
22106 \begin_inset Flex Code
22109 \begin_layout Plain Layout
22110 cd $path; cvs -q update
22120 \begin_layout Standard
22122 \begin_inset Flex Code
22125 \begin_layout Plain Layout
22131 stands for the path to the document.
22134 \begin_layout Subsubsection
22140 \begin_layout Standard
22141 This shows the complete history of the CVS document.
22144 cvs log "<file-name>"
22146 is shown in a browser.
22149 \begin_layout Subsubsection
22153 \begin_layout Standard
22155 supports CVS version number, author name, date and time of last commit.
22156 All those are extracted from
22158 cvs log -r <file-name>
22162 \begin_inset CommandInset ref
22164 reference "subsec:VCS-Revision-Information"
22171 \begin_layout Subsection
22172 SVN commands in \SpecialChar LyX
22176 \begin_layout Standard
22177 SVN is now partially supported by \SpecialChar LyX
22179 You can find the commands in the
22181 File\SpecialChar menuseparator
22183 \begin_inset space ~
22189 Please note that if you use password protected access to repository via
22190 ssh, you will be asked in terminal window.
22192 was tested against SVN 1.5, 1.6, 1.7 and 1.8
22196 \begin_layout Plain Layout
22197 Most of the commands will work with 1.4 too, see
22198 \begin_inset CommandInset ref
22200 reference "subsec:SVN-Repo-Update"
22205 There seems to be currently unresolved permissions problem under SVN 1.8
22206 with reverting changes when file is locked.
22214 \begin_layout Subsubsection
22220 \begin_layout Standard
22221 If your document is not under revision control, this is the only item shown
22223 And if it is under revision control, the
22227 item is not visible.
22230 \begin_layout Standard
22231 This command registers in SVN your document ONLY in case you have already
22232 the documents directory under SVN control (in particular
22237 This means you have to checkout the archive by yourself.
22240 \begin_layout Standard
22241 Then you are asked interactively to supply an initial description of the
22243 Don't forget that registered file is not yet commited.
22246 \begin_layout Standard
22247 SVN command that is run:
22250 \begin_inset Quotes eld
22254 \begin_inset Quotes erd
22260 \begin_layout Standard
22265 to understand the switches.
22268 \begin_layout Subsubsection
22274 \begin_layout Standard
22275 When you are finished editing a file, you commit your changes.
22276 When you do this, you are asked for a description of the changes.
22277 After that changes are commited.
22280 \begin_layout Standard
22285 \begin_layout Plain Layout
22286 In case locking is not enabled.
22288 \begin_inset CommandInset ref
22290 reference "subsec:SVN-File-Locking"
22301 svn commit -q -m"<description>" <file-name>
22304 \begin_layout Subsubsection
22310 \begin_layout Standard
22311 Updates the changes of this file from the repository.
22312 Be sure you understand SVN merging and conflicts resolving before using
22313 this function, because all conflicts has to be resolved manually by you!
22316 \begin_layout Standard
22321 \begin_layout Plain Layout
22329 svn update --non-interactive
22330 \begin_inset Quotes eld
22334 \begin_inset Quotes erd
22340 \begin_layout Subsubsection
22343 Revert To Repository Version
22346 \begin_layout Standard
22347 This will discard all changes made to the document since the last check
22349 You get a warning before changes are discarded.
22352 \begin_layout Standard
22356 \begin_inset Quotes eld
22360 \begin_inset Quotes erd
22366 \begin_layout Subsubsection
22372 \begin_layout Standard
22373 This will create a copy of the current document including the version history.
22374 It requires a clean document without any changes since the last checkin.
22375 You are asked for a file name and a description of the copy operation.
22376 After that the copy is created, both locally and in the repository.
22377 If the parent directories of the copied and original document differ, all
22378 relative paths of included files of the copy are adjusted (like in
22380 File\SpecialChar menuseparator
22385 Finally, the copy is loaded instead of the original document.
22388 \begin_layout Labeling
22389 \labelwidthstring 00.00.0000
22391 \begin_inset space ~
22395 \begin_inset space ~
22399 \begin_inset Newline newline
22403 \begin_inset Flex Code
22406 \begin_layout Plain Layout
22410 \begin_inset Quotes eld
22414 \begin_inset Quotes erd
22418 \begin_inset Quotes eld
22422 \begin_inset Quotes erd
22431 \begin_inset Newline newline
22435 \begin_inset Flex Code
22438 \begin_layout Plain Layout
22447 \begin_layout Subsubsection
22453 \begin_layout Standard
22454 This will rename the current document including the version history.
22455 It requires a clean document without any changes since the last checkin.
22456 You are asked for a file name and a description of the rename operation.
22457 After that the document is renamed, both locally and in the repository.
22458 If the parent directories of the new and old file names differ, all relative
22459 paths of included files are adjusted (like in
22461 File\SpecialChar menuseparator
22466 Finally, the document is reloaded using the new name.
22469 \begin_layout Labeling
22470 \labelwidthstring 00.00.0000
22472 \begin_inset space ~
22476 \begin_inset space ~
22480 \begin_inset Newline newline
22484 \begin_inset Flex Code
22487 \begin_layout Plain Layout
22491 \begin_inset Quotes eld
22495 \begin_inset Quotes erd
22499 \begin_inset Quotes eld
22503 \begin_inset Quotes erd
22512 \begin_inset Newline newline
22516 \begin_inset Flex Code
22519 \begin_layout Plain Layout
22528 \begin_layout Subsubsection
22529 \begin_inset CommandInset label
22531 name "subsec:SVN-Repo-Update"
22535 Update of the local directory checkout from repository
22539 \begin_layout Plain Layout
22540 Note that this command will work only with subversion
22541 \begin_inset Formula $\geqq1.5$
22552 \begin_layout Standard
22553 All the commands above have one shortcomming - they deal with the current
22555 Once your document contains pictures, includes external
22556 \begin_inset Flex Code
22559 \begin_layout Plain Layout
22565 files and so on administration becomes more complicated.
22567 now supports updating the whole tree in which resides the document
22571 \begin_layout Plain Layout
22572 One need to organize the files structure so that all external files are
22573 in the same directory or subdirectories of the document.
22580 This become especially useful once you cooperate with people which neither
22581 know about subversion management nor they have ambition to commit additional
22582 material to the repository.
22586 \begin_layout Standard
22587 \begin_inset Flex Code
22590 \begin_layout Plain Layout
22591 Update local directory from repository
22596 command updates the whole directory and in case of merge conflicts local
22597 version of the files are left, so no unintended data loss occurs.
22598 If local changes are detected user is warned before update starts.
22601 \begin_layout Labeling
22602 \labelwidthstring 00.00.0000
22604 \begin_inset space ~
22608 \begin_inset space ~
22612 \begin_inset Newline newline
22616 \begin_inset Flex Code
22619 \begin_layout Plain Layout
22625 (Ask if changes are detected.)
22626 \begin_inset Newline newline
22630 \begin_inset Flex Code
22633 \begin_layout Plain Layout
22634 svn update –accept mine-full $path
22642 \begin_layout Standard
22644 \begin_inset Flex Code
22647 \begin_layout Plain Layout
22653 stands for the path to the document.
22656 \begin_layout Subsubsection
22662 \begin_layout Standard
22663 This shows the complete history of the SVN document.
22667 \begin_inset Quotes eld
22671 \begin_inset Quotes erd
22676 is shown in a browser.
22679 \begin_layout Subsubsection
22681 \begin_inset CommandInset label
22683 name "subsec:SVN-File-Locking"
22690 \begin_layout Standard
22691 The file exchange through various revision control systems brings the problem
22692 of merge conflicts in case two different users try to edit the same (parts
22694 When such a conflict happens it needs manual resolving and one reasonable
22695 alternative is to provide some kind of locking mechanism, which guarantees
22696 that only one user is allowed to edit file at the given time.
22699 \begin_layout Standard
22700 SVN has two such mechanisms to provide mutual exclusivity for file access
22701 - locks and automatic setting of write permissions (see sec.
22703 \begin_inset CommandInset ref
22705 reference "subsec:Automatical-Locking-Property"
22710 \begin_inset Flex Code
22713 \begin_layout Plain Layout
22723 \begin_layout Plain Layout
22724 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
22730 If this property is detected for a given document \SpecialChar LyX
22731 starts to use SVN locks
22732 for document editing automatically and the whole check-in/out mechanism
22733 switches to the same regimen as for RCS.
22734 This in particular means there are two different modes of file use in \SpecialChar LyX
22738 \begin_layout Itemize
22740 The loaded file is in the read-only mode.
22741 For editing on needs to check-out.
22746 consists of updating from the repository and gaining write lock.
22747 If the lock is not possible to obtain, we remain in unlocked state.
22750 \begin_layout Itemize
22752 The loaded file is in the 'normal' edit mode.
22753 No other user is allowed to edit the file.
22758 consists of commiting changes and releasing write-lock.
22759 If no changes have been made to the document, no commit will be produced
22763 \begin_layout Plain Layout
22764 Don't be puzzled by the fact that you will be asked for commit message anyway.
22769 and only the write-lock will be released.
22772 \begin_layout Standard
22776 \begin_layout Labeling
22777 \labelwidthstring 00.00.0000
22780 svn commit -q -m"<description>" "<file-name>"
22781 \begin_inset Newline newline
22784 svn unlock "<file-name>"
22787 \begin_layout Labeling
22788 \labelwidthstring 00.00.0000
22791 svn update "<file-name>"
22792 \begin_inset Newline newline
22795 svn lock "<file-name>"
22798 \begin_layout Subsubsection
22801 \begin_inset CommandInset label
22803 name "subsec:Automatical-Locking-Property"
22809 Automatic Locking Property
22812 \begin_layout Standard
22813 The above mentioned automatic setting of write permissions of the .lyx file
22816 File\SpecialChar menuseparator
22818 \begin_inset space ~
22821 Control\SpecialChar menuseparator
22822 Toggle locking property
22825 This command is active only when the file is not locked on the svn server
22827 you need to check-out before proceeding).
22830 \begin_layout Labeling
22831 \labelwidthstring 00.00.0000
22833 \begin_inset space ~
22839 \begin_layout Labeling
22840 \labelwidthstring 00.00.0000
22843 svn propset svn:needs-lock ON "<file-name>"
22846 \begin_layout Labeling
22847 \labelwidthstring 00.00.0000
22850 svn propdel svn:needs-lock "<file-name>"
22853 \begin_layout Subsubsection
22854 \begin_inset CommandInset label
22856 name "subsec:VCS-Revision-Information"
22860 Revision Information in Documents
22863 \begin_layout Standard
22864 There are more possibilities how to activate revision information in our
22868 \begin_layout Itemize
22874 \begin_layout Itemize
22875 tree revision information (
22876 \begin_inset Flex Code
22879 \begin_layout Plain Layout
22886 The result is the output of the
22887 \begin_inset Flex Code
22890 \begin_layout Plain Layout
22896 command, the following table gives you an idea, how to read the results.
22899 \begin_layout Standard
22901 \begin_inset Tabular
22902 <lyxtabular version="3" rows="6" columns="2">
22903 <features tabularvalignment="middle">
22904 <column alignment="center" valignment="top">
22905 <column alignment="center" valignment="top">
22907 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
22910 \begin_layout Plain Layout
22916 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
22919 \begin_layout Plain Layout
22927 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22930 \begin_layout Plain Layout
22936 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22939 \begin_layout Plain Layout
22940 mixed revision working copy
22947 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22950 \begin_layout Plain Layout
22956 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22959 \begin_layout Plain Layout
22960 modified working copy
22967 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22970 \begin_layout Plain Layout
22976 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22979 \begin_layout Plain Layout
22980 switched working copy
22987 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22990 \begin_layout Plain Layout
22996 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22999 \begin_layout Plain Layout
23000 partial working copy, from a sparse checkout
23007 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
23010 \begin_layout Plain Layout
23016 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
23019 \begin_layout Plain Layout
23020 mixed revision, modified, switched working copy
23033 \begin_layout Itemize
23034 file revision information.
23035 The result comes from parsing the output of
23036 \begin_inset Flex Code
23039 \begin_layout Plain Layout
23041 \begin_inset space ~
23045 \begin_inset space ~
23049 \begin_inset space ~
23058 Supported flags are:
23062 \begin_layout Itemize
23063 version number of the last commit (
23064 \begin_inset Flex Code
23067 \begin_layout Plain Layout
23076 \begin_layout Itemize
23077 author of the last commit (
23078 \begin_inset Flex Code
23081 \begin_layout Plain Layout
23090 \begin_layout Itemize
23091 date of the last commit (
23092 \begin_inset Flex Code
23095 \begin_layout Plain Layout
23104 \begin_layout Itemize
23105 time of the last commit (
23106 \begin_inset Flex Code
23109 \begin_layout Plain Layout
23119 \begin_layout Standard
23120 You can obtain this info via InsetInfo (e.g.
23122 \begin_inset Flex Code
23125 \begin_layout Plain Layout
23126 info-insert buffer vcs-date
23132 The information will be available only when you have the file stored under
23133 svn managment (i.e.
23135 \begin_inset Flex Code
23138 \begin_layout Plain Layout
23144 directory is available with your document).
23148 \begin_layout Itemize
23149 Another—a hacking one—possibility is to use svn keywords
23153 \begin_layout Plain Layout
23154 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
23160 In short – you set file keywords property (e.g.
23163 svn propset svn:keywords 'Rev' file.lyx
23165 ) and then paste keyword \SpecialChar TeX
23170 \begin_layout Plain Layout
23171 This is an easy way how to ensure that \SpecialChar LyX
23172 won't break the line in the middle
23178 tag in your document (e.g.
23183 \begin_layout Plain Layout
23191 This way svn client will automatically substitute revision number (e.g.
23196 \begin_layout Plain Layout
23203 ) after each update and commit.
23204 There are more problems with this approach.
23205 Firstly, the '$' character is used in \SpecialChar TeX
23206 world for math equations, so any
23207 occurence of math formula
23208 \begin_inset Formula $Rev$
23212 \begin_inset Formula $Rev:59$
23215 in your \SpecialChar LyX
23217 Similarly for other keywords like Id, Date, Author, etc.
23218 Secondly svn output is dependent on your locales, so its very easy that
23219 svn would produce some problematic strings once Date is used.
23220 Thirdly you get the whole 'Rev: 59' string in your document instead of
23222 Until subversion implements user's custom keywords it will be hard to use
23223 this approach reliably or let \SpecialChar LyX
23224 to support it directly.
23227 \begin_layout Subsection
23228 SVN and Windows Environment
23231 \begin_layout Quote
23232 My inclination is to say that if the user cannot figure out the command
23233 line operations on their own fairly quickly, they would be well advised
23234 to use TortoiseSVN.
23240 \begin_layout Subsubsection
23244 \begin_layout Standard
23245 In addition to installing \SpecialChar LyX
23246 , and having access to a Subversion repository,
23247 the user will need to install the Subversion client program.
23248 A Windows installer for the client program is available from
23249 \begin_inset CommandInset href
23252 target "http://www.collab.net/nonav/downloads/subversion/"
23258 The user may also want to install
23259 \begin_inset CommandInset href
23262 target "http://tortoisesvn.tigris.org/"
23267 , which integrates Subversion operations into the context (rightclick) menu
23268 of Windows Explorer.
23269 Operations done outside \SpecialChar LyX
23270 will typically be more convenient using the Explorer
23272 Note that TortoiseSVN is not a replacement for the client program, which
23273 is what \SpecialChar LyX
23277 \begin_layout Subsubsection
23278 Bringing a document under Subversion control
23281 \begin_layout Standard
23282 Before a \SpecialChar LyX
23283 document can be brought under version control in Subversion, its
23284 parent directory needs to be under version control.
23285 If the document is being added to a project already in the repository,
23286 this is accomplished by checking the project out to the directory where
23287 the new document will be placed.
23288 If the project itself is not yet under version control (for instance, if
23289 this document starts a new project), the directory must be imported into
23291 This is done outside \SpecialChar LyX
23293 Both import and checkout are easily accomplished from the Explorer context
23294 menu using TortoiseSVN, or alternatively can be done using the command
23295 line client at a DOS prompt.
23296 The procedure for importing the project using TortoiseSVN is described
23297 below, assuming an existing repository and a new project being started
23305 For information on using the Subversion client program, run
23312 \begin_layout Enumerate
23319 in Windows Explorer, right click it, and select
23321 TortoiseSVN\SpecialChar menuseparator
23325 If necessary, adjust the URL for the repository, then click OK.
23328 \begin_layout Enumerate
23329 Right click the level of the repository under which you want to place the
23330 new project folder (typically the top level) and click
23334 Supply a name for the project folder and click OK.
23335 Add a message for the log file if desired, then click OK again.
23336 The new project folder should appear in the repository.
23337 Finally, click OK again to exit the repository browser.
23340 \begin_layout Enumerate
23341 Once again right click
23347 , this time selecting SVN Checkout\SpecialChar ldots
23348 Select the URL of the project folder
23349 you just created in the repository, and set the checkout directory to
23357 You will be warned about a non-empty folder; click OK to proceed.
23358 You should now have a
23369 \begin_layout Enumerate
23370 Create or open your document in \SpecialChar LyX
23373 File\SpecialChar menuseparator
23375 \begin_inset space ~
23378 Control\SpecialChar menuseparator
23382 Add a log message and click OK to commit the document to version control.
23385 \begin_layout Standard
23386 From this point onward, you should have full functionality in the
23388 File\SpecialChar menuseparator
23390 \begin_inset space ~
23396 You also have the option of checking the document in and out, viewing its
23398 using the TortoiseSVN context menu in Windows Explorer or the Subversion
23399 client program from a command prompt.
23402 \begin_layout Subsubsection
23403 SSH tunnel used with SVN under Windows
23406 \begin_layout Standard
23407 Compared with Linux setting up an svn client to communicate over ssh under
23408 Windows is a rather troublesome task.
23409 We will at least offer some hints how to setup the client side but prior
23410 knowledge about ssh and the Windows command line is needed, also be prepared
23411 for a great deal of frustration\SpecialChar ldots
23415 \begin_layout Enumerate
23416 Get an svn client for windows, as described in the previous sections.
23417 When it is a fresh install run some svn command (e.g.
23419 \begin_inset Flex Code
23422 \begin_layout Plain Layout
23428 ) to create config files, which you will need to change later on.
23431 \begin_layout Enumerate
23432 Choose an ssh client for Windows.
23433 There are several possibilities, we will use the one from Putty tools
23437 \begin_layout Plain Layout
23438 \begin_inset Flex URL
23441 \begin_layout Plain Layout
23443 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
23454 You will need to set the connection up so that the client doesn't ask for
23455 any password from you.
23456 To keep things easy we will use only keys without any additional password
23461 \begin_layout Enumerate
23463 \begin_inset Flex Code
23466 \begin_layout Plain Layout
23473 Save your private .ppk key file and put the public one on the server side.
23474 If the SVN server runs on Linux, note that the format of the public key
23475 is not compatible with Linux openssh and you will need to direcly copy-paste
23478 Public key for pasting into OpenSSH authorized_keys file
23480 :” edit field into the server's
23481 \begin_inset Flex Code
23484 \begin_layout Plain Layout
23485 ~/.ssh/authorized_keys
23491 \begin_inset Flex Code
23494 \begin_layout Plain Layout
23503 \begin_layout Enumerate
23505 \begin_inset Flex Code
23508 \begin_layout Plain Layout
23515 In the SVN config file
23519 \begin_layout Plain Layout
23520 Exact path depends on Windows version, usually somewhere around
23521 \begin_inset Flex Code
23524 \begin_layout Plain Layout
23527 Documents and Settings
23541 \begin_inset Flex Code
23544 \begin_layout Plain Layout
23559 , section [tunnels], setup ssh command, e.g.
23561 \begin_inset Flex Code
23564 \begin_layout Plain Layout
23565 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
23574 \begin_layout Plain Layout
23575 It will usually take a lot of time to get exact command right and it depends
23577 For example do not have some remote server saved as a default session in
23579 If things fail, try to connect via plink without SVN first.
23588 \begin_layout Enumerate
23589 Checkout the SVN archive, e.
23590 \begin_inset space \thinspace{}
23594 \begin_inset Newline newline
23598 \begin_inset Flex Code
23601 \begin_layout Plain Layout
23602 svn co svn+ssh://user@server/repository_path
23610 \begin_layout Subsubsection
23611 End-of-Line Conversions
23614 \begin_layout Standard
23615 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
23617 use different line endings inside the .lyx files.
23618 This is not a problem as far as \SpecialChar LyX
23619 functionality is concerned, but the commit
23620 diffs will be huge and merge-conflicts prone.
23621 Fortunately SVN itself knows
23625 \begin_layout Plain Layout
23626 \begin_inset Flex URL
23629 \begin_layout Plain Layout
23631 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
23641 how to deal with CR/LF problems when switching .lyx files to the
23642 \begin_inset Flex Code
23645 \begin_layout Plain Layout
23655 \begin_layout Plain Layout
23657 \begin_inset Flex Code
23660 \begin_layout Plain Layout
23661 svn propset svn:eol-style native FILE_NAME
23674 \begin_layout Subsection
23675 GIT commands in \SpecialChar LyX
23679 \begin_layout Standard
23680 A minimal subset of GIT commands is now supported by \SpecialChar LyX
23682 You can find the commands in the
23684 File\SpecialChar menuseparator
23686 \begin_inset space ~
23692 Please note that if you use password protected access to repository via
23693 ssh, you will be asked in terminal window.
23695 was tested against GIT 1.7.
23699 \begin_layout Plain Layout
23700 Windows users please note that you need to ensure that git is on the path.
23701 This can be set from within \SpecialChar LyX
23704 Tools\SpecialChar menuseparator
23705 Preferences\SpecialChar menuseparator
23706 Paths\SpecialChar menuseparator
23717 \begin_layout Standard
23718 One big difference of GIT and the other supported version control systems
23719 is the distributed nature of GIT: With traditional version control systems
23720 there is one central server which hosts the repository.
23721 Users commit their changes to the server, and get updates made by other
23723 With GIT, users commit to a local repository.
23724 The local repository can be synchronized with one or more remote repositories
23726 \begin_inset Flex Code
23729 \begin_layout Plain Layout
23736 \begin_inset Flex Code
23739 \begin_layout Plain Layout
23747 does not interact in any way with remote GIT repositories.
23748 It works exclusively with the local repository in a very similar way as
23749 with a central CVS or SVN repository.
23750 If you use remote GIT repositories you need to do the
23751 \begin_inset Flex Code
23754 \begin_layout Plain Layout
23761 \begin_inset Flex Code
23764 \begin_layout Plain Layout
23770 operations with your favourite GIT client.
23773 \begin_layout Subsubsection
23779 \begin_layout Standard
23780 If your document is not under revision control, this is the only item shown
23782 And if it is under revision control, the
23786 item is not visible.
23789 \begin_layout Standard
23790 This command registers in GIT your document ONLY in case you have already
23791 the documents directory under GIT control (in particular
23796 This means you have to checkout the archive by yourself.
23799 \begin_layout Standard
23800 Then you are asked interactively to supply an initial description of the
23802 Don't forget that registered file is not yet commited.
23805 \begin_layout Standard
23806 GIT command that is run:
23809 \begin_inset Quotes eld
23813 \begin_inset Quotes erd
23819 \begin_layout Standard
23824 to understand the switches.
23827 \begin_layout Subsubsection
23833 \begin_layout Standard
23834 When you are finished editing a file, you commit your changes.
23835 When you do this, you are asked for a description of the changes.
23836 After that changes are commited.
23839 \begin_layout Standard
23842 git commit -q -m"<description>" <file-name>
23845 \begin_layout Subsubsection
23848 Revert To Repository Version
23851 \begin_layout Standard
23852 This will discard all changes made to the document since the last check
23854 You get a warning before changes are discarded.
23857 \begin_layout Standard
23861 \begin_inset Quotes eld
23865 \begin_inset Quotes erd
23871 \begin_layout Subsubsection
23877 \begin_layout Standard
23878 This will rename the current document including the version history.
23879 It requires a clean document without any changes since the last checkin.
23880 You are asked for a file name and a description of the rename operation.
23881 After that the document is renamed, both locally and in the repository.
23882 If the parent directories of the new and old file names differ, all relative
23883 paths of included files are adjusted (like in
23885 File\SpecialChar menuseparator
23890 Finally, the document is reloaded using the new name.
23893 \begin_layout Labeling
23894 \labelwidthstring 00.00.0000
23896 \begin_inset space ~
23900 \begin_inset space ~
23904 \begin_inset Newline newline
23908 \begin_inset Flex Code
23911 \begin_layout Plain Layout
23915 \begin_inset Quotes eld
23919 \begin_inset Quotes erd
23923 \begin_inset Quotes eld
23927 \begin_inset Quotes erd
23936 \begin_inset Newline newline
23940 \begin_inset Flex Code
23943 \begin_layout Plain Layout
23952 \begin_layout Subsubsection
23958 \begin_layout Standard
23959 This shows the complete history of the GIT document.
23963 \begin_inset Quotes eld
23967 \begin_inset Quotes erd
23972 is shown in a browser.
23975 \begin_layout Subsubsection
23979 \begin_layout Standard
23981 supports GIT hash number of the last commit to the file, author name, date
23982 and time of last commit.
23983 All those are extracted from
23985 git log -n 1 --pretty=format:%H%n%an%n%ai
23988 Tree version information is obtained via
23990 git describe --abbrev --dirty --long
23994 \begin_inset CommandInset ref
23996 reference "subsec:VCS-Revision-Information"
24003 \begin_layout Subsection
24007 \begin_layout Standard
24008 With the recent addition of the vc-command function \SpecialChar LyX
24009 power users are allowed
24010 to create their own commands for revision control.
24013 \begin_layout Standard
24014 As an example you can see how two TortoiseSVN commands could be integrated
24018 \begin_layout Description
24020 \begin_inset Flex Code
24023 \begin_layout Plain Layout
24024 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
24032 \begin_layout Description
24034 \begin_inset Flex Code
24037 \begin_layout Plain Layout
24038 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
24046 \begin_layout Subsection
24047 Version control and Document comparison
24050 \begin_layout Standard
24051 One of the typical uses of version control is to inspect the changes between
24052 revisions, usually by creating
24053 \begin_inset Flex Code
24056 \begin_layout Plain Layout
24063 While this is useful for plain text files, it is much less useful in the
24064 case of \SpecialChar LyX
24065 files, which have more a complicated structure.
24066 Hence we provide binding to the Document comparison feature.
24067 There are two ways of calling this feature - either by direct call of
24068 \begin_inset Flex Code
24071 \begin_layout Plain Layout
24078 function (for details see \SpecialChar LyX
24079 functions manual) or by icon/menu item
24080 \begin_inset Flex Noun
24083 \begin_layout Plain Layout
24084 Compare with older revision...
24090 One can either compare two chosen revisions of the document or he can simply
24091 compare the current version of edited text with older revisions (where
24093 \begin_inset Flex Noun
24096 \begin_layout Plain Layout
24102 ' revisions back means comparison of the edited file with last commited
24107 \begin_layout Standard
24108 This feature is supported for SVN and RCS though due to the more complicated
24109 versioning scheme of RCS there is a constraint – when addressing the revisions
24110 in dialog, numbers always point to the last number in RCS revision number,
24113 We don't currently support GIT addressing of revisions, one can just compare
24114 edited document with its revision X steps backs, where X is addressed as
24118 \begin_layout Section
24119 Literate Programming
24122 \begin_layout Standard
24127 (kayvan@sylvan.com)
24131 original documentation written by
24133 Edmar Wienskoski Jr.
24136 (edmar-w-jr@technologist.com)
24139 \begin_layout Subsection
24143 \begin_layout Standard
24144 The main purpose of this documentation is to show you how to use \SpecialChar LyX
24146 programming, where it is assumed that you are familiar with this programming
24147 technique, and know what
24148 \begin_inset Quotes eld
24152 \begin_inset Quotes erd
24156 \begin_inset Quotes eld
24160 \begin_inset Quotes erd
24164 If that is not the case, please follow the web links provided in the following
24166 There is a lot of good documentation out there covering old development
24167 history to the latest tools tips.
24170 \begin_layout Standard
24171 It is also assumed that you are familiar with \SpecialChar LyX
24172 itself to a point that you
24173 are comfortable changing your \SpecialChar LyX
24174 preferences, and X resources file.
24175 If that is not the case please refer to other \SpecialChar LyX
24176 documentation to cover your
24180 \begin_layout Subsection
24181 Literate Programming
24184 \begin_layout Standard
24185 From the Literate Programming FAQ:
24188 \begin_layout Quotation
24189 Literate programming is the combination of documentation and source together
24190 in a fashion suited for reading by human beings.
24191 In fact, literate programs should be enjoyable reading, even inviting!
24192 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
24193 and documentation in a single file.
24194 Literate programming tools then parse the file to produce either readable
24195 documentation or compilable source.
24196 The WEB style of literate programming was created by D.
24197 \begin_inset space \thinspace{}
24201 Knuth during the development of his \SpecialChar TeX
24202 typesetting software.
24206 \begin_layout Standard
24207 Another excerpt says:
24210 \begin_layout Quotation
24213 How is literate programming different from verbose commenting?
24216 \begin_layout Quotation
24217 There are three distinguishing characteristics.
24218 In order of importance, they are:
24222 \begin_layout Itemize
24223 flexible order of elaboration
24226 \begin_layout Itemize
24227 automatic support for browsing
24230 \begin_layout Itemize
24231 typeset documentation, especially diagrams and mathematics
24235 \begin_layout Standard
24236 Now that I sparked your curiosity, take a look in the references.
24239 \begin_layout Subsubsection
24243 \begin_layout Standard
24244 The complete Literate Programming FAQ can be found at:
24247 \begin_layout Quote
24248 Literate Programming FAQ
24249 \begin_inset Flex URL
24252 \begin_layout Plain Layout
24254 http://www.literateprogramming.com/lpfaq.pdf
24262 \begin_layout Standard
24263 The FAQ lists 23 (twenty three!) different literate programming tools.
24264 Where some are specialized or
24265 \begin_inset Quotes eld
24269 \begin_inset Quotes erd
24272 for particular programming languages, while other have general scope.
24277 for my own use for several reasons:
24280 \begin_layout Itemize
24281 It can generate the documentation either in \SpecialChar LaTeX
24285 \begin_layout Itemize
24286 It has a open architecture, i.
24287 \begin_inset space \thinspace{}
24291 \begin_inset space \space{}
24294 it is easy to plug in new filters
24295 \change_inserted -712698321 1501229014
24300 \begin_layout Plain Layout
24302 \change_inserted -712698321 1501229136
24307 are programs that read a given data stream and output a manipulated data
24309 That way, a WEB file (consisting of literate code) can be turned into a
24310 file consisting only of C program code or \SpecialChar LaTeX
24318 and to perform special processing that you may need.
24322 \begin_layout Itemize
24323 There is a good selection of filters available already (the HTML is one
24327 \begin_layout Itemize
24331 \begin_layout Standard
24332 The Noweb web page can be found at:
24335 \begin_layout Quote
24337 \begin_inset Flex URL
24340 \begin_layout Plain Layout
24342 http://www.cs.virginia.edu/~nr/noweb/
24350 \begin_layout Standard
24351 Starting from there you can reach many other interesting links and even
24352 some literate program examples.
24355 \begin_layout Subsection
24357 and Literate Programming with Noweb
24360 \begin_layout Standard
24361 The \SpecialChar LyX
24362 support for Literate Programming is provided by using the generic \SpecialChar LyX
24364 converters mechanism.
24365 This support is provided in a
24366 \begin_inset Quotes eld
24370 \begin_inset Quotes erd
24374 \begin_inset space \thinspace{}
24378 \begin_inset space \space{}
24381 you will be able to use this new \SpecialChar LyX
24382 feature with some other literate programming
24383 tool of your choice by just changing your \SpecialChar LyX
24387 \begin_layout Subsubsection
24388 Generating documents and code (weaving and tangling)
24391 \begin_layout Paragraph
24392 Using the noweb module
24395 \begin_layout Standard
24396 If you have installed Noweb and \SpecialChar LyX
24397 successfully, whenever you open a new document,
24398 after you have chosen its document class, use the
24401 \change_deleted -712698321 1501229457
24403 \change_inserted -712698321 1501229457
24404 \SpecialChar menuseparator
24410 \begin_inset Quotes eld
24414 \begin_inset Quotes erd
24418 If Noweb is correctly installed, when you click on the
24419 \begin_inset Quotes eld
24423 \begin_inset Quotes erd
24426 link, you will see the
24427 \begin_inset Quotes eld
24431 \begin_inset Quotes erd
24434 module in the available list and you can add it to your document.
24437 \begin_layout Paragraph
24441 \begin_layout Standard
24443 enables you to write code with a
24444 \change_deleted -712698321 1501229783
24446 \change_inserted -712698321 1501229785
24450 \begin_inset Flex Noun
24453 \begin_layout Plain Layout
24460 Noweb delimits chunks like this:
24463 \begin_layout LyX-Code
24467 \begin_layout LyX-Code
24471 \begin_layout LyX-Code
24475 \begin_layout LyX-Code
24479 \begin_layout LyX-Code
24483 \begin_layout Standard
24484 The problem is that whatever is written in between the << and the
24488 must be taken literally, i.
24489 \begin_inset space \thinspace{}
24493 \begin_inset space \space{}
24497 should be prevented from making any special interpretation of what has
24499 This is also handled by
24500 \begin_inset Flex Noun
24503 \begin_layout Plain Layout
24509 , that works like a normal
24510 \change_deleted -712698321 1501229871
24512 \change_inserted -712698321 1501229873
24515 but has a free spacing capability.
24518 \begin_layout Standard
24519 As a special note, you can also use the
24520 \begin_inset Quotes eld
24524 \begin_inset Quotes erd
24527 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
24531 \begin_layout LyX-Code
24535 \begin_layout LyX-Code
24536 def some_function(args):
24539 \begin_layout LyX-Code
24540 "This is the doc string for this function."
24543 \begin_layout LyX-Code
24544 print "My args: ", args
24547 \begin_layout LyX-Code
24548 @ %def some_function
24551 \begin_layout Standard
24552 For an example of this usage and the resulting cross-reference output, look
24553 at the Literate python program in
24555 LIBDIR/examples/listerrors.lyx
24557 which should make this all clear.
24560 \begin_layout Paragraph
24561 Generating the documentation
24564 \begin_layout Standard
24565 At this point you already have a new document file with a proper document
24566 class, and with some code and text on it.
24567 How do I print it? The answer is simple, you select
24569 View\SpecialChar menuseparator
24573 Just like you would do for a plain document.
24574 No special procedure is required.
24577 \begin_layout Standard
24578 To help orientate you, I will now explain what happens inside \SpecialChar LyX
24582 \begin_layout Enumerate
24585 Update\SpecialChar menuseparator
24588 menu option is chosen, a \SpecialChar LaTeX
24594 \begin_layout Standard
24595 If the document is of any literate class the generated file will be named
24596 with an extension name defined by the
24597 \begin_inset Quotes eld
24601 \begin_inset Quotes erd
24604 format (defined in the Preferences panel), otherwise the file will have
24613 \begin_layout Enumerate
24614 Note that the only difference so far is in the name of the file, no special
24615 processing is required by \SpecialChar LyX
24617 Given that you formatted the code using the
24618 \begin_inset Flex Noun
24621 \begin_layout Plain Layout
24628 \change_deleted -712698321 1501230025
24630 \change_inserted -712698321 1501230027
24633 that, by itself, takes care of the business.
24636 \begin_layout Enumerate
24637 If the document is of any literate class \SpecialChar LyX
24638 will then use the internal \SpecialChar LyX
24640 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
24645 \begin_layout Plain Layout
24646 The converters are defined in the
24648 Tools\SpecialChar menuseparator
24652 \begin_inset Quotes eld
24656 \begin_inset Quotes erd
24668 manual for general information about converters.
24673 to generate the \SpecialChar LaTeX
24678 \begin_layout Standard
24679 Otherwise it will just skip this step.
24683 \begin_layout Enumerate
24684 Finally, \SpecialChar LaTeX
24685 is invoked and the regular post processing continues as in a plain
24689 \begin_layout Standard
24690 Independence from a particular
24691 \begin_inset Quotes eld
24695 \begin_inset Quotes erd
24698 is easily achieved by changing the commands that are run by the various
24702 \begin_layout Paragraph
24703 Generating the code
24706 \begin_layout Standard
24707 When the build menu option is chosen or the corresponding button in the
24708 toolbar is pressed, a \SpecialChar LaTeX
24709 file is generated just like step 1 above.
24710 Next, \SpecialChar LyX
24716 This converter needs to be defined by the user and is not installed by
24717 default, though the Program format is.
24718 This converter (like any other converter) will have two parts:
24721 \begin_layout Enumerate
24722 The converter program itself.
24723 This program performs the conversion from the one format to the other (in
24724 this case, from the Noweb format to the Program pseudo-format).
24727 \begin_layout Enumerate
24728 The error log parser.
24729 This is a program whose sole purpose is to rewrite error messages in a
24730 format that \SpecialChar LyX
24732 This makes it possible for \SpecialChar LyX
24733 to place error boxes in the right places in
24737 \begin_layout Standard
24738 The first part, the
24739 \begin_inset Quotes eld
24743 \begin_inset Quotes erd
24746 setting, should be set to
24747 \change_inserted -712698321 1501230220
24751 \begin_layout LyX-Code
24753 \change_deleted -712698321 1501230232
24754 \begin_inset Newline newline
24758 \begin_inset Quotes eld
24768 \change_deleted -712698321 1501230236
24770 \begin_inset Quotes erd
24774 \begin_inset Newline newline
24778 \change_inserted -712698321 1501230224
24782 \begin_layout Standard
24783 This basically means that \SpecialChar LyX
24785 \begin_inset Quotes eld
24789 \begin_inset Quotes erd
24792 (a program or script) with the name of the Noweb file (normally a file
24793 in the \SpecialChar LyX
24794 temp directory) and the directory path of the original \SpecialChar LyX
24799 \begin_layout Standard
24800 This is an implementation of
24801 \begin_inset Quotes eld
24805 \begin_inset Quotes erd
24808 that you can place in a directory on your path:
24811 \begin_layout Standard
24813 \change_deleted -712698321 1501230298
24814 \begin_inset VSpace defskip
24822 \begin_layout Standard
24824 \change_deleted -712698321 1501230296
24825 \begin_inset Newpage pagebreak
24833 \begin_layout LyX-Code
24839 \begin_layout LyX-Code
24845 \begin_layout LyX-Code
24848 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
24851 \begin_layout Standard
24853 \change_deleted -712698321 1501230299
24854 \begin_inset VSpace defskip
24862 \begin_layout Standard
24863 The next part of the converter setting is the
24864 \begin_inset Quotes eld
24868 \begin_inset Quotes erd
24871 which is to be set to
24872 \change_inserted -712698321 1501230552
24876 \begin_layout LyX-Code
24878 \change_deleted -712698321 1501230577
24879 \begin_inset Newline newline
24883 \begin_inset Quotes eld
24890 parselog=$$s/scripts/listerrors
24891 \change_deleted -712698321 1501230575
24895 \begin_inset Quotes erd
24899 \begin_inset Newline newline
24903 \change_inserted -712698321 1501230544
24907 \begin_layout Standard
24908 This will run any errors that are generated by the
24909 \begin_inset Quotes eld
24913 \begin_inset Quotes erd
24916 process through the
24917 \begin_inset Quotes eld
24921 \begin_inset Quotes erd
24927 \begin_layout Standard
24928 The build will normally take place in \SpecialChar LyX
24929 's temporary directory, so the files
24930 produced by the conversion will be in that directory.
24932 will copy out what it regards as the `main' file, but the
24936 conversion may produce several files, and so most of these would then be
24937 deleted when \SpecialChar LyX
24939 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
24940 the build-script chunk can place the generated files in that location.
24943 \begin_layout Paragraph
24944 Build instructions in the document
24947 \begin_layout Standard
24948 The last piece of the integration between \SpecialChar LyX
24950 \begin_inset Quotes eld
24954 \begin_inset Quotes erd
24958 Generally, the instructions for building your program should be embedded
24959 in a chunk of its own.
24961 \begin_inset Quotes eld
24965 \begin_inset Quotes erd
24968 above uses the notangle command to look for this chunk (called
24969 \begin_inset Quotes eld
24973 \begin_inset Quotes erd
24976 ) and runs its contents through
24977 \begin_inset Quotes eld
24981 \begin_inset Quotes erd
24987 \begin_layout Standard
24988 Typically, such a chunk would look something like this:
24991 \begin_layout LyX-Code
24995 \begin_layout LyX-Code
24997 \begin_inset Newline newline
25000 if [ -z "${NOWEB_SOURCE}" ]
25001 \begin_inset Newline newline
25007 \begin_layout LyX-Code
25008 NOWEB_SOURCE=myfile.nw
25009 \begin_inset Newline newline
25013 \begin_inset Newline newline
25017 code to extract files ...
25018 use NOWEB_OUTPUT_DIR here ...]
25019 \begin_inset Newline newline
25023 code to compile files ...]
25024 \begin_inset Newline newline
25030 \begin_layout Standard
25033 LIBDIR/examples/listerrors.lyx
25037 LIBDIR/examples/Literate.lyx
25039 which implement two versions of the
25040 \begin_inset Quotes eld
25044 \begin_inset Quotes erd
25047 program for some illustrations of how all of these pieces go together or
25050 LIBDIR/examples/noweb2lyx.lyx.
25053 Interestingly, these three files show off the language-indepence of the
25055 literate programming support since they are written in Python, C and Perl
25059 \begin_layout Subsubsection
25060 Configuring \SpecialChar LyX
25064 \begin_layout Standard
25065 All the Literate Programming support is configured by the
25067 Tools\SpecialChar menuseparator
25071 \begin_inset Quotes eld
25075 \begin_inset Quotes erd
25079 The important parts are:
25082 \begin_layout Description
25084 \begin_inset space ~
25088 \begin_inset Quotes eld
25092 \begin_inset Quotes erd
25096 \begin_inset space ~
25099 format Set up via the File Formats tab, this is where the Noweb-specific
25109 , the file extension is set to
25114 This tells \SpecialChar LyX
25115 to create a file with a
25119 extension in the first step of the conversion process.
25122 \begin_layout Description
25124 \begin_inset space ~
25132 \begin_inset space ~
25135 format This is an empty format whose sole purpose is to be the endpoint
25136 of a conversion (which then allows us to set up a converter for it).
25139 \begin_layout Description
25149 This converter performs the
25150 \begin_inset Quotes eld
25154 \begin_inset Quotes erd
25157 of the literate document.
25158 For Noweb, it is set to
25159 \begin_inset Quotes eld
25164 noweave -delay -index $$i > $$o
25167 \begin_inset Quotes erd
25173 \begin_layout Description
25183 \begin_inset Quotes eld
25187 \begin_inset Quotes erd
25191 As stated above, the Converter is set to
25192 \begin_inset Quotes eld
25200 \begin_inset Quotes erd
25203 , with Flags set to
25204 \begin_inset Newline newline
25208 \begin_inset Quotes eld
25213 parselog=$$s/scripts/listerrors
25216 \begin_inset Quotes erd
25222 \begin_layout Subsubsection
25226 \begin_layout Standard
25227 There is also a new function implemented in the \SpecialChar LyX
25229 \begin_inset Quotes eld
25232 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
25236 \begin_layout Standard
25237 When debugging code with ddd/gdb, it is possible to invoke a text editor
25238 at the current execution position with a single key stroke.
25239 The default ddd configuration for that is shift-ctrl-V.
25240 It happens that you can define the editor command line invocation in ddd
25243 Edit\SpecialChar menuseparator
25244 Preferences\SpecialChar menuseparator
25247 dialog and changing the "Edit Sources" entry.
25250 \begin_layout Standard
25251 I take advantage of the newly created \SpecialChar LyX
25252 server function and this ddd feature,
25254 \begin_inset Quotes eld
25258 \begin_inset Quotes erd
25264 \begin_layout Standard
25266 \change_deleted -712698321 1501232274
25267 \begin_inset VSpace defskip
25271 \change_inserted -712698321 1501232276
25275 \begin_layout LyX-Code
25278 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
25281 \begin_layout Standard
25283 \change_deleted -712698321 1501232278
25284 \begin_inset VSpace defskip
25292 \begin_layout Standard
25293 With this, whenever you are using ddd and find a point in the program that
25294 you want to edit, you just press shift-ctrl-V (in the ddd window), and
25295 ddd will forward this information to \SpecialChar LyX
25296 through the \SpecialChar LyX
25297 server and then the
25299 window will show the same file with the cursor at the same position ddd
25301 No more guessing or long scrolling to locate a point in the program back
25305 \begin_layout Standard
25306 Note however that you must enable the \SpecialChar LyX
25307 server to get this feature working
25308 (it is disabled by default).
25310 \change_deleted -712698321 1501232597
25311 You can enable it in
25323 ) by entering in the
25329 \begin_inset Quotes eld
25334 /home/<your-home-directory>/.lyx/lyxpipe
25337 \begin_inset Quotes erd
25343 \begin_layout Standard
25345 \change_inserted -712698321 1501232576
25347 \begin_inset space ~
25351 \begin_inset CommandInset ref
25353 reference "sec:Starting-the-Server"
25357 explains how to do that
25358 \change_deleted -712698321 1501232579
25359 Read the \SpecialChar LyX
25360 server documentation in the
25362 Customization Manual
25364 for further information
25369 \begin_layout Subsubsection
25373 \begin_layout Standard
25374 There are six new buttons that can be added to your \SpecialChar LyX
25377 \change_deleted -712698321 1501232976
25379 \change_inserted -712698321 1501232977
25382 of these buttons are short cuts to layout styles:
25396 \change_inserted -712698321 1501232982
25405 \change_deleted -712698321 1501232984
25407 \change_inserted -712698321 1501232988
25408 one fpr the custom inset
25415 The last one is a short cut to the
25416 \begin_inset Quotes eld
25420 \begin_inset Quotes erd
25427 \begin_layout Standard
25429 has a range of buttons that are available for tool bar customization.
25430 In my toolbar I like to combine the six short cuts above with two more:
25435 \SpecialChar menuseparator
25440 \SpecialChar menuseparator
25447 Document\SpecialChar menuseparator
25448 View\SpecialChar menuseparator
25452 Here is how it looks like:
25455 \begin_layout LyX-Code
25459 \begin_layout LyX-Code
25463 \begin_layout LyX-Code
25464 Icon "layout Standard"
25467 \begin_layout LyX-Code
25468 Icon "layout Section"
25471 \begin_layout LyX-Code
25472 Icon "layout \SpecialChar LaTeX
25476 \begin_layout LyX-Code
25477 Icon "layout \SpecialChar LyX
25481 \begin_layout LyX-Code
25483 \change_deleted -712698321 1501232918
25485 \change_inserted -712698321 1501232921
25491 \begin_layout LyX-Code
25495 \begin_layout LyX-Code
25499 \begin_layout LyX-Code
25500 Icon "buffer-typeset"
25503 \begin_layout LyX-Code
25504 Icon "build-program"
25507 \begin_layout LyX-Code
25511 \begin_layout LyX-Code
25515 \begin_layout LyX-Code
25519 \begin_layout LyX-Code
25523 \begin_layout LyX-Code
25527 \begin_layout Subsubsection
25528 Colors customization
25531 \begin_layout Standard
25532 There are a number of colors in \SpecialChar LyX
25533 that can be customized in
25538 One of the things that bothers people is the \SpecialChar LaTeX
25540 The default color is red, since the chunks uses \SpecialChar LaTeX
25541 font, and there is a lot
25542 of chunks in literate documents, you may get tired of seeing everything
25544 You can change it by going to the tabs
25553 \begin_layout Standard
25554 The next thing is the visible presence of the newline character in the screen.
25555 You can choose the color of this particular character and make it blend
25557 I recommend you choosing a color that is close to the background but not
25558 equal, that way you still can see it is there, but it is not bothering
25562 \begin_layout Subsection
25567 \begin_layout Standard
25576 is documented in the
25580 example file and in the Sweave manual (menu
25582 Help\SpecialChar menuseparator
25588 \begin_layout Chapter
25592 \begin_layout Standard
25593 You can do everything with \SpecialChar LyX
25594 that you can do with \SpecialChar LaTeX
25596 However, \SpecialChar LyX
25597 cannot support every \SpecialChar LaTeX
25599 But you can always use \SpecialChar TeX
25601 This chapter shows you some more special things you might want to use.
25602 For other special things you can do with figures, tables, floats, boxes
25603 and notes, have a look at the
25606 \begin_inset space ~
25614 \begin_layout Section
25615 Multiple Text Columns
25618 \begin_layout Standard
25619 This feature is independent of the option
25621 Two-column document
25623 in the document settings under
25628 If you want to have 2
25629 \begin_inset space ~
25632 columns for the whole document, it is recommended to use the
25634 Two-column document
25637 For all other cases use this feature.
25640 \begin_layout Standard
25641 To use multiple text columns in your document, you have to load the module
25648 Document\SpecialChar menuseparator
25649 Settings\SpecialChar menuseparator
25652 ) and must have the \SpecialChar LaTeX
25654 \change_deleted -712698321 1501235255
25656 \change_inserted -712698321 1501235255
25658 \begin_inset Flex Code
25661 \begin_layout Plain Layout
25663 \change_inserted -712698321 1501235255
25676 \begin_layout Standard
25677 Footnotes within multiple columns will be placed at the bottom of the page
25678 and not under each column.
25679 Within the different columns you can use everything, with the limitation
25680 that for floats you need to use the float option
25687 \begin_layout Subsection
25691 \begin_layout Standard
25692 If you want to have 2
25693 \begin_inset space ~
25696 columns in your text, insert a multicolumn inset via the menu
25698 Insert\SpecialChar menuseparator
25700 \begin_inset space ~
25703 Insets\SpecialChar menuseparator
25705 \begin_inset space ~
25710 where the columns should start.
25711 Write all text that should be printed in 2
25712 \begin_inset space ~
25715 columns into this inset.
25718 \begin_layout Standard
25719 Here is an example:
25722 \begin_layout Standard
25724 \begin_inset Flex Multiple Columns
25727 \begin_layout Plain Layout
25732 The Adventure of the Empty House
25735 \begin_inset Newline newline
25738 by Sir Arthur Conan Doyle
25741 \begin_layout Plain Layout
25744 It was in the spring of the year 1894 that all London was interested, and
25745 the fashionable world dismayed, by the murder of the Honourable Ronald
25746 Adair under most unusual and inexplicable circumstances.
25747 The public has already learned those particulars of the crime which came
25748 out in the police investigation, but a good deal was suppressed upon that
25749 occasion, since the case for the prosecution was so overwhelmingly strong
25750 that it was not necessary to bring forward all the facts.
25751 Only now, at the end of nearly ten years, am I allowed to supply those
25752 missing links which make up the whole of that remarkable chain.
25753 The crime was of interest in itself, but that interest was as nothing to
25754 me compared to the inconceivable sequel, which afforded me the greatest
25755 shock and surprise of any event in my adventurous life.
25756 Even now, after this long interval, I find myself thrilling as I think
25757 of it, and feeling once more that sudden flood of joy, amazement, and increduli
25758 ty which utterly submerged my mind.
25759 Let me say to that public, which has shown some interest in those glimpses
25760 which I have occasionally given them of the thoughts and actions of a very
25761 remarkable man, that they are not to blame me if I have not shared my knowledge
25762 with them, for I should have considered it my first duty to do so, had
25763 I not been barred by a positive prohibition from his own lips, which was
25764 only withdrawn upon the third of last month.
25772 \begin_layout Standard
25773 To get 3 or more columns, set the cursor into the multicolumn inset and
25776 Insert\SpecialChar menuseparator
25778 \begin_inset space ~
25782 \begin_inset space ~
25788 The number of the desired columns is written into that inset (for 3
25789 \begin_inset space ~
25793 \begin_inset Quotes eld
25797 \begin_inset Quotes erd
25801 \begin_inset Newline newline
25804 Here is an example with 3
25805 \begin_inset space ~
25811 \begin_layout Standard
25812 \begin_inset Flex Multiple Columns
25815 \begin_layout Plain Layout
25818 \begin_inset Argument 1
25821 \begin_layout Plain Layout
25827 It can be imagined that my close intimacy with Sherlock Holmes had interested
25828 me deeply in crime, and that after his disappearance I never failed to
25829 read with care the various problems which came before the public.
25830 And I even attempted, more than once, for my own private satisfaction,
25831 to employ his methods in their solution, though with indifferent success.
25832 There was none, however, which appealed to me like this tragedy of Ronald
25834 As I read the evidence at the inquest, which led up to a verdict of willful
25835 murder against some person or persons unknown, I realized more clearly
25836 than I had ever done the loss which the community had sustained by the
25837 death of Sherlock Holmes.
25838 There were points about this strange business which would, I was sure,
25839 have specially appealed to him, and the efforts of the police would have
25840 been supplemented, or more probably anticipated, by the trained observation
25841 and the alert mind of the first criminal agent in Europe.
25842 All day, as I drove upon my round, I turned over the case in my mind and
25843 found no explanation which appeared to me to be adequate.
25844 At the risk of telling a twice-told tale, I will recapitulate the facts
25845 as they were known to the public at the conclusion of the inquest.
25853 \begin_layout Standard
25854 You can have up to 10
25855 \begin_inset space ~
25858 columns if you want to, but that might not be very pleasant for the readers
25862 \begin_layout Standard
25863 \begin_inset Newpage newpage
25869 \begin_layout Subsection
25870 Columns inside Columns
25873 \begin_layout Standard
25874 You can also have columns inside columns:
25877 \begin_layout Standard
25878 \begin_inset Flex Multiple Columns
25881 \begin_layout Plain Layout
25884 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
25885 at that time governor of one of the Australian colonies.
25886 Adair's mother had returned from Australia to undergo the operation for
25887 cataract, and she, her son Ronald, and her daughter Hilda were living together
25891 \begin_layout Plain Layout
25892 \begin_inset Flex Multiple Columns
25895 \begin_layout Plain Layout
25898 The youth moved in the best society–had, so far as was known, no enemies
25899 and no particular vices.
25900 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
25901 had been broken off by mutual consent some months before, and there was
25902 no sign that it had left any very profound feeling behind it.
25903 For the rest {sic} the man's life moved in a narrow and conventional circle,
25904 for his habits were quiet and his nature unemotional.
25905 Yet it was upon this easy-going young aristocrat that death came, in most
25906 strange and unexpected form, between the hours of ten and eleven-twenty
25907 on the night of March 30, 1894.
25915 \begin_layout Plain Layout
25918 Ronald Adair was fond of cards–playing continually, but never for such stakes
25920 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
25921 It was shown that, after dinner on the day of his death, he had played
25922 a rubber of whist at the latter club.
25923 He had also played there in the afternoon.
25928 The evidence of those who had played with him– Mr.
25929 Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
25930 and that there was a fairly equal fall of the cards.
25931 Adair might have lost five pounds, but not more.
25932 His fortune was a considerable one, and such a loss could not in any way
25934 He had played nearly every day at one club or other, but he was a cautious
25935 player, and usually rose a winner.
25936 It came out in evidence that, in partnership with Colonel Moran, he had
25937 actually won as much as four hundred and twenty pounds in a sitting, some
25938 weeks before, from Godfrey Milner and Lord Balmoral.
25939 So much for his recent history as it came out at the inquest.
25947 \begin_layout Subsection
25951 \begin_layout Standard
25952 The examples in this section show some more special features of multiple
25956 \begin_layout Standard
25957 For more features of multiple columns, have a look at the
25958 \change_deleted -712698321 1501236578
25960 \change_inserted -712698321 1501236578
25962 \begin_inset CommandInset href
25964 name "documentation"
25965 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
25972 of the \SpecialChar LaTeX
25974 \change_deleted -712698321 1501235271
25976 \change_inserted -712698321 1501235271
25978 \begin_inset Flex Code
25981 \begin_layout Plain Layout
25983 \change_inserted -712698321 1501235271
25992 \change_deleted -712698321 1501236609
25994 \begin_inset CommandInset citation
26006 \begin_layout Subsubsection
26010 \begin_layout Standard
26011 To add a preface text for multiple columns, set the cursor into the multicolumn
26012 inset and use the menu
26014 Insert\SpecialChar menuseparator
26018 Write your preface text into that inset.
26019 \begin_inset Newline newline
26022 This is an example with some preface text:
26025 \begin_layout Standard
26026 \begin_inset VSpace bigskip
26032 \begin_layout Standard
26033 \begin_inset Flex Multiple Columns
26036 \begin_layout Plain Layout
26037 \begin_inset Argument 2
26040 \begin_layout Plain Layout
26041 And the story continues and continues and continues and continues\SpecialChar ldots
26049 On the evening of the crime, he returned from the club exactly at ten.
26050 His mother and sister were out spending the evening with a relation.
26051 The servant deposed that she heard him enter the front room on the second
26052 floor, generally used as his sitting-room.
26053 She had lit a fire there, and as it smoked she had opened the window.
26054 No sound was heard from the room until eleven-twenty, the hour of the return
26055 of Lady Maynooth and her daughter.
26056 Desiring to say good-night, she attempted to enter her son's room.
26057 The door was locked on the inside, and no answer could be got to their
26058 cries and knocking.
26059 Help was obtained, and the door forced.
26060 The unfortunate young man was found lying near the table.
26061 His head had been horribly mutilated by an expanding revolver bullet, but
26062 no weapon of any sort was to be found in the room.
26070 \begin_layout Standard
26071 You can also use a section heading as the preface if you use a section command
26072 as \SpecialChar TeX
26074 For example the command
26077 \begin_layout LyX-Code
26080 subsection{subsection title}
26083 \begin_layout Standard
26084 creates a subsection.
26085 In this example the preface is a subsubsection:
26088 \begin_layout Standard
26089 \begin_inset Flex Multiple Columns
26092 \begin_layout Plain Layout
26093 \begin_inset Argument 2
26096 \begin_layout Plain Layout
26100 \begin_layout Plain Layout
26109 This is a subsubsection heading as a preface
26113 \begin_layout Plain Layout
26127 A minute examination of the circumstances served only to make the case more
26129 In the first place, no reason could be given why the young man should have
26130 fastened the door upon the inside.
26131 There was the possibility that the murderer had done this, and had afterwards
26132 escaped by the window.
26133 The drop was at least twenty feet, however, and a bed of crocuses in full
26135 Neither the flowers nor the earth showed any sign of having been disturbed,
26136 nor were there any marks upon the narrow strip of grass which separated
26137 the house from the road.
26138 Apparently, therefore, it was the young man himself who had fastened the
26140 But how did he come by his death? No one could have climbed up to the window
26141 without leaving traces.
26142 Suppose a man had fired through the window, he would indeed be a remarkable
26143 shot who could with a revolver inflict so deadly a wound.
26144 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
26145 a hundred yards of the house.
26146 No one had heard a shot.
26154 \begin_layout Standard
26155 If there is less vertical space than 6
26156 \begin_inset space ~
26159 text lines is left on the page at the beginning of the multiple columns,
26160 a page break will be inserted before the multiple columns.
26161 Depending on the number of lines of the preface text, you might want to
26163 This is done by setting the cursor into the mulitcolumn inset behind the
26164 preface (if there is any) and using the menu
26166 Insert\SpecialChar menuseparator
26168 \begin_inset space ~
26172 \begin_inset space ~
26176 \begin_inset space ~
26182 Insert into that inset the amount of space like e.
26183 \begin_inset space \thinspace{}
26187 \begin_inset space \space{}
26191 \begin_inset Quotes eld
26195 \begin_inset Quotes erd
26199 \begin_inset Newline newline
26202 In this example the space is set to 7
26203 \begin_inset space ~
26206 text lines by using
26207 \change_deleted -712698321 1501235295
26209 \begin_inset Quotes eld
26215 \change_inserted -712698321 1501235293
26217 \begin_inset Flex Code
26220 \begin_layout Plain Layout
26222 \change_inserted -712698321 1501235293
26233 \change_deleted -712698321 1501235296
26235 \begin_inset Quotes erd
26241 \change_deleted -712698321 1501235285
26245 \change_inserted -712698321 1501235285
26247 \begin_inset Flex Code
26250 \begin_layout Plain Layout
26252 \change_inserted -712698321 1501235285
26264 needs to be inserted as \SpecialChar TeX
26268 \begin_layout Standard
26269 \begin_inset Flex Multiple Columns
26272 \begin_layout Plain Layout
26273 \begin_inset Argument 3
26276 \begin_layout Plain Layout
26281 \begin_layout Plain Layout
26297 On the evening of the crime, he returned from the club exactly at ten.
26298 His mother and sister were out spending the evening with a relation.
26299 The servant deposed that she heard him enter the front room on the second
26300 floor, generally used as his sitting-room.
26301 She had lit a fire there, and as it smoked she had opened the window.
26302 No sound was heard from the room until eleven-twenty, the hour of the return
26303 of Lady Maynooth and her daughter.
26304 Desiring to say good-night, she attempted to enter her son's room.
26305 The door was locked on the inside, and no answer could be got to their
26306 cries and knocking.
26307 Help was obtained, and the door forced.
26308 The unfortunate young man was found lying near the table.
26309 His head had been horribly mutilated by an expanding revolver bullet, but
26310 no weapon of any sort was to be found in the room.
26318 \begin_layout Subsubsection
26322 \begin_layout Standard
26323 The amount of space before and after multiple columns can be changed by
26324 changing the length
26325 \change_deleted -712698321 1501235307
26329 \change_inserted -712698321 1501235307
26331 \begin_inset Flex Code
26334 \begin_layout Plain Layout
26336 \change_inserted -712698321 1501235307
26349 For example the command
26352 \begin_layout LyX-Code
26360 \begin_layout Standard
26361 in \SpecialChar TeX
26362 Code changes its value to 3
26363 \begin_inset space \thinspace{}
26367 The change must be made before the multiple columns' start.
26368 The predefined value is 13
26369 \begin_inset space \thinspace{}
26375 \begin_layout Standard
26377 \change_deleted -712698321 1501235314
26381 \change_inserted -712698321 1501235315
26383 \begin_inset Flex Code
26386 \begin_layout Plain Layout
26388 \change_inserted -712698321 1501235315
26401 \begin_inset space \thinspace{}
26407 \begin_layout Standard
26411 \begin_layout Plain Layout
26417 multicolsep}{2.5cm}
26425 \begin_layout Standard
26426 \begin_inset Flex Multiple Columns
26429 \begin_layout Plain Layout
26432 All day I turned these facts over in my mind, endeavouring to hit upon some
26433 theory which could reconcile them all, and to find that line of least resistanc
26434 e which my poor friend had declared to be the starting-point of every investigat
26436 I confess that I made little progress.
26437 In the evening I strolled across the Park, and found myself about six o'clock
26438 at the Oxford Street end of Park Lane.
26439 A group of loafers upon the pavements, all staring up at a particular window,
26440 directed me to the house which I had come to see.
26441 A tall, thin man with coloured glasses, whom I strongly suspected of being
26442 a plain-clothes detective, was pointing out some theory of his own, while
26443 the others crowded round to listen to what he said.
26444 I got as near him as I could, but his observations seemed to me to be absurd,
26445 so I withdrew again in some disgust.
26446 As I did so I struck against an elderly, deformed man, who had been behind
26447 me, and I knocked down several books which he was carrying.
26455 \begin_layout Standard
26456 \begin_inset Note Greyedout
26459 \begin_layout Plain Layout
26464 The values you set with
26465 \change_inserted -712698321 1501235328
26467 \begin_inset Flex Code
26470 \begin_layout Plain Layout
26472 \change_inserted -712698321 1501235333
26483 \change_deleted -712698321 1501235331
26492 will be used for all following multiple columns until you change them again.
26500 \begin_layout Standard
26504 \begin_layout Plain Layout
26516 \begin_inset Note Note
26519 \begin_layout Plain Layout
26520 go back to the default
26528 \begin_layout Standard
26529 \begin_inset Newpage newpage
26535 \begin_layout Subsubsection
26539 \begin_layout Standard
26540 A column break can be forced by inserting the command
26541 \change_deleted -712698321 1501235399
26545 \change_inserted -712698321 1501235399
26547 \begin_inset Flex Code
26550 \begin_layout Plain Layout
26552 \change_inserted -712698321 1501235399
26564 as \SpecialChar TeX
26565 Code to that position in the text where the column should be broken.
26566 Note that this leads in most cases to whitespace in the text.
26567 \begin_inset Newline newline
26570 Here is an example:
26573 \begin_layout Standard
26574 \begin_inset Flex Multiple Columns
26577 \begin_layout Plain Layout
26580 \begin_inset Quotes eld
26583 You're surprised to see me, sir,
26584 \begin_inset Quotes erd
26587 said he, in a strange, croaking voice.
26590 \begin_layout Plain Layout
26593 I acknowledged that I was.
26596 \begin_layout Plain Layout
26599 \begin_inset Quotes eld
26602 Well, I've a conscience, sir, and when I chanced to see you go into this
26603 house, as I came hobbling after you, I thought to myself, I'll just step
26604 in and see that kind gentleman, and tell him that if I was a bit gruff
26605 in my manner there was not any harm meant, and that I am much obliged to
26606 him for picking up my books.
26607 \begin_inset Quotes erd
26613 \begin_layout Plain Layout
26616 \begin_inset Quotes eld
26619 You make too much of a trifle,
26620 \begin_inset Quotes erd
26625 \begin_inset Quotes eld
26628 May I ask how you knew who I was?
26629 \begin_inset Quotes erd
26632 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
26636 \begin_layout Plain Layout
26648 \begin_layout Plain Layout
26651 \begin_inset Quotes eld
26654 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
26655 you'll find my little bookshop at the corner of Church Street, and very
26656 happy to see you, I am sure.
26657 Maybe you collect yourself, sir.
26661 \begin_inset space ~
26674 –a bargain, every one of them.
26675 With five volumes you could just fill that gap on that second shelf.
26676 It looks untidy, does it not, sir?
26677 \begin_inset Quotes erd
26688 \begin_layout Subsubsection
26692 \begin_layout Standard
26693 The width of the columns is automatically calculated, but you can modify
26694 the space between the columns.
26695 This is done by changing the length
26696 \change_deleted -712698321 1501235412
26700 \change_inserted -712698321 1501235412
26702 \begin_inset Flex Code
26705 \begin_layout Plain Layout
26707 \change_inserted -712698321 1501235412
26720 Its predefined value is 10
26721 \begin_inset space \thinspace{}
26725 Here is an example where
26726 \change_deleted -712698321 1501235418
26730 \change_inserted -712698321 1501235418
26732 \begin_inset Flex Code
26735 \begin_layout Plain Layout
26737 \change_inserted -712698321 1501235418
26750 \begin_inset space \thinspace{}
26756 \begin_layout Standard
26760 \begin_layout Plain Layout
26774 \begin_layout Standard
26775 \begin_inset Flex Multiple Columns
26778 \begin_layout Plain Layout
26781 My observations of No.
26782 \begin_inset space \space{}
26785 427 Park Lane did little to clear up the problem in which I was interested.
26786 The house was separated from the street by a low wall and railing, the
26787 whole not more than five feet high.
26788 It was perfectly easy, therefore, for anyone to get into the garden, but
26789 the window was entirely inaccessible, since there was no water pipe or
26790 anything which could help the most active man to climb it.
26791 More puzzled than ever, I retraced my steps to Kensington.
26792 I had not been in my study five minutes when the maid entered to say that
26793 a person desired to see me.
26794 To my astonishment it was none other than my strange old book collector,
26795 his sharp, wizened face peering out from a frame of white hair, and his
26796 precious volumes, a dozen of them at least, wedged under his right arm.
26804 \begin_layout Standard
26808 \begin_layout Plain Layout
26820 \begin_inset Note Note
26823 \begin_layout Plain Layout
26824 go back to the default
26832 \begin_layout Subsubsection
26836 \begin_layout Standard
26837 Between the columns a rule with a width of the length
26838 \change_deleted -712698321 1501235428
26842 \change_inserted -712698321 1501235428
26844 \begin_inset Flex Code
26847 \begin_layout Plain Layout
26849 \change_inserted -712698321 1501235428
26862 If this rule width is set to 0
26863 \begin_inset space \thinspace{}
26866 pt (this is the default), the rule is suppressed.
26867 In the following example the rule is 2
26868 \begin_inset space \thinspace{}
26874 \begin_layout Standard
26878 \begin_layout Plain Layout
26884 columnseprule}{2pt}
26892 \begin_layout Standard
26893 \begin_inset Flex Multiple Columns
26896 \begin_layout Plain Layout
26899 \begin_inset Quotes eld
26902 You're surprised to see me, sir,
26903 \begin_inset Quotes erd
26906 said he, in a strange, croaking voice.
26909 \begin_layout Plain Layout
26912 I acknowledged that I was.
26915 \begin_layout Plain Layout
26918 \begin_inset Quotes eld
26921 Well, I've a conscience, sir, and when I chanced to see you go into this
26922 house, as I came hobbling after you, I thought to myself, I'll just step
26923 in and see that kind gentleman, and tell him that if I was a bit gruff
26924 in my manner there was not any harm meant, and that I am much obliged to
26925 him for picking up my books.
26926 \begin_inset Quotes erd
26932 \begin_layout Plain Layout
26935 \begin_inset Quotes eld
26938 You make too much of a trifle,
26939 \begin_inset Quotes erd
26944 \begin_inset Quotes eld
26947 May I ask how you knew who I was?
26948 \begin_inset Quotes erd
26954 \begin_layout Plain Layout
26957 \begin_inset Quotes eld
26960 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
26961 you'll find my little bookshop at the corner of Church Street, and very
26962 happy to see you, I am sure.
26963 Maybe you collect yourself, sir.
26967 \begin_inset space ~
26980 –a bargain, every one of them.
26981 With five volumes you could just fill that gap on that second shelf.
26982 It looks untidy, does it not, sir?
26983 \begin_inset Quotes erd
26994 \begin_layout Standard
26995 \begin_inset VSpace defskip
27001 \begin_layout Standard
27002 The rule can be colored by redefining the command
27003 \change_deleted -712698321 1501235439
27007 \change_inserted -712698321 1501235439
27009 \begin_inset Flex Code
27012 \begin_layout Plain Layout
27014 \change_inserted -712698321 1501235439
27027 This is done by inserting the command
27028 \change_deleted -712698321 1501235443
27030 \begin_inset Newline newline
27034 \change_inserted -712698321 1501235444
27038 \begin_layout LyX-Code
27043 columnseprulecolor}{
27046 \change_deleted -712698321 1501235445
27048 \begin_inset Newline newline
27052 \change_inserted -712698321 1501235446
27056 \begin_layout Standard
27057 as \SpecialChar TeX
27058 Code before the multicolumn inset.
27060 \change_deleted -712698321 1501235460
27062 \change_inserted -712698321 1501235457
27064 \begin_inset Flex Code
27067 \begin_layout Plain Layout
27069 \change_inserted -712698321 1501235462
27079 in this command by a color of your choice.
27080 You can use all pre- and self-defined colors.
27088 \begin_inset space ~
27093 for more information about pre- and self-defined colors.
27094 To go back to the default color insert the command
27095 \change_inserted -712698321 1501235474
27099 \begin_layout LyX-Code
27101 \change_deleted -712698321 1501235472
27102 \begin_inset Newline newline
27111 columnseprulecolor}{
27114 \change_inserted -712698321 1501235475
27118 \begin_layout Standard
27120 \change_deleted -712698321 1501235473
27121 \begin_inset Newline newline
27126 Here is the example with a cyan rule and 1
27127 \begin_inset space \thinspace{}
27130 cm column separation:
27133 \begin_layout Standard
27137 \begin_layout Plain Layout
27146 \begin_layout Plain Layout
27152 columnseprulecolor}{
27162 \begin_layout Standard
27163 \begin_inset Flex Multiple Columns
27166 \begin_layout Plain Layout
27169 \begin_inset Quotes eld
27172 You're surprised to see me, sir,
27173 \begin_inset Quotes erd
27176 said he, in a strange, croaking voice.
27179 \begin_layout Plain Layout
27182 I acknowledged that I was.
27185 \begin_layout Plain Layout
27188 \begin_inset Quotes eld
27191 Well, I've a conscience, sir, and when I chanced to see you go into this
27192 house, as I came hobbling after you, I thought to myself, I'll just step
27193 in and see that kind gentleman, and tell him that if I was a bit gruff
27194 in my manner there was not any harm meant, and that I am much obliged to
27195 him for picking up my books.
27196 \begin_inset Quotes erd
27202 \begin_layout Plain Layout
27205 \begin_inset Quotes eld
27208 You make too much of a trifle,
27209 \begin_inset Quotes erd
27214 \begin_inset Quotes eld
27217 May I ask how you knew who I was?
27218 \begin_inset Quotes erd
27224 \begin_layout Plain Layout
27227 \begin_inset Quotes eld
27230 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
27231 you'll find my little bookshop at the corner of Church Street, and very
27232 happy to see you, I am sure.
27233 Maybe you collect yourself, sir.
27237 \begin_inset space ~
27250 –a bargain, every one of them.
27251 With five volumes you could just fill that gap on that second shelf.
27252 It looks untidy, does it not, sir?
27253 \begin_inset Quotes erd
27264 \begin_layout Standard
27268 \begin_layout Plain Layout
27274 columnseprule}{0pt}
27277 \begin_layout Plain Layout
27283 columnseprulecolor}{
27291 \begin_inset Note Note
27294 \begin_layout Plain Layout
27295 go back to the default
27303 \begin_layout Section
27304 Non-standard Paragraph Shapes
27307 \begin_layout Standard
27310 as well as any other text processor uses by default rectangular paragraphs.
27311 For special cases like for example posters, invitation cards or poems you
27312 can modify the paragraph shape to one of your choice.
27313 This can be done by using the \SpecialChar LaTeX
27315 \change_deleted -712698321 1501236703
27317 \change_inserted -712698321 1501236703
27319 \begin_inset Flex Code
27322 \begin_layout Plain Layout
27325 \change_inserted -712698321 1501236703
27335 which is loaded by using in the document settings the module
27337 Custom paragraph shapes
27342 \begin_layout Subsection
27346 \begin_layout Standard
27351 provides the following shapes:
27354 \begin_layout Standard
27355 \begin_inset Tabular
27356 <lyxtabular version="3" rows="13" columns="3">
27357 <features booktabs="true" islongtable="true" longtabularalignment="center">
27358 <column alignment="left" valignment="middle" width="16col%">
27359 <column alignment="left" valignment="middle" width="40col%">
27360 <column alignment="left" valignment="middle" width="35col%">
27361 <row endhead="true">
27362 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
27365 \begin_layout Plain Layout
27374 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
27377 \begin_layout Plain Layout
27386 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
27389 \begin_layout Plain Layout
27399 <row interlinespace="default">
27400 <cell alignment="left" valignment="top" usebox="none">
27403 \begin_layout Plain Layout
27411 <cell alignment="left" valignment="top" usebox="none">
27414 \begin_layout Plain Layout
27417 Circle with circular hole (in the size of a CD/DVD)
27422 <cell alignment="left" valignment="top" usebox="none">
27425 \begin_layout Plain Layout
27428 Cannot be scaled, take care there is not too much text
27434 <row interlinespace="default">
27435 <cell alignment="left" valignment="top" usebox="none">
27438 \begin_layout Plain Layout
27446 <cell alignment="left" valignment="top" usebox="none">
27449 \begin_layout Plain Layout
27457 <cell alignment="left" valignment="top" usebox="none">
27460 \begin_layout Plain Layout
27463 Fragile, calculation might fail
27469 <row interlinespace="default">
27470 <cell alignment="left" valignment="top" usebox="none">
27473 \begin_layout Plain Layout
27481 <cell alignment="left" valignment="top" usebox="none">
27484 \begin_layout Plain Layout
27487 Rhomboid (symbolizing a
27488 \begin_inset Quotes eld
27492 \begin_inset Quotes erd
27500 <cell alignment="left" valignment="top" usebox="none">
27503 \begin_layout Plain Layout
27512 <row interlinespace="default">
27513 <cell alignment="left" valignment="top" usebox="none">
27516 \begin_layout Plain Layout
27524 <cell alignment="left" valignment="top" usebox="none">
27527 \begin_layout Plain Layout
27535 <cell alignment="left" valignment="top" usebox="none">
27538 \begin_layout Plain Layout
27547 <row interlinespace="default">
27548 <cell alignment="left" valignment="top" usebox="none">
27551 \begin_layout Plain Layout
27559 <cell alignment="left" valignment="top" usebox="none">
27562 \begin_layout Plain Layout
27570 <cell alignment="left" valignment="top" usebox="none">
27573 \begin_layout Plain Layout
27582 <row interlinespace="default">
27583 <cell alignment="left" valignment="top" usebox="none">
27586 \begin_layout Plain Layout
27594 <cell alignment="left" valignment="top" usebox="none">
27597 \begin_layout Plain Layout
27600 Nut for bolt (hexagon with circular hole)
27605 <cell alignment="left" valignment="top" usebox="none">
27608 \begin_layout Plain Layout
27617 <row interlinespace="default">
27618 <cell alignment="left" valignment="top" usebox="none">
27621 \begin_layout Plain Layout
27629 <cell alignment="left" valignment="top" usebox="none">
27632 \begin_layout Plain Layout
27640 <cell alignment="left" valignment="top" usebox="none">
27643 \begin_layout Plain Layout
27652 <row interlinespace="default">
27653 <cell alignment="left" valignment="top" usebox="none">
27656 \begin_layout Plain Layout
27664 <cell alignment="left" valignment="top" usebox="none">
27667 \begin_layout Plain Layout
27675 <cell alignment="left" valignment="top" usebox="none">
27678 \begin_layout Plain Layout
27687 <row interlinespace="default">
27688 <cell alignment="left" valignment="top" usebox="none">
27691 \begin_layout Plain Layout
27699 <cell alignment="left" valignment="top" usebox="none">
27702 \begin_layout Plain Layout
27710 <cell alignment="left" valignment="top" usebox="none">
27713 \begin_layout Plain Layout
27722 <row interlinespace="default">
27723 <cell alignment="left" valignment="top" usebox="none">
27726 \begin_layout Plain Layout
27734 <cell alignment="left" valignment="top" usebox="none">
27737 \begin_layout Plain Layout
27740 Normal/reversed rain drop
27745 <cell alignment="left" valignment="top" usebox="none">
27748 \begin_layout Plain Layout
27751 Fragile, calculation might fail
27757 <row interlinespace="default">
27758 <cell alignment="left" valignment="top" usebox="none">
27761 \begin_layout Plain Layout
27770 <cell alignment="left" valignment="top" usebox="none">
27773 \begin_layout Plain Layout
27776 The \SpecialChar TeX
27782 <cell alignment="left" valignment="top" usebox="none">
27785 \begin_layout Plain Layout
27794 <row interlinespace="default">
27795 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
27798 \begin_layout Plain Layout
27802 \begin_inset Newline newline
27810 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
27813 \begin_layout Plain Layout
27816 Triangles in different orientations
27821 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
27824 \begin_layout Plain Layout
27840 \begin_layout Standard
27841 To use a shape for your paragraph, simply select it in \SpecialChar LyX
27843 for environments in the toolbar.
27846 \begin_layout Standard
27847 \begin_inset Newpage newpage
27853 \begin_layout Standard
27854 Here is an example paragraph in the shape of a nut:
27857 \begin_layout Standard
27858 \begin_inset VSpace bigskip
27867 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
27868 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
27870 At vero eos et accusam et justo duo dolores et ea rebum.
27871 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
27873 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
27874 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
27878 \begin_layout Standard
27879 \begin_inset VSpace bigskip
27885 \begin_layout Standard
27886 \begin_inset Note Greyedout
27889 \begin_layout Plain Layout
27894 : shapepar paragraphs cannot run over a page break.
27902 \begin_layout Standard
27903 \begin_inset VSpace bigskip
27909 \begin_layout Standard
27911 \change_inserted -712698321 1501236716
27915 \change_deleted -712698321 1501236722
27919 \change_inserted -712698321 1501236723
27921 \begin_inset Flex Code
27924 \begin_layout Plain Layout
27926 \change_inserted -712698321 1501236723
27936 takes care that the shape will always be preserved, no matter how much
27937 text is in the paragraph.
27938 Therefore the paragraph size changes with the amount of contained text.
27939 This can lead to paragraph sizes exceeding the page margins.
27940 To demonstrate the size scaling, here is the same example paragraph but
27941 with twice as much text:
27944 \begin_layout Standard
27945 \begin_inset Newpage newpage
27954 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
27955 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
27957 At vero eos et accusam et justo duo dolores et ea rebum.
27958 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
27960 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
27961 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
27963 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
27964 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
27966 At vero eos et accusam et justo duo dolores et ea rebum.
27967 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
27969 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
27970 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
27974 \begin_layout Standard
27975 \begin_inset VSpace bigskip
27981 \begin_layout Standard
27982 An exception is the shape
27987 It cannot be scaled because it must fit the size of a CD/DVD.
27988 Therefore the amount of text that fits into the shape is limited.
27989 \begin_inset Newline newline
28000 shape are fragile, meaning that the calculation of their size can fail,
28001 depending on the amount of text.
28002 You will then get the \SpecialChar LaTeX
28004 \begin_inset Quotes eld
28007 Arithmetic overflow
28008 \begin_inset Quotes erd
28012 In this case one can try to remove or add some text; if nothing works one
28013 has to use another shape.
28016 \begin_layout Standard
28017 \begin_inset VSpace bigskip
28023 \begin_layout Standard
28024 For shapes with tips you will maybe see that \SpecialChar LaTeX
28025 's hyphenation routine fails
28026 for text in the tips.
28027 Therefore it is often necessary to add hyphenation points
28032 arg "specialchar-insert hyphenation"
28037 ) to the corresponding text parts.
28040 \begin_layout Standard
28041 \begin_inset VSpace bigskip
28047 \begin_layout Standard
28048 Shapepar paragraphs are either always centered or placed on the page so
28049 that their left border touches the left page margin.
28050 You can therefore not use the paragraph dialog to align such paragraphs.
28051 A solution is to put the paragraph into a minipage or parbox and align
28053 The problem is hereby to find the right width for the box.
28054 Because if it is too wide and you center the box, the paragraph is not
28055 centered too because it sticks at the left side of the box.
28056 So you might have to play a bit with the width until it fits.
28057 Here are two heart-shaped paragraphs, the first one is not aligned, the
28058 second one is right-aligned:
28061 \begin_layout Standard
28062 \begin_inset Newpage newpage
28068 \begin_layout Heart
28072 Lo\SpecialChar softhyphen
28073 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28074 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28076 At vero eos et accusam et justo duo dolores et ea rebum.
28077 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
28081 \begin_layout Standard
28082 \begin_inset VSpace bigskip
28088 \begin_layout Standard
28091 \begin_inset Box Frameless
28101 height_special "totalheight"
28106 backgroundcolor "none"
28109 \begin_layout Heart
28113 Lo\SpecialChar softhyphen
28114 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28115 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28117 At vero eos et accusam et justo duo dolores et ea rebum.
28118 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
28127 \begin_layout Subsection
28131 \begin_layout Standard
28132 You can define any shape you want.
28133 Doing this manually is a lot of work because every coordinate must be specified.
28134 But there is a way to let the computer calculate the coordinates:
28137 \begin_layout Enumerate
28138 Install the program
28139 \begin_inset CommandInset href
28142 target "http://www.ctan.org/tex-archive/graphics/jpgfdraw"
28150 \begin_layout Enumerate
28157 TeX/LaTeX\SpecialChar menuseparator
28158 Settings\SpecialChar menuseparator
28161 and select the font size you are using in your document.
28162 For example this document uses the size 12
28163 \begin_inset space \thinspace{}
28169 \begin_layout Enumerate
28173 \begin_layout Enumerate
28176 TeX/LaTeX\SpecialChar menuseparator
28179 to export the shape to coordinates.
28180 In the appearing dialog use either the outline of your shape for the coordinate
28181 s or the path itself.
28185 \begin_layout Plain Layout
28186 For more information see
28187 \begin_inset CommandInset href
28189 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
28202 \begin_layout Standard
28203 The coordinates are written into a \SpecialChar TeX
28205 To use it for your \SpecialChar LyX
28209 \begin_layout Enumerate
28210 Place the cursor before the first character of your paragraph (or into a
28214 \begin_layout Enumerate
28215 Open in \SpecialChar LyX
28218 Insert\SpecialChar menuseparator
28219 File\SpecialChar menuseparator
28221 \begin_inset space ~
28226 , select the file and use
28235 \begin_layout Standard
28236 \begin_inset VSpace defskip
28242 \begin_layout Standard
28243 \begin_inset Note Greyedout
28246 \begin_layout Plain Layout
28251 : The changed shape only applies to the current paragraph; everything is
28252 reset to normal for the next paragraph.
28253 Therefore the shape definition file must be input into every paragraph
28254 with the desired shape.
28262 \begin_layout Standard
28263 \begin_inset VSpace bigskip
28269 \begin_layout Standard
28270 Here is an example:
28273 \begin_layout Standard
28274 \begin_inset VSpace bigskip
28280 \begin_layout Standard
28281 \begin_inset CommandInset include
28283 filename "SpecialParagraphShape.tex"
28289 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28290 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28292 At vero eos et accusam et justo duo dolores et ea rebum.
28293 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
28295 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28296 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28300 \begin_layout Standard
28301 \begin_inset VSpace bigskip
28307 \begin_layout Standard
28312 to draw complexer shapes in
28316 you can draw the shape in a program of your choice and import the resulting
28322 Then you only need to draw a line or spline along the outline of the image.
28325 \begin_layout Standard
28326 \begin_inset VSpace bigskip
28332 \begin_layout Standard
28335 Custom paragraph shapes
28337 also provides the two commands
28345 which can be used to define custom shapes coordinate by coordinate.
28349 \begin_layout Plain Layout
28350 These commands are internally used for all shapes described here.
28355 For information how these styles are used and about further customization
28356 possibilities, have a look at the
28357 \change_inserted -712698321 1501236534
28361 \begin_inset CommandInset href
28363 name "documentation"
28364 target "http://mirrors.ctan.org/macros/latex/contrib/shapepar/shapepar.pdf"
28370 \change_deleted -712698321 1501236537
28376 \change_deleted -712698321 1501236618
28378 \change_inserted -712698321 1501236618
28380 \begin_inset Flex Code
28383 \begin_layout Plain Layout
28385 \change_inserted -712698321 1501236618
28394 \change_deleted -712698321 1501236618
28396 \begin_inset CommandInset citation
28406 \change_deleted -712698321 1501236666
28410 \begin_layout Bibliography
28412 \change_deleted -712698321 1501236522
28413 \begin_inset CommandInset bibitem
28414 LatexCommand bibitem
28420 Documentation of the \SpecialChar LaTeX
28422 \begin_inset CommandInset href
28425 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
28433 \begin_layout Bibliography
28435 \change_deleted -712698321 1501236522
28436 \begin_inset CommandInset bibitem
28437 LatexCommand bibitem
28443 Documentation of the \SpecialChar LaTeX
28445 \begin_inset CommandInset href
28448 target "http://mirrors.ctan.org/macros/latex/contrib/shapepar/shapepar.pdf"