1 #LyX 2.2 created this file. For more info see http://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 % DO NOT ALTER THIS PREAMBLE!!!
11 % This preamble is designed to ensure that the manual prints
12 % out as advertised. If you mess with this preamble,
13 % parts of the manual may not print out as expected. If you
14 % have problems LaTeXing this file, please contact
15 % the documentation team
16 % email: lyx-docs@lists.lyx.org
18 % the pages of the TOC are numbered roman
19 % and a PDF-bookmark for the TOC is added
21 \let\myTOC\tableofcontents
22 \renewcommand{\tableofcontents}{%
23 \pdfbookmark[1]{\contentsname}{}
26 \pagenumbering{arabic}}
28 % extra space for tables
29 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
31 \options fleqn,bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
32 \use_default_options false
40 \maintain_unincluded_children false
42 \language_package default
45 \font_roman "lmodern" "default"
46 \font_sans "lmss" "default"
47 \font_typewriter "lmtt" "default"
48 \font_math "auto" "auto"
49 \font_default_family default
50 \use_non_tex_fonts false
53 \font_sf_scale 100 100
54 \font_tt_scale 100 100
56 \default_output_format pdf2
58 \bibtex_command default
59 \index_command default
63 \pdf_title "LyX's Additional Features manual"
64 \pdf_author "LyX Team"
65 \pdf_subject "LyX's additional features documentation"
66 \pdf_keywords "LyX, Documentation, Additional"
68 \pdf_bookmarksnumbered true
69 \pdf_bookmarksopen false
70 \pdf_bookmarksopenlevel 1
75 \pdf_pdfusetitle false
76 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
79 \use_package amsmath 1
80 \use_package amssymb 1
83 \use_package mathdots 1
84 \use_package mathtools 0
86 \use_package stackrel 0
87 \use_package stmaryrd 0
88 \use_package undertilde 0
90 \cite_engine_type default
94 \paperorientation portrait
98 \notefontcolor #0000ff
105 \paragraph_separation indent
106 \paragraph_indentation default
107 \quotes_language english
110 \paperpagestyle headings
111 \tracking_changes false
112 \output_changes false
121 Additional \SpecialChar LyX
125 \begin_layout Subtitle
130 by the \SpecialChar LyX
135 \begin_layout Plain Layout
137 Principal maintainer of this file is
142 If you have comments or error corrections, please send them to the \SpecialChar LyX
145 \begin_inset Flex Code
148 \begin_layout Plain Layout
150 <lyx-docs@lists.lyx.org>
163 \begin_layout Standard
164 \begin_inset CommandInset toc
165 LatexCommand tableofcontents
172 \begin_layout Chapter
176 \begin_layout Standard
177 This manual is essentially Part II of the
179 User's Guide\SpecialChar endofsentence
182 The reason for separating the two documents is simple: the
186 is already quite lengthy, and it contains information on all of the basic
187 features one needs to know in order to prepare most documents.
188 However, the \SpecialChar LyX
189 Team has worked to make \SpecialChar LyX
190 extensible through various configuration
191 files and external packages.
192 That means that if you want to support the Fizzwizzle \SpecialChar LaTeX
194 create a layout file (or module) for it without having to alter \SpecialChar LyX
196 We've already had contributions of several new features this way, and some
197 of them are documented here.
198 There are also some more `advanced' features, such as how to control the
199 presentation of bibliographies and how to work with multi-part documents,
200 that are not covered in the
204 and are discussed here.
207 \begin_layout Standard
208 This manual also documents some special features, like fax support, version
209 control, and SGML support, which require additional software to work properly.
210 There is also a chapter on \SpecialChar LyX
212 And lastly, there's a chapter of \SpecialChar LaTeX
213 tools and tips, things you can use to
214 spruce up your documents by directly using the powerful features of \SpecialChar LaTeX
216 After all, \SpecialChar LyX
221 only WYSIWYM and will only ever interface to some, not all, \SpecialChar LaTeX
225 \begin_layout Standard
226 If you haven't read the
230 yet, you are definitely in the wrong manual.
235 is the first place to go, since it describes the notation and format of
237 You should also be thoroughly familiar with the
241 and all of the basic features of \SpecialChar LyX
242 before attempting to read this one.
245 \begin_layout Standard
246 Since many of the topics in this manual depend heavily on \SpecialChar LyX
248 with \SpecialChar LaTeX
249 , this first chapter covers the inner workings of \SpecialChar LyX
252 to generate exactly the \SpecialChar LaTeX
254 It is obviously for more seasoned \SpecialChar LyX
258 \begin_layout Chapter
260 and \SpecialChar LaTeX
264 \begin_layout Section
266 Uses \SpecialChar LaTeX
270 \begin_layout Standard
271 This chapter is for both \SpecialChar TeX
272 -nicians and the \SpecialChar LaTeX
274 In it, we'll explain how \SpecialChar LyX
275 and \SpecialChar LaTeX
276 work together to produce printable output.
277 This is the only place in any of the manuals where we assume you know something
278 about \SpecialChar LaTeX
282 \begin_layout Standard
283 At one time, \SpecialChar LyX
285 \begin_inset Quotes eld
288 WYSIWYM frontend to \SpecialChar LaTeX
290 \begin_inset Quotes erd
293 but that's no longer true.
294 There are frontends to \SpecialChar LaTeX
299 \begin_layout Plain Layout
300 Some familar ones are \SpecialChar TeX
301 maker and kile, on Linux, and \SpecialChar TeX
303 There are also the \SpecialChar LaTeX
304 modes for vi and emacs, of course.
309 These are basically text editors with the ability to run \SpecialChar LaTeX
311 errors in the file you're editing.
312 Although \SpecialChar LyX
321 run \SpecialChar LaTeX
322 , and it also indicates errors in the file, it also does much, much
324 For one thing, you don't need to know \SpecialChar LaTeX
325 to use \SpecialChar LyX
328 has added its own extensions to \SpecialChar LaTeX
330 Try the following sometime: select
331 \begin_inset Flex Noun
334 \begin_layout Plain Layout
335 Export\SpecialChar menuseparator
342 \begin_inset Flex Noun
345 \begin_layout Plain Layout
352 \begin_inset Flex Noun
355 \begin_layout Plain Layout
356 View\SpecialChar menuseparator
366 ), then look at the preamble of the resulting
367 \begin_inset Flex Code
370 \begin_layout Plain Layout
377 You'll notice a variety of new macros defined specifically by \SpecialChar LyX
379 These macros are defined automatically, according to the features you use
383 \begin_layout Standard
384 There are several commands that automatically invoke \SpecialChar LaTeX
389 \begin_layout Itemize
390 \begin_inset Flex Noun
393 \begin_layout Plain Layout
394 Document\SpecialChar menuseparator
403 \begin_layout Itemize
404 \begin_inset Flex Noun
407 \begin_layout Plain Layout
408 Document\SpecialChar menuseparator
417 \begin_layout Standard
418 They will only invoke \SpecialChar LaTeX
419 if the file has changed since the last time \SpecialChar LaTeX
425 \begin_layout Standard
426 When \SpecialChar LyX
427 runs \SpecialChar LaTeX
428 on the file you're editing, it performs these steps:
431 \begin_layout Enumerate
432 Convert the document to \SpecialChar LaTeX
433 and save to a file with the extension
434 \begin_inset Flex Code
437 \begin_layout Plain Layout
444 \begin_inset Flex Code
447 \begin_layout Plain Layout
456 \begin_layout Enumerate
457 Run \SpecialChar LaTeX
459 \begin_inset Flex Code
462 \begin_layout Plain Layout
468 file (maybe several times), and run any other commands (such as
469 \begin_inset Flex Code
472 \begin_layout Plain Layout
479 \begin_inset Flex Code
482 \begin_layout Plain Layout
488 ) needed to compile the \SpecialChar LaTeX
492 \begin_layout Enumerate
493 If there are any errors, show the error log.
496 \begin_layout Standard
497 If you have run \SpecialChar LaTeX
499 \begin_inset Flex Noun
502 \begin_layout Plain Layout
503 View\SpecialChar menuseparator
510 then runs a DVI viewer to display the DVI-file.
512 \begin_inset Flex Noun
515 \begin_layout Plain Layout
516 View\SpecialChar menuseparator
523 performs further steps:
526 \begin_layout Itemize
528 \begin_inset Flex Code
531 \begin_layout Plain Layout
537 to convert the DVI file to PostScript.
540 \begin_layout Itemize
541 Run a PostScript viewer, such as
542 \begin_inset Flex Code
545 \begin_layout Plain Layout
551 , to display the PostScript file.
554 \begin_layout Standard
556 does similar things when viewing, or exporting, other formats.
559 \begin_layout Section
560 Translating \SpecialChar LaTeX
561 files into \SpecialChar LyX
565 \begin_layout Standard
566 You can import a \SpecialChar LaTeX
567 file into \SpecialChar LyX
569 \begin_inset Flex Noun
572 \begin_layout Plain Layout
573 File\SpecialChar menuseparator
574 Import\SpecialChar menuseparator
580 command in \SpecialChar LyX
582 This will call a program named
583 \begin_inset Flex Code
586 \begin_layout Plain Layout
592 which will create a file
593 \begin_inset Flex Code
596 \begin_layout Plain Layout
603 \begin_inset Flex Code
606 \begin_layout Plain Layout
614 will then open that file.
618 \begin_layout Plain Layout
619 \begin_inset Flex Code
622 \begin_layout Plain Layout
628 can also be run from the command line, of course.
636 \begin_layout Standard
637 \begin_inset Flex Code
640 \begin_layout Plain Layout
646 will translate most legal \SpecialChar LaTeX
647 , but not everything.
648 It will put things it doesn't understand into \SpecialChar TeX
649 code, so after translating
651 \begin_inset Flex Code
654 \begin_layout Plain Layout
660 , you can look for \SpecialChar TeX
661 code and hand-edit it until it looks right.
664 \begin_layout Standard
665 If you don't know what \SpecialChar TeX
666 code is, read the next section.
669 \begin_layout Section
670 \begin_inset CommandInset label
672 name "sec:Inserting-TeX-Code"
676 Inserting \SpecialChar TeX
677 Code into \SpecialChar LyX
681 \begin_layout Standard
682 Anything you can do in \SpecialChar LaTeX
683 you can do in \SpecialChar LyX
684 , for a very simple reason: You can
685 always insert \SpecialChar TeX
686 code into any \SpecialChar LyX
689 cannot, and will never be able to, display every possible \SpecialChar LaTeX
691 If ever you need to insert \SpecialChar LaTeX
692 commands into your \SpecialChar LyX
693 document, you can use the
695 \begin_inset Flex Code
698 \begin_layout Plain Layout
705 box, which you can insert into your document with
706 \begin_inset Flex Noun
709 \begin_layout Plain Layout
710 Insert\SpecialChar menuseparator
720 or the keyboard shortcut
729 \begin_layout Standard
730 Here's an example of inserting \SpecialChar LaTeX
731 commands in a \SpecialChar LyX
733 The code looks like this:
736 \begin_layout LyX-Code
740 \begin_inset Newline newline
746 \begin_inset Newline newline
749 This is an example of a minipage environment.
751 \begin_inset Newline newline
754 can put nearly everything in it, even (non-floating)
755 \begin_inset Newline newline
760 \begin_inset Newline newline
766 \begin_inset Newline newline
770 \begin_inset Newline newline
776 \begin_inset Newline newline
782 \begin_inset Newline newline
788 \begin_inset Newline newline
793 \begin_inset Newline newline
799 \begin_inset Newline newline
805 \begin_inset Newline newline
811 \begin_inset Newline newline
819 \begin_layout LyX-Code
823 \begin_layout Standard
825 \begin_inset Flex Code
828 \begin_layout Plain Layout
835 box containing this text is directly after this paragraph.
836 Those of you reading the manual in \SpecialChar LyX
837 will only see the \SpecialChar TeX
839 Those reading a printed version of the manuals will see the actual results:
840 \begin_inset VSpace bigskip
846 \begin_layout Standard
850 \begin_layout Plain Layout
857 \begin_layout Plain Layout
864 \begin_layout Plain Layout
866 This is an example of a minipage environment.
867 You can put nearly everything in it, even (non-floating) figures and tables.
871 \begin_layout Plain Layout
878 \begin_layout Plain Layout
883 \begin_layout Plain Layout
890 \begin_layout Plain Layout
897 \begin_layout Plain Layout
904 \begin_layout Plain Layout
910 \begin_layout Plain Layout
917 \begin_layout Plain Layout
924 \begin_layout Plain Layout
931 \begin_layout Plain Layout
941 \begin_inset VSpace bigskip
947 \begin_layout Standard
948 In addition to using \SpecialChar TeX
949 code, you can also create a separate file containing
950 some complex \SpecialChar LaTeX
951 structure and then use
952 \begin_inset Flex Noun
955 \begin_layout Plain Layout
956 Insert\SpecialChar menuseparator
966 to include your file (you should select the type
967 \begin_inset Flex Code
970 \begin_layout Plain Layout
977 We recommend that you only do this if you have a
978 \begin_inset Flex Code
981 \begin_layout Plain Layout
992 Otherwise, you'll have a big job tracking down \SpecialChar LaTeX
996 \begin_layout Standard
997 There are a few last points to emphasize:
1000 \begin_layout Itemize
1006 check if your \SpecialChar LaTeX
1010 \begin_layout Itemize
1011 Beware of reinventing the wheel.
1014 \begin_layout Standard
1015 On that last point, \SpecialChar LyX
1016 does have quite a few features tucked into it, and
1018 Be sure to check the manuals to make sure that \SpecialChar LyX
1019 doesn't have such-and-such
1020 feature before you decide you have to do it by hand.
1021 Moreover, there are numerous \SpecialChar LaTeX
1022 packages out there to do all sorts of things,
1023 from labels to envelopes to fancy multipage tables.
1025 \begin_inset CommandInset href
1028 target "http://www.ctan.org/"
1035 \begin_layout Standard
1036 If you do need to do some wild and fancy things within your document, be
1037 sure to check out a good \SpecialChar LaTeX
1038 book for assistance.
1039 There are a number of them listed in the bibliography of the
1046 \begin_layout Section
1048 and the \SpecialChar LaTeX
1052 \begin_layout Subsection
1053 About the \SpecialChar LaTeX
1057 \begin_layout Standard
1058 If you already know \SpecialChar LaTeX
1059 , there is no need to explain here what the preamble
1061 If you don't, the following will give you some ideas—we recommend again
1062 that you consult a \SpecialChar LaTeX
1063 book for further information.
1064 In any case, you should read the points below, because they explain what
1065 you can do and what you don't need to do in the \SpecialChar LaTeX
1066 preamble of a \SpecialChar LyX
1070 \begin_layout Standard
1071 The \SpecialChar LaTeX
1072 preamble comes at the very beginning of a document,
1080 \begin_layout Itemize
1081 Declare the document class.
1083 \begin_inset Newline newline
1087 already does this for you.
1088 If you're a seasoned \SpecialChar LaTeX
1089 -nician, and you have a custom document class you
1090 want to use, check out the
1092 Customization Manual
1094 for information on how to make \SpecialChar LyX
1098 \begin_layout Itemize
1099 Declare the usage of packages.
1101 \begin_inset Newline newline
1105 packages provide special commands, which are only available within a document
1106 when the package has been declared in the preamble.
1107 In addition to providing special commands, the inclusion of a package can
1108 change the document.
1109 For example, the package
1110 \begin_inset Flex Code
1113 \begin_layout Plain Layout
1119 forces all paragraphs to be indented.
1120 There are other packages for labels, envelopes, margins, etc.
1124 \begin_layout Itemize
1125 Set counters, variables, lengths and widths.
1127 \begin_inset Newline newline
1130 There are several \SpecialChar LaTeX
1131 counters and variables that
1135 be set globally from within the preamble in order to have the desired effect.
1136 (There are variables that you can set and reset inside the document, too.)
1137 Margins are a good example of something that must be set in the preamble.
1138 Another example is the label format for lists.
1139 You can actually set these just about anywhere, but it's best to do it
1140 just once, inside the preamble.
1143 \begin_layout Itemize
1144 Declare user defined commands (with
1145 \begin_inset Flex Code
1148 \begin_layout Plain Layout
1157 \begin_inset Flex Code
1160 \begin_layout Plain Layout
1169 \begin_inset Newline newline
1172 These are abbreviations for \SpecialChar LaTeX
1173 commands which appear very often inside a document.
1174 Although the preamble is a good place to declare such commands, they
1178 be declared anywhere (before they are used for the first time, of course).
1179 This can be useful if there is a lot of raw \SpecialChar LaTeX
1180 code in your document, which
1181 normally should not be the case.
1184 \begin_layout Standard
1186 adds its own set of definitions to the preamble of the
1187 \begin_inset Flex Code
1190 \begin_layout Plain Layout
1197 This makes \SpecialChar LaTeX
1198 files generated by \SpecialChar LyX
1202 \begin_layout Subsection
1203 Changing the Preamble
1206 \begin_layout Standard
1207 The commands which \SpecialChar LyX
1208 adds to the preamble of a \SpecialChar LaTeX
1209 file are fixed; you can't
1210 change them without patching \SpecialChar LyX
1212 You can, however, add your own stuff to the preamble by selecting
1213 \begin_inset Flex Noun
1216 \begin_layout Plain Layout
1219 \begin_inset space ~
1228 \begin_inset Flex Noun
1231 \begin_layout Plain Layout
1232 Document\SpecialChar menuseparator
1240 adds anything in the
1241 \begin_inset Flex Noun
1244 \begin_layout Plain Layout
1250 dialog to its own built-in preamble.
1251 Before adding your own declarations in the preamble, you should make sure
1252 that \SpecialChar LyX
1253 doesn't already support what you want to do.
1254 (Remember what we said about reinventing the wheel?) Also,
1256 make sure your preamble code is correct
1260 doesn't check it for you.
1261 If there is an error, you're likely to get an error like
1262 \begin_inset Quotes eld
1266 \begin_inset Flex Code
1269 \begin_layout Plain Layout
1278 \begin_inset Quotes erd
1282 If you see this error, check your preamble.
1285 \begin_layout Subsection
1289 \begin_layout Standard
1290 Here are some examples of what you can add to a preamble, and what they
1294 \begin_layout Subsubsection
1298 \begin_layout Standard
1299 There are two variables under \SpecialChar LaTeX
1300 that control page position:
1301 \begin_inset Flex Code
1304 \begin_layout Plain Layout
1313 \begin_inset Flex Code
1316 \begin_layout Plain Layout
1325 Their names should be self-explanatory.
1326 These variables are useful if you think for a moment about computer labels.
1327 Sometimes, the size of a print medium and the area of the medium that you
1328 can actually print on aren't the same.
1330 \begin_inset Flex Code
1333 \begin_layout Plain Layout
1342 \begin_inset Flex Code
1345 \begin_layout Plain Layout
1356 \begin_layout Standard
1357 The default values for
1358 \begin_inset Flex Code
1361 \begin_layout Plain Layout
1370 \begin_inset Flex Code
1373 \begin_layout Plain Layout
1382 \begin_inset space \thinspace{}
1386 \begin_inset space \thinspace{}
1390 \begin_inset space \space{}
1393 the page isn't shifted.
1394 Unfortunately, some DVI drivers always seem to shift the page.
1395 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1396 If you're using \SpecialChar LyX
1397 on a system that you don't personally maintain, and your
1398 sysadmin is a doofus,
1399 \begin_inset Flex Code
1402 \begin_layout Plain Layout
1411 \begin_inset Flex Code
1414 \begin_layout Plain Layout
1423 Suppose your left and top margins are always 0.5
1424 \begin_inset space \thinspace{}
1428 You can add this to the preamble:
1431 \begin_layout LyX-Code
1439 \begin_layout LyX-Code
1447 \begin_layout Standard
1448 and your margins should now be correct.
1451 \begin_layout Subsubsection
1455 \begin_layout Standard
1456 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1457 There's a rather nice package, available at your nearest CTAN archive,
1458 for printing sheets of labels:
1459 \begin_inset Flex Code
1462 \begin_layout Plain Layout
1469 Now, your system may not have this package installed by default.
1470 We leave that up to you to check.
1471 You'll also want to read the documentation for it; we're not going to do
1473 Since this is an example, however, we'll give you an example of how you
1477 \begin_layout Standard
1478 First, make sure you're using the
1479 \begin_inset Flex Code
1482 \begin_layout Plain Layout
1489 Next, you need to put the following in your preamble:
1492 \begin_layout LyX-Code
1498 \begin_layout LyX-Code
1504 \begin_layout LyX-Code
1510 \begin_layout LyX-Code
1516 \begin_layout LyX-Code
1522 \begin_layout LyX-Code
1528 \begin_layout LyX-Code
1534 \begin_layout Standard
1535 This sets things up for Avery label sheets, stock #5360.
1536 You're now ready to print labels, but you'll need to insert \SpecialChar LaTeX
1539 \begin_inset Flex Code
1542 \begin_layout Plain Layout
1551 \begin_inset Flex Code
1554 \begin_layout Plain Layout
1562 around each label text.
1563 This and other special features of
1564 \begin_inset Flex Code
1567 \begin_layout Plain Layout
1573 are explained in its documentation.
1576 \begin_layout Standard
1577 Someday, someone may write a \SpecialChar LyX
1578 layout file to support this package directly.
1579 Maybe that someone is you.
1582 \begin_layout Subsubsection
1583 Example #3: Paragraph Indentation
1586 \begin_layout Standard
1587 Americans are trained to indent the first line of
1592 As with all of their other weird quirks, most Americans will whine and
1593 moan until they can have their way and indent the first line of all paragraphs.
1602 \begin_layout Standard
1603 Of course, this behavior isn't standard typography.
1604 In books, you typically only indent the first line of a paragraph
1608 it follows another one.
1609 The idea behind indenting the first line of a paragraph is to distinguish
1610 neighboring paragraphs from one another.
1611 If there is no previous paragraph—for example, if it follows a figure or
1612 is the first paragraph in a section—then there is no need for indentation.
1616 \begin_layout Standard
1617 If you're a typical American (we're still joking!), though, you don't care
1618 about such esoteric things; you want your indentation! Add this to the
1622 \begin_layout LyX-Code
1625 usepackage{indentfirst}
1628 \begin_layout Standard
1629 If your \SpecialChar TeX
1630 distribution isn't braindead, you'll have this package, and all
1631 of your paragraphs will get the indentation the Founding Fathers intended
1635 \begin_layout Subsubsection
1636 Example #4: This Document
1639 \begin_layout Standard
1640 You can also check out the preamble of this document to get an idea of some
1641 of the advanced things you can do.
1644 \begin_layout Section
1646 and \SpecialChar LaTeX
1650 \begin_layout Standard
1651 When \SpecialChar LyX
1652 calls \SpecialChar LaTeX
1653 , it tells \SpecialChar LaTeX
1654 to blithely ignore any errors and keep going.
1655 It then uses the logfile from the \SpecialChar LaTeX
1656 run to do a post-mortem.
1657 After analyzing the logfile, \SpecialChar LyX
1658 displays a dialog listing the errors.
1659 Clicking on any one of them will take you to the position in your \SpecialChar LyX
1661 where the error occurred.
1665 \begin_layout Plain Layout
1667 Analyzing the logfile is a tough job, and \SpecialChar LyX
1668 doesn't always go to the right
1670 There are also cases where \SpecialChar LaTeX
1671 reports the error on one line, but the actual
1673 This is not unlike forgetting a closing brace in a program: You'll get
1674 an error, but only later.
1682 \begin_layout Standard
1683 Some folks also like to look at the log file directly: It is available from
1685 \begin_inset Flex Noun
1688 \begin_layout Plain Layout
1689 Document\SpecialChar menuseparator
1691 \begin_inset space ~
1700 There are some fairly common error messages and warnings.
1701 We'll cover those here.
1702 You should look at a good \SpecialChar LaTeX
1703 book for a complete listing.
1706 \begin_layout Itemize
1707 \begin_inset Flex Code
1710 \begin_layout Plain Layout
1717 \begin_inset Newline newline
1720 Anything beginning with these words is a warning message for the purpose
1722 \begin_inset Quotes eld
1726 \begin_inset Quotes erd
1729 the \SpecialChar LaTeX
1731 You'll get messages like this if you added or changed cross-references
1732 or bibliography entries, in which case, \SpecialChar LaTeX
1733 is trying to tell you that you
1734 need to make another run.
1735 You can by-and-large ignore these.
1738 \begin_layout Itemize
1739 \begin_inset Flex Code
1742 \begin_layout Plain Layout
1749 \begin_inset Newline newline
1752 Another warning message, this time about fonts which \SpecialChar LaTeX
1754 The rest of the message will often say something about a replacement font
1755 that \SpecialChar LaTeX
1757 You can safely ignore these, too.
1760 \begin_layout Itemize
1761 \begin_inset Flex Code
1764 \begin_layout Plain Layout
1773 \begin_inset Newline newline
1782 They are warnings about lines that were too long and run past the right
1784 Almost always, this is unnoticeable in the final output.
1785 (It can be just a point or two.) Or, only one or two characters extend past
1788 seems to generate at least one of these messages for just about any document
1790 \begin_inset Newline newline
1793 You can ignore these messages.
1794 Your eyes will tell you if there's a problem with something that's too
1795 wide; just look at the output.
1799 \begin_layout Plain Layout
1800 You can also enable the `draft' option in
1801 \begin_inset Flex Noun
1804 \begin_layout Plain Layout
1805 Document\SpecialChar menuseparator
1811 , and then \SpecialChar LaTeX
1812 will draw a black box in the margin of lines that are overfull.
1820 \begin_layout Itemize
1821 \begin_inset Flex Code
1824 \begin_layout Plain Layout
1833 \begin_inset Newline newline
1836 Not quite as common as its cousin.
1838 seems to like to print lines that are a bit too wide as opposed to ones
1839 that are a bit too narrow.
1840 We have no idea why.
1843 \begin_layout Itemize
1844 \begin_inset Flex Code
1847 \begin_layout Plain Layout
1856 \begin_inset Flex Code
1859 \begin_layout Plain Layout
1868 \begin_inset Newline newline
1871 Warnings about troubles breaking the page.
1872 Once again, just look at the output.
1873 Your eyes will tell you where something has gone wrong.
1876 \begin_layout Itemize
1877 \begin_inset Flex Code
1880 \begin_layout Plain Layout
1882 \begin_inset Quotes els
1886 \begin_inset Quotes ers
1895 \begin_inset Newline newline
1899 \begin_inset Quotes eld
1903 \begin_inset Quotes erd
1906 isn't installed on this system.
1907 This usually appears because some package your document needs isn't installed.
1908 If you didn't touch the preamble or didn't use the
1909 \begin_inset Flex Code
1912 \begin_layout Plain Layout
1920 command, then one of the packages \SpecialChar LyX
1921 tried to load is missing.
1923 \begin_inset Flex Noun
1926 \begin_layout Plain Layout
1927 Help\SpecialChar menuseparator
1934 to get a list of packages that \SpecialChar LyX
1936 This file is updated whenever you reconfigure \SpecialChar LyX
1938 \begin_inset Flex Noun
1941 \begin_layout Plain Layout
1942 Tools\SpecialChar menuseparator
1948 ) and tells you which packages have been detected and what they do.
1949 \begin_inset Newline newline
1953 \begin_inset Flex Code
1956 \begin_layout Plain Layout
1964 command and the package in question isn't installed, then you'll need to
1965 install it yourself.
1968 \begin_layout Itemize
1969 \begin_inset Flex Code
1972 \begin_layout Plain Layout
1973 LaTeX Error: Unknown option
1979 \begin_inset Newline newline
1982 Error messages beginning with this are trying to tell you that you specified
1983 a bad or undefined option to a package.
1984 Check the package's documentation.
1987 \begin_layout Itemize
1988 \begin_inset Flex Code
1991 \begin_layout Plain Layout
1992 Undefined control sequence
1998 \begin_inset Newline newline
2001 If you've inserted \SpecialChar LaTeX
2002 code into your document, but made a typo, you'll get
2004 You may have forgotten to load a package.
2005 In any case, this error message usually means that you used an undefined
2010 \begin_layout Standard
2011 There are other error and warning messages.
2012 Some are self-explanatory.
2013 These are usually \SpecialChar LaTeX
2015 Others are downright cryptic.
2016 These are usually \SpecialChar TeX
2017 error messages, and we really have
2021 what they mean or how to decipher them.
2025 \begin_layout Standard
2026 There's a general sequence you should follow if you get error messages:
2029 \begin_layout Enumerate
2030 Look at the \SpecialChar LaTeX
2031 code you inserted for typos.
2034 \begin_layout Enumerate
2035 If there are no typos, check that you used the command(s) correctly.
2038 \begin_layout Enumerate
2039 If you get a bunch of error boxes piled up at the very top of the document—and
2040 especially if you see a
2041 \begin_inset Quotes eld
2045 \begin_inset Flex Code
2048 \begin_layout Plain Layout
2057 \begin_inset Quotes erd
2060 error—it means that there are errors in the preamble.
2061 Start debugging your preamble.
2064 \begin_layout Enumerate
2065 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2067 document, the first suspect is your \SpecialChar LaTeX
2068 distribution itself.
2069 Check for missing packages and install them.
2072 \begin_layout Enumerate
2073 Okay, so there are no missing packages.
2074 Did you use any of the fine-tuning options in \SpecialChar LyX
2075 ? Specifically, did you
2079 any of them, like trying to manually insert lots of
2080 \begin_inset Flex Code
2083 \begin_layout Plain Layout
2085 \begin_inset space ~
2094 \begin_inset Flex Code
2097 \begin_layout Plain Layout
2104 \begin_inset Flex Code
2107 \begin_layout Plain Layout
2113 ? Did you try to kludge something together with these instead of using the
2114 appropriate paragraph environment?
2117 \begin_layout Enumerate
2118 All right, you didn't use any of the fine-tuning options, you played by
2120 Did you try to pull a fancy maneuver? Did you do something funky inside
2121 a table or an equation, like inserting a graphic into a table cell?
2124 \begin_layout Enumerate
2125 Do you have long sections of text where \SpecialChar LaTeX
2126 cannot find a place to break a
2127 line? By default, \SpecialChar LaTeX
2128 is rather strict about how much extra inter-word spacing
2129 it will add in order to break a line.
2130 Preferably, you should rework the paragraph to avoid the problem.
2133 \begin_layout Enumerate
2134 Did you go overboard with the nesting? \SpecialChar LyX
2135 (currently) doesn't check to make
2136 sure you're in the limits for nesting environments.
2137 If you nested a bunch of environments to the
2138 \begin_inset Formula $17^{\mathrm{th}}$
2141 level, that's the problem.
2142 (The limit in \SpecialChar LaTeX
2146 \begin_layout Enumerate
2147 Okay, you didn't get any error messages, but your output looks awful.
2148 If you have a table or figure that's too wide or long for the page, you
2150 \begin_inset Separator latexpar
2157 \begin_layout Enumerate
2158 rescale the figure so it fits.
2161 \begin_layout Enumerate
2162 trim down the table so it fits.
2166 \begin_layout Enumerate
2167 If something else is wrong with the output, and you didn't try to pull anything
2168 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2171 \begin_layout Standard
2172 If all this doesn't help—well, then
2176 you might have found a bug in \SpecialChar LyX
2181 \begin_layout Chapter
2185 \begin_layout Section
2186 Customizing Bibliographies with Bib\SpecialChar TeX
2190 \begin_layout Standard
2191 The most basic information about how to use Bib\SpecialChar TeX
2192 with \SpecialChar LyX
2196 Bibliography databases (Bib\SpecialChar TeX
2204 The following subsections explain special bibliography features supported
2209 \begin_layout Subsection
2210 Alternative Citation Styles
2213 \begin_layout Standard
2214 Standard Bib\SpecialChar TeX
2216 \begin_inset space \thinspace{}
2220 \begin_inset space \space{}
2224 \begin_inset Quotes eld
2228 \begin_inset Quotes erd
2231 ) to refer to a cited work.
2232 However, in many scientific disciplines, other citation styles are in use.
2233 The most common one is the author-year style (e.
2234 \begin_inset space \thinspace{}
2238 \begin_inset space \space{}
2242 \begin_inset Quotes eld
2246 \begin_inset Quotes erd
2251 supports two packages that provide this style,
2252 \begin_inset Flex Code
2255 \begin_layout Plain Layout
2262 \begin_inset Flex Code
2265 \begin_layout Plain Layout
2272 Both packages have their pros and cons, which cannot be listed in detail.
2273 If you only want to have simple author-year (or author-numerical) style,
2274 or if you want to use one of the countless style files for
2275 \begin_inset Flex Code
2278 \begin_layout Plain Layout
2284 , then the established
2285 \begin_inset Flex Code
2288 \begin_layout Plain Layout
2294 package is probably your choice.
2295 If you need special features like short title references, ibidem etc., you
2297 \begin_inset Flex Code
2300 \begin_layout Plain Layout
2309 \begin_layout Standard
2310 The handling of both packages in \SpecialChar LyX
2311 is basically the same.
2313 \begin_inset Flex Noun
2316 \begin_layout Plain Layout
2317 Document\SpecialChar menuseparator
2324 \begin_inset Flex Noun
2327 \begin_layout Plain Layout
2334 \begin_inset Flex Noun
2337 \begin_layout Plain Layout
2344 \begin_inset Flex Noun
2347 \begin_layout Plain Layout
2354 With both packages, you will get some extra features in the citation dialog
2355 and you can select the style of the reference (
2356 \begin_inset Quotes eld
2360 \begin_inset Quotes erd
2364 \begin_inset Quotes eld
2368 \begin_inset Quotes erd
2372 \begin_inset Quotes eld
2376 \begin_inset Quotes erd
2380 \begin_inset Quotes eld
2384 \begin_inset Quotes erd
2388 Note that both packages need specifically designed style files.
2389 They both ship their own, but there are lots of additional style files,
2390 and there is even an interactive style file builder
2394 \begin_layout Plain Layout
2396 \begin_inset Flex URL
2399 \begin_layout Plain Layout
2401 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2412 \begin_inset Flex Code
2415 \begin_layout Plain Layout
2424 \begin_layout Subsection
2425 Sectioned Bibliographies
2428 \begin_layout Standard
2429 Sometimes you might need to divide your bibliography into several sections.
2430 If you are for instance a historian, the possibility to separate sources
2431 and scientific works is most likely a
2432 \begin_inset Quotes eld
2436 \begin_inset Quotes erd
2440 Unfortunately, Bib\SpecialChar TeX
2441 itself does not allow you to do this.
2442 But with the help of some \SpecialChar LaTeX
2443 packages, Bib\SpecialChar TeX
2444 can be extended to fit your needs.
2447 \begin_layout Standard
2449 provides native support for one of these packages,
2457 \begin_layout Plain Layout
2459 \begin_inset Flex URL
2462 \begin_layout Plain Layout
2464 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2474 The advantage of this package (compared to other packages like
2478 ) is that you don't need to define new citation commands.
2479 Instead, you need to prepare different bibliographic databases which include
2480 the entries for the different sections of the bibliography.
2481 For example: If you want to divide your bibliography into the sections
2483 \begin_inset Quotes eld
2487 \begin_inset Quotes erd
2491 \begin_inset Quotes eld
2495 \begin_inset Quotes erd
2498 , you first need to create two bibliographic databases, e.
2499 \begin_inset space \thinspace{}
2503 \begin_inset space \space{}
2507 \begin_inset Flex Code
2510 \begin_layout Plain Layout
2517 \begin_inset Flex Code
2520 \begin_layout Plain Layout
2530 \begin_layout Standard
2532 \begin_inset Flex Noun
2535 \begin_layout Plain Layout
2536 Document\SpecialChar menuseparator
2543 \begin_inset Flex Noun
2546 \begin_layout Plain Layout
2553 \begin_inset Flex Noun
2556 \begin_layout Plain Layout
2557 Sectioned bibliography
2563 Now you can insert multiple Bib\SpecialChar TeX
2564 bibliographies, one for each section of
2566 Returning to our example: Insert the Bib\SpecialChar TeX
2568 \begin_inset Flex Code
2571 \begin_layout Plain Layout
2577 and a second one for the database
2578 \begin_inset Flex Code
2581 \begin_layout Plain Layout
2588 You are free to use the same or different styles for each section.
2589 Additionally, you can choose if the bibliography section should contain
2591 \begin_inset Quotes eld
2594 all cited references
2595 \begin_inset Quotes erd
2598 of the specified database(s) (which is the default),
2599 \begin_inset Quotes eld
2602 all uncited references
2603 \begin_inset Quotes erd
2607 \begin_inset Quotes eld
2611 \begin_inset Quotes erd
2615 This might be useful if you would like to separate your bibliography into
2617 \begin_inset Quotes eld
2621 \begin_inset Quotes erd
2625 \begin_inset Quotes eld
2629 \begin_inset Quotes erd
2633 \begin_inset Quotes eld
2637 \begin_inset Quotes erd
2641 The titles for the sections can be added as ordinary sections or subsections.
2643 \begin_inset Flex Code
2646 \begin_layout Plain Layout
2652 removes the bibliography title, you have to manually re-add that, too (as
2653 a chapter* or section*, for instance).
2656 \begin_layout Subsection
2657 Multiple Bibliographies
2660 \begin_layout Standard
2661 Multiple bibliographies, e.
2662 \begin_inset space \thinspace{}
2666 \begin_inset space \space{}
2669 a bibliography for each section or chapter of the document, are not supported
2670 by Bib\SpecialChar TeX
2673 \begin_inset Flex Code
2676 \begin_layout Plain Layout
2682 package, which is used for the creation of sectioned bibliographies in
2684 (see the previous section), provides an easy way to solve this task, if
2685 you are willing to use some
2686 \begin_inset Flex Noun
2689 \begin_layout Plain Layout
2697 \begin_inset space ~
2701 \begin_inset CommandInset ref
2703 reference "sec:Inserting-TeX-Code"
2711 \begin_layout Plain Layout
2712 An alternative approach is to use the
2713 \begin_inset Flex Code
2716 \begin_layout Plain Layout
2723 \begin_inset Flex Code
2726 \begin_layout Plain Layout
2732 package, respectively.
2740 \begin_layout Standard
2742 \begin_inset Flex Noun
2745 \begin_layout Plain Layout
2746 Document\SpecialChar menuseparator
2753 \begin_inset Flex Noun
2756 \begin_layout Plain Layout
2763 \begin_inset Flex Noun
2766 \begin_layout Plain Layout
2767 Sectioned bibliography
2773 In the document, you have to enclose the sections, which shall contain
2774 their own bibliography (including the Bib\SpecialChar TeX
2775 bibliography itself), between
2777 \begin_inset Flex Code
2780 \begin_layout Plain Layout
2789 \begin_inset Flex Code
2792 \begin_layout Plain Layout
2800 (those commands have to be inserted as \SpecialChar TeX
2802 The bibliography will contain all references that have been cited in the
2804 \begin_inset Flex Code
2807 \begin_layout Plain Layout
2818 If you are using this approach, then every citation reference has to be
2820 \begin_inset Flex Code
2823 \begin_layout Plain Layout
2831 \begin_inset Flex Code
2834 \begin_layout Plain Layout
2843 \begin_layout Section
2847 \begin_layout Subsection
2851 \begin_layout Standard
2852 When you are working on a large file with many sections, it is often convenient
2853 to break up the document into several files, or perhaps you have something
2854 where a table may change from time to time, but the preceding text does
2856 In these cases, you should seriously consider using multipart documents.
2857 For example, scientific papers often have five major sections: the introduction
2858 , observations, results, discussion, and conclusion.
2859 Each of these could be its own separate \SpecialChar LyX
2861 \begin_inset Quotes eld
2865 \begin_inset Quotes erd
2868 file which contains the title, authors, abstract, references, etc., plus
2869 the five included files.
2870 It is important to note that each of these files is a full \SpecialChar LyX
2872 can be formatted and printed on its own, as well as included in a master
2874 Each of these files must have the same document class, however—don't attempt
2875 to mix book classes with article classes.
2876 You may also include \SpecialChar LaTeX
2877 files; however, these files must not have their own
2879 \begin_inset space \thinspace{}
2883 \begin_inset space \space{}
2886 everything up to and including the
2887 \begin_inset Flex Code
2890 \begin_layout Plain Layout
2899 \begin_inset Flex Code
2902 \begin_layout Plain Layout
2910 line must be deleted) or else errors will be generated when you try to
2914 \begin_layout Standard
2916 allows you to include files quite easily with
2917 \begin_inset Flex Noun
2920 \begin_layout Plain Layout
2921 Insert\SpecialChar menuseparator
2923 \begin_inset space ~
2932 When you click on this selection a small box is inserted into the file
2933 at the current cursor location.
2934 Clicking on the box raises a dialog which allows you to select the file
2935 to be included, and the method of its inclusion.
2939 \begin_layout Standard
2940 The file selection box should by now be obvious.
2941 The three inclusion methods are
2942 \begin_inset Quotes eld
2946 \begin_inset Quotes erd
2950 \begin_inset Quotes eld
2954 \begin_inset Quotes erd
2958 \begin_inset Quotes eld
2962 \begin_inset Quotes erd
2966 The difference between
2967 \begin_inset Quotes eld
2971 \begin_inset Quotes erd
2975 \begin_inset Quotes eld
2979 \begin_inset Quotes erd
2982 is really only meaningful to \SpecialChar LaTeX
2983 perts, but the practical difference is that
2985 \begin_inset Quotes eld
2989 \begin_inset Quotes erd
2992 are typeset beginning on a new page, while files that are
2993 \begin_inset Quotes eld
2997 \begin_inset Quotes erd
3000 are typeset starting on the current page.
3003 \begin_layout Standard
3004 Generally, the master file is converted into a full \SpecialChar LaTeX
3005 file before typesetting,
3006 while the included files are converted to \SpecialChar LaTeX
3007 files that do not have all the
3008 preamble information.
3011 \begin_layout Standard
3013 \begin_inset Quotes eld
3017 \begin_inset Quotes erd
3020 included file allows you to include a file typeset exactly as it appears
3022 \begin_inset space \thinspace{}
3026 \begin_inset space \space{}
3030 \begin_inset Flex Code
3033 \begin_layout Plain Layout
3039 mode, with the characters set in a fixed-width typewriter font.
3040 Normally, spaces in this file are invisible, though two consecutive spaces
3041 are conserved, unlike \SpecialChar LyX
3042 's normal treatment of spaces.
3043 However, setting the
3044 \begin_inset Flex Noun
3047 \begin_layout Plain Layout
3049 \begin_inset space ~
3053 \begin_inset space ~
3057 \begin_inset space ~
3065 checkbox typesets a mark to unambiguously define the presence of a space.
3069 \begin_layout Subsection
3070 Cross-References Between Files
3073 \begin_layout Standard
3074 \begin_inset Box Shadowbox
3084 height_special "totalheight"
3089 backgroundcolor "none"
3092 \begin_layout Plain Layout
3093 This section is somewhat out of date.
3094 Need to describe default master documents and how children are opened when
3104 \begin_layout Standard
3105 It is possible to set up cross-references between the different files.
3106 First, open all the files in question: let's call them A and B in a two
3107 file example, where B is included in A.
3108 Let's say you insert a label in A, then want to reference it in B.
3109 Open the cross-reference dialog whilst in document B, and you can select
3111 \begin_inset Quotes eld
3115 \begin_inset Quotes erd
3121 \begin_layout Subsection
3122 Bibliography Lists in all Subdocuments
3125 \begin_layout Standard
3126 \begin_inset Box Frameless
3136 height_special "totalheight"
3141 backgroundcolor "none"
3144 \begin_layout Plain Layout
3145 This section also needs updating.
3146 There is now material about this on the wiki, and it could be copied here.
3154 \begin_layout Standard
3155 Copy the bibliography list with all entries to all subdocuments and transform
3157 This way \SpecialChar LyX
3159 \begin_inset Flex Code
3162 \begin_layout Plain Layout
3168 -files and you can easily insert references without making the bibliography
3172 \begin_layout Standard
3173 As the bibliography list is in a comment, \SpecialChar LaTeX
3174 won't use it and the references
3175 will look like this: [?], instead of like this: [1].
3176 One solution is to use the \SpecialChar LaTeX
3178 \begin_inset Flex Code
3181 \begin_layout Plain Layout
3187 that will only include comments by processing the files separately.
3188 To do this, add in the \SpecialChar LaTeX
3189 preamble of every subdocument the following:
3192 \begin_layout LyX-Code
3198 \begin_layout LyX-Code
3201 includecomment{comment}
3204 \begin_layout Standard
3206 \begin_inset Flex URL
3209 \begin_layout Plain Layout
3211 http://wiki.lyx.org/FAQ/Unsorted#toc31
3219 \begin_layout Section
3224 \begin_layout Standard
3225 Users sometimes need to be able to
3226 \begin_inset Quotes eld
3230 \begin_inset Quotes erd
3234 file together with all the images (and other files) on which it depends,
3235 either for sending to a publisher or for sharing with a co-author.
3237 2.0 includes a Python script (
3238 \begin_inset Flex Code
3241 \begin_layout Plain Layout
3247 ) that automates this process.
3248 To use it, you must have either the
3249 \begin_inset Flex Code
3252 \begin_layout Plain Layout
3259 \begin_inset Flex Code
3262 \begin_layout Plain Layout
3268 python modules installed on your system.
3269 By default, the script prefers the
3270 \begin_inset Flex Code
3273 \begin_layout Plain Layout
3280 \begin_inset Flex Code
3283 \begin_layout Plain Layout
3289 format on Unix-like systems and the
3290 \begin_inset Flex Code
3293 \begin_layout Plain Layout
3302 \begin_layout Standard
3304 's configuration process will set the script up to export a `\SpecialChar LyX
3306 and this format will then be available under
3307 \begin_inset Flex Code
3310 \begin_layout Plain Layout
3311 File\SpecialChar menuseparator
3320 \begin_layout Standard
3321 Independently of the platform, the generation of a particular archive format
3322 can be forced by adding either the
3323 \begin_inset Flex Code
3326 \begin_layout Plain Layout
3333 \begin_inset Flex Code
3336 \begin_layout Plain Layout
3343 \begin_inset Flex Code
3346 \begin_layout Plain Layout
3353 \begin_inset Flex Code
3356 \begin_layout Plain Layout
3362 format) switch to the
3363 \begin_inset Flex Code
3366 \begin_layout Plain Layout
3368 \SpecialChar menuseparator
3376 \begin_inset Flex Code
3379 \begin_layout Plain Layout
3380 Tools\SpecialChar menuseparator
3381 Preferences\SpecialChar menuseparator
3382 File Handling\SpecialChar menuseparator
3389 (Make sure you add the switch after the script name, not before it.)
3392 \begin_layout Section
3393 Fancy Headers and Footers
3396 \begin_layout Standard
3397 The default page layout is rather plain; for an
3398 \begin_inset Flex Code
3401 \begin_layout Plain Layout
3407 document class, all you get is a centered page number at the bottom of
3409 This document uses KOMA-script's book class, so it appears to be a bit
3411 But to really put on a show, you need to set the document page style to
3413 \begin_inset Quotes eld
3417 \begin_inset Quotes erd
3420 , as mentioned in the
3425 This section describes the \SpecialChar LaTeX
3426 code you need to insert in your \SpecialChar LaTeX
3428 order to get the desired effects.
3431 \begin_layout Standard
3432 For more information on fancy headers, see the
3433 \begin_inset Flex Code
3436 \begin_layout Plain Layout
3442 package documentation.
3444 \begin_inset Flex URL
3447 \begin_layout Plain Layout
3449 http://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
3457 \begin_layout Standard
3458 The page header is divided into three fields, not surprisingly labeled
3459 \begin_inset Quotes eld
3463 \begin_inset Quotes erd
3467 \begin_inset Quotes eld
3471 \begin_inset Quotes erd
3475 \begin_inset Quotes eld
3479 \begin_inset Quotes erd
3483 The footer is also divided into these three fields.
3484 The \SpecialChar LaTeX
3485 commands to set these fields in the simplest manner are
3486 \begin_inset Flex Code
3489 \begin_layout Plain Layout
3498 \begin_inset Flex Code
3501 \begin_layout Plain Layout
3510 \begin_inset Flex Code
3513 \begin_layout Plain Layout
3522 \begin_inset Flex Code
3525 \begin_layout Plain Layout
3534 Suppose you wish to put your name in the upper left hand corner of each
3536 Simply insert the following command in the preamble:
3539 \begin_layout Standard
3548 \begin_layout Standard
3549 You will now see your name in the upper left.
3550 If a field has a default entry that you would like to get rid of (often
3551 the page number appears in the central footer) simply include a command
3552 with a blank argument, e.
3553 \begin_inset space \thinspace{}
3559 \begin_layout Standard
3567 \begin_layout Standard
3568 Let's get really fancy: lets put the section number with the word
3569 \begin_inset Quotes eld
3573 \begin_inset Quotes erd
3577 \begin_inset space \thinspace{}
3581 \begin_inset space \space{}
3584 Section 3) in the upper left, the page number (e.
3585 \begin_inset space \thinspace{}
3589 \begin_inset space \space{}
3592 Page 4) in the upper right, your name in the lower left, and the date in
3594 The following commands should now appear in the preamble:
3597 \begin_layout Standard
3607 \begin_layout Standard
3615 \begin_layout Standard
3625 \begin_layout Standard
3634 \begin_layout Standard
3642 \begin_layout Standard
3652 \begin_layout Standard
3654 \begin_inset Flex Code
3657 \begin_layout Plain Layout
3666 \begin_inset Flex Code
3669 \begin_layout Plain Layout
3677 access \SpecialChar LaTeX
3678 's section and page counters, and so print out the current section
3681 \begin_inset Flex Code
3684 \begin_layout Plain Layout
3692 simply prints out today's date.
3695 \begin_layout Standard
3696 The thicknesses of the horizontal rules drawn beneath the header and above
3697 the footer can also be modified.
3698 If you don't want one of the rules, set its thickness to 0.
3699 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
3705 \begin_inset Flex Code
3708 \begin_layout Plain Layout
3713 headrulewidth}{0.4pt}
3719 \begin_inset Flex Code
3722 \begin_layout Plain Layout
3727 footrulewidth}{0.4pt}
3732 to set the thicknesses.
3735 \begin_layout Standard
3736 You can switch the header/footer settings on and off for individual pages
3738 \begin_inset Flex Code
3741 \begin_layout Plain Layout
3744 thispagestyle{empty}
3750 \begin_inset Flex Code
3753 \begin_layout Plain Layout
3756 thispagestyle{plain}
3762 \begin_inset Flex Code
3765 \begin_layout Plain Layout
3768 thispagestyle{fancy}
3774 Simply insert them in the text on the page you want changed and mark them
3777 In fact, title pages are marked as plain by default, while following pages
3778 are marked fancy when using the global fancy setting.
3781 \begin_layout Standard
3782 As a final example, it is possible to include an image in the header or
3784 Suppose you want to put a company logo in the upper lefthand corner.
3785 You might try something like
3788 \begin_layout Standard
3797 includegraphics{logo.eps}}}
3800 \begin_layout Standard
3802 (you may need to preface this with
3803 \begin_inset Flex Code
3806 \begin_layout Plain Layout
3810 usepackage{graphics}
3815 if you don't include graphics elsewhere in your document).
3818 \begin_layout Section
3819 Itemize Bullet Selection
3820 \begin_inset CommandInset label
3829 \begin_layout Standard
3835 \begin_layout Subsection
3839 \begin_layout Standard
3841 provides 216 bullet shapes that can be accessed from a simple dialog.
3842 Using this dialog you can easily specify what bullet shape to use at each
3843 level of an itemized list.
3844 These settings are document-wide so you won't be able to specify different
3845 sets of bullets for different paragraphs.
3849 \begin_layout Plain Layout
3850 Well, actually you can but you'll have to do it by hand.
3858 \begin_layout Subsection
3862 \begin_layout Standard
3863 Open the dialog by selecting the
3864 \begin_inset Flex Noun
3867 \begin_layout Plain Layout
3868 Document\SpecialChar menuseparator
3874 menu item and then select the
3875 \begin_inset Flex Noun
3878 \begin_layout Plain Layout
3887 \begin_layout Standard
3888 The dialog provides you with a table of bullet shapes.
3889 A column of buttons on the left of the table provides access to the six
3890 different panels of bullet shapes.
3891 The row of buttons across the top is used to select which bullet depth
3893 A text entry under the table shows the currently selected bullet shape's
3895 equivalent and this can be edited if desired.
3896 If you do modify the text you will also need to specify any needed packages
3897 in the \SpecialChar LaTeX
3901 \begin_layout Standard
3902 The six panels are divided up by the packages they require.
3903 The following table shows the mappings from button name to \SpecialChar LaTeX
3905 \begin_inset Separator latexpar
3911 \begin_layout Standard
3913 \begin_inset Tabular
3914 <lyxtabular version="3" rows="7" columns="2">
3915 <features tabularvalignment="middle">
3916 <column alignment="center" valignment="top" width="0pt">
3917 <column alignment="center" valignment="top" width="0pt">
3919 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3922 \begin_layout Plain Layout
3937 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3940 \begin_layout Plain Layout
3957 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3960 \begin_layout Plain Layout
3975 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3978 \begin_layout Plain Layout
3987 base \SpecialChar LaTeX
3995 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3998 \begin_layout Plain Layout
4013 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4016 \begin_layout Plain Layout
4033 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4036 \begin_layout Plain Layout
4051 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4054 \begin_layout Plain Layout
4071 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4074 \begin_layout Plain Layout
4089 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4092 \begin_layout Plain Layout
4109 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4112 \begin_layout Plain Layout
4127 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4130 \begin_layout Plain Layout
4147 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4150 \begin_layout Plain Layout
4165 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4168 \begin_layout Plain Layout
4191 \begin_layout Standard
4193 doesn't stop you using bullets from packages you don't have.
4194 If you get errors from \SpecialChar LaTeX
4195 when you try to view or print the file, then it
4196 is likely you are missing a package.
4200 \begin_layout Plain Layout
4202 doesn't restrict your use since you may be editing locally and exporting
4211 \begin_layout Subsection
4215 \begin_layout Standard
4216 Select which bullet depth you want to change then select the bullet shape
4218 Any changes will not be visible in \SpecialChar LyX
4219 , but are visible when viewing the document.
4222 \begin_layout Standard
4223 You can reset a bullet shape to the default simply by clicking your right
4224 mouse button on the appropriate bullet depth button.
4228 \begin_layout Plain Layout
4233 want to have multiple sets of paragraphs with different sets of bullets
4234 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
4236 The bullet selection dialog can help though because it provides you with
4237 the \SpecialChar LaTeX
4238 code for a wide range of bullet shapes.
4239 To make your own custom paragraphs you have the following options:
4242 \begin_layout Plain Layout
4246 \begin_layout Plain Layout
4262 \begin_layout Plain Layout
4266 \begin_layout Plain Layout
4288 \begin_layout Itemize
4289 Use the \SpecialChar LaTeX
4291 \begin_inset Flex Code
4294 \begin_layout Plain Layout
4302 to specify a new bullet shape for a given depth.
4303 You'll also need to save the current bullet shape so you can restore it
4305 In this itemized list the following \SpecialChar LaTeX
4306 code was used to change the bullet
4307 used for the first depth.
4308 \begin_inset Separator latexpar
4315 \begin_layout LyX-Code
4325 \begin_layout LyX-Code
4342 \begin_layout Itemize
4343 Note that the itemize depth is specified in Roman numerals as part of the
4353 \begin_layout Itemize
4357 \begin_layout Plain Layout
4370 Specify each individual entry by starting each item with the bullet shape
4371 enclosed in square brackets and set as
4372 \begin_inset Flex Noun
4375 \begin_layout Plain Layout
4383 For example, this item was started with
4384 \begin_inset Flex Code
4387 \begin_layout Plain Layout
4402 \begin_layout Plain Layout
4406 \begin_layout Plain Layout
4422 \begin_layout Plain Layout
4423 You'll also need to revert the labelitem back to its previous setting for
4424 the global bullet shape settings to remain in effect.
4425 The way used here was:
4428 \begin_layout LyX-Code
4443 \begin_layout Chapter
4445 and the World Wide Web
4448 \begin_layout Standard
4450 has long supported the export of documents to various web-friendly formats,
4452 Before verson 2.0, however, HTML export was always accomplished by the use
4453 of external converters.
4457 \begin_layout Plain Layout
4458 For details on the use of external converters with \SpecialChar LyX
4463 section of the Customization manual.
4468 These fall into two large groups: there are converters that use \SpecialChar LaTeX
4470 intermediate format, such as
4471 \begin_inset Flex Code
4474 \begin_layout Plain Layout
4481 \begin_inset Flex Code
4484 \begin_layout Plain Layout
4491 \begin_inset Flex Code
4494 \begin_layout Plain Layout
4500 , relying upon \SpecialChar LyX
4501 to produce the \SpecialChar LaTeX
4502 ; and there is a converter that works directly
4505 \begin_inset Flex Code
4508 \begin_layout Plain Layout
4516 All of these have different advantages and disadvantages.
4520 \begin_layout Standard
4521 The \SpecialChar LaTeX
4522 -based converters have the advantage that, in principle, they know everythin
4523 g about the exported document that \SpecialChar LaTeX
4525 Such converters do not care, for example, if a certain block of code was
4526 produced by \SpecialChar LyX
4527 or was Evil Red Text.
4528 These converters know about
4529 \begin_inset Flex Code
4532 \begin_layout Plain Layout
4538 files, counters, and references, and can often make use of the
4539 \begin_inset Flex Code
4542 \begin_layout Plain Layout
4548 files generated by Bib\SpecialChar TeX
4550 On the other hand, \SpecialChar LaTeX
4551 is a very hard language to parse—it is sometimes said
4552 that only \SpecialChar TeX
4553 itself understands \SpecialChar TeX
4554 —and \SpecialChar LaTeX
4555 -based converters will often choke on
4556 what seem to be quite simple constructs; complex ones can throw them completely
4557 , and as of this writing, for example, the
4561 manual will not export with
4562 \begin_inset Flex Code
4565 \begin_layout Plain Layout
4571 , though the others will.
4572 The other issue concerns how math is handled.
4573 These converters typically convert the formulae into little pictures that
4574 are then linked from the HTML document.
4575 Since these are actually generated by \SpecialChar LaTeX
4576 , they are accurate.
4577 But they do not scale well, and just getting them to look as if they are
4578 actually meant to be in your document—so that the font sizes seem to be
4579 roughly the same—can be a challenge.
4582 \begin_layout Standard
4584 \begin_inset Flex Code
4587 \begin_layout Plain Layout
4595 \begin_inset CommandInset href
4597 name "http://elyxer.nongnu.org/"
4598 target "http://elyxer.nongnu.org/"
4602 ) solves some of these problems.
4603 In particular, the formulae it produces scale perfectly, since it renders
4604 math using a combination of HTML and CSS rather than converting the formulae
4606 But even moderately complex formula are rendered less well than with
4607 \begin_inset Flex Code
4610 \begin_layout Plain Layout
4616 ; this reflects the limitations of HTML.
4620 \begin_layout Plain Layout
4622 \begin_inset Flex Code
4625 \begin_layout Plain Layout
4632 can also use jsMath and MathJax for equations, but this setting is only
4633 available globally and requires one to have access to a server that runs
4639 More importantly (as of version 1.1.1, at least),
4640 \begin_inset Flex Code
4643 \begin_layout Plain Layout
4650 has limited support for math macros and no support for user-defined paragraph
4651 or character styles.
4652 These limitations make
4653 \begin_inset Flex Code
4656 \begin_layout Plain Layout
4663 unsuitable for many of the documents \SpecialChar LyX
4665 In principle, of course, these problems could be solved, but the \SpecialChar LyX
4667 have decided to follow a different path and have made \SpecialChar LyX
4669 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
4670 , DocBook, and plaintext.
4673 \begin_layout Standard
4674 As of this writing, XHTML output remains under development and should probably
4676 \begin_inset Quotes eld
4680 \begin_inset Quotes erd
4687 \begin_layout Plain Layout
4689 \begin_inset Flex Code
4692 \begin_layout Plain Layout
4693 development/HTML.notes
4698 , which can be found in the \SpecialChar LyX
4700 \begin_inset CommandInset href
4702 name "accessed online"
4703 target "http://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
4707 , usually contains up-to-date information about the state of XHTML output.
4708 See also the list of XHTML bugs on
4709 \begin_inset CommandInset href
4711 name "the bug tracker"
4712 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"
4721 Still, the developers have chosen this approach because it has several
4722 potential advantages over the other two.
4725 \begin_layout Standard
4726 These advantages are primarily due to the fact that the XHTML output routines,
4727 since they are part of \SpecialChar LyX
4728 , know everything \SpecialChar LyX
4729 knows about the document being
4734 \begin_layout Plain Layout
4735 Another advantage is that, since these routines are internal to \SpecialChar LyX
4737 immune to changes in \SpecialChar LyX
4738 's file format, or to changes in the semantics of
4744 So they know about the table of contents (as displayed in the outline),
4745 about the counters associated with different paragraph styles, and about
4746 user-defined styles.
4747 The XHTML output routines know what \SpecialChar LyX
4748 knows about internationalization,
4749 too, so they will output
4750 \begin_inset Quotes eld
4754 \begin_inset Quotes erd
4758 \begin_inset Quotes eld
4766 \begin_inset Quotes erd
4769 , depending upon the language in effect at the time.
4773 \begin_layout Standard
4774 Quite generally, the output routines know what \SpecialChar LyX
4775 knows about document layout,
4776 that is, about how the document is to be rendered on screen.
4777 We use this information when we output the document as XHTML.
4778 In particular, \SpecialChar LyX
4783 generates CSS style information corresponding to the layout information
4784 it uses to render the document on screen: if section headings are supposed
4785 to be sans-serif and bold as seen in \SpecialChar LyX
4786 , then (by default) they will be sans-seri
4787 f and bold when viewed in a web browser, too.
4788 And this is true not just for pre-defined styles, like Section, but for
4789 any style, including user-defined styles.
4790 Indeed, the XHTML output routines make no distinction between user-defined
4791 paragraph and character styles and \SpecialChar LyX
4792 's own pre-defined styles: in each case,
4793 everything \SpecialChar LyX
4794 knows about the styles is contained in the layout files.
4795 And much the same is true as regards pre-defined textual insets, such as
4796 footnotes, and various custom insets.
4800 \begin_layout Standard
4801 The result is that XHTML output can be customized and extended in exactly
4802 the same way \SpecialChar LaTeX
4803 output can be customized and extended: through layout files
4805 See chapter five of the
4809 manual for the details.
4812 \begin_layout Standard
4813 The remainder of this chapter contains more detailed information on XHTML
4814 output, its limitations, and ways to work around those limitations.
4817 \begin_layout Section
4818 Math Output in XHTML
4821 \begin_layout Standard
4823 offers four choices for how math is rendered.
4824 These have various advantages and disadvantages:
4827 \begin_layout Itemize
4829 \begin_inset Newline newline
4832 MathML is a dialect of XML designed specifically for mathematics on the
4833 web, and it typically renders very well in browsers that support it.
4834 The disadvantage is that not all browsers support MathML, and support is
4835 not complete even in the Gecko-based browsers, such as Firefox.
4836 \begin_inset Newline newline
4840 is unable to render a formula as MathML—for example, if the formula
4842 \begin_inset Flex Code
4845 \begin_layout Plain Layout
4851 package or ERT—then it will instead output the formula as an image.
4855 \begin_layout Itemize
4857 \begin_inset Newline newline
4861 \begin_inset Flex Code
4864 \begin_layout Plain Layout
4870 outputs math as HTML, styled by CSS.
4874 \begin_layout Plain Layout
4876 has borrowed some of the CSS for its HTML output from
4877 \begin_inset Flex Code
4880 \begin_layout Plain Layout
4891 For simple formulae, this can work quite well, though with more complicated
4892 formulae it tends to break down.
4893 Still, this method has the advantage that it is very widely supported and
4894 so it may be appropriate for documents that contain only a little, fairly
4896 \begin_inset Newline newline
4899 If Lyx is unable to render a formula as HTML—for example, if the formula
4901 \begin_inset Flex Code
4904 \begin_layout Plain Layout
4910 package or ERT—then it will instead output the formula as an image.
4914 \begin_layout Itemize
4916 \begin_inset Newline newline
4920 \begin_inset Flex Code
4923 \begin_layout Plain Layout
4930 will output formulae as images, the very same images, in fact, that are
4931 used for instant preview.
4935 \begin_layout Plain Layout
4936 Instant preview does
4940 have to be on for images to be output, however.
4945 The advantage to this method is that the images are simply generated by
4947 , so they are very accurate.
4948 The disadvantage, as mentioned earlier, is that these are bitmapped images,
4949 so they do not scale terribly well, and one cannot copy them, etc.
4950 (As of this writing, there are also problems about equation numbering.
4952 \begin_inset CommandInset href
4955 target "http://www.lyx.org/trac/ticket/6894"
4960 \begin_inset Newline newline
4963 The size of the images can be controlled by setting the
4964 \begin_inset Quotes eld
4968 \begin_inset Quotes erd
4972 \begin_inset Flex Noun
4975 \begin_layout Plain Layout
4976 Document\SpecialChar menuseparator
4977 Settings\SpecialChar menuseparator
4987 \begin_layout Plain Layout
4988 For those who want to know, this controls the resolution of the image in
4989 dots per inch and is based upon a default of 75 dpi.
4995 \begin_inset Newline newline
4999 for some reason fails to create an image for a formula (e.g., if a required
5001 package is not installed), then it will fall back to outputing the raw
5006 \begin_layout Itemize
5009 \begin_inset Newline newline
5012 Finally, \SpecialChar LyX
5013 will happily output math as \SpecialChar LaTeX
5015 As well as being the output of last resort, this method can be used with
5017 \begin_inset CommandInset href
5020 target "http://www.math.union.edu/~dpvc/jsMath/"
5024 , which uses JavaScript to render \SpecialChar LaTeX
5025 embedded in HTML documents.
5027 wraps the \SpecialChar LaTeX
5029 \begin_inset Flex Code
5032 \begin_layout Plain Layout
5038 (for inline formulas) or
5039 \begin_inset Flex Code
5042 \begin_layout Plain Layout
5048 (for displayed formulas) with
5049 \begin_inset Flex Code
5052 \begin_layout Plain Layout
5058 , as is required for jsMath.
5061 \begin_layout Standard
5062 One of these output methods must be selected under
5063 \begin_inset Flex Noun
5066 \begin_layout Plain Layout
5067 Document\SpecialChar menuseparator
5068 Settings\SpecialChar menuseparator
5075 By default, \SpecialChar LyX
5077 This is a document-wide setting, therefore.
5080 \begin_layout Standard
5081 Eventually, \SpecialChar LyX
5082 will offer the user the option to select an alternate output
5083 method for a particular inset, say, one that isn't being rendered very
5088 \begin_layout Plain Layout
5089 That said, since \SpecialChar LyX
5090 falls back to images if the inset contains ERT, then one
5091 can force output as an image by putting some harmless ERT into the math,
5093 \begin_inset Formula $a=b\relax$
5104 \begin_layout Section
5105 Bibliography and Citations
5108 \begin_layout Standard
5109 XHTML output fully supports bibliographies and citations.
5113 \begin_layout Standard
5114 Citation labels are generated by the same machinery that generates \SpecialChar LyX
5116 labels, so the labels will look in the output much as they do in \SpecialChar LyX
5119 If you are using numerical citations, then \SpecialChar LyX
5120 will output numerical labels,
5121 such as [1] or [17], rather than simply showing the citation key in square
5122 brackets, as it does on-screen.
5123 If you are using author-year citations, then \SpecialChar LyX
5124 will add lowercase letters
5125 to the years, just as Bib\SpecialChar TeX
5126 does, if it finds more than one citation for
5127 a given author-year combination.
5128 The labels will be printed with the bibliography entries.
5129 Note that there is, at present, no way to customize the appearance of the
5130 labels, for example, to choose between square brackets and parentheses.
5133 \begin_layout Standard
5134 Bibliography output is handled by the same machinery that handles the presentati
5135 on of reference information in the citation dialog, so you will see in the
5136 XHTML output pretty much what you would see if you were to look at a given
5137 entry in the citation dialog.
5138 The formatting can be customized in your layout file or, preferably, in
5144 manual for the details.
5147 \begin_layout Standard
5148 The main defect at present is that cross-referenced information is printed
5149 with every entry with which it is associated.
5150 So you can see things like this:
5155 \begin_inset Quotes eld
5158 Context and Logical Form
5159 \begin_inset Quotes erd
5164 Language in Context: Selected Essays
5166 (Oxford: Oxford University Press, 2007), pp.
5172 \begin_inset Quotes eld
5175 Semantics in Context
5176 \begin_inset Quotes erd
5181 Language in Context: Selected Essays
5183 (Oxford: Oxford University Press, 2007), pp.
5187 \begin_layout Standard
5188 This should be fixed before long.
5191 \begin_layout Standard
5192 There is no support at present for sectioned bibliographies.
5193 If you have multiple bibliographies, then \SpecialChar LyX
5194 will print the same bibliography
5198 \begin_layout Section
5202 \begin_layout Standard
5204 will happily export indexes as XHTML, but with certain limitations at the
5208 \begin_layout Standard
5209 Index export will be most reliable when you do not attempt to use the fancy
5210 constructs that are described in the section on indexes in the
5218 \begin_layout Plain Layout
5219 The main issue here is that \SpecialChar LyX
5220 itself does not really handle these.
5221 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
5227 We'll describe how they are handled using the subsection headings from
5231 \begin_layout Itemize
5232 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
5233 makes an effort to support these,
5234 but the entries must be separated by
5235 \begin_inset Quotes eld
5239 \begin_inset Quotes erd
5242 , that is, there must be spaces around the exclamation point.
5243 This is because it is otherwise too difficult to check for escaped exclamation
5244 points, ones in math, and so forth.
5247 \begin_layout Itemize
5248 Page Ranges: There is no support at all for page ranges, since these make
5249 no sense with XHMTL.
5250 Instead, you will just get two index entries, one at either end.
5253 \begin_layout Itemize
5254 Cross-referencing: There is no support for cross-referencing.
5256 finds an entry containing the
5257 \begin_inset Quotes eld
5260 |see\SpecialChar ldots
5262 \begin_inset Quotes erd
5265 construct, it is just dropped, and the rest is treated as an ordinary index
5269 \begin_layout Itemize
5270 Index Entry Order: \SpecialChar LyX
5271 does support attempts to fix the sorting order.
5272 It will take what is before the first `@' it finds and use that for sorting,
5273 taking what follows the first `@' to be the actual entry.
5274 At present, \SpecialChar LyX
5275 does not check for escaped `@', so do not try to index email
5279 \begin_layout Itemize
5280 Index Entry Layout: You can format entries by using the text style dialog,
5281 or by using any other method available within \SpecialChar LyX
5283 There is no support for constructs like:
5284 \begin_inset Quotes eld
5288 \begin_inset Quotes erd
5292 Indeed, if \SpecialChar LyX
5293 finds a pipe symbol, `|', in an entry, it will delete it and
5294 everything that follows it.
5297 \begin_layout Itemize
5298 Multiple Indexes: There is no support for multiple indexes.
5299 Rather, all index entries will be printed as one large index.
5300 To avoid our printing several versions of the index, we print only the
5301 main index, so make sure you have one.
5304 \begin_layout Section
5305 Nomenclature and Glossary
5308 \begin_layout Standard
5309 There is at present no support for glossaries.
5310 Adding it would be fairly trivial, and welcome.
5313 \begin_layout Chapter
5314 The \SpecialChar LyX
5318 \begin_layout Section
5322 \begin_layout Standard
5323 The `\SpecialChar LyX
5324 server' allows other programs to talk to \SpecialChar LyX
5325 , invoke \SpecialChar LyX
5326 commands, and retrieve
5327 information about the \SpecialChar LyX
5329 This is only intended for advanced users, but they should find it useful.
5330 It is by writing to the \SpecialChar LyX
5331 server, for example, that bibliography managers,
5332 such as JabRef, are able to
5333 \begin_inset Quotes eld
5337 \begin_inset Quotes erd
5340 citations to \SpecialChar LyX
5344 \begin_layout Section
5345 Starting the \SpecialChar LyX
5349 \begin_layout Standard
5350 The \SpecialChar LyX
5351 server works through the use of a pair of named pipes.
5352 These are usually located in
5353 \begin_inset Flex Code
5356 \begin_layout Plain Layout
5362 , (except on Windows, where
5366 named pipes are special objects located in
5367 \begin_inset Flex Code
5370 \begin_layout Plain Layout
5382 ) and have the names
5383 \begin_inset Quotes eld
5387 \begin_inset Flex Code
5390 \begin_layout Plain Layout
5397 \begin_inset Quotes erd
5401 \begin_inset Quotes eld
5405 \begin_inset Flex Code
5408 \begin_layout Plain Layout
5415 \begin_inset Quotes erd
5419 External programs write into
5420 \begin_inset Flex Code
5423 \begin_layout Plain Layout
5429 and read back data from
5430 \begin_inset Flex Code
5433 \begin_layout Plain Layout
5440 The stem of the pipe names can be defined in the
5441 \begin_inset Flex Noun
5444 \begin_layout Plain Layout
5445 Tools\SpecialChar menuseparator
5452 \begin_inset Flex Code
5455 \begin_layout Plain Layout
5456 "/home/myhome/lyxpipe"
5462 \begin_inset Flex Code
5465 \begin_layout Plain Layout
5479 on Windows (where any working path instead of lyxpipe can be used, for
5481 \begin_inset Flex Code
5484 \begin_layout Plain Layout
5507 configure this manually in order for the server to start.
5510 \begin_layout Standard
5513 \begin_inset Flex Code
5516 \begin_layout Plain Layout
5523 \begin_inset Flex Code
5526 \begin_layout Plain Layout
5532 ' to create the pipes.
5533 If one of the pipes already exists, \SpecialChar LyX
5534 will assume that another \SpecialChar LyX
5536 is already running and will not start the server.
5537 On POSIX (Unix like) systems, if for some other reason, an unused
5538 \begin_inset Quotes eld
5542 \begin_inset Quotes erd
5545 pipe is left in existence when \SpecialChar LyX
5546 closes, then \SpecialChar LyX
5547 will try to delete it.
5548 If this fails for some reason, you will need to delete the pipes manually
5549 and then restart \SpecialChar LyX
5551 On Windows, pipes are deleted by the OS on program termination or crash,
5553 \begin_inset Quotes eld
5557 \begin_inset Quotes erd
5560 pipes should not be possible.
5563 \begin_layout Standard
5564 To have several \SpecialChar LyX
5565 processes with servers at the same time, you have to use
5566 different configurations, perhaps by using separate user directories, each
5568 \begin_inset Flex Code
5571 \begin_layout Plain Layout
5577 file, for each process.
5580 \begin_layout Standard
5581 If you are developing a client program, you might find it useful to enable
5582 debugging information from the \SpecialChar LyX
5584 Do this by starting \SpecialChar LyX
5586 \begin_inset Flex Code
5589 \begin_layout Plain Layout
5598 \begin_layout Standard
5599 You can find a complete example client written in C++ in the source distribution
5601 \begin_inset Flex Code
5604 \begin_layout Plain Layout
5605 development/lyxserver/server_monitor.cpp
5613 \begin_layout Standard
5614 Another useful tool is the command-line based client found in
5615 \begin_inset Flex Code
5618 \begin_layout Plain Layout
5619 src/client/lyxclient
5627 \begin_layout Section
5628 Normal communication
5631 \begin_layout Standard
5632 To issue a \SpecialChar LyX
5633 call, the client writes a line of ASCII text into the input
5635 This line has the following format:
5652 \begin_layout Description
5653 clientname is a name that the client can choose arbitrarily.
5654 Its only use is that \SpecialChar LyX
5655 will echo it if it sends an answer—so a client can
5656 dispatch results from different requesters.
5659 \begin_layout Description
5660 function is the function you want \SpecialChar LyX
5662 It is the same as the commands you'd use in the minibuffer.
5665 \begin_layout Description
5666 argument is an optional argument which is meaningful only to some functions
5668 \begin_inset Quotes eld
5672 \begin_inset Quotes erd
5675 LFUN will insert the argument as text at the cursor position).
5678 \begin_layout Standard
5679 The answer from \SpecialChar LyX
5680 will arrive in the output pipe and be of the form
5697 \begin_layout Standard
5706 are just echoed from the command request, while
5710 is more or less useful information filled according to how the command
5711 execution worked out.
5712 Some commands, such as
5713 \begin_inset Quotes eld
5717 \begin_inset Quotes erd
5720 , will return information about the internal state of \SpecialChar LyX
5722 return an empty data-response.
5723 This means that the command execution went fine.
5726 \begin_layout Standard
5727 In case of errors, the response from \SpecialChar LyX
5745 \begin_layout Standard
5750 should contain an explanation of why the command failed.
5753 \begin_layout Standard
5757 \begin_layout LyX-Code
5758 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
5759 \begin_inset Newline newline
5762 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
5763 \begin_inset Newline newline
5766 read a <~/.lyxpipe.out
5767 \begin_inset Newline newline
5773 \begin_layout Subsection
5774 AppleScript (Mac OS X)
5777 \begin_layout Standard
5778 Since \SpecialChar LyX
5779 2.1, \SpecialChar LyX
5780 supports basic interactions with AppleScript for normal communicatio
5781 n through the command run.
5782 This command takes a direct argument (the
5786 to perform) and an optional argument.
5787 It either returns the output of the function or triggers an error with
5788 the error message and code.
5791 \begin_layout Standard
5795 \begin_layout LyX-Code
5796 tell application "\SpecialChar LyX
5800 \begin_layout LyX-Code
5804 \begin_layout LyX-Code
5805 -- Stores the current file name into f
5808 \begin_layout LyX-Code
5809 set f to (run "server-get-filename" with argument "")
5812 \begin_layout LyX-Code
5813 on error the error_message number the error_number
5816 \begin_layout LyX-Code
5817 display dialog "Error: " & the error_number & ".
5821 \begin_layout LyX-Code
5822 & the error_message buttons {"OK"} default button 1
5825 \begin_layout LyX-Code
5829 \begin_layout LyX-Code
5833 \begin_layout Section
5837 \begin_layout Standard
5839 can notify clients of events going on asynchronously.
5840 Currently it will only do this if the user binds a key sequence with the
5842 \begin_inset Quotes eld
5846 \begin_inset Quotes erd
5850 The format of the string \SpecialChar LyX
5851 sends is as follows:
5855 \begin_inset Flex Code
5858 \begin_layout Plain Layout
5869 \begin_layout Standard
5874 is the printed representation of the key sequence that was actually typed
5878 \begin_layout Standard
5879 This mechanism can be used to extend \SpecialChar LyX
5880 's command set and implement macros.
5881 Bind some key sequence to
5882 \begin_inset Quotes eld
5886 \begin_inset Quotes erd
5890 Then start a client that listens on the output pipe, dispatches the command
5891 according to the sequence, and starts a function that may use \SpecialChar LyX
5894 requests to issue a command or a series of commands to \SpecialChar LyX
5898 \begin_layout Section
5899 The simple \SpecialChar LyX
5903 \begin_layout Standard
5905 implements a simple protocol that can be used for session management.
5906 All messages are of the form
5919 \begin_layout Standard
5925 \begin_inset Quotes eld
5929 \begin_inset Quotes erd
5933 \begin_inset Quotes eld
5937 \begin_inset Quotes erd
5942 \begin_inset Quotes eld
5946 \begin_inset Quotes erd
5949 is received from a client, \SpecialChar LyX
5950 will report back to inform the client that
5951 it's listening to it's messages, while
5952 \begin_inset Quotes eld
5956 \begin_inset Quotes erd
5959 sent from \SpecialChar LyX
5960 will inform clients that \SpecialChar LyX
5964 \begin_layout Section
5965 Reverse DVI/PDF search
5968 \begin_layout Standard
5969 Some DVI/PDF viewers
5973 \begin_layout Plain Layout
5974 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
5975 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
5984 facility (also called
5989 This means that you can tell \SpecialChar LyX
5990 to put the cursor to a specific line in the
5991 document by clicking at the respective position in the DVI/PDF output.
5992 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
5994 This is done via the \SpecialChar LyX
5995 server either by using the named pipe (
5999 ), or the UNIX domain socket (
6003 ) that \SpecialChar LyX
6004 creates in its temporary directory (this is the way the
6005 \begin_inset Flex Code
6008 \begin_layout Plain Layout
6014 program communicates with \SpecialChar LyX
6016 In some cases, you need a helper script that mediates between the viewer
6017 and \SpecialChar LyX
6018 , in others, the viewer can communicate with \SpecialChar LyX
6020 This depends on the selected viewer and on your operating system.
6021 The same applies to the way viewers need to be configured and the way the
6022 reverse search is actually performed.
6023 In what follows, we will thus describe how to setup reverse search for
6025 Before we turn to this, though, we will explain what needs to be done generally
6026 to enable reverse search in the DVI/PDF output.
6029 \begin_layout Subsection
6031 \begin_inset CommandInset label
6033 name "subsec:rev-search"
6040 \begin_layout Standard
6041 In most cases \SpecialChar LyX
6042 will do the work for you by enabling the option
6043 \begin_inset Flex Noun
6046 \begin_layout Plain Layout
6047 Synchronize with Output
6053 \begin_inset Flex Noun
6056 \begin_layout Plain Layout
6057 Document\SpecialChar menuseparator
6058 Settings\SpecialChar menuseparator
6065 In such a case \SpecialChar LyX
6066 will automatically insert the necessary Sync\SpecialChar TeX
6068 PDF) or load the srcltx package (for DVI) respectively.
6069 This option can be easily reached also on
6070 \begin_inset Flex Code
6073 \begin_layout Plain Layout
6082 \begin_layout Standard
6083 If you need a different setting, you can select or input a custom macro
6084 from the drop down box just below
6085 \begin_inset Flex Noun
6088 \begin_layout Plain Layout
6089 Document\SpecialChar menuseparator
6090 Settings\SpecialChar menuseparator
6091 Output\SpecialChar menuseparator
6092 Synchronize with Output
6100 \begin_layout Standard
6101 Note that the method
6102 \begin_inset Flex Code
6105 \begin_layout Plain Layout
6113 enables gzip compression.
6114 If your viewer does not support it, you should instead use
6115 \begin_inset Flex Code
6118 \begin_layout Plain Layout
6129 \begin_layout Standard
6130 Please also note that including the
6131 \begin_inset Flex Code
6134 \begin_layout Plain Layout
6141 \begin_inset Flex Code
6144 \begin_layout Plain Layout
6150 sometimes has an undesired impact on the typesetting.
6151 Thus, you should switch output synchronization off for the final typesetting
6153 \begin_inset Flex Code
6156 \begin_layout Plain Layout
6163 \begin_inset Flex Code
6166 \begin_layout Plain Layout
6176 \begin_layout Standard
6177 In case you need some more special settings that are not covered by the
6178 automatic settings, read the next section about how to set up output synchroniz
6180 If the automatic setup suits your needs, you can readily jump to section
6181 \begin_inset space ~
6185 \begin_inset CommandInset ref
6187 reference "subsec:configuring-viewers"
6191 , where the necessary configuration steps in your viewer – needed both with
6192 the automatic and the manual setup – are described.
6195 \begin_layout Subsection
6199 \begin_layout Standard
6201 provides several different methods for reverse search.
6202 Some are built-in in the
6203 \begin_inset Flex Code
6206 \begin_layout Plain Layout
6212 program, some are provided by external packages.
6213 Your choice depends on whether your \SpecialChar LaTeX
6214 distribution already provides a given
6215 method (the built-in methods are rather new) and whether your viewer can
6217 The available methods are described in the following.
6220 \begin_layout Subsubsection*
6221 Built-in DVI-search via src-specials (DVI only)
6224 \begin_layout Standard
6225 This method provides the DVI file with the necessary information for reverse
6227 It is available in \SpecialChar LaTeX
6228 since quite some time (any somewhat recent \SpecialChar LaTeX
6230 should include it), and it works reliably.
6231 To enable it, change the
6232 \begin_inset Flex Noun
6235 \begin_layout Plain Layout
6246 \begin_inset Flex Noun
6249 \begin_layout Plain Layout
6260 \begin_inset Flex Noun
6263 \begin_layout Plain Layout
6264 Preferences\SpecialChar menuseparator
6265 File Handling\SpecialChar menuseparator
6272 \begin_inset Flex Code
6275 \begin_layout Plain Layout
6276 latex -src-specials $$i
6282 If this doesn't work, check if your \SpecialChar TeX
6283 engine needs different options (the
6284 syntax might differ in some distributions).
6287 \begin_layout Subsubsection*
6288 External Packages (PDFSync and scrltx)
6291 \begin_layout Standard
6300 provide reverse search facility for PDF output (via pdflatex) and DVI output,
6302 In order to enable it, load the packages in the \SpecialChar LyX
6306 \begin_layout Itemize
6307 \begin_inset Flex Code
6310 \begin_layout Plain Layout
6318 for reverse PDF search,
6321 \begin_layout Itemize
6322 \begin_inset Flex Code
6325 \begin_layout Plain Layout
6328 usepackage[active]{srcltx}
6333 for reverse DVI search.
6336 \begin_layout Standard
6337 If you want to be able to perform both DVI and PDF reverse searches, you
6338 can also insert in the preamble the following lines
6341 \begin_layout LyX-Code
6345 \begin_inset Newline newline
6351 \begin_inset Newline newline
6357 \begin_inset Newline newline
6363 \begin_inset Newline newline
6368 usepackage[active]{srcltx}
6369 \begin_inset Newline newline
6377 \begin_layout Standard
6378 This way, you can preview the file as either DVI or PDF (pdflatex) and the
6379 right package will be used.
6382 \begin_layout Standard
6383 Note that PDFSync might affect the output layout of your document.
6384 It is therefore advised to disable PDFsync for final documents.
6387 \begin_layout Subsubsection*
6388 Built-in reverse search via Sync\SpecialChar TeX
6392 \begin_layout Standard
6394 \begin_inset Flex Code
6397 \begin_layout Plain Layout
6403 have built-in support for both PDF and DVI reverse search.
6406 Sync\SpecialChar TeX
6409 facility is basically the result of the integration of the PDFSync package
6410 to the pdftex program and its merge with the
6415 You need at least \SpecialChar TeX
6416 Live 2008 or a recent Mik\SpecialChar TeX
6417 distribution in order to use
6422 \begin_layout Plain Layout
6423 For some reason, Mik\SpecialChar TeX
6424 does not understand/obey the command \SpecialChar LyX
6426 the preamble when you check the "Enable Forward/Reverse Search" button
6427 in the toolbar and does not generate the necessary info.
6430 \begin_layout Plain Layout
6431 The generation of the required info can be forced by changing the converter
6433 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
6434 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
6435 the -synctex=1 switch).
6440 Also note that only a few PDF viewers (Okular and Qpdfview on Unix, Skim
6441 on the Mac, SumatraPDF on Windows) already provide Sync\SpecialChar TeX
6445 \begin_layout Standard
6446 To enable Sync\SpecialChar TeX
6447 for DVI output, change the
6448 \begin_inset Flex Noun
6451 \begin_layout Plain Layout
6462 \begin_inset Flex Noun
6465 \begin_layout Plain Layout
6476 \begin_inset Flex Noun
6479 \begin_layout Plain Layout
6480 Preferences\SpecialChar menuseparator
6481 File Handling\SpecialChar menuseparator
6488 \begin_inset Flex Code
6491 \begin_layout Plain Layout
6492 latex -synctex=1 $$i
6497 , and for PDF output, change the
6498 \begin_inset Flex Noun
6501 \begin_layout Plain Layout
6506 (pdflatex) -> PDF (pdflatex)
6512 \begin_inset Flex Code
6515 \begin_layout Plain Layout
6516 pdflatex -synctex=1 $$i
6522 Check the documentation of your viewer whether the viewer needs to be configure
6523 d for the use with Sync\SpecialChar TeX
6528 \begin_layout Plain Layout
6529 Note that the option
6530 \begin_inset Flex Code
6533 \begin_layout Plain Layout
6539 option enables gzip compression.
6540 If your viewer does not support it, you should instead use
6541 \begin_inset Flex Code
6544 \begin_layout Plain Layout
6558 \begin_layout Subsection
6559 Configuring and using specific viewers
6560 \begin_inset CommandInset label
6562 name "subsec:configuring-viewers"
6569 \begin_layout Subsubsection*
6570 Xdvi (all platforms)
6573 \begin_layout Standard
6575 \begin_inset Flex Code
6578 \begin_layout Plain Layout
6584 , you don't need to do anything else for performing a reverse DVI search,
6586 already provides the necessary hooks for automatically using the
6587 \begin_inset Flex Code
6590 \begin_layout Plain Layout
6597 Just setup your document as described above (reverse search is triggered
6598 by Ctrl-click or Alt-click on Mac OSX, respectively).
6601 \begin_layout Standard
6602 However, if for whatever reason you want to use the named pipe instead of
6603 the socket for communicating with \SpecialChar LyX
6604 , simply change the DVI viewer in
6605 \begin_inset Flex Noun
6608 \begin_layout Plain Layout
6609 Preferences\SpecialChar menuseparator
6610 File Handling\SpecialChar menuseparator
6620 \begin_layout Plain Layout
6621 On Mac OSX you have to use
6622 \begin_inset Flex Code
6625 \begin_layout Plain Layout
6626 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
6637 \begin_inset Flex Code
6640 \begin_layout Plain Layout
6641 xdvi -editor "lyxeditor.sh %f %l"
6647 \begin_inset Flex Code
6650 \begin_layout Plain Layout
6656 is a suitable script.
6657 For example, a minimal shell script is the following one:
6660 \begin_layout LyX-Code
6662 \begin_inset Newline newline
6665 LYXPIPE="/path/to/lyxpipe"
6666 \begin_inset Newline newline
6669 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
6670 \begin_inset Newline newline
6673 echo "$COMMAND" > "${LYXPIPE}".in || exit
6674 \begin_inset Newline newline
6677 read TMP < "${LYXPIPE}".out || exit
6680 \begin_layout Standard
6682 \begin_inset Flex Code
6685 \begin_layout Plain Layout
6695 \begin_layout Plain Layout
6702 XServer pipe path specified in
6703 \begin_inset Flex Noun
6706 \begin_layout Plain Layout
6707 Preferences\SpecialChar menuseparator
6717 \begin_layout Plain Layout
6719 \begin_inset Flex Code
6722 \begin_layout Plain Layout
6728 folder of a source distribution you can find a
6729 \begin_inset Flex Code
6732 \begin_layout Plain Layout
6738 script which is able to locate the
6742 based on your preferences.
6750 \begin_layout Subsubsection*
6754 \begin_layout Standard
6756 \begin_inset Flex Code
6759 \begin_layout Plain Layout
6760 /Applications/MacDviX_Folder/calleditor.script
6765 , add the following lines:
6768 \begin_layout LyX-Code
6773 \begin_layout Plain Layout
6780 X.app/Contents/MacOS/lyxeditor "$2" $1
6781 \begin_inset Newline newline
6787 \begin_layout Standard
6788 Modify the lines accordingly if you install \SpecialChar LyX
6789 somewhere else than in the
6790 Applications folder.
6793 \begin_layout Standard
6794 Reverse search is triggered by Alt-click (OPTION-click).
6797 \begin_layout Subsubsection*
6801 \begin_layout Standard
6803 \begin_inset Flex Code
6806 \begin_layout Plain Layout
6807 open -a Skim.app $$i
6812 to the viewer setting in
6813 \begin_inset Flex Noun
6816 \begin_layout Plain Layout
6817 Preferences\SpecialChar menuseparator
6818 File Handling\SpecialChar menuseparator
6819 File formats\SpecialChar menuseparator
6826 \begin_inset Flex Noun
6829 \begin_layout Plain Layout
6830 Skim\SpecialChar menuseparator
6831 Preferences\SpecialChar menuseparator
6838 \begin_inset Flex Noun
6841 \begin_layout Plain Layout
6847 preset and enter command
6848 \begin_inset Flex Noun
6851 \begin_layout Plain Layout
6852 /Applications/\SpecialChar LyX
6853 .app/Contents/MacOS/lyxeditor
6861 \begin_layout Standard
6862 Reverse search is triggered by COMMAND-SHIFT-click
6865 \begin_layout Subsubsection*
6869 \begin_layout Standard
6871 \begin_inset Flex Noun
6874 \begin_layout Plain Layout
6875 Settings\SpecialChar menuseparator
6876 Configure Okular\SpecialChar menuseparator
6883 \begin_inset Quotes eld
6887 \begin_inset Quotes erd
6891 \begin_inset Flex Code
6894 \begin_layout Plain Layout
6903 \begin_layout Standard
6904 Reverse search is triggered by SHIFT-click.
6907 \begin_layout Subsubsection*
6911 \begin_layout Standard
6912 Qpdfview supports Sync\SpecialChar TeX
6913 since version 0.3.5.
6915 \begin_inset Flex Noun
6918 \begin_layout Plain Layout
6919 Edit\SpecialChar menuseparator
6920 Settings\SpecialChar menuseparator
6926 , click on the input field of the
6927 \begin_inset Quotes eld
6931 \begin_inset Quotes erd
6934 item and add the command
6935 \begin_inset Flex Code
6938 \begin_layout Plain Layout
6947 \begin_layout Standard
6948 Reverse search is triggered by double-click.
6951 \begin_layout Subsubsection*
6955 \begin_layout Standard
6956 Launch yap, choose its
6957 \begin_inset Flex Noun
6960 \begin_layout Plain Layout
6961 View\SpecialChar menuseparator
6968 \begin_inset Quotes eld
6972 \begin_inset Quotes erd
6977 \begin_inset Quotes eld
6980 New\SpecialChar ldots
6982 \begin_inset Quotes erd
6985 button and, in the window that opens, enter
6986 \begin_inset Quotes eld
6991 \begin_inset Quotes erd
6994 (or any other name you like) in the
6995 \begin_inset Quotes eld
6999 \begin_inset Quotes erd
7003 Now click on the button labeled
7004 \begin_inset Quotes eld
7009 \begin_inset Quotes erd
7012 to open a file dialog and navigate to the directory containing the batch
7014 \begin_inset Flex Code
7017 \begin_layout Plain Layout
7025 \begin_inset Flex Code
7028 \begin_layout Plain Layout
7034 and then specify the program arguments as
7035 \begin_inset Flex Code
7038 \begin_layout Plain Layout
7046 \begin_inset Flex Code
7049 \begin_layout Plain Layout
7055 wrapper is used for communicating with \SpecialChar LyX
7063 \begin_layout LyX-Code
7065 \begin_inset Newline newline
7068 echo LYXCMD:revdvi:server-goto-file-row:%1 %2>
7077 \begin_inset Newline newline
7091 \begin_layout Standard
7092 Make sure that the \SpecialChar LyX
7093 Server pipe path you specified in \SpecialChar LyX
7095 \begin_inset Flex Code
7098 \begin_layout Plain Layout
7112 , otherwise change the
7113 \begin_inset Flex Code
7116 \begin_layout Plain Layout
7122 wrapper accordingly.
7125 \begin_layout Standard
7126 In yap, reverse search is triggered by double-click.
7129 \begin_layout Subsubsection*
7130 SumatraPDF (Windows)
7133 \begin_layout Standard
7134 In order to use SumatraPDF for inverse search, enter
7135 \begin_inset Flex Code
7138 \begin_layout Plain Layout
7139 SumatraPDF -inverse-search "lyxeditor.bat %f %l"
7144 in the viewer setting in
7145 \begin_inset Flex Noun
7148 \begin_layout Plain Layout
7149 Preferences\SpecialChar menuseparator
7150 File Handling\SpecialChar menuseparator
7151 File formats\SpecialChar menuseparator
7158 \begin_inset Flex Code
7161 \begin_layout Plain Layout
7167 is the previous wrapper.
7168 If SumatraPDF.exe is not in your command PATH, use its full file name.
7171 \begin_layout Standard
7172 Reverse search is triggered by double-click.
7175 \begin_layout Subsubsection*
7179 \begin_layout Standard
7180 First of all, make sure that yap is your default DVI viewer in the Windows
7181 environment, then launch it, choose its
7182 \begin_inset Flex Noun
7185 \begin_layout Plain Layout
7186 View\SpecialChar menuseparator
7193 \begin_inset Quotes eld
7197 \begin_inset Quotes erd
7202 \begin_inset Quotes eld
7205 New\SpecialChar ldots
7207 \begin_inset Quotes erd
7210 button and, in the window that opens, enter
7211 \begin_inset Quotes eld
7216 \begin_inset Quotes erd
7219 (or any other name you like) in the
7220 \begin_inset Quotes eld
7224 \begin_inset Quotes erd
7228 Now click on the button labeled
7229 \begin_inset Quotes eld
7234 \begin_inset Quotes erd
7237 to open a file dialog and navigate to the directory containing the
7238 \begin_inset Flex Code
7241 \begin_layout Plain Layout
7247 program (which is installed by default on Cygwin along with the \SpecialChar LyX
7250 \begin_inset Flex Code
7253 \begin_layout Plain Layout
7259 and then specify the program arguments as
7260 \begin_inset Flex Code
7263 \begin_layout Plain Layout
7270 In this way, you will be using the
7274 for communicating with \SpecialChar LyX
7276 If, for whatever reason, you want to use the
7281 \begin_inset Flex Code
7284 \begin_layout Plain Layout
7290 option and be sure to specify the \SpecialChar LyX
7291 Server pipe path in the \SpecialChar LyX
7295 \begin_layout Standard
7296 In yap, reverse search is triggered by double-click.
7299 \begin_layout Subsubsection*
7303 \begin_layout Standard
7304 In order to use SumatraPDF for inverse search, enter
7305 \begin_inset Flex Code
7308 \begin_layout Plain Layout
7309 SumatraPDF -inverse-search "lyxeditor -g %f %l"
7314 in the viewer setting in
7315 \begin_inset Flex Noun
7318 \begin_layout Plain Layout
7319 Preferences\SpecialChar menuseparator
7320 File Handling\SpecialChar menuseparator
7321 File formats\SpecialChar menuseparator
7328 If SumatraPDF.exe is not in your command PATH, use its full posix path.
7330 \begin_inset Flex Code
7333 \begin_layout Plain Layout
7339 enables communication via the
7345 \begin_inset Flex Code
7348 \begin_layout Plain Layout
7354 option if you want to use the
7358 , and be sure to specify the \SpecialChar LyX
7359 Server pipe path in the \SpecialChar LyX
7363 \begin_layout Standard
7364 Reverse search is triggered by double-click.
7367 \begin_layout Section
7371 \begin_layout Standard
7372 Forward search is, as the name implies, in a sense the
7373 \begin_inset Quotes eld
7377 \begin_inset Quotes erd
7381 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
7383 If forward search is set up (as described in what follows), you can put
7384 the cursor anywhere in your \SpecialChar LyX
7386 \begin_inset Flex Noun
7389 \begin_layout Plain Layout
7390 Navigate\SpecialChar menuseparator
7397 \begin_inset Flex Noun
7400 \begin_layout Plain Layout
7406 in the context menu via right mouse click), and then the viewer will jump
7407 to that position as well.
7408 This implies, of course, that your viewer supports this function.
7411 \begin_layout Standard
7412 To make forward search possible, you first need to provide the generated
7413 output PDF/DVI file with additional information about the \SpecialChar TeX
7415 This can be done via the methods described in the section
7416 \begin_inset CommandInset ref
7418 reference "subsec:rev-search"
7425 \begin_layout Standard
7426 Additionally, you need to configure \SpecialChar LyX
7427 for using your viewers in
7428 \begin_inset Flex Noun
7431 \begin_layout Plain Layout
7432 Tools\SpecialChar menuseparator
7433 Preferences\SpecialChar menuseparator
7434 Output\SpecialChar menuseparator
7441 We provide a range of tested configurations for some viewers, which you
7442 can select from the drop down list.
7443 If none of these configurations suits you, you have to find out and enter
7444 a suitable configuration yourself.
7445 The definition syntax uses the following placeholders:
7448 \begin_layout Itemize
7450 \begin_inset Flex Code
7453 \begin_layout Plain Layout
7462 \begin_layout Itemize
7464 \begin_inset Flex Code
7467 \begin_layout Plain Layout
7473 : name of the (temporary) exported .tex file (without path)
7476 \begin_layout Itemize
7478 \begin_inset Flex Code
7481 \begin_layout Plain Layout
7487 : name of the (temporary) exported .tex file (including path)
7490 \begin_layout Itemize
7492 \begin_inset Flex Code
7495 \begin_layout Plain Layout
7501 : name of the exported output file (either dvi or pdf, depending on which
7502 one exists in the temporary directory)
7505 \begin_layout Standard
7506 Note that only some of the viewers provide full forward search functionality,
7507 among them yap, xdvi, okular
7511 \begin_layout Plain Layout
7512 You might want to set
7513 \begin_inset Flex Code
7516 \begin_layout Plain Layout
7523 \begin_inset Flex Noun
7526 \begin_layout Plain Layout
7527 Tools\SpecialChar menuseparator
7528 Preferences\SpecialChar menuseparator
7529 File Handling\SpecialChar menuseparator
7531 \begin_inset space ~
7544 , qpdfview and SumatraPDF
7548 \begin_layout Plain Layout
7549 SumatraPDF can also use DDE commands through the external program CMCDDE
7551 \begin_inset CommandInset href
7553 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
7563 While many of the widespread PDF viewers (most notably Adobe Reader) do
7564 not support forward search at all, some other viewers – e.
7565 \begin_inset space \thinspace{}
7569 evince and xpdf – allow at least to reload the document and jump to a specific
7570 page of the file, so you can at least navigate
7571 \begin_inset Quotes eld
7575 \begin_inset Quotes erd
7579 This latter functionality is provided by an external call of synctex (see
7580 the predefined example configurations).
7584 \begin_layout Standard
7585 Forward search works both with DVI and PDF output.
7587 simply checks which preview format you have used before (i.
7588 \begin_inset space \thinspace{}
7591 e., which format is already there in the temporary directory) and chooses
7592 the appropriate configuration for the respective format.
7595 \begin_layout Chapter
7596 Special Document Classes
7599 \begin_layout Section
7603 \begin_layout Standard
7609 \begin_layout Subsection
7613 \begin_layout Standard
7614 This section describes how \SpecialChar LyX
7615 can be used to write articles for submission
7616 to the scientific journal
7618 Astronomy and Astrophysics
7621 \begin_inset Flex URL
7624 \begin_layout Plain Layout
7626 http://www.edpsciences.fr/aa/
7631 ) using Version 5.01 of the document class
7636 This package can be downloaded from the ftp site
7639 \begin_layout Standard
7640 \begin_inset VSpace medskip
7646 \begin_layout Standard
7648 \begin_inset Flex URL
7651 \begin_layout Plain Layout
7653 ftp://ftp.edpsciences.org/pub/aa/readme.html
7661 \begin_layout Standard
7662 \begin_inset VSpace medskip
7668 \begin_layout Standard
7669 A manual comes together with that package, and this text is not meant to
7670 replace the original manual but is merely a short guide in how to realize
7671 the correct form of your paper.
7675 \begin_layout Standard
7676 Please note that the publisher of the journal was changed from Springer
7677 to EDP Sciences starting January 1, 2001.
7678 That change involved also some slight changes to the style files, namely
7679 the removal of the thesaurus command.
7680 The \SpecialChar LyX
7681 class aa supports the newest version of these style files, V 5.01.
7682 If you have an older version installed, please upgrade.
7683 For compatibility, the old (version 4) layout has been kept as
7688 Please refer to the comments in
7691 Dir/layouts/aapaper.layout
7696 \begin_layout Subsection
7700 \begin_layout Standard
7701 It is recommended you start from the example template distributed with \SpecialChar LyX
7703 If you are not using a template, note the following settings:
7706 \begin_layout Itemize
7713 Document\SpecialChar menuseparator
7716 dialog (OK, that one was obvious).
7719 \begin_layout Itemize
7720 Don't change the option
7723 \begin_inset space ~
7733 The whole layout is done by the macros, you shouldn't change anything.
7736 \begin_layout Subsection
7740 \begin_layout Standard
7741 First thing to enter is the header information.
7742 It consists of seven entries, of which some are optional.
7746 \begin_layout Itemize
7754 \begin_layout Itemize
7762 \begin_layout Itemize
7770 \begin_layout Itemize
7778 \begin_layout Itemize
7783 : [optional] if more than one author: whom to contact for offprint requests.
7786 \begin_layout Itemize
7791 : [optional] mail address for contacts.
7794 \begin_layout Itemize
7802 Received: <date>; Accepted <date>
7805 \begin_layout Standard
7806 There is no need to issue the
7812 command, this is done automatically by \SpecialChar LyX
7813 when the header is finished.
7814 Although the order of the single header entries doesn't matter it is advised
7815 to keep the above sequence, just to get the best optics and meets the layout
7816 of the real document.
7819 \begin_layout Standard
7820 If you want to place footnotes in the header block, e.
7821 \begin_inset space \thinspace{}
7825 \begin_inset space \space{}
7828 to state your present address, just use the standard footnote via the menu
7831 Insert\SpecialChar menuseparator
7836 will automagically use the term
7845 \begin_layout Standard
7846 In addition to these topics, the macros use three additional \SpecialChar LaTeX
7848 have no counterpart in \SpecialChar LyX
7852 \begin_layout Itemize
7859 to separate different names for more than one author and institute, respectivel
7863 \begin_layout Itemize
7870 to mark corresponding author/institute pairs.
7871 The institutes are numbered sequentially as they appear in the
7875 field, so you have to put a marker to each author.
7878 \begin_layout Itemize
7885 to supply an email address for fast contact.
7888 \begin_layout Standard
7889 In all cases, the appropriate command has to be entered in \SpecialChar LyX
7897 \begin_layout Subsection
7901 \begin_layout Standard
7902 The abstract should immediately follow the header block.
7903 With version 5 the abstract environment was changed to a command, and there
7904 is now a resctriction to only one paragraph.
7905 In addition, it should contain an entry with the keywords.
7906 This is not yet implemented for \SpecialChar LyX
7907 , therefore you have to enter the \SpecialChar LaTeX
7915 by hand and mark it as \SpecialChar LaTeX
7917 Refer to the example paper.
7920 \begin_layout Subsection
7921 Supported environments
7924 \begin_layout Standard
7925 The A&A paper layout supports the following environments for structuring
7929 \begin_layout Itemize
7935 \begin_layout Itemize
7941 \begin_layout Itemize
7947 \begin_layout Itemize
7953 \begin_layout Itemize
7959 \begin_layout Itemize
7965 \begin_layout Itemize
7971 \begin_layout Itemize
7977 \begin_layout Itemize
7983 \begin_layout Itemize
7989 \begin_layout Itemize
7995 \begin_layout Itemize
8002 \begin_layout Subsection
8003 Commands not supported by \SpecialChar LyX
8007 \begin_layout Standard
8008 Some commands are not yet supported by the
8012 layout for \SpecialChar LyX
8014 Some have already been mentioned.
8015 For the sake of completeness, they are listed all together here:
8018 \begin_layout Itemize
8026 \begin_layout Itemize
8034 \begin_layout Itemize
8042 \begin_layout Itemize
8050 \begin_layout Itemize
8058 \begin_layout Itemize
8066 \begin_layout Itemize
8074 \begin_layout Itemize
8082 \begin_layout Standard
8083 If you want to use any of these commands, you have to enter them yourself.
8086 Do not forget to mark them as \SpecialChar LaTeX
8090 \begin_layout Subsection
8091 Figure and Table Floats
8094 \begin_layout Standard
8096 provides support for the necessary float environments
8098 figure, figure*, table
8104 , therefore we won't tell much about it here.
8108 \begin_inset space ~
8114 Just remember that tables should be left-aligned.
8115 For that, select the table and change the alignment in
8117 Edit\SpecialChar menuseparator
8119 \begin_inset space ~
8125 \begin_layout Standard
8126 There is only one special thing: the figures with caption besides the figure.
8127 To create such a figure, you have to do the following:
8130 \begin_layout Enumerate
8131 Create a wide figure float:
8133 Insert\SpecialChar menuseparator
8134 Float\SpecialChar menuseparator
8137 , then right click in the figure and select
8140 \begin_inset space ~
8148 \begin_layout Enumerate
8149 Enter your caption text.
8152 \begin_layout Enumerate
8157 to move the cursor above the caption.
8160 \begin_layout Enumerate
8164 \begin_layout Enumerate
8165 Position the cursor behind the figure and insert a horizontal fill:
8167 Insert\SpecialChar menuseparator
8169 \begin_inset space ~
8172 Character\SpecialChar menuseparator
8174 \begin_inset space ~
8182 \begin_layout Enumerate
8183 Switch to \SpecialChar LaTeX
8187 \begin_inset space ~
8195 \begin_layout Enumerate
8205 Do not close the brace!
8208 \begin_layout Enumerate
8209 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
8214 \begin_inset space ~
8226 \begin_layout Standard
8227 Also, refer to the figures in the example paper.
8230 \begin_layout Subsection
8234 \begin_layout Standard
8235 For submission, the paper has to be formated in a special double-spacing
8237 For this purpose, you have to give the option
8241 to the documentclass.
8242 This must be done using the extra class options field in the
8244 Document\SpecialChar menuseparator
8248 Just enter the string
8255 \begin_layout Subsection
8259 \begin_layout Standard
8264 directory contains an example paper written with \SpecialChar LyX
8266 It is the example paper from the original macro package, translated to
8269 Use it for inspiration, and compare the original \SpecialChar LaTeX
8270 code with \SpecialChar LyX
8274 \begin_layout Section
8279 \begin_layout Standard
8285 \begin_layout Subsection
8289 \begin_layout Standard
8291 is a set of macros produced by the American Astronomical Society to
8292 facilitate electronic manuscript submission to the three journals they
8293 publish: the Astrophysical Journal (including the Letters and Supplement),
8294 the Astronomical Journal, and the Publications of the Astronomical Society
8297 has proven to be an excellent tool for generating these documents, especially
8298 given its equation, citation, and figure handling capabilities.
8300 requires version 5.0 (or higher) of these macros; preferably 5.2, which
8301 is the version described here, or higher.
8302 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
8303 2.09 and are fundamentally
8304 incompatible with \SpecialChar LyX
8306 The AAS\SpecialChar TeX
8307 package may be downloaded from the AAS\SpecialChar TeX
8311 \begin_layout Standard
8312 \begin_inset VSpace medskip
8318 \begin_layout Standard
8320 \begin_inset Flex URL
8323 \begin_layout Plain Layout
8325 https://aas.org/aastex/aastex-downloads
8333 \begin_layout Standard
8334 \begin_inset VSpace medskip
8340 \begin_layout Standard
8341 A complete user guide is contained in that package and you should familiarize
8342 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
8345 will not reduce the need to figure out all the AAS\SpecialChar TeX
8346 commands, it will only
8347 reduce the drudgery of typing everything in.
8348 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
8350 completely to the requirements of the journal to which you are submitting
8354 \begin_layout Subsection
8355 Starting a New Paper
8358 \begin_layout Standard
8359 I strongly suggest that you start with the AAS\SpecialChar TeX
8363 File\SpecialChar menuseparator
8370 , enter the new file name, then choose the
8375 This will show the most common fields found in a manuscript.
8376 Simply overwrite the existing text (including the brackets,
8380 ) with the correct information.
8381 Many of the AAS\SpecialChar TeX
8382 commands and environments can be implemented directly in
8384 , but some cannot: most noticeably
8396 , which should stick out like a sore thumb if you actually just opened the
8398 For commands such as these, the \SpecialChar LaTeX
8399 code must be entered directly and marked
8401 Such commands are referred to as \SpecialChar TeX
8402 code, or Evil Red Text.
8403 I tried to minimize the amount of \SpecialChar TeX
8404 code needed in an AAS\SpecialChar TeX
8406 there is still a bit more required than any of us would like.
8409 \begin_layout Subsection
8410 Finishing Your Paper
8413 \begin_layout Standard
8414 When the paper is finished to your satisfaction and previews/prints correctly,
8416 \begin_inset Quotes eld
8420 \begin_inset Quotes erd
8423 actions which need to be done before you submit it to the journals.
8427 \begin_layout Enumerate
8428 Export your paper as a \SpecialChar LaTeX
8431 File\SpecialChar menuseparator
8432 Export\SpecialChar menuseparator
8440 \begin_layout Enumerate
8445 file with your favorite text editor
8446 \begin_inset Separator latexpar
8453 \begin_layout Enumerate
8454 remove the comment lines before the
8463 \begin_layout Enumerate
8468 usepackage...{fontenc}
8470 line if it appears (usually just after
8485 \begin_layout Enumerate
8486 remove everything between (and including) the
8498 commands, except for any commands you specifically put into the \SpecialChar LaTeX
8500 (which should appear immediately after the
8501 \begin_inset Quotes eld
8504 User specified \SpecialChar LaTeX
8506 \begin_inset Quotes erd
8517 \begin_layout Enumerate
8518 Run the resulting file through \SpecialChar LaTeX
8519 to make sure it still processes correctly.
8522 \begin_layout Enumerate
8523 Reread the journal requirements to make sure your filenames and formats
8527 \begin_layout Enumerate
8531 \begin_layout Subsection
8532 Comments On Specific Commands
8535 \begin_layout Standard
8536 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
8543 ) gives a good description of each.
8544 Thus it's probably easiest for me to go down the list as found in the guide
8545 and offer comments where necessary.
8546 So let's begin \SpecialChar ldots
8550 \begin_layout Subsubsection
8551 Things that work as expected
8554 \begin_layout Standard
8555 Because they work as you might expect, I simply list them and the section
8656 begin{thebibliography}
8664 (2.13.2), all the cite commands and their variations (2.13.2), the generic
8665 graphicx figure commands (2.14.1),
8689 (2.15.4, amongst other places),
8716 \begin_layout Standard
8717 The following style options also work correctly:
8738 Simply put them in the
8744 Layout\SpecialChar menuseparator
8750 \begin_layout Subsubsection
8751 Things that work, but require more comment
8754 \begin_layout Standard
8755 The following items work, but require a little more discussion:
8758 \begin_layout Itemize
8759 These items are reserved for use by the journal editors, but you can put
8760 them into the \SpecialChar LaTeX
8761 preamble if you feel compelled to do so:
8794 \begin_layout Itemize
8795 These items may be placed in the \SpecialChar LaTeX
8796 preamble, and are included as blanks in
8818 \begin_layout Itemize
8825 (2.3) – can only be used
8826 \begin_inset Quotes eld
8830 \begin_inset Quotes erd
8833 , not in the middle of a paragraph.
8834 Use \SpecialChar TeX
8835 code if you need to embed it.
8838 \begin_layout Itemize
8845 (2.3) – will have extra {} after it.
8846 This should not cause an error.
8849 \begin_layout Itemize
8856 (2.6) – can only be used
8857 \begin_inset Quotes eld
8861 \begin_inset Quotes erd
8864 , not in the middle of a paragraph.
8865 Use \SpecialChar TeX
8866 code if you need to embed it.
8869 \begin_layout Itemize
8876 (2.8) – can't insert a cross-reference tag, you must type the tag name by
8880 \begin_layout Itemize
8894 \begin_layout Itemize
8901 (2.9) – will have extra {} after it.
8902 This should not cause an error.
8905 \begin_layout Itemize
8912 (2.11) – will have extra {} after it.
8913 This should not cause an error.
8916 \begin_layout Itemize
8923 (2.14.2) – you can insert an optional filename argument by placing the cursor
8924 at the beginning of the text and selecting
8926 Insert\SpecialChar menuseparator
8931 \begin_inset Quotes eld
8935 \begin_inset Quotes erd
8938 inserts an optional argument of the type needed by
8945 Hopefully it will be renamed someday.
8948 \begin_layout Itemize
8961 for the catalog ID optional parameter
8964 \begin_layout Itemize
8977 for the catalog ID optional parameter
8980 \begin_layout Subsubsection
8981 Things not implemented, use \SpecialChar TeX
8985 \begin_layout Standard
9008 setcounter{equation}
9010 (2.12), Journal name abbreviations (2.13.4),
9046 (2.15.4, insert it as the first element in the lefthand cell after where
9048 Don't use any of \SpecialChar LyX
9049 's rules in the table),
9061 (2.15.5), much of Misc (2.17, except
9112 \begin_layout Subsubsection
9113 Things that cannot be implemented
9116 \begin_layout Standard
9118 at least in any meaningful sort of way, so I suggest ignoring them.
9119 They are the references environment (2.13.3), and the deluxetable environment
9121 If you really, really need to use deluxetable, I suggest editing it in
9122 a separate file with a text editor, then using
9124 Insert\SpecialChar menuseparator
9126 \begin_inset space ~
9131 to include it in your \SpecialChar LyX
9137 file to see an example of this.
9140 \begin_layout Subsection
9141 FAQs, Tips, Tricks, and Other Ruminations
9144 \begin_layout Subsubsection
9145 Getting \SpecialChar LyX
9146 and AAS\SpecialChar TeX
9150 \begin_layout Standard
9151 It can be a bit tricky to get \SpecialChar LyX
9152 to recognize a new layout and document class.
9153 When all else fails, do this:
9156 \begin_layout Enumerate
9157 Make certain that \SpecialChar LaTeX
9158 can find AAS\SpecialChar TeX
9160 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
9162 directory completely unrelated to \SpecialChar LaTeX
9163 or AAS\SpecialChar TeX
9164 and run \SpecialChar LaTeX
9172 \begin_layout Enumerate
9177 appears in \SpecialChar LyX
9185 \begin_layout Enumerate
9188 Tools\SpecialChar menuseparator
9192 , then restart \SpecialChar LyX
9196 \begin_layout Enumerate
9197 Open a regular new file, not from a template.
9198 Does AAS\SpecialChar TeX
9199 appear in the class list in
9201 Document\SpecialChar menuseparator
9207 \begin_layout Standard
9208 If you get a warning from an existing AAS\SpecialChar TeX
9209 document about not being able
9210 to find the AAS\SpecialChar TeX
9211 layout or a message about
9212 \begin_inset Quotes eld
9215 You should not mix title layouts with normal ones
9216 \begin_inset Quotes erd
9219 , things haven't been installed correctly.
9222 \begin_layout Subsubsection
9224 error processing a table
9227 \begin_layout Standard
9229 , by default, attempts to center the table caption/title.
9230 This seems to produce a bad interaction in AAS\SpecialChar TeX
9231 so you should click somewhere
9232 in the caption/title, then select
9234 Edit\SpecialChar menuseparator
9236 \begin_inset space ~
9250 This took care of it for me.
9253 \begin_layout Subsubsection
9257 \begin_layout Standard
9258 A couple of things: 1) I have noticed some funny spacing in the reference
9259 entries in the text.
9260 When you enter the bibliography item data, make sure their is
9264 space between the last author and the parenthesis setting off the year;
9268 \begin_inset space \thinspace{}
9272 \begin_inset space \space{}
9286 2) Entering the references at all is not obvious.
9287 The easiest thing is to start typing your first reference at the end of
9288 the document, then mark it as type
9293 That will put a small gray box in front of what you just typed.
9294 Click on the box to fill in the rest of the information.
9295 For new references, go to the end of an existing reference and press return.
9296 That will create a new line with its own box, etc.
9299 \begin_layout Subsubsection
9303 \begin_layout Standard
9304 Even though AAS\SpecialChar TeX
9305 provides its own figure commands (
9311 , for example), I much prefer \SpecialChar LaTeX
9312 's standard figure commands (with the default
9321 \begin_inset space ~
9324 commands as \SpecialChar TeX
9325 code into a Figure Float box if you desire, but I never have
9326 much luck getting the layout right.
9327 With the standard graphics, \SpecialChar LyX
9332 usepackage{graphicx}
9334 command into the \SpecialChar LaTeX
9335 preamble and handle the figures in the standard \SpecialChar LaTeX2e
9337 interspersing the figures in the text.
9338 I believe ApJ accepts figures exactly this way now; AJ might still use
9340 \begin_inset Quotes eld
9343 stack everything at the end
9344 \begin_inset Quotes erd
9350 \begin_layout Subsubsection
9351 Things I could have done, but didn't
9354 \begin_layout Standard
9356 \begin_inset Quotes eld
9360 \begin_inset Quotes erd
9363 things I could have implemented, but chose not to.
9364 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
9366 even though it is double-spaced in the paper manuscript.
9367 Also, I chose not to make separate layouts for the preprint and preprint2
9369 Since I assume you will spend most of your time in the plain manuscript
9370 mode anyway, I decided not to chew up more disk space with this.
9374 \begin_layout Subsection
9378 \begin_layout Standard
9379 Your mileage may vary.
9380 I've now had papers published by both ApJ and AJ that have had 98% of the
9381 effort done in \SpecialChar LyX
9382 ; the last 2% was the \SpecialChar LaTeX
9383 post-processing and a few cleanups.
9384 I have had no trouble with the submission process, and I'm sure the journals
9385 were never aware that there might be a difference.
9386 So, go forth and publish!
9389 \begin_layout Section
9390 AMS \SpecialChar LaTeX
9394 \begin_layout Standard
9404 \begin_layout Standard
9405 \begin_inset VSpace bigskip
9411 \begin_layout Standard
9413 The AMS \SpecialChar LaTeX
9414 layouts are set up to conform to suggested styles for mathematical
9415 papers to be submitted to American Mathematical Society publications.
9416 The layouts are not tailored to a specific journal, but easily can be.
9417 You should refer to the AMS documentation for specific instructions for
9418 each journal (usually it will entail only changing a single line in the
9421 That documentation is available on the Web at
9422 \begin_inset Flex URL
9425 \begin_layout Plain Layout
9433 \begin_inset Flex URL
9436 \begin_layout Plain Layout
9438 ftp://ftp.ams.org/pub/tex/amslatex/
9444 These layouts are appropriate, and useful, for any mathematical writing.
9448 \begin_layout Standard
9449 There are two basic AMS \SpecialChar LaTeX
9453 \begin_layout Itemize
9454 amsart: The standard AMS article format.
9457 \begin_layout Itemize
9458 amsbook: the standard AMS book (really, monograph) format.
9462 \begin_layout Standard
9463 The layouts themselves contain only the minimum necessary to use the AMS
9465 They do not, in particular, contain any of the `theorem' environments used
9466 for setting theorems, lemmas, and the like.
9467 These are contained, instead, in the
9468 \begin_inset Flex Code
9471 \begin_layout Plain Layout
9477 module, which is loaded by default when you select one of the AMS classes.
9478 (It can also be used with other classes and can be removed, if you would
9479 rather use something else.) Less commonly used environments are in the
9480 \begin_inset Flex Code
9483 \begin_layout Plain Layout
9484 Theorems (AMS-Extended)
9489 module, which must be loaded manually.
9492 \begin_layout Standard
9493 By default, theorems and the like are numbered consecutively throughout
9494 the document, but this may be modified by loading the module
9495 \begin_inset Flex Code
9498 \begin_layout Plain Layout
9499 Theorems (Order by Section)
9504 or, if you are using
9505 \begin_inset Flex Code
9508 \begin_layout Plain Layout
9515 \begin_inset Flex Code
9518 \begin_layout Plain Layout
9519 Theorems (Order by Chapter)
9525 These will number the results as
9526 \begin_inset Formula $n.m$
9529 , where the first number refers to the section (or chapter) and the second
9530 refers to the total number of results so far in that section (or chapter).
9531 Many environments are also available unnumbered.
9532 These are indicated by an asterisk at the end.
9533 If you happen to want
9537 unnumbered results, the module
9538 \begin_inset Flex Code
9541 \begin_layout Plain Layout
9547 provides that option.
9550 \begin_layout Standard
9551 Note that these modules do not
9555 to be used with the AMS classes.
9556 It is perfectly possible to use the
9557 \begin_inset Flex Code
9560 \begin_layout Plain Layout
9566 module, and the others mentioned, with other classes, such as
9567 \begin_inset Flex Code
9570 \begin_layout Plain Layout
9577 \begin_inset Flex Code
9580 \begin_layout Plain Layout
9587 \begin_inset Flex Code
9590 \begin_layout Plain Layout
9599 \begin_layout Subsection
9600 What these layouts provide
9603 \begin_layout Standard
9604 There is a long list of included environments provided by these layouts.
9605 In AMS-\SpecialChar LaTeX
9606 , there is, in fact, an opportunity to define an unlimited variety
9607 of `theorem' environments.
9608 However, the AMS recommends the environments that are available in \SpecialChar LyX
9613 \begin_layout Standard
9614 The following environments—as well as the standard environments, such as
9616 \begin_inset Flex Noun
9619 \begin_layout Plain Layout
9626 \begin_inset Flex Noun
9629 \begin_layout Plain Layout
9636 \begin_inset Flex Noun
9639 \begin_layout Plain Layout
9646 \begin_inset Flex Noun
9649 \begin_layout Plain Layout
9656 \begin_inset Flex Noun
9659 \begin_layout Plain Layout
9666 \begin_inset Flex Code
9669 \begin_layout Plain Layout
9676 \begin_inset Flex Code
9679 \begin_layout Plain Layout
9688 \begin_layout Description
9689 Address This should be the author's permanent address.
9692 \begin_layout Description
9694 \begin_inset space ~
9697 Address This should be the author's temporary address at the time of submission,
9698 if different from the Address.
9701 \begin_layout Description
9702 Email Author's e-mail address
9705 \begin_layout Description
9706 URL Author's Web address, if desired.
9709 \begin_layout Description
9710 Keywords Key words or phrases used to identify specific topics discussed
9714 \begin_layout Description
9715 Subjectclass These refer to the AMS Subject Classifications, published and
9718 Mathematical Reviews
9721 These are also available online at the AMS cites listed above.
9724 \begin_layout Description
9728 \begin_layout Description
9732 \begin_layout Description
9736 \begin_layout Standard
9737 The following environments are provided by both the
9738 \begin_inset Flex Code
9741 \begin_layout Plain Layout
9748 \begin_inset Flex Code
9751 \begin_layout Plain Layout
9757 modules, in the latter case in both starred (unnumbered) and unstarred
9758 (numbered) versions.
9759 These same environments are provided only in the starred versions by the
9761 \begin_inset Flex Code
9764 \begin_layout Plain Layout
9773 \begin_layout Theorem
9774 This is typically used for the statements of major results.
9778 \begin_layout Corollary*
9779 This is used for statements which follow fairly directly from previous statement
9781 Again, these can be major results.
9786 These are smaller results needed to prove other statements.
9789 \begin_layout Proposition
9790 These are less major results which (hopefully) add to the general theory
9794 \begin_layout Conjecture
9795 These are statements provided without justification, which the author does
9796 not know how to prove, but which seem to be true (to the author, at least).
9799 \begin_layout Definition*
9800 Guess what this is for.
9801 The font is different for this environment than for the previous ones.
9805 \begin_layout Example*
9806 Used for examples illustrating proven results.
9809 \begin_layout Problem
9810 It's not really known what this is for.
9811 You should figure it out.
9814 \begin_layout Exercise*
9815 Write a description for this one.
9818 \begin_layout Remark
9819 This environment is also a type of theorem, usually a lesser sort of observation.
9822 \begin_layout Claim*
9823 Often used in the course of giving a proof of a larger result.
9827 Generally, these are used to break up long arguments, using specific instances
9833 The numbering scheme for cases is on its own, not together with other numbered
9839 At the end of this environment, a QED symbol (usually a square, but it can
9840 vary with different styles) is placed.
9841 If you want to have other environments within this one—for example, Case
9842 environments—and have the QED symbol appear only after them, then the other
9843 environments need to be nested within the proof environment.
9846 Nesting Environments
9852 for information on nesting.
9855 \begin_layout Standard
9856 And these environments are provided by
9857 \begin_inset Flex Code
9860 \begin_layout Plain Layout
9861 Theorems (AMS-Extended)
9869 \begin_layout Criterion*
9870 A required condition.
9873 \begin_layout Algorithm*
9874 A general procedure to be used.
9877 \begin_layout Axiom*
9878 This is a property or statement taken as true within the system being discussed.
9881 \begin_layout Condition*
9882 Sometimes used to state a condition assumed within the present context of
9887 Similar to a Remark.
9890 \begin_layout Notation*
9891 Used for the explanation of, yes, notation.
9894 \begin_layout Summary
9895 Do we really need to tell you?
9898 \begin_layout Acknowledgement*
9902 \begin_layout Conclusion*
9903 Sometimes used at the end of a long train of argument.
9907 Used in a way similar to Proposition, though perhaps lower on the scale.
9910 \begin_layout Standard
9911 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
9914 They need to be available on your system in order to use these environments.
9917 \begin_layout Section
9925 \begin_layout Standard
9931 \begin_layout Subsection
9935 \begin_layout Standard
9936 These are the layout files for some of the journals of the American Geophysical
9938 It is assumed that you have both the AGU's own class files and AGUplus
9939 installed (everything to be found at
9940 \begin_inset Flex URL
9943 \begin_layout Plain Layout
9945 http://publications.agu.org/files/2013/08/AGU-LaTeX.zip
9953 \begin_layout Subsection
9957 \begin_layout Standard
9967 They are still called this in the \SpecialChar LyX
9968 GUI, though their \SpecialChar LaTeX
9981 \begin_layout Standard
9982 Newly defined styles are
10019 These are mostly manuscript attributes and defined in the AGU class documentati
10023 \begin_layout Standard
10024 I suspect this is still badly incomplete.
10027 \begin_layout Subsection
10031 \begin_layout Standard
10048 \begin_layout Subsection
10052 \begin_layout Itemize
10055 Journal of Geophysical Research
10064 \begin_layout Standard
10065 Add your own, it isn't so hard! Look at the
10076 \begin_layout Subsection
10077 Bugs and things to remember
10080 \begin_layout Standard
10081 In order to use the new layouts, you must remember to do the following for
10085 \begin_layout Enumerate
10091 This can be done in the
10093 Layout\SpecialChar menuseparator
10098 Document\SpecialChar menuseparator
10102 (AGU articles are always in English, right? So
10106 choose a language.)
10109 \begin_layout Enumerate
10114 into the document's
10119 (Yes, this is a bug.)
10122 \begin_layout Enumerate
10123 Make sure you use the
10127 bibliography style, by entering
10131 into the second field of the Bib\SpecialChar TeX
10133 None of the standard styles will do.
10136 \begin_layout Section
10140 \begin_layout Standard
10146 \begin_layout Subsection
10150 \begin_layout Standard
10151 Broadway is for writing plays.
10152 The format is more decorative than Hollywood, and much less standardized.
10153 This format should be suitable for workshops.
10156 \begin_layout Subsection
10160 \begin_layout Standard
10161 The same as in Hollywood.
10164 \begin_layout Subsection
10168 \begin_layout Standard
10173 names as labels then cross-reference the label to insert the name.
10174 The cross-reference dialog will show the current cast of characters.
10177 \begin_layout Subsection
10178 Paper size and Margins
10181 \begin_layout Standard
10182 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
10185 \begin_layout Subsection
10189 \begin_layout Standard
10190 The following environments are available.
10191 You can use broadway.bind to get the bind keys shown at the right.
10194 \begin_layout Itemize
10198 \begin_inset Newline newline
10203 You should not have to use this, but it is here for anything that does not
10207 \begin_layout Itemize
10211 \begin_inset space \hfill{}
10215 \begin_inset Newline newline
10220 Used to describe stage setting and the action.
10221 First use of speaker names in all CAPs.
10224 \begin_layout Itemize
10228 \begin_inset space \hfill{}
10232 \begin_inset Newline newline
10237 Automatically numbered.
10238 On screen it will be arabic, but will print as Roman.
10241 \begin_layout Itemize
10245 \begin_inset space \hfill{}
10249 \begin_inset Newline newline
10259 It is just centered text.
10262 \begin_layout Itemize
10266 \begin_inset space \hfill{}
10270 \begin_inset Newline newline
10275 Not automatically numbered.
10276 You supply the number.
10277 This is because I couldn't figure out how.
10280 \begin_layout Itemize
10284 \begin_inset space \hfill{}
10288 \begin_inset Newline newline
10293 A special case of Narrative to describe the setting and action as the curtain
10297 \begin_layout Itemize
10301 \begin_inset space \hfill{}
10305 \begin_inset Newline newline
10310 The speaker's (actor's) title, centered in all CAPS.
10313 \begin_layout Itemize
10317 \begin_inset space \hfill{}
10321 \begin_inset Newline newline
10326 Instructions to the speaker.
10327 The parentheses are automatically inserted.
10328 The ( will appear on screen, but both will be in the printed play.
10329 This environment is only used within
10336 \begin_layout Itemize
10340 \begin_inset space \hfill{}
10344 \begin_inset Newline newline
10349 What the Speaker says.
10352 \begin_layout Itemize
10356 \begin_inset space \hfill{}
10360 \begin_inset Newline newline
10365 The curtain comes down.
10368 \begin_layout Itemize
10372 \begin_inset space \hfill{}
10378 \begin_layout Itemize
10382 \begin_inset space \hfill{}
10388 \begin_layout Itemize
10392 \begin_inset space \hfill{}
10398 \begin_layout Standard
10402 \begin_layout Section
10406 \begin_layout Standard
10411 can be used to type letters according to German conventions.
10412 A template file is included in
10414 .../lyx/share/templates
10416 for you to use as a starting point.
10419 \begin_layout Section
10427 \begin_layout Standard
10433 \begin_layout Subsection
10437 \begin_layout Standard
10438 This is the layout file for the European Geophysical Society journals.
10443 can be downloaded from the web site of the EGS under
10444 \begin_inset Flex URL
10447 \begin_layout Plain Layout
10457 \begin_layout Subsection
10461 \begin_layout Standard
10464 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
10472 The current layout file is unfortunately very unmodular and would benefit
10473 from using the various
10480 \begin_layout Section
10484 \begin_layout Standard
10485 See the \SpecialChar LyX
10491 It contains all infos you need.
10494 \begin_layout Section
10497 Foil\SpecialChar TeX
10501 \begin_inset CommandInset label
10510 \begin_layout Standard
10516 \begin_layout Subsection
10520 \begin_layout Standard
10521 This section describes how to use \SpecialChar LyX
10522 to make slides for overhead projectors.
10523 There are two document classes that can do this: the default slides class
10526 Foil\SpecialChar TeX
10530 This section documents the latter.
10533 \begin_layout Standard
10534 I'm going to say this again, nice and clear, so that there's no misunderstanding
10538 \begin_layout Standard
10539 \begin_inset VSpace bigskip
10545 \begin_layout Standard
10549 This section documents the class
10550 \begin_inset Quotes eld
10558 \begin_inset Quotes erd
10566 \begin_layout Standard
10567 \begin_inset VSpace bigskip
10573 \begin_layout Standard
10574 If you're looking for the documentation for
10575 \begin_inset Quotes eld
10583 \begin_inset Quotes erd
10586 , check out section
10587 \begin_inset space ~
10591 \begin_inset CommandInset ref
10593 reference "sec:slitex"
10598 If your machine doesn't have the
10606 installed, you'll probably have to use the default
10610 class, which isn't quite as good as
10615 \begin_layout Standard
10620 class is designed for use with version
10621 \begin_inset space ~
10629 class file which is now an integral part of \SpecialChar LaTeX2e
10633 \begin_layout Subsection
10637 \begin_layout Standard
10638 Obviously, to use this document class, you need to select
10649 \begin_inset space ~
10655 There are some settings in the
10658 \begin_inset space ~
10663 dialog that you should know about that are specific to this class:
10666 \begin_layout Itemize
10667 Don't change the options
10678 \begin_inset space ~
10684 They're ignored by the
10691 \begin_layout Itemize
10692 The default font size is 20
10693 \begin_inset space \thinspace{}
10696 pt with the other options being 17
10697 \begin_inset space \thinspace{}
10701 \begin_inset space \thinspace{}
10705 \begin_inset space \thinspace{}
10711 \begin_layout Itemize
10712 The default font is
10720 but all math equations are still typeset in the usual roman font.
10723 \begin_layout Itemize
10726 Foil\SpecialChar TeX
10729 supports A4 and Letter paper sizes as well as a special size for working
10731 \begin_inset space \thinspace{}
10735 It doesn't support A5, B5, legal or executive paper sizes.
10738 \begin_layout Itemize
10739 Don't bother changing the
10743 settings because they are ignored anyway.
10744 All floats appear where they are defined in the text.
10747 \begin_layout Itemize
10752 setting behaves a bit differently for this class.
10755 Foil\SpecialChar TeX
10758 provides extensive footer and header capabilities including a user-defined
10761 \begin_inset space ~
10765 \begin_inset CommandInset ref
10767 reference "sec:foilfoot"
10772 The title page is treated differently to all other pages in the document
10781 has the logo centered at the bottom of the page (if one is defined).
10782 The possible page style choices and what they do are as follows:
10783 \begin_inset Separator latexpar
10790 \begin_layout Labeling
10791 \labelwidthstring MMMMMMM
10798 The final output contains no page numbers, or other headers or footers
10799 (except footnotes of course).
10803 \begin_layout Labeling
10804 \labelwidthstring MMMMMMM
10811 The final output contains page numbers centered at the bottom of the page.
10812 No other headings or footers (other than footnotes).
10815 \begin_layout Labeling
10816 \labelwidthstring MMMMMMM
10821 Page numbers in lower right corner.
10822 Additional headers and footers are also shown.
10823 This is also the default.
10826 \begin_layout Labeling
10827 \labelwidthstring MMMMMMM
10832 Gives you access to the
10836 package although its use with
10838 Foil\SpecialChar TeX
10841 is discouraged by the writer of the
10843 Foil\SpecialChar TeX
10846 package because of some potential page layout clashes.
10850 \begin_layout Subsubsection
10854 \begin_layout Standard
10855 The following options may be used in the extra class options in the
10857 Document\SpecialChar menuseparator
10863 \begin_layout Labeling
10864 \labelwidthstring MMMMMMx
10869 This sets up the page layout for 7.33
10870 \begin_inset space \thinspace{}
10874 \begin_inset space \thinspace{}
10877 in paper, which is about the same aspect ratio as a 35
10878 \begin_inset space \thinspace{}
10881 mm slide, making it a bit easier to work with this medium.
10884 \begin_layout Labeling
10885 \labelwidthstring MMMMMMx
10890 Places a rule across the page below the header on every page except the
10894 \begin_layout Labeling
10895 \labelwidthstring MMMMMMx
10900 Places a rule across the page above the footer on every page except the
10904 \begin_layout Labeling
10905 \labelwidthstring MMMMMMx
10910 This is automatically set each time you create a new
10917 Foil\SpecialChar TeX
10920 to use the dvips driver to rotate those pages that are set as landscape
10924 \begin_layout Labeling
10925 \labelwidthstring MMMMMMx
10930 Simply changes the page dimensions to those of a landscape page but doesn't
10932 Thus if you use this option you need to use an external program to rotate
10933 each page or feed your paper through your printer as landscape.
10934 Note that this option effectively reverses the roles of the
10942 environments (don't worry these are described in the next section).
10945 \begin_layout Labeling
10946 \labelwidthstring MMMMMMx
10951 Equation numbers on the left.
10954 \begin_layout Labeling
10955 \labelwidthstring MMMMMMx
10960 Flush-left equations.
10963 \begin_layout Subsection
10964 Supported Environments
10967 \begin_layout Standard
10968 Most of the environments commonly supported in other classes are also supported
10974 There are several additional environments provided by
10976 Foil\SpecialChar TeX
10979 as well as a couple added by \SpecialChar LyX
10981 The following environments are shared with other classes:
10984 \begin_layout Standard
10985 \begin_inset Flex Multiple Columns
10988 \begin_layout Itemize
10994 \begin_layout Itemize
11000 \begin_layout Itemize
11006 \begin_layout Itemize
11012 \begin_layout Itemize
11018 \begin_layout Itemize
11025 \begin_layout Itemize
11031 \begin_layout Itemize
11037 \begin_layout Itemize
11043 \begin_layout Itemize
11049 \begin_layout Itemize
11055 \begin_layout Itemize
11061 \begin_layout Itemize
11067 \begin_layout Itemize
11073 \begin_layout Itemize
11079 \begin_layout Itemize
11085 \begin_layout Itemize
11091 \begin_layout Itemize
11102 \begin_layout Standard
11103 That is, all the major environments apart from the sectioning environments.
11104 Since foils are essentially self-contained sections, with a title and body,
11107 Foil\SpecialChar TeX
11110 provides specific commands for starting new foils and these are:
11113 \begin_layout Itemize
11119 \begin_layout Itemize
11125 \begin_layout Standard
11127 also provides slightly modified versions of these two environments called:
11130 \begin_layout Itemize
11136 \begin_layout Itemize
11139 ShortRotatefoilhead
11142 \begin_layout Standard
11143 and the differences will be explained in the next section.
11146 \begin_layout Standard
11147 Since foils are often used in presenting ideas or new theorems and such
11150 Foil\SpecialChar TeX
11153 also provides a comprehensive box of goodies for presenting them:
11156 \begin_layout Standard
11157 \begin_inset Flex Multiple Columns
11160 \begin_layout Itemize
11166 \begin_layout Itemize
11172 \begin_layout Itemize
11178 \begin_layout Itemize
11184 \begin_layout Itemize
11190 \begin_layout Itemize
11196 \begin_layout Itemize
11202 \begin_layout Itemize
11208 \begin_layout Itemize
11214 \begin_layout Itemize
11220 \begin_layout Itemize
11231 \begin_layout Standard
11232 The starred versions are unnumbered while the unstarred versions are numbered.
11233 There are also two list environments added by \SpecialChar LyX
11237 \begin_layout Itemize
11243 \begin_layout Itemize
11249 \begin_layout Standard
11252 Foil\SpecialChar TeX
11255 provides some powerful header and footer capabilities that are best set
11256 in the preamble although they may be set at any point in a document.
11257 If you want to change these settings in your document the best place to
11258 do so is at the very top of a foil, i.
11259 \begin_inset space \thinspace{}
11265 \begin_inset space \space{}
11270 straight after the foilhead.
11273 \begin_layout Standard
11274 For this purpose, the following command styles are provided [
11281 \begin_layout Standard
11282 \begin_inset Flex Multiple Columns
11285 \begin_layout Itemize
11289 \begin_inset space ~
11295 \begin_layout Itemize
11301 \begin_layout Itemize
11305 \begin_inset space ~
11311 \begin_layout Itemize
11315 \begin_inset space ~
11321 \begin_layout Itemize
11325 \begin_inset space ~
11331 \begin_inset Separator latexpar
11338 \begin_layout Plain Layout
11339 \begin_inset space ~
11351 \begin_layout Standard
11352 There are also a few commands provided by
11354 Foil\SpecialChar TeX
11357 that aren't directly supported by \SpecialChar LyX
11358 but I'll tell you what they do and how
11359 to use them in section
11360 \begin_inset space ~
11364 \begin_inset CommandInset ref
11366 reference "sec:unsuppfoils"
11373 \begin_layout Subsection
11374 Building a Set of Foils
11377 \begin_layout Standard
11378 This section will give a simple introduction to using the different environments
11379 to build a set of foils.
11380 If you want to see an example set of foils, take a look at the
11384 file you find in \SpecialChar LyX
11392 \begin_layout Subsubsection
11393 Give It a Title Page
11396 \begin_layout Standard
11397 Unlike other classes that provide
11417 creates the title on a page of its own.
11418 If you leave out the
11422 environment \SpecialChar LaTeX
11423 will substitute the current date (every time you regenerate
11427 \begin_layout Subsubsection
11431 \begin_layout Standard
11432 As I mentioned earlier, there are four ways of starting a new foil.
11433 For portrait foils you should use
11442 The difference between these two environments is the amount of space between
11443 the title of the foil (the foilhead) and the body of the foil.
11446 \begin_layout Standard
11447 Landscape foils are generated using the
11453 ShortRotatefoilhead
11456 Again the only difference is the spacing between foilhead and body.
11457 Both of the short versions have 0.5
11458 \begin_inset space ~
11461 inches less separation between the foilhead and the body.
11465 \begin_layout Standard
11466 One problem with the support for landscape foils is the requirement that
11467 you have to use the
11471 driver to generate the PostScript output otherwise the foils won't be rotated.
11472 It is possible to get landscape foils even if you haven't got the
11476 driver provided you can feed your foils sideways through your printer ;-)
11479 \begin_layout Subsubsection
11480 Theorems, Lemmas, Proofs and more
11483 \begin_layout Standard
11484 Due to a small bug in \SpecialChar LyX
11485 you can't have two of the same type of these environments
11486 directly following each other.
11487 They must be separated by something.
11488 If you try, you will just be extending the previous environment as if you
11489 had merged the two environments together.
11490 So, how do you get around this problem? The simplest option is to insert
11491 some text between the two environments or add a
11496 environment between the two with just a
11497 \begin_inset Quotes eld
11505 \begin_inset Quotes erd
11509 This will force \SpecialChar LyX
11510 to produce two separate environments and hence the correct
11513 An example is provided in the example file included with the \SpecialChar LyX
11515 Remember, this problem only occurs if you are trying to place two of the
11516 same type of theorem-like environments one directly after the other.
11519 \begin_layout Subsubsection
11523 \begin_layout Standard
11524 You get all the commonly supported list styles found in other classes as
11525 well as two new ones.
11526 I'll only describe the new ones here.
11527 If you want to find out more about the other list environments check out
11533 If you intend to use itemized lists you might also want to read about the
11537 \begin_inset space ~
11541 \begin_inset space ~
11546 dialog described above in section
11547 \begin_inset space ~
11551 \begin_inset CommandInset ref
11553 reference "sec:bullet"
11560 \begin_layout Standard
11561 The two new list styles,
11569 , are designed to make it easier for you to create lists of do's and don'ts
11570 or right and wrong by providing dedicated environments that use a tick
11571 or a cross as the label of the list.
11572 These lists are in fact dedicated variants of the
11577 They do however require that you have the
11581 packages installed.
11584 \begin_layout Subsubsection
11588 \begin_layout Standard
11591 Foil\SpecialChar TeX
11594 redefines the floating tables and figures so that they appear exactly where
11595 they are in the text rather than pushing them to the top of the page or
11596 to some user specified location.
11597 In fact if you change the float placement settings they are simply ignored.
11600 \begin_layout Subsubsection
11601 Page Headers and Footers
11602 \begin_inset CommandInset label
11604 name "sec:foilfoot"
11611 \begin_layout Standard
11615 \begin_inset space ~
11624 are two commands used to control the left-footer text string.
11625 The first is meant to allow you to include a graphic logo on your foils
11627 \begin_inset Quotes eld
11632 Foil\SpecialChar TeX
11636 \begin_inset Quotes erd
11640 While the second is meant to provide a classification for the audience,
11644 \begin_inset space \thinspace{}
11650 \begin_inset space \space{}
11654 It is empty by default.
11657 \begin_layout Standard
11658 The remaining page corners can be filled by
11661 \begin_inset space ~
11666 (which defaults to page numbers),
11669 \begin_inset space ~
11677 \begin_inset space ~
11685 \begin_layout Subsection
11688 Foil\SpecialChar TeX
11692 \begin_inset CommandInset label
11694 name "sec:unsuppfoils"
11701 \begin_layout Standard
11702 All the commands mentioned below need to be set in a
11712 within another environment.
11715 \begin_layout Subsubsection
11719 \begin_layout Standard
11720 All lengths are adjusted using the
11743 should be replaced by the name given to the length you want to change and
11748 is the length value.
11749 All lengths should be specified in units of length such as inches (
11761 ) or relative to some document or font-based length such as
11771 \begin_layout Standard
11772 It's possible to change the spacing between a foilhead and the body of the
11773 foil by adjusting the length specified by
11780 For example, to make
11785 \begin_inset space \space{}
11788 in closer to their bodies put the following in the preamble:
11794 foilheadskip}{-0.5in}
11797 \begin_layout Standard
11798 The spacings around floats can be adjusted by setting these lengths:
11801 \begin_layout Labeling
11802 \labelwidthstring MMMMMMMMMMM
11809 Separation between the text and the top of the float
11812 \begin_layout Labeling
11813 \labelwidthstring MMMMMMMMMMM
11820 Separation between the float and the caption
11823 \begin_layout Labeling
11824 \labelwidthstring MMMMMMMMMMM
11831 Separation between the caption and the following text
11834 \begin_layout Labeling
11835 \labelwidthstring MMMMMMMMMMM
11842 You can make the captions narrower than the surrounding text by adjusting
11844 Best done relative to
11853 \begin_layout Standard
11854 There are also several title page related lengths that you may find useful
11855 if you have a long title or several authors:
11858 \begin_layout Labeling
11859 \labelwidthstring MMMMMMMMMMM
11866 Separation from headers to
11871 \begin_layout Labeling
11872 \labelwidthstring MMMMMMMMMMM
11890 \begin_layout Labeling
11891 \labelwidthstring MMMMMMMMMMM
11905 \begin_layout Labeling
11906 \labelwidthstring MMMMMMMMMMM
11922 \begin_layout Labeling
11923 \labelwidthstring MMMMMMMMMMM
11939 \begin_layout Standard
11940 The last length related command affects all the list environments.
11951 a list environment then all the vertical spacing between the list items
11953 Note that this is a command not a length so it doesn't require
11959 like the stuff mentioned above.
11962 \begin_layout Subsubsection
11963 Headers and Footers
11966 \begin_layout Standard
11979 commands control whether the logo in the
11983 definition appear on a given page.
11990 in the preamble then none of the foils will have the logo on them.
11991 If you don't want the logo on a particular page place the
11997 directly after the foilhead of that page and the
12003 directly after the next foilhead.
12006 \begin_layout Standard
12007 If you decide to use the
12011 page style setting in the
12014 \begin_inset space ~
12019 dialog you should probably add
12029 to your preamble so headers and footers on landscape pages are correctly
12030 placed when rotated.
12031 This is due to some clashes between the page layouts provided by the
12042 \begin_layout Section
12043 Hollywood (Hollywood spec scripts)
12046 \begin_layout Standard
12052 \begin_layout Subsection
12056 \begin_layout Standard
12057 Getting the format of a Hollywood script right is a
12058 \begin_inset Quotes eld
12062 \begin_inset Quotes erd
12065 It is designed to make the readers focus on content and to be easy and
12066 familiar for the actors to read.
12067 Each page of a script should be one minute of film.
12068 Nothing goes in a script that you cannot see or hear on screen.
12069 The courier 12 pt font should be used throughout.
12073 \begin_layout Subsection
12077 \begin_layout Standard
12078 Speakers' lines should NEVER break in mid-sentence.
12079 If a speaker's lines continue over a page break, repeat the
12083 title followed by (Cont'd).
12086 \begin_layout Subsection
12090 \begin_layout Standard
12095 names as labels then cross-reference the label to insert the name.
12096 The cross-reference dialog will show the current cast of characters.
12097 You can use this to insert the speaker name in narratives also.
12100 \begin_layout Subsection
12101 Paper size and Margins
12104 \begin_layout Standard
12105 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12108 \begin_layout Subsection
12112 \begin_layout Standard
12113 The following environments are available.
12114 You can use hollywood.bind to get the bind keys shown at the right.
12117 \begin_layout Itemize
12121 \begin_inset Newline newline
12126 Used where nothing else works.
12130 \begin_layout Itemize
12136 \begin_inset space \hfill{}
12144 \begin_inset Newline newline
12147 Usually followed by something like
12148 \begin_inset Quotes eld
12151 on Sally waking up.
12152 \begin_inset Quotes erd
12158 \begin_layout Itemize
12162 \begin_inset space \hfill{}
12166 \begin_inset Newline newline
12171 Introduces a new INTERIOR camera set-up.
12172 Always followed by DAY or NIGHT, or something similar to define the lighting
12174 Everthing on this line in CAPS.
12177 \begin_layout Itemize
12181 \begin_inset space \hfill{}
12185 \begin_inset Newline newline
12190 Introduces a new EXTERIOR camera set-up.
12191 Everthing on this line in CAPS.
12194 \begin_layout Itemize
12198 \begin_inset space \hfill{}
12202 \begin_inset Newline newline
12207 The character speaking.
12210 \begin_layout Itemize
12214 \begin_inset space \hfill{}
12218 \begin_inset Newline newline
12223 Instructions to the speaker.
12224 The () are automatically inserted, but only the ( will show in \SpecialChar LyX
12226 Both will be printed.
12229 \begin_layout Itemize
12233 \begin_inset space \hfill{}
12237 \begin_inset Newline newline
12249 \begin_layout Itemize
12253 \begin_inset space \hfill{}
12257 \begin_inset Newline newline
12262 Camera movement instruction.
12264 \begin_inset space \thinspace{}
12268 \begin_inset space \space{}
12274 \begin_layout Itemize
12278 \begin_inset space \hfill{}
12284 \begin_layout Itemize
12288 \begin_inset space \hfill{}
12294 \begin_layout Itemize
12298 \begin_inset space \hfill{}
12304 \begin_layout Itemize
12308 \begin_inset space \hfill{}
12314 \begin_layout Subsection
12318 \begin_layout Itemize
12322 \begin_layout Itemize
12326 \begin_layout Itemize
12328 \begin_inset space \thinspace{}
12335 \begin_layout Itemize
12340 \begin_layout Itemize
12341 PAN — camera movement
12344 \begin_layout Itemize
12345 INSERT — cut to close-up of
12348 \begin_layout Section
12352 \begin_layout Standard
12355 Panayotis Papasotiriou
12358 \begin_layout Subsection
12362 \begin_layout Standard
12363 The ijmpc package is a set of macros that facilitates electronic manuscript
12366 International Journal of Modern Physics C
12369 Similarly, the ijmpd package is for creating manuscripts to be submitted
12372 International Journal of Modern Physics D
12375 Both journals are published by World Scientific.
12376 The corresponding document classes are named
12385 These files, together with instructions for the authors, can be downloaded
12387 \begin_inset Flex URL
12390 \begin_layout Plain Layout
12392 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
12398 \begin_inset Flex URL
12401 \begin_layout Plain Layout
12403 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
12409 Both packages are modified versions of the standard
12410 \begin_inset Quotes eld
12414 \begin_inset Quotes erd
12417 package, and they are almost (but not exactly) identical.
12418 Most of their features are supported by \SpecialChar LyX
12420 I have used \SpecialChar LyX
12421 successfully to write articles submitted to both journals
12422 without any problem.
12425 \begin_layout Subsection
12429 \begin_layout Standard
12430 As usual, the easiest way to write a paper is to start with a template.
12433 File\SpecialChar menuseparator
12449 This will give an (almost) empty document that includes the most common
12450 fields found in a manuscript.
12451 Simply overwrite the existing text (including the brackets,
12456 You should keep in mind the following remarks.
12459 \begin_layout Enumerate
12461 won't let you change the font size and the page style of the document,
12462 because such modifications are not allowed by both packages.
12465 \begin_layout Enumerate
12466 The language of the document should not be changed.
12467 Before previewing your paper, be sure that the babel package is not used.
12468 To do this, click on
12470 Tools\SpecialChar menuseparator
12481 checkbox in the language settings, and click on
12489 , if you wish to make this change permanent).
12492 \begin_layout Enumerate
12494 \begin_inset Quotes eld
12498 \begin_inset Quotes erd
12501 style must be used to define keywords.
12504 \begin_layout Enumerate
12505 The ijmpc package provides a style named
12506 \begin_inset Quotes eld
12509 Classification Codes
12510 \begin_inset Quotes erd
12513 , which can be used to define classification codes, such as PACS numbers.
12514 Note that this facility is not supported by the ijmpd package.
12517 \begin_layout Enumerate
12518 Several new environments are available:
12519 \begin_inset Quotes eld
12523 \begin_inset Quotes erd
12527 \begin_inset Quotes eld
12531 \begin_inset Quotes erd
12535 \begin_inset Quotes eld
12539 \begin_inset Quotes erd
12543 \begin_inset Quotes eld
12547 \begin_inset Quotes erd
12551 \begin_inset Quotes eld
12555 \begin_inset Quotes erd
12559 \begin_inset Quotes eld
12563 \begin_inset Quotes erd
12567 \begin_inset Quotes eld
12571 \begin_inset Quotes erd
12575 \begin_inset Quotes eld
12579 \begin_inset Quotes erd
12583 \begin_inset Quotes eld
12587 \begin_inset Quotes erd
12591 \begin_inset Quotes eld
12595 \begin_inset Quotes erd
12599 \begin_inset Quotes eld
12603 \begin_inset Quotes erd
12607 \begin_inset Quotes eld
12611 \begin_inset Quotes erd
12615 \begin_inset Quotes eld
12619 \begin_inset Quotes erd
12623 \begin_inset Quotes eld
12627 \begin_inset Quotes erd
12631 Their use is more or less obvious.
12633 supports all these environments; it will use the proper label, text style,
12634 and numbering scheme for each of them.
12637 \begin_layout Enumerate
12638 Both packages use basic citations; the natbib package should not be used.
12639 In \SpecialChar LyX
12640 , citation references are shown as usual; in the output, citations are
12641 shown as superscripts.
12642 If you want to use a citation as normal text, you should use the
12647 \begin_inset space \thinspace{}
12651 \begin_inset space \space{}
12655 \begin_inset Quotes eld
12659 \begin_inset space \space{}
12669 \begin_inset Quotes erd
12675 \begin_layout Enumerate
12677 \begin_inset Quotes eld
12681 \begin_inset Quotes erd
12684 section in both packages.
12685 To put acknowledgments, just use the
12686 \begin_inset Quotes eld
12690 \begin_inset Quotes erd
12696 \begin_layout Enumerate
12697 Appendices may be added to the paper,
12701 the Acknowledgments and
12707 provides a special environment, called
12708 \begin_inset Quotes eld
12712 \begin_inset Quotes erd
12715 which marks the beginning of the appendices.
12716 This environment should be left blank; it just sends a \SpecialChar LaTeX
12717 command, but nothing
12719 In \SpecialChar LyX
12721 \begin_inset Quotes eld
12725 \begin_inset Quotes erd
12728 is printed with blue letters, as a signal that all sections after that
12729 point are appendices.
12730 To write an appendix, use the
12731 \begin_inset Quotes eld
12735 \begin_inset Quotes erd
12740 will number each appendix with capital letters, as required by both journals.
12742 \begin_inset Quotes eld
12746 \begin_inset Quotes erd
12753 be present before the first appendix; if not, all appendices will be numbered
12754 as normal sections in the output.
12757 \begin_layout Enumerate
12758 The ijmpc and the ijmpd packages use the
12762 command to implement table captions.
12763 As a result, a table created by \SpecialChar LyX
12764 is printed correctly, but its caption
12766 However, you can use some \SpecialChar TeX
12767 code to overcome this problem, so that captions
12768 are printed as expected.
12769 To do so, create a float table as usual, remove the caption, and replace
12770 it with the \SpecialChar TeX
12781 (sic); you must also the \SpecialChar TeX
12786 immediately after the tabular material.
12787 Study the example table included in the template files to see how this
12788 trick is implemented.
12789 Alternatively, If you need table captions, you should implement the whole
12794 file, then include this file to the \SpecialChar LyX
12797 Insert\SpecialChar menuseparator
12798 File\SpecialChar menuseparator
12800 \begin_inset space ~
12806 Details on how to create a table float can be found in the files
12814 , included in the corresponding packages.
12817 \begin_layout Subsection
12818 Preparing a paper for submission
12821 \begin_layout Standard
12822 Before you submit your paper you must export the \SpecialChar LyX
12823 document as a \SpecialChar LaTeX
12826 File\SpecialChar menuseparator
12827 Export\SpecialChar menuseparator
12835 \begin_layout Plain Layout
12836 Actually you have the choice between \SpecialChar LaTeX
12837 (plain) and pdflatex.
12838 If you intend to use pdflatex to prepare the paper, you should use the
12839 pdflatex option so that included graphics are converted to PDF format,
12840 ready for use by pdflatex.
12845 , then make the following changes to the resulting
12852 \begin_layout Enumerate
12853 Remove the comment lines before the
12862 \begin_layout Enumerate
12863 Remove everything between (and including) the
12875 commands, except for any commands you specifically put into the \SpecialChar LaTeX
12879 \begin_layout Standard
12884 file should be saved and processed through \SpecialChar LaTeX
12885 as many times as necessary.
12886 You may also want to check the resulting
12893 \begin_layout Subsection
12894 Use of \SpecialChar TeX
12898 \begin_layout Standard
12899 The use of \SpecialChar TeX
12900 code is reduced to two commands, which must be placed at the
12901 top of the document.
12902 If you started writing your paper by using the
12910 template, the \SpecialChar TeX
12911 code needed is already in its place; you usually don't need
12913 You may only modify the first \SpecialChar TeX
12914 code to specify the information printed
12915 to the top of odd and even pages (authors' names and short paper's title,
12917 This \SpecialChar TeX
12918 code must have the form
12922 markboth{Authors' Names}{Short Paper's Title}
12927 \begin_layout Section
12931 \begin_layout Standard
12937 \begin_layout Subsection
12941 \begin_layout Standard
12942 The iopart package provides a document class to create electronic manuscript
12943 submission to the journals published by the Institute of Physics.
12944 Instructions for the authors how to create a paper using the iopart class
12945 can be downloaded together with the iopart package from the site
12946 \begin_inset Flex URL
12949 \begin_layout Plain Layout
12951 ftp://ftp.iop.org/pub/journals/latex2e
12959 \begin_layout Subsection
12963 \begin_layout Standard
12964 The easiest way to write a paper is to start with the file
12968 that is available in \SpecialChar LyX
12969 's examples files folder.
12970 Open this file, save it under a new name, and start writing.
12971 The example file explains how to use the special text environments.
12972 Here are the most important advices:
12975 \begin_layout Itemize
12976 To be able to compile your document to a PDF, PS, or DVI, ensure that the
12979 Use AMS math package
12981 in the document settings under
12988 \begin_layout Itemize
12991 The title environment defines the kind of your paper.
12992 So use one of the following environments for the title:
12995 \begin_inset Separator latexpar
13002 \begin_layout Itemize
13011 \begin_layout Itemize
13020 \begin_layout Itemize
13026 for a Topical review
13029 \begin_layout Itemize
13038 \begin_layout Itemize
13047 \begin_layout Itemize
13053 for a Paper (same as Title)
13056 \begin_layout Itemize
13062 for a Preliminary communication
13065 \begin_layout Itemize
13071 for a Rapid communication
13074 \begin_layout Itemize
13080 for a Letter to the editor
13084 \begin_layout Itemize
13087 All title environments except of
13091 can have an optional short title.
13094 \begin_layout Itemize
13095 There is a general title environment
13099 which is not directly supported by the \SpecialChar LyX
13101 This can be used as \SpecialChar TeX
13102 code when your document doesn't fit into one of the
13106 \begin_layout Standard
13107 For more informations like hints for special table and formula formatting,
13108 look at the IOP author guidelines.
13111 \begin_layout Section
13115 \begin_layout Standard
13118 Panayotis Papasotiriou
13121 \begin_layout Subsection
13125 \begin_layout Standard
13126 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
13127 that facilitates electronic manuscript submission to the journals they
13129 Most known of them (at least in my domain of interest) are
13131 Astrophysics and Space Science
13137 , but there are many others (see a complete list at
13138 \begin_inset Flex URL
13141 \begin_layout Plain Layout
13143 http://www.wkap.nl/jrnllist.htm/JRNLHOME
13149 The Kluwer package may be downloaded from the site
13150 \begin_inset Flex URL
13153 \begin_layout Plain Layout
13155 http://www.wkap.nl/kaphtml.htm/STYLEFILES
13161 A complete user guide is contained in that package (but it can also be
13162 downloaded separately).
13165 \begin_layout Standard
13167 supports many features of the package but not everything.
13168 However, the \SpecialChar TeX
13169 code needed is reduced to some
13170 \begin_inset Quotes eld
13174 \begin_inset Quotes erd
13177 commands of the package (see
13178 \begin_inset space ~
13182 \begin_inset CommandInset ref
13184 reference "subsec:kluwer_peculiarities"
13189 I have recently used \SpecialChar LyX
13190 to write an article submitted to the
13192 Astrophysics and Space Science
13194 without any problem.
13197 \begin_layout Subsection
13201 \begin_layout Standard
13202 The easiest way to write a paper is to start with the Kluwer template file.
13205 File\SpecialChar menuseparator
13217 This will give an (almost) empty document that includes the most common
13218 fields found in a manuscript and a short description of their use.
13219 As in most templates, simply overwrite the existing text (including the
13224 ) with the correct information.
13227 \begin_layout Subsection
13228 Preparing a paper for submission
13231 \begin_layout Standard
13232 As in the AAS\SpecialChar TeX
13233 package, before you submit your paper to a journal you must
13235 \begin_inset Quotes eld
13239 \begin_inset Quotes erd
13245 \begin_layout Enumerate
13246 Export your paper as a \SpecialChar LaTeX
13248 To do this, click on
13250 File\SpecialChar menuseparator
13251 Export\SpecialChar menuseparator
13259 \begin_layout Enumerate
13264 file with a text editor and make the following changes
13265 \begin_inset Separator latexpar
13272 \begin_layout Enumerate
13273 remove the comment lines before the
13282 \begin_layout Enumerate
13283 remove everything between (and including) the
13295 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13299 \begin_layout Standard
13308 \begin_layout Enumerate
13313 file through \SpecialChar LaTeX
13314 as many times as necessary (usually up to three).
13317 \begin_layout Enumerate
13323 \begin_inset space \thinspace{}
13327 \begin_inset space \space{}
13334 , and check if everything is OK (it should, if you didn't make any mistake).
13337 \begin_layout Subsection
13338 \begin_inset Quotes eld
13342 \begin_inset Quotes erd
13345 of the Kluwer package
13346 \begin_inset CommandInset label
13348 name "subsec:kluwer_peculiarities"
13355 \begin_layout Standard
13356 The Kluwer package has the following
13357 \begin_inset Quotes eld
13361 \begin_inset Quotes erd
13367 \begin_layout Enumerate
13368 It is possible to write multiple articles in the same \SpecialChar LaTeX
13373 \begin_layout Plain Layout
13374 I can't imagine any good reason to do this.
13380 Each article must be included in the environment
13381 \begin_inset Quotes eld
13385 \begin_inset Quotes erd
13389 Unfortunately, this environment cannot be omitted, even if you write just
13391 Therefore, each article starts with the command
13397 and, obviously, ends with the command
13404 Although this can be implemented in \SpecialChar LyX
13405 , I didn't included it, since it looks
13406 ugly and can confuse the novice user.
13407 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
13410 \begin_inset Quotes eld
13415 \begin_inset Quotes erd
13421 \begin_layout Enumerate
13422 Information given at the beginning of the article (i.
13423 \begin_inset space \thinspace{}
13427 \begin_inset space \space{}
13430 title, subtitle, author, institution, running title, running author, abstract
13431 and keywords) must be included in an environment called
13432 \begin_inset Quotes eld
13436 \begin_inset Quotes erd
13440 This is not implemented in \SpecialChar LyX
13441 , so you must enter title, subtitle etc.
13442 \begin_inset space ~
13445 between two \SpecialChar TeX
13461 \begin_layout Enumerate
13462 According to the user manual, the label of each bibliography item must be
13486 \begin_layout Standard
13491 template takes care of all these
13492 \begin_inset Quotes eld
13496 \begin_inset Quotes erd
13500 If you start a new paper using this template you don't need to do anything
13505 \begin_layout Enumerate
13506 don't delete the \SpecialChar TeX
13507 code included in the template, and
13510 \begin_layout Enumerate
13511 copy the example bibliography item included in the template and modify it
13512 as necessary to enter new bibliography items.
13515 \begin_layout Section
13519 \begin_layout Standard
13525 \begin_layout Subsection
13529 \begin_layout Standard
13530 The \SpecialChar LyX
13533 article (koma-script)
13537 report (koma-script)
13555 correspond to the \SpecialChar LaTeX
13573 \begin_inset space ~
13576 of the Koma-Script family.
13577 They are replacements for the standard document classes
13593 , resp., and fit better to European typography conventions in a number of
13597 \begin_layout Itemize
13598 Standard character size is 11pt in
13600 article (koma-script)
13604 report (koma-script)
13612 letter (koma-script)
13617 \begin_layout Itemize
13618 Headings, labels of the description environment, and a number of elements
13621 letter (koma-script)
13623 document class are set in a bold sans serif font.
13627 \begin_layout Plain Layout
13628 There is a big difference between the bold sans serif old cm fonts and new
13629 ec fonts, especially in the appearance of headings.
13630 In comparison, the ec bold sans serif fonts look a bit thin.
13631 Here the \SpecialChar LaTeX
13640 helps to produce the
13641 \begin_inset Quotes eld
13645 \begin_inset Quotes erd
13648 appearance when using the ec fonts.
13653 The numbering of chapter headings is made in the same way as the numbering
13654 of section headings, that is without the extra line
13655 \begin_inset Quotes eld
13658 Chapter\SpecialChar ldots
13660 \begin_inset Quotes erd
13664 In addition, the appearance of the headings can be modified by using a
13665 number of options (in \SpecialChar LyX
13666 to be entered in the field
13669 \begin_inset space ~
13676 Layout\SpecialChar menuseparator
13683 \begin_layout Itemize
13684 The main means in the Koma-Script document classes to design the type area
13693 (in \SpecialChar LyX
13694 to be entered in the extra class options field in the dialog
13696 Document\SpecialChar menuseparator
13700 They make a clearer modification of page margins possible as do the options
13703 Document\SpecialChar menuseparator
13710 \begin_layout Itemize
13711 The \SpecialChar LaTeX
13712 document classes of the Koma-Script family define a number of additional
13714 Those part of it which makes sense in \SpecialChar LyX
13715 is implemented in corresponding
13719 \begin_layout Standard
13720 Detailed descriptions of the \SpecialChar LaTeX
13721 document classes of the Koma-Script family
13722 can be found in the Koma-Script documentation
13733 \begin_layout Subsection
13734 article (koma-script), report (koma-script), and book (koma-script)
13737 \begin_layout Standard
13738 The document classes
13740 article (koma-script)
13744 report (koma-script)
13754 are implemented in the layout files
13767 They contain all the paragraph types of the corresponding standard document
13780 , resp., partly modified, with the exception of the \SpecialChar LyX
13785 -type, which is replaced by the new
13789 -type having the same functionality.
13794 -Type there is a number of new paragraph types added.
13801 letter (koma-script)
13806 \begin_layout Itemize
13815 : are equivalents to
13823 , resp., additionally inserting an entry in the table of contents.
13832 are not contained in
13834 article (koma-script)
13839 \begin_layout Itemize
13848 : behave exactly as
13856 , resp., additionally clearing running heads.
13861 is not contained in
13863 article (koma-script)
13869 \begin_layout Plain Layout
13882 report (koma-script)
13884 , but since this is identical to
13888 , is has not been implemented in \SpecialChar LyX
13897 \begin_layout Itemize
13902 : generates a heading directly above the following paragraph in the standard
13903 character size without affecting the structure of the document.
13906 \begin_layout Itemize
13915 are special captions which respect the different space settings needed
13916 for captions placed above or below an element (if you follow strict typographic
13917 rules, you might want to place table captions always above the table).
13918 You can also use the class option
13922 , which will switch
13935 You need at least Koma-Script version 2.8q to use this.
13938 \begin_layout Itemize
13943 : can be used to set a bonmot, e.
13944 \begin_inset space \thinspace{}
13948 \begin_inset space \space{}
13951 at the beginning of a chapter.
13952 If you use the optional argument (
13954 Insert\SpecialChar menuseparator
13956 \begin_inset space ~
13961 ), you can insert the dictum's author there.
13962 Dictum and author are separated by a line.
13963 You need at least Koma-Script version 2.8q to use this.
13968 is not contained in
13970 article (koma-script)
13975 \begin_layout Standard
13976 The following types, together with the standard types
13988 , form the title area of the document.
13989 They must be entered ahead of the first
13990 \begin_inset Quotes eld
13994 \begin_inset Quotes erd
14001 \begin_layout Plain Layout
14002 The corresponding \SpecialChar LaTeX
14003 commands must appear before the
14014 When such a type is used more than once, the latter usage overwrites the
14015 former one, that means, for every type only the latest usage is valid.
14016 The order of the different types however has, like
14028 , no effect on the appearance of the produced document.
14031 \begin_layout Itemize
14036 : produces a centered paragraph above the ordinary title (
14048 ) for the subject of the document.
14051 \begin_layout Itemize
14056 : produces a centered paragraph below the ordinary title (
14068 ) for the publishers' name.
14071 \begin_layout Itemize
14078 report (koma-script)
14084 produces a centered paragraph on its own page behind the title page, or
14087 article (koma-script)
14089 produces a centered paragraph below the ordinary title (
14105 ) for a dedication.
14108 \begin_layout Itemize
14113 : produces a left aligned paragraph above the ordinary title (
14129 ) for a document`s head.
14132 \begin_layout Itemize
14137 : produces in a double-sided print in
14139 report (koma-script)
14145 a left-aligned paragraph at the top of the title page`s back or has no
14146 effect in a single-sided print or in
14148 article (koma-script)
14153 \begin_layout Itemize
14158 : produces in a double-sided print in
14160 report (koma-script)
14166 a left-aligned paragraph at the bottom of the title page`s back or has
14167 no effect in a single-sided print or in
14169 article (koma-script)
14174 \begin_layout Itemize
14179 : produces a special
14180 \begin_inset Quotes eld
14184 \begin_inset Quotes erd
14187 page ahead of the actual document containing a paragraph without special
14191 \begin_layout Standard
14192 The layout files for the document classes
14194 article (koma-script)
14198 report (koma-script)
14204 do include the file
14209 This is thought of as a place to define your own types.
14214 in your personal layout directory and edit the file!
14217 \begin_layout Subsection
14218 letter (koma-script)
14221 \begin_layout Standard
14225 letter (koma-script)
14227 is implemented in the layout file
14232 It contains all the paragraph types of the corresponding standard document
14237 , partly modified, with the exception of the \SpecialChar LyX
14251 type, which is replaced by the new
14256 In addition, it contains, in contrast to the standard document class, the
14275 Furthermore, there are a number of new letter specific types.
14278 \begin_layout Standard
14279 The appearance of the letter produced by this document class can be controlled
14280 by a number of \SpecialChar LaTeX
14281 commands, which you can put in the \SpecialChar LaTeX
14286 \begin_layout Plain Layout
14287 For example, the standard appearance of the letter`s heading, consisting
14288 of name and address, is quite self-willed.
14290 \begin_inset Quotes eld
14294 \begin_inset Quotes erd
14297 heading is produced by the following \SpecialChar LaTeX
14298 commands in the preamble:
14301 \begin_layout LyX-Code
14311 \begin_layout LyX-Code
14327 \begin_layout LyX-Code
14337 \begin_layout LyX-Code
14357 A detailed German description of such \SpecialChar LaTeX
14358 commands can be found in the Koma-Script
14364 With it, the letter's author can produce his personal letter layout.
14367 \begin_layout Standard
14376 define the beginning of the letter and must be used in every letter.
14377 To emphasize them in the \SpecialChar LyX
14378 document class, they are marked with the letter
14388 \begin_inset space ~
14391 in the left margin.
14392 It is possible to write any number of letters in one file.
14397 type produces a new letter using the same addressee and a
14401 type produces a new addressee.
14418 are ordinary paragraph types and can also be used several times in one
14419 and the same letter.
14422 \begin_layout Itemize
14427 : produces a paragraph for the addressee and implicitly defines the beginning
14431 \begin_layout Itemize
14436 : produces a paragraph for the form of address and implicitly produces a
14440 \begin_layout Itemize
14445 : produces a paragraph for a close.
14448 \begin_layout Itemize
14453 : produces a paragraph for a postscript.
14456 \begin_layout Itemize
14461 : produces a paragraph for a distribution list.
14464 \begin_layout Itemize
14469 : produces a paragraph for enclosures.
14472 \begin_layout Standard
14513 are input types provided with a label to enter information, which will
14514 be processed by the document class.
14518 \begin_layout Plain Layout
14519 It could be seen as a matter of inconsequence, that the types
14527 described above are not such input types as well.
14528 Because of the special meaning of those types, however, I have implemented
14529 them as ordinary paragraph types with a one letter mark in the left margin.
14530 Moreover, it would affect my feeling of symmetry, if the
14538 type had such a serious different appearance.
14543 The types must be used ahead of the corresponding
14550 \begin_layout Standard
14551 An implementation of these types in a WYSIWYG fashion does not seem to make
14552 sense, because the real appearance of the produced letter does not only
14553 depend on the usage of the particular type, but also on other factors.
14554 For example, a signature entered in the
14558 type will in the standard behavior appear in the produced letter only,
14559 when in the same letter also a
14564 The entered value of the
14568 type will in the standard behavior not appear in the produced letter at
14570 The possibility to design the letter`s heading freely is already indicated
14571 in a footnote above.
14574 \begin_layout Standard
14575 The input types can also be used as empty paragraphs.
14576 This makes sense e.
14577 \begin_inset space \thinspace{}
14581 \begin_inset space \space{}
14593 type is not used at all, in the standard behavior the value of the
14597 type is used as signature, whereas if an empty
14601 type is used, no signature value is defined.
14604 \begin_layout Standard
14605 By using the input types it is possible to write a letter template, containing
14606 filled input types with your personal dates (name, address, etc.) and empty
14607 input types for other dates you want to enter.
14610 \begin_layout Itemize
14615 : sender's name, in the standard behavior appears as a centered paragraph
14616 in small caps in the letter`s heading.
14619 \begin_layout Itemize
14624 : sender's signature, in the standard behavior appears below the
14633 type is used, the value of the
14637 type appears instead.
14640 \begin_layout Itemize
14645 : sender's address, in the standard behavior appears in a centered paragraph
14646 in the letter`s heading below the sender's name.
14649 \begin_layout Itemize
14654 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
14665 \begin_layout Itemize
14670 : place of the letter`s making.
14673 \begin_layout Itemize
14678 : date of the letter`s making.
14687 , in the standard behavior, produce the place and the date in a right-aligned
14688 line below the addressee's field.
14693 type is used, neither place nor date appear, independent of the value of
14703 type is used, the date of the letter `s production is used.
14706 \begin_layout Itemize
14711 : sender`s back address, in the standard behavior appears above the addressee's
14712 field in a small sans serif font.
14715 \begin_layout Itemize
14720 : special mail information, in the standard behavior appears underlined
14721 above the addressee's field below the back address.
14724 \begin_layout Itemize
14729 : additional information, in the standard behavior appears on right side
14730 below the addressee`s field.
14733 \begin_layout Itemize
14738 : the letter's title, in the standard behavior appears in a big, bold, sans
14739 serif font above the subject.
14742 \begin_layout Itemize
14747 : the letter's subject, in the standard behavior appears in a bold font
14755 \begin_layout Standard
14776 produce a business letter like line above the
14780 line containing the fields
14781 \begin_inset Quotes eld
14785 \begin_inset Quotes erd
14789 \begin_inset Quotes eld
14793 \begin_inset Quotes erd
14797 \begin_inset Quotes eld
14801 \begin_inset Quotes erd
14805 \begin_inset Quotes eld
14809 \begin_inset Quotes erd
14813 \begin_inset Quotes eld
14817 \begin_inset Quotes erd
14821 \begin_inset Quotes eld
14825 \begin_inset Quotes erd
14829 For the date field, the value of the
14835 \begin_inset Quotes eld
14838 business letter types
14839 \begin_inset Quotes erd
14842 is used, the value of the
14846 type however does not appear, but only the \SpecialChar LaTeX
14854 The ordinary output of place and date in a right-aligned line below the
14855 addressee`s field is suppressed.
14856 The types are implemented as input types provided with a label and must
14857 be used ahead of the corresponding
14864 \begin_layout Itemize
14872 \begin_layout Itemize
14880 \begin_layout Itemize
14888 \begin_layout Itemize
14896 \begin_layout Itemize
14904 \begin_layout Subsection
14905 The new letter class: letter (koma-script v.2)
14908 \begin_layout Standard
14914 \begin_layout Standard
14915 \begin_inset VSpace medskip
14921 \begin_layout Standard
14923 Koma-Script version 2.8 has introduced a new letter class
14927 which supersedes the now unsupported
14932 It has — on the \SpecialChar LaTeX
14933 side — a completely new interface and is not compatible
14934 with the old class.
14935 Therefore, \SpecialChar LyX
14936 supports both, though it is recommended you use the new class.
14939 \begin_layout Standard
14940 This class covers the same functionality as
14942 letter (koma-script),
14945 The basic items are
14949 (receiver's address, same as
14953 in the old layout),
14966 will start a new letter (i.
14967 \begin_inset space \thinspace{}
14971 \begin_inset space \space{}
14974 you can write several letters per document).
14975 New elements are sender's
14991 and the possibility to use a
14997 Insert\SpecialChar menuseparator
15003 \begin_layout Standard
15004 The biggest improvement is, though, that the letter's layout is configurable
15005 to meet almost any needs.
15006 This can be done via the preamble or with a special style file (Letter
15007 Class Option, extension
15011 ), that will be read in as a class option.
15015 \begin_layout Plain Layout
15016 The KOMA package comes with some default
15021 There is, for instance, a
15025 file that follows german typesetting rules, or a
15029 that provides the default layout of the old
15034 The latter can be loaded with the class option
15040 Layout\SpecialChar menuseparator
15041 Document\SpecialChar menuseparator
15053 template that is included in \SpecialChar LyX
15055 A detailed description is to be found in the Koma-Script documentation
15063 \begin_layout Subsection
15067 \begin_layout Standard
15068 Visualizing the Koma-Script document classes in \SpecialChar LyX
15069 , the \SpecialChar LyX
15070 internals cause some
15074 \begin_layout Itemize
15075 The chapter number of a
15079 type appears on a line of its own above the chapter heading instead of
15080 appearing in the same line ahead of it.
15081 The cause for that is the \SpecialChar LyX
15082 internal behavior for the labeltype
15086 in the layout file.
15089 \begin_layout Itemize
15090 The headings of the types
15098 are only put in the
15099 \begin_inset Quotes eld
15103 \begin_inset Quotes erd
15107 table of contents, but not in the \SpecialChar LyX
15108 table of contents (
15110 Document\SpecialChar menuseparator
15112 \begin_inset space ~
15116 \begin_inset space ~
15124 \begin_layout Itemize
15125 The paragraphs in a
15129 document class appear in a skip separation mode, not indented.
15130 This is the standard behavior, no special \SpecialChar LaTeX
15131 commands are needed for that.
15134 Document\SpecialChar menuseparator
15137 dialog the corresponding radio button indicates
15146 value always has the effect that extra \SpecialChar LaTeX
15147 commands are inserted in the document
15148 to produce the gap, which is not what is wanted in this case.
15151 \begin_layout Section
15155 \begin_layout Standard
15161 \begin_layout Subsection
15165 \begin_layout Standard
15166 Memoir is a very powerful and constantly evolving class.
15167 It has been designed with regard to fictional and non-fictional literature.
15168 Its aim is to let the user have maximum control over the typesetting of
15170 Memoir is based on the standard book class, but it can also emulate the
15171 article class (see below).
15174 \begin_layout Standard
15175 Peter Wilson, the developer of Memoir, is known as the author of lots of
15176 useful packages in the \SpecialChar LaTeX
15178 Most of them have been merged with Memoir.
15179 Therefore, it is much easier to layout the table of contents, appendices,
15180 chapter designs and such.
15182 , though, does not support all of these goodies natively.
15183 Some of them might be added to forthcoming releases
15187 \begin_layout Plain Layout
15188 You are invited to send suggestions to
15189 \begin_inset Flex URL
15192 \begin_layout Plain Layout
15194 lyx-devel@lists.lyx.org
15204 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
15206 Of course you can still use all features with the help of some native \SpecialChar LaTeX
15208 commands (\SpecialChar TeX
15213 \begin_layout Plain Layout
15218 \begin_layout Plain Layout
15228 \begin_inset space ~
15232 \begin_inset CommandInset ref
15234 reference "sec:Inserting-TeX-Code"
15244 In this section, we can only list those features that are natively supported
15245 by \SpecialChar LyX
15247 For detailed descriptions (and for the rest of features) we recommend you
15248 have a look at the detailed manual of the Memoir class
15252 \begin_layout Plain Layout
15257 \begin_layout Plain Layout
15267 \begin_inset Flex URL
15270 \begin_layout Plain Layout
15272 CTAN:/macros/latex/memoir/memman.pdf
15282 , which is not only a user guide for the class, but also both a comprehensive
15283 description on good typesetting and a superb example for good typesetting
15287 \begin_layout Subsection
15288 Basic features and restrictions
15291 \begin_layout Standard
15292 Memoir supports basically all features of the standard book classes.
15293 There are, however, some differences, as follows:
15296 \begin_layout Description
15298 \begin_inset space ~
15301 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
15304 \begin_layout Description
15306 \begin_inset space ~
15309 style: The fancy page style is not supported, due to a command clash between
15310 Memoir and the fancyhdr package (they both define a command with the same
15311 name, which confuses \SpecialChar LaTeX
15313 Instead, Memoir comes with a number of its own page styles (see
15315 Layout\SpecialChar menuseparator
15316 Document\SpecialChar menuseparator
15318 \begin_inset space ~
15324 If you want to use these for the chapter pages, you have to use the command
15331 in the main text or in preamble (e.
15332 \begin_inset space \thinspace{}
15336 \begin_inset space \space{}
15343 chapterstyle{companion}
15348 \begin_layout Description
15349 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
15350 optional argument in the standard classes.
15351 With this, you can specify an alternative version of the title for the
15352 table of contents and the headers (for instance, if the title is too long).
15353 In \SpecialChar LyX
15354 , you can do this via
15356 Insert\SpecialChar menuseparator
15358 \begin_inset space ~
15363 at the beginning of a chapter/section.
15364 Memoir features a second optional argument and thus separates the table
15365 of contents from the header.
15366 You can define three variants of a title with this: one for the main text,
15367 one for the table of contents, and one for the headers.
15368 Simply insert two optional arguments if you need this feature, the first
15369 one containing the short title for the Table of Contents, the second one
15370 containing an alternative short title for the headers.
15373 \begin_layout Description
15374 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
15375 of contents, the list of figures and the list of table start a new page
15377 Memoir does not follow this route.
15378 You have to insert a page break yourself, if you want to have one.
15381 \begin_layout Description
15382 Titlepage: For some unknown reason, Memoir uses pagination on the title
15383 page (in the standard classes, title pages are
15384 \begin_inset Quotes eld
15388 \begin_inset Quotes erd
15392 If you want an empty title page, type
15396 aliaspagestyle{title}{empty}
15401 \begin_layout Description
15402 Article: With the class option
15408 Layout\SpecialChar menuseparator
15409 Document\SpecialChar menuseparator
15411 \begin_inset space ~
15416 ), you can emulate article style.
15417 That is, counters (footnotes, figures, tables etc.) will not be reset on
15418 new chapters, chapters don't start a new page (but are—in contrary to
15419 \begin_inset Quotes eld
15423 \begin_inset Quotes erd
15426 article classes—still allowed), parts, though, use their own page, as in
15430 \begin_layout Description
15431 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
15432 font commands, which have been used in the old \SpecialChar LaTeX
15434 \begin_inset space \thinspace{}
15438 \begin_inset space \space{}
15454 It produces an error and stops \SpecialChar LaTeX
15455 whenever such a command appears.
15460 reallows the commands and spits out warnings instead (which does at least
15461 not stop \SpecialChar LaTeX
15463 Since a lot of packages and particularly Bib\SpecialChar TeX
15464 style files are still using
15465 those commands, we have decided to use this option by default.
15468 \begin_layout Subsection
15472 \begin_layout Standard
15473 We will only describe the features supported by \SpecialChar LyX
15474 (which is not much currently).
15475 Please consult the Memoir manual
15479 \begin_layout Plain Layout
15484 \begin_layout Plain Layout
15494 \begin_inset Flex URL
15497 \begin_layout Plain Layout
15499 CTAN:/macros/latex/memoir/memman.pdf
15512 \begin_layout Description
15513 Abstract: You may wonder why an abstract is an extra feature.
15514 Well, it is in book class.
15515 Usually books don't have abstracts.
15516 Memoir, however, has.
15517 You can use it wherever and how often you like.
15520 \begin_layout Description
15521 Chapterprecis: You may know this older typesetting style: The contents of
15522 a chapter are summarized below the title and also in the table of contents
15524 \begin_inset space \thinspace{}
15528 \begin_inset space \space{}
15533 Our hero arrives in Troia; he loses some friends; he finds others
15536 Chapterprecis does exactly this.
15537 It is therefore only sensible below a chapter.
15540 \begin_layout Description
15541 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
15542 The epigraph environment provides an elegant way of typesetting such a
15544 The motto itself (text) and its author (source) are divided by a short
15546 Unfortunately, we have to fool \SpecialChar LyX
15547 a bit here again, since the environment
15548 needs two arguments (text and source).
15549 In this case, we have to use curly brackets (in \SpecialChar TeX
15550 mode) between the two
15561 <author of the slogan>.
15564 \begin_layout Description
15565 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
15566 complex figurative poems).
15568 can only support a few of them.
15569 One is poemtitle, which is a centered title for poems, which will also
15570 be added to the table of contents (verse is the standard environment for
15572 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
15574 because they have to be nested inside regular verse environments, which
15575 is not possible with \SpecialChar LyX
15579 \begin_layout Description
15580 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
15583 \begin_layout Section
15584 Article (mwart), book (mwbk) and report (mwrep)
15585 \begin_inset Argument status
15588 \begin_layout Plain Layout
15601 \begin_layout Standard
15607 \begin_layout Standard
15608 The \SpecialChar LyX
15625 correspond to the \SpecialChar LaTeX
15639 They are replacements for the standard document classes
15651 , resp., and fit better to Polish typography conventions in a number of points.
15655 \begin_layout Standard
15659 \begin_layout Itemize
15660 Unnumbered titles (with star, e.
15661 \begin_inset space \thinspace{}
15665 \begin_inset space \space{}
15672 ) are added into table of contents,
15675 \begin_layout Itemize
15676 Additional page styles:
15677 \begin_inset Separator latexpar
15684 \begin_layout Description
15685 uheadings header with separated lines,
15688 \begin_layout Description
15689 myheadings custom header, contents headers via commands:
15704 \begin_layout Description
15705 myuheadings custom header with separated lines,
15708 \begin_layout Description
15709 outer page number is placed on outer side of page
15713 \begin_layout Itemize
15715 \begin_inset Separator latexpar
15722 \begin_layout Description
15723 rmheadings serif titles — default,
15726 \begin_layout Description
15727 sfheadings sansserif titles,
15730 \begin_layout Description
15731 authortitle on title page first placed is author next title — default,
15734 \begin_layout Description
15735 titleauthor on title page first placed is title next author,
15738 \begin_layout Description
15739 withmarginpar reserve place on page for margins.
15743 \begin_layout Section
15747 \begin_layout Standard
15752 provides an alternative to the standard
15757 It provides similar functionality, but you might prefer this layout with
15758 sans serif sections, headings, and more.
15761 \begin_layout Section
15762 Rev\SpecialChar TeX
15766 \begin_layout Standard
15772 \begin_layout Standard
15773 \begin_inset VSpace bigskip
15779 \begin_layout Standard
15784 \begin_inset space ~
15789 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
15791 \begin_inset Formula $\beta$
15794 release of May, 1999) class.
15797 \begin_layout Standard
15803 textclass, which works with Rev\SpecialChar TeX
15805 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
15807 That means that it doesn't interact very well with \SpecialChar LyX
15808 , which requires \SpecialChar LaTeX2e
15810 it has been kludged to work.
15811 Since Rev\SpecialChar TeX
15812 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
15817 Rev\SpecialChar TeX
15819 \begin_inset space ~
15824 textclass should also be pretty easy to use.
15827 \begin_layout Standard
15828 These documents are supposed to be used in
15832 to the Rev\SpecialChar TeX
15833 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
15835 and assume you'll know what to put in the preamble if necessary.
15838 \begin_layout Subsection
15842 \begin_layout Standard
15843 All you need to do is install Rev\SpecialChar TeX
15844 4, as described in the package's README
15846 The package can be found at The Rev\SpecialChar TeX
15848 \begin_inset Flex URL
15851 \begin_layout Plain Layout
15853 http://publish.aps.org/revtex4/
15859 Install it somewhere that \SpecialChar LaTeX
15861 Test it by trying to \SpecialChar LaTeX
15862 a short Rev\SpecialChar TeX
15863 4 document in some random directory (i.
15864 \begin_inset space \thinspace{}
15868 \begin_inset space \space{}
15871 not the directory where you installed the class file.) Then, if you reconfigure
15873 , it will find the class file and let you use the Rev\SpecialChar TeX
15877 \begin_layout Standard
15878 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
15887 \begin_inset space ~
15892 template, found in the templates directory.
15895 \begin_layout Subsection
15899 \begin_layout Standard
15900 Optional arguments to
15907 \begin_inset Quotes eld
15911 \begin_inset Quotes erd
15915 \begin_inset Quotes eld
15919 \begin_inset Quotes erd
15925 \begin_inset space ~
15933 \begin_inset space ~
15939 Remember that in Rev\SpecialChar TeX
15940 , at least one optional argument is required!
15943 \begin_layout Standard
15944 Other preamble matter, like
15951 \begin_inset space ~
15958 \begin_inset space ~
15963 dialog, also as usual.
15966 \begin_layout Subsection
15970 \begin_layout Standard
15971 The layouts basically correspond to the commands in Rev\SpecialChar TeX
15973 For example, the Email layout corresponds to
15980 Note that (at least as of Rev\SpecialChar TeX
15989 layouts are exactly equivalent, so you shouldn't need to use both.
15993 \begin_layout Plain Layout
15994 In case you're curious, both were included so that
15998 would be able to translate both
16018 \begin_layout Subsection
16022 \begin_layout Standard
16023 There are a couple of important unique aspects of Rev\SpecialChar TeX
16024 4 which might cause
16025 bugs that will be even more confusing in \SpecialChar LyX
16029 \begin_layout Standard
16030 In Rev\SpecialChar TeX
16048 The \SpecialChar LyX
16049 equivalent is that there is a separate Thanks layout.
16054 write footnotes in the
16058 layout, or weird things may happen.
16059 See the Rev\SpecialChar TeX
16060 4 documentation for more details.
16063 \begin_layout Standard
16067 \begin_inset space ~
16075 \begin_inset space ~
16084 layouts must be placed
16092 layout and the corresponding
16109 , the \SpecialChar LaTeX
16113 \begin_layout Subsection
16117 \begin_layout Standard
16118 The main problem with this layout is that you can't use the optional arguments
16119 to layouts like Email and Title.
16120 (The problem is not unique to this layout; you can't use optional arguments
16121 to the Section layouts either.) This means that after you export that file
16122 to \SpecialChar LaTeX
16123 (which you'll need to do eventually to send it in to APS), you'll need
16124 to edit the \SpecialChar LaTeX
16125 file with a text editor to add the optional arguments to set,
16127 \begin_inset space \thinspace{}
16131 \begin_inset space \space{}
16134 the running title for the page headers.
16135 Lacking these layouts makes the
16141 (and the equivalent
16147 ) useless, so the corresponding layouts don't exist, and will have to be
16152 \begin_layout Plain Layout
16157 actually, \SpecialChar LyX
16158 1.3.0 supports some forms of optional arguments, but this layout
16159 has not been updated yet to take advantage of it.
16167 \begin_layout Section
16168 Springer Journals (
16175 \begin_layout Standard
16181 \begin_layout Subsection
16185 \begin_layout Standard
16186 These are the layout files for some of the journal formats used by Springer
16187 Verlag and listed on
16188 \begin_inset Flex URL
16191 \begin_layout Plain Layout
16193 http://www.springer.de/author/tex/help-journals.html
16198 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
16200 It is a modular system: the things common to all journals are implemented
16205 , which journal-specific layout files (such as, e.
16206 \begin_inset space \thinspace{}
16210 \begin_inset space \space{}
16217 for Journal of Geodesy) can include.
16220 \begin_layout Standard
16221 This means that implementing support for any other Springer journal on this
16222 list is as simple as writing your own
16230 file following the outline given in
16238 \begin_layout Standard
16239 It is reasonably well tested only for the Journal of Geodesy.
16248 come with the standard \SpecialChar LyX
16250 Install the relevant class file (downloaded from Springer) in a proper
16251 directory, reconfigure \SpecialChar LaTeX
16252 (in the te\SpecialChar TeX
16257 , as root if necessary — doesn't \SpecialChar LyX
16258 take care of this?), reconfigure \SpecialChar LyX
16263 \begin_layout Subsection
16267 \begin_layout Standard
16268 A large number of theorem-like styles —
16280 \begin_layout Standard
16283 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
16284 _Title, Author_Running, Institute,
16285 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
16288 See the Springer class file documentation for details.
16291 \begin_layout Subsection
16295 \begin_layout Itemize
16307 \begin_layout Itemize
16310 Probability Theory and Related Fields
16316 — Jean-Marc Lasgouttes
16319 \begin_layout Standard
16320 Add your own, it isn't so hard!
16323 \begin_layout Subsection
16327 \begin_layout Standard
16328 These files are partly based on the older
16332 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
16334 file from Springer.
16339 layout, are now defunct.
16340 Jean-Marc Lasgouttes helped out big in making me find my way around the
16342 layout file mechanism.
16345 \begin_layout Subsection
16349 \begin_layout Standard
16351 But probably less than in the old hacked-\SpecialChar LaTeX
16359 \begin_layout Standard
16361 \begin_inset space \thinspace{}
16364 g.: does not display the number for theorem-like layouts, just #.
16367 \begin_layout Section
16370 Sli\SpecialChar TeX
16374 \begin_inset CommandInset label
16383 \begin_layout Standard
16391 \begin_layout Subsection
16395 \begin_layout Standard
16396 This section describes how to use \SpecialChar LyX
16397 to make slides for overhead projectors.
16398 There are two document classes that can do this: the default slides class
16401 Foil\SpecialChar TeX
16405 This section documents the former.
16408 \begin_layout Standard
16409 I'm going to say this again, nice and clear, so that there's no misunderstanding
16413 \begin_layout Standard
16414 \begin_inset VSpace bigskip
16420 \begin_layout Standard
16424 This section documents the class
16425 \begin_inset Quotes eld
16433 \begin_inset Quotes erd
16441 \begin_layout Standard
16442 \begin_inset VSpace bigskip
16448 \begin_layout Standard
16449 If you're looking for the documentation for
16450 \begin_inset Quotes eld
16455 slides (Foil\SpecialChar TeX
16459 \begin_inset Quotes erd
16462 , check out section
16463 \begin_inset space ~
16467 \begin_inset CommandInset ref
16469 reference "sec:foiltex"
16479 \begin_inset Quotes eld
16484 slides (Foil\SpecialChar TeX
16488 \begin_inset Quotes erd
16491 ] is actually somewhat better than the default
16499 \begin_layout Plain Layout
16501 or so I've been told repeatedly by its advocates.
16502 Having never used it, I have no idea if this claim is true or not.
16507 which this section documents.
16510 \begin_layout Standard
16511 This class is the \SpecialChar LaTeX2e
16512 improvement of the old
16514 Sli\SpecialChar TeX
16518 Every \SpecialChar LaTeX2e
16519 distribution includes this class [which I'll just refer to as
16520 \begin_inset Quotes eld
16528 \begin_inset Quotes erd
16531 from now on], so you're bound to have it.
16532 As I noted earlier, there are other classes, such as
16536 , which also produce slides for overhead projectors and do a better job
16538 However, there are some things which
16542 can do which the others can't, such as generate overlays.
16543 Read on to learn more!
16546 \begin_layout Subsection
16548 \begin_inset CommandInset label
16550 name "sec:slidesetup"
16557 \begin_layout Standard
16558 Obviously, to use this document class, you need to select
16559 \begin_inset Quotes eld
16567 \begin_inset Quotes erd
16570 from the class list in the
16572 Document\SpecialChar menuseparator
16576 There are some other special things you should know about this class:
16579 \begin_layout Itemize
16580 Don't bother changing the options
16585 They're not supported by the
16592 \begin_layout Itemize
16596 \begin_inset space ~
16601 behaves a bit differently for this class.
16602 The possible choices and what they do are as follows:
16603 \begin_inset Separator latexpar
16610 \begin_layout Description
16615 The final output contains page numbers in the lower right corner.
16618 \begin_layout Description
16627 , but also prints out any time markers you've put in.
16628 This is the default.
16631 \begin_layout Description
16636 The final output contains no page numbers, time markers, or alignment markers.
16640 \begin_layout Itemize
16645 class has an extra option:
16651 \begin_inset Quotes eld
16659 \begin_inset Quotes erd
16662 in the extra class options.
16663 \begin_inset Separator latexpar
16670 \begin_layout Standard
16671 Using this options allows you to add time markers to
16677 \begin_inset space ~
16681 \begin_inset CommandInset ref
16683 reference "sec:slideNote"
16691 \begin_layout Standard
16692 You can also use the template file
16693 \begin_inset Quotes eld
16701 \begin_inset Quotes erd
16704 to automatically set up a document to use the
16710 File\SpecialChar menuseparator
16712 \begin_inset space ~
16716 \begin_inset space ~
16721 to open your new document].
16722 The template file also contains some examples of the special paragraph
16723 environments used by this class.
16724 I'll describe those next.
16727 \begin_layout Subsection
16728 Paragraph Environments
16731 \begin_layout Subsubsection
16732 Supported Environments
16735 \begin_layout Standard
16736 The first thing you'll notice when you start up a new
16740 document is the font size and type: it's the equivalent of the size
16741 \begin_inset Quotes eld
16749 \begin_inset Quotes erd
16755 \begin_inset space ~
16761 This is also what's used in the output.
16763 \begin_inset Quotes eld
16767 \begin_inset Quotes erd
16770 to remind you that this is a slide.
16771 Your final slides will use a larger font; ergo, you'll have less space.
16772 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
16775 \begin_layout Standard
16776 The next thing that becomes obvious is the changes to the paragraph environment
16777 pull-down box [at the far-left end of the toolbar].
16778 Most of the paragraph environments you're used to seeing are missing.
16779 There are also five new ones.
16784 class itself only supports certain paragraph environments:
16787 \begin_layout Itemize
16793 \begin_layout Itemize
16799 \begin_layout Itemize
16805 \begin_layout Itemize
16811 \begin_layout Itemize
16817 \begin_layout Itemize
16823 \begin_layout Itemize
16829 \begin_layout Itemize
16835 \begin_layout Itemize
16841 \begin_layout Itemize
16848 \begin_layout Itemize
16854 \begin_layout Standard
16855 All of the other standard environments, including the section-heading environmen
16856 ts, aren't used in the
16863 \begin_layout Standard
16864 On the other hand, you'll notice the following new environments:
16867 \begin_layout Itemize
16873 \begin_layout Itemize
16879 \begin_layout Itemize
16885 \begin_layout Itemize
16891 \begin_layout Itemize
16897 \begin_layout Standard
16898 These five are kind of quirky, due to a
16899 \begin_inset Quotes eld
16903 \begin_inset Quotes erd
16906 in \SpecialChar LyX
16908 You see, \SpecialChar LyX
16909 doesn't permit you to nest any other paragraph environment into
16910 an empty environment.
16911 Now, that's fine and dandy, but it means that you wouldn't be able to start
16912 a slide with anything except plain text.
16913 To deal with this, I've performed a little
16914 \begin_inset Quotes eld
16919 \begin_inset Quotes erd
16925 \begin_layout Subsubsection
16926 Quirks of the New Environments
16927 \begin_inset CommandInset label
16929 name "sec:slideQuirk"
16936 \begin_layout Standard
16937 All five of the new paragraph environments are somewhat quirky due to inherent
16938 limitiations in the current version of \SpecialChar LyX
16940 As I just mentioned, \SpecialChar LyX
16941 forbids environments that begin with another environment.
16942 To get around this, the
16946 environment isn't a paragraph environment as described in the
16954 \begin_layout Standard
16955 You should consider
16968 \begin_inset Quotes eld
16971 pseudo-environments.
16972 \begin_inset Quotes erd
16975 They look like a section heading or a
16976 \begin_inset Quotes eld
16984 \begin_inset Quotes erd
16987 but really begin a [and, if necessary, end the previous] paragraph environment.
16997 \begin_inset Quotes eld
17001 \begin_inset Quotes erd
17004 These two perform some action.
17007 \begin_layout Standard
17008 A common feature of all five environments,
17028 , is a rather long-ish label.
17029 The text following this label — ordinarily the contents of the paragraph
17030 environment — is utterly irrelevant for
17052 completely ignores it.
17053 In fact, you can leave these five environments completely empty.
17057 \begin_layout Standard
17062 to put any text after the rather long-ish label, you might want to.
17063 This could be a short description of the contents of the
17068 In that case, enter your descriptive comment and hit
17072 as you normally would.
17075 \begin_layout Standard
17076 If, on the other hand, you don't want to enter any descriptive text, you'll
17077 hit another \SpecialChar LyX
17080 , like nature, abhors a vacuum, and will not let you start a new paragraph
17081 environment until you put something in the old one.
17085 \begin_layout Itemize
17086 Start entering the text that will
17114 \begin_layout Itemize
17115 Now move to the beginning of that paragraph.
17119 \begin_layout Itemize
17128 \begin_layout Itemize
17129 Finally, change this new, empty paragraph to a
17153 \begin_layout Standard
17154 Some future version of \SpecialChar LyX
17155 will, hopefully, resolve this quirkiness\SpecialChar ldots
17159 \begin_layout Subsection
17160 Making a Presentation with
17173 \begin_layout Subsubsection
17181 \begin_layout Standard
17182 If you're expecting this section to teach you how to actually make a presentatio
17183 n, you'll be sorely disappointed.
17184 Naturally, I'll describe all of the ways the
17188 class can assist you in preparing the materials for a presentation.
17189 Filling in the contents, however, is up to you.
17194 the \SpecialChar LyX
17198 \begin_layout Standard
17203 environment [in the manner described in section
17204 \begin_inset space ~
17208 \begin_inset CommandInset ref
17210 reference "sec:slideQuirk"
17214 ] tells \SpecialChar LyX
17215 to begin a new slide [duh].
17216 The label for this environment/
17217 \begin_inset Quotes erd
17221 \begin_inset Quotes erd
17225 \begin_inset Quotes eld
17229 \begin_inset Quotes erd
17232 in cool blue, followed by the label,
17233 \begin_inset Quotes eld
17237 \begin_inset Quotes erd
17241 Any text or paragraph environments that follow this one go on the new slide.
17245 \begin_layout Standard
17246 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
17248 (this can be specified in the
17253 In fact, you'll want to, once you finish entering the contents of one slide.
17254 If you've entered more text than can physically fit on a slide, the extra
17255 overflows onto a new slide.
17256 I don't recommend doing this, however, since the overflow slide won't have
17257 any page number on it.
17258 Furthermore, it may interfere with any
17262 you've made to accompany the oversized
17269 \begin_layout Standard
17278 environments work the same way as the
17283 They both create an
17284 \begin_inset Quotes eld
17288 \begin_inset Quotes erd
17291 followed by a label [
17292 \begin_inset Quotes eld
17296 \begin_inset Quotes erd
17300 \begin_inset Quotes eld
17304 \begin_inset Quotes erd
17308 The color is a stunning magenta instead of blue, and the
17309 \begin_inset Quotes eld
17313 \begin_inset Quotes erd
17316 will look different, in style and in length.
17317 The label fonts of all three also differ from one another.
17320 \begin_layout Standard
17325 , if the contents of a
17333 exceed the physical size of a slide or sheet of paper, the extra will overflow
17335 Again, you should avoid this.
17336 It defeats the whole purpose of
17347 \begin_layout Subsubsection
17357 \begin_layout Standard
17362 is a slide that sits atop another slide.
17363 Perhaps you wish to discuss a figure on the main
17367 before displaying the text associated with it.
17368 One way to accomplish this is tape a flap of dark paper over the part of
17373 you want to display later.
17374 This method fails, however, if you wish to overlap one graph with another,
17376 You would then have to fumble while speaking to align the two separate,
17381 s to align the two graphs.
17386 environment in both cases makes life much easier.
17389 \begin_layout Standard
17394 receives the page number of its
17395 \begin_inset Quotes eld
17399 \begin_inset Quotes erd
17407 \begin_inset Quotes eld
17415 \begin_inset Quotes erd
17422 \begin_layout Plain Layout
17423 Presumably, mutliple
17428 \begin_inset Quotes eld
17436 \begin_inset Quotes erd
17440 \begin_inset Quotes eld
17448 \begin_inset Quotes erd
17452 \begin_inset Quotes eld
17460 \begin_inset Quotes erd
17464 \begin_inset space ~
17467 appended to the page number of the parent
17477 Clearly, you want the contents of both the
17485 to each fit on a single physical slide! You should probably consider an
17491 \begin_inset Quotes eld
17495 \begin_inset Quotes erd
17503 Indeed, the \SpecialChar LyX
17508 class provides a visual cue for this: the label at the start of an
17512 is shorter than that at the start of a
17517 Lastly, when you generate printable output, you'll find alignment markers
17518 in all four corners of both the
17522 page and its parent
17527 These will assist you in lining up the two physical slides.
17530 \begin_layout Standard
17531 The major problem in overlaying two slides is aligning the contents of the
17532 two transparencies.
17533 How much space should you leave for that graph on the second slide? Worse
17534 still, what if you want a graph and a sentence on second slide, but there
17535 is text on the main transparency that goes in between them? You could try
17536 and insert vertical space of the right size.
17537 The better way is to use
17548 \begin_layout Standard
17549 As their names imply,
17557 are two command-like paragraph environments that make all subsequent text
17558 invisible and visible, respectively.
17560 \begin_inset space ~
17564 \begin_inset CommandInset ref
17566 reference "sec:slideQuirk"
17570 that you don't place anything
17574 these two environments, however.
17579 , it inserts a centered, sky-blue label into the page reading
17580 \begin_inset Quotes eld
17583 <Invisible Text Follows>
17584 \begin_inset Quotes erd
17588 For paragraphs following this label, the parts of the
17596 ; it doesn't matter which] where they would be contain instead blank space.
17600 \begin_layout Standard
17605 , the corresponding centered label is
17606 \begin_inset Quotes eld
17609 <Visible Text Follows>
17610 \begin_inset Quotes erd
17614 Paragraphs following this label behave normally.
17615 Note that the beginning of a new
17627 automatically shuts off an
17632 It's therefore not necessary to use
17643 \begin_layout Standard
17644 By now, it should be obvious how to create overlay transparencies using
17645 the proper combination of
17664 \begin_layout Enumerate
17669 , including everything that will appear on it, whether on the main slide
17677 \begin_layout Enumerate
17678 Before each figure or paragraph that will appear only on the
17687 If necessary, insert a
17691 environment after the
17698 \begin_layout Enumerate
17703 immediately following the
17710 \begin_layout Enumerate
17711 Copy the contents of this
17722 \begin_layout Enumerate
17727 , change all of the
17738 \begin_layout Standard
17740 You've just made an
17747 \begin_layout Standard
17748 There's one problem with the way I've designed the \SpecialChar LyX
17753 class: you can't make text in the middle of a paragraph invisible, nor
17754 make text in the middle of an invisible paragraph visible again.
17755 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
17760 \begin_layout Plain Layout
17761 The commands of interest are:
17764 \begin_layout Itemize
17769 invisible \SpecialChar ldots
17773 \begin_layout Itemize
17778 visible \SpecialChar ldots
17782 \begin_layout Plain Layout
17784 and need to be marked as \SpecialChar TeX
17787 \begin_inset Quotes eld
17791 \begin_inset Quotes erd
17794 you wish to change goes in between the brackets [and after the
17807 If you don't know how to mark text as \SpecialChar TeX
17808 , see the appropriate section of
17821 \begin_layout Subsubsection
17831 \begin_inset CommandInset label
17833 name "sec:slideNote"
17840 \begin_layout Standard
17849 is associated with a
17850 \begin_inset Quotes eld
17854 \begin_inset Quotes erd
17862 Here, too, the \SpecialChar LyX
17867 class provides visual cues.
17872 is shorter than that of a
17876 [yet longer than that of an
17880 ] and, like the label of an
17884 is shockingly magenta.
17885 Additionally, the printed
17889 has the page number of its
17890 \begin_inset Quotes eld
17894 \begin_inset Quotes erd
17902 \begin_inset Quotes eld
17910 \begin_inset Quotes erd
17914 \begin_inset Quotes eld
17922 \begin_inset Quotes erd
17926 \begin_inset Quotes eld
17934 \begin_inset Quotes erd
17938 You can have multiple
17942 s associated with a single
17954 , you'll probably want to break up long
17958 s so that they fit on a single sheet of paper.
17961 \begin_layout Standard
17966 is obvious: it contains anything additional you might want to say about
17972 It could also be used as a sheet of reminders for a particular
17977 In the case of the latter, you might want to make use of time markers.
17978 Currently, the \SpecialChar LyX
17984 \begin_inset Quotes eld
17988 \begin_inset Quotes erd
17991 support for time markers, a
17993 Sli\SpecialChar TeX
17997 So, you'll have to resort to using the \SpecialChar LaTeX
18001 \begin_layout Standard
18002 To use time markers, you'll need to specify the extra class option
18003 \begin_inset Quotes eld
18011 \begin_inset Quotes erd
18015 \begin_inset space ~
18019 \begin_inset CommandInset ref
18021 reference "sec:slidesetup"
18026 This option turns on timing marks, which will appear in the lower-left-hand
18032 To set what appears in the time marker, you use the \SpecialChar LaTeX
18034 \begin_inset Quotes eld
18044 \begin_inset Quotes erd
18048 \begin_inset Quotes eld
18058 \begin_inset Quotes erd
18062 The arguments of both commands are time measured in seconds.
18064 \begin_inset Quotes eld
18074 \begin_inset Quotes erd
18077 sets the time marker to a given time.
18079 \begin_inset Quotes eld
18089 \begin_inset Quotes erd
18092 increments the time marker by the specified amount.
18093 Using time markers and
18097 s in this fashion, you can remind yourself how much time to spend on a particula
18105 \begin_layout Standard
18106 There's one last feature to describe.
18107 Clearly, you'd like to print out all of your
18115 s on transparencies while printing all of your
18132 with which it is associated.
18133 What's a person to do?
18136 \begin_layout Standard
18137 Luckily, there are two \SpecialChar LaTeX
18138 commands that allow you to select what to print
18140 Both must be placed into the preamble of your document.
18142 \begin_inset Quotes eld
18154 \begin_inset Quotes erd
18157 will cause the output to contain only the
18166 Correspondingly, the command
18167 \begin_inset Quotes eld
18179 \begin_inset Quotes erd
18182 prevents the output of anything but
18187 I'd advise placing both commands in the preamble and initially comment
18189 You can then preview your entire presentation as you write.
18190 When you're done writing, you can then uncomment one of the two to select
18191 what you want to print.
18192 I like to uncomment
18193 \begin_inset Quotes eld
18205 \begin_inset Quotes erd
18208 , print to a file with
18209 \begin_inset Quotes eld
18217 \begin_inset Quotes erd
18220 in its name, comment it back out, then uncomment
18221 \begin_inset Quotes eld
18233 \begin_inset Quotes erd
18237 \begin_inset Quotes eld
18245 \begin_inset Quotes erd
18249 I can then send either file to a printer, loading transparencies or plain
18250 paper as appropriate.
18253 \begin_layout Standard
18254 You can also provide other arguments to the
18255 \begin_inset Quotes eld
18265 \begin_inset Quotes erd
18269 \begin_inset Quotes eld
18279 \begin_inset Quotes erd
18283 See a good \SpecialChar LaTeX
18287 \begin_layout Subsection
18292 Class Template File
18295 \begin_layout Standard
18296 I have also provided a template file,
18297 \begin_inset Quotes eld
18305 \begin_inset Quotes erd
18313 To use it, begin your new presentation with
18315 File\SpecialChar menuseparator
18317 \begin_inset space ~
18321 \begin_inset space ~
18327 Your new \SpecialChar LyX
18328 presentation file will contain an example
18349 additionally contain an example of the use of
18358 Lastly, the preamble will contain:
18361 \begin_layout LyX-Code
18362 % Uncomment to print out only slides and overlays
18365 \begin_layout LyX-Code
18369 \begin_layout LyX-Code
18375 \begin_inset Newline newline
18381 \begin_layout LyX-Code
18382 % Uncomment to print out only notes
18385 \begin_layout LyX-Code
18389 \begin_layout LyX-Code
18397 \begin_layout Standard
18398 One final thing: I created this class to support the \SpecialChar LaTeX2e
18400 \begin_inset Quotes eld
18405 Sli\SpecialChar TeX
18409 \begin_inset Quotes erd
18412 class, one of the built-in \SpecialChar LaTeX2e
18414 Neither I nor the rest of the \SpecialChar LyX
18415 Team endorse or oppose the use of this built-in
18417 It's here if you want it or need it.
18418 There exist other \SpecialChar LaTeX2e
18419 classes for creating presentations, such as the
18424 \begin_inset space ~
18428 \begin_inset CommandInset ref
18430 reference "sec:foiltex"
18435 \begin_inset Quotes eld
18443 \begin_inset Quotes erd
18446 package [present on some \SpecialChar TeX
18448 The latter is not yet supported under \SpecialChar LyX
18453 \begin_layout Plain Layout
18454 Perhaps you can take on the task\SpecialChar ldots
18460 I know nothing about these other classes.
18461 Try them out to see what sort of alternative they provide.
18464 \begin_layout Chapter
18466 Features needing Extra Software
18469 \begin_layout Section
18470 Checking \SpecialChar TeX
18474 \begin_layout Standard
18480 \begin_layout Subsection
18484 \begin_layout Standard
18493 \begin_layout Plain Layout
18498 is not yet available when you are using the \SpecialChar LaTeX
18499 distribution MiK\SpecialChar TeX
18505 , you'll find in the
18512 \begin_inset space ~
18523 \begin_inset Newline newline
18527 \begin_inset CommandInset href
18529 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
18536 \begin_layout Standard
18539 Chk\SpecialChar TeX
18542 package is a program that was written by
18543 \begin_inset Flex Noun
18546 \begin_layout Plain Layout
18548 \begin_inset space ~
18556 in frustration because some constructs in \SpecialChar LaTeX
18557 are sometimes non-intuitive,
18558 and easy to forget.
18559 The program runs over your \SpecialChar LaTeX
18560 file, checks the integrity of the file, and
18561 flags some common errors.
18562 In other technical words, it is
18566 for \SpecialChar LaTeX
18570 \begin_layout Standard
18571 Well, what is a syntax checker doing in \SpecialChar LyX
18572 which is supposed to produce correct
18574 anyways? The answer is simple: Just as
18578 not only checks the
18582 of C programs, but also does
18586 checks for type-errors,
18588 Chk\SpecialChar TeX
18591 catches some common
18595 errors, in addition to the syntactical ones.
18598 Chk\SpecialChar TeX
18601 is capable of detecting several common errors, such as
18604 \begin_layout Itemize
18605 Ellipsis detection:
18606 \begin_inset Newline newline
18609 Use \SpecialChar ldots
18613 \begin_layout Itemize
18614 No space in front of/after parenthesis:
18615 \begin_inset Newline newline
18621 \begin_layout Itemize
18622 Enforcement of normal space after common abbreviations:
18623 \begin_inset Newline newline
18627 \begin_inset space \thinspace{}
18631 \begin_inset space \space{}
18634 is too wide spacing.
18637 \begin_layout Itemize
18638 Enforcement of end-of-sentence space when the last sentence ends with a
18640 \begin_inset Newline newline
18644 And this is wrong spacing.
18647 \begin_layout Itemize
18648 Space in front of labels and similar commands:
18649 \begin_inset Newline newline
18652 The label should stick right up to the text to avoid falling to a wrong
18655 \begin_inset CommandInset label
18665 \begin_layout Plain Layout
18666 This footnote is in danger of falling off to a wrong page
18671 The label is separated too much.
18674 \begin_layout Itemize
18675 Space in front of references, instead of hard spaces:
18676 \begin_inset Newline newline
18679 If you have bad luck, the text will break right between the referenced text
18680 and reference number, and that's a pity.
18682 \begin_inset CommandInset ref
18684 reference "sec:chktex"
18691 \begin_layout Itemize
18693 \begin_inset Quotes eld
18697 \begin_inset Quotes erd
18701 \begin_inset Formula $\times$
18705 \begin_inset Newline newline
18708 2x2 looks cheap compared to
18709 \begin_inset Formula $2\times2$
18715 \begin_layout Standard
18716 and more \SpecialChar ldots
18717 It is an invaluable tool when you are
18718 \begin_inset Quotes eld
18722 \begin_inset Quotes erd
18725 your document before printing, and you should run it right after the obligatory
18726 spelling check, and before you go fine tuning the typesetting.
18729 \begin_layout Subsection
18733 \begin_layout Standard
18734 If you have the program installed, usage is as simple as choosing
18736 Tools\SpecialChar menuseparator
18738 \begin_inset space ~
18744 This will make \SpecialChar LyX
18745 generate a \SpecialChar LaTeX
18746 file of your document, start
18748 Chk\SpecialChar TeX
18751 to check it, and then make \SpecialChar LyX
18753 \begin_inset Quotes eld
18757 \begin_inset Quotes erd
18760 with the warnings from
18762 Chk\SpecialChar TeX
18765 , if there were any.
18766 The warnings will be placed close to the point of the mistake, and you
18767 can quickly find them by using the
18769 Navigate\SpecialChar menuseparator
18772 menu item, or the shortcut key
18781 Open the error boxes by clicking on them with the mouse, or use the shortcut
18790 bindings, or the corresponding
18799 Read the warning and correct the mistake, if it is a mistake.
18800 If you have trouble understanding what the warning is about, you can safely
18802 Remember that there is a hidden layer between the document on screen and
18803 the technical details in invoking
18805 Chk\SpecialChar TeX
18808 , and this gap can make some warnings seem arcane or just plain silly.
18811 \begin_layout Standard
18812 This document is an excellent testing bed for the feature, and it should
18813 provide quite a few warnings for you to fiddle with.
18814 Since computers are only so smart, expect most of the warnings to be false
18818 \begin_layout Subsection
18819 How to fine tune it
18822 \begin_layout Standard
18823 Sometimes, you'll find that
18825 Chk\SpecialChar TeX
18828 makes more noise than suits your mood.
18829 Then you can choose not to use it, wait until your mood changes, or try
18832 Chk\SpecialChar TeX
18835 to get better along with you.
18838 \begin_layout Standard
18841 Chk\SpecialChar TeX
18848 very configurable and extensible, you should not expect to solve all problems
18851 Chk\SpecialChar TeX
18854 in \SpecialChar LyX
18856 Since \SpecialChar LyX
18857 has to generate a somewhat special \SpecialChar LaTeX
18858 file to be able to match the
18859 line numbers from the
18861 Chk\SpecialChar TeX
18868 \begin_layout Plain Layout
18869 You can inspect the specific output from
18875 Document\SpecialChar menuseparator
18878 \begin_inset space ~
18892 to the internal document structure, some of the warnings will not appear
18894 There are two things you can do about this:
18897 \begin_layout Itemize
18900 Chk\SpecialChar TeX
18903 invocation command line in
18904 \begin_inset Flex Noun
18907 \begin_layout Plain Layout
18908 Tools\SpecialChar menuseparator
18909 Preferences\SpecialChar menuseparator
18910 Output\SpecialChar menuseparator
18911 LaTeX\SpecialChar menuseparator
18919 Chk\SpecialChar TeX
18922 installation configuration file (usually with the file
18927 See below to learn what warnings can be enabled and disabled on the command
18931 \begin_layout Itemize
18932 Export your document as a raw \SpecialChar LaTeX
18935 File\SpecialChar menuseparator
18936 Export\SpecialChar menuseparator
18945 Invoked in this way, it can be a hassle to find the corresponding place
18946 in the document inside \SpecialChar LyX
18947 , but with a little patience, you should be able
18951 \begin_layout Standard
18952 Here follows the warning messages that can be enabled and disabled in
18961 to disable a warning, and
18965 to enable a warning.
18966 The emphasized entries are disabled by default, because the default is
18969 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
18974 \begin_layout Standard
18975 Notice that you should only use the options that enable and disable warnings,
18976 because \SpecialChar LyX
18977 relies on some of the other command line parameters to be set
18978 in a specific way to have a chance to communicate with
18985 \begin_layout Enumerate
18989 Command terminated with space.
18992 \begin_layout Enumerate
18995 Non-breaking space (
18996 \begin_inset Quotes eld
19004 \begin_inset Quotes erd
19007 ) should have been used.
19010 \begin_layout Enumerate
19014 You should enclose the previous parenthesis with
19015 \begin_inset Quotes eld
19023 \begin_inset Quotes erd
19029 \begin_layout Enumerate
19032 Italic correction (
19033 \begin_inset Quotes eld
19043 \begin_inset Quotes erd
19046 ) found in non-italic buffer.
19049 \begin_layout Enumerate
19052 Italic correction (
19053 \begin_inset Quotes eld
19063 \begin_inset Quotes erd
19066 ) found more than once.
19069 \begin_layout Enumerate
19073 No italic correction (
19074 \begin_inset Quotes eld
19084 \begin_inset Quotes erd
19090 \begin_layout Enumerate
19094 \begin_inset Quotes eld
19102 \begin_inset Quotes erd
19106 \begin_inset Quotes eld
19114 \begin_inset Quotes erd
19120 \begin_layout Enumerate
19123 Wrong length of dash may have been used.
19126 \begin_layout Enumerate
19130 \begin_inset Quotes eld
19138 \begin_inset Quotes erd
19142 \begin_inset Quotes eld
19150 \begin_inset Quotes erd
19156 \begin_layout Enumerate
19160 \begin_inset Quotes eld
19168 \begin_inset Quotes erd
19174 \begin_layout Enumerate
19178 \begin_inset Quotes eld
19186 \begin_inset Quotes erd
19189 to achieve an ellipsis.
19192 \begin_layout Enumerate
19195 Inter-word spacing (
19196 \begin_inset Quotes eld
19206 \begin_inset Quotes eld
19209 ) should perhaps be used.
19212 \begin_layout Enumerate
19215 Inter-sentence spacing (
19216 \begin_inset Quotes eld
19226 \begin_inset Quotes erd
19229 ) should perhaps be used.
19232 \begin_layout Enumerate
19235 Could not find argument for command.
19238 \begin_layout Enumerate
19242 \begin_inset Quotes eld
19250 \begin_inset Quotes erd
19256 \begin_layout Enumerate
19259 Math mode still on at end of \SpecialChar LaTeX
19263 \begin_layout Enumerate
19267 \begin_inset Quotes eld
19275 \begin_inset Quotes erd
19278 doesn't match the number of
19279 \begin_inset Quotes eld
19287 \begin_inset Quotes erd
19293 \begin_layout Enumerate
19296 You should use either
19299 \begin_inset Quotes eld
19307 \begin_inset Quotes erd
19312 as an alternative to
19313 \begin_inset Quotes eld
19321 \begin_inset Quotes erd
19327 \begin_layout Enumerate
19334 " (ASCII 39) instead of "
19341 \begin_layout Enumerate
19344 User-specified pattern found.
19347 \begin_layout Enumerate
19350 This command might not be intended.
19353 \begin_layout Enumerate
19360 \begin_layout Enumerate
19378 \begin_layout Enumerate
19381 Delete this space to maintain correct page references.
19384 \begin_layout Enumerate
19388 You might wish to put this between a pair of
19389 \begin_inset Quotes eld
19397 \begin_inset Quotes erd
19403 \begin_layout Enumerate
19406 You ought to remove spaces in front of punctuation.
19409 \begin_layout Enumerate
19412 Could not execute \SpecialChar LaTeX
19416 \begin_layout Enumerate
19425 in front of small punctuation.
19428 \begin_layout Enumerate
19436 may look prettier here.
19439 \begin_layout Enumerate
19443 Multiple spaces detected in output.
19446 \begin_layout Enumerate
19449 This text may be ignored.
19452 \begin_layout Enumerate
19458 \begin_inset Quotes eld
19463 to begin quotation, not
19470 \begin_layout Enumerate
19477 to end quotation, not
19480 \begin_inset Quotes eld
19488 \begin_layout Enumerate
19494 \begin_layout Enumerate
19497 You should perhaps use
19498 \begin_inset Quotes eld
19506 \begin_inset Quotes erd
19512 \begin_layout Enumerate
19515 You should put a space in front of/after parenthesis.
19518 \begin_layout Enumerate
19521 You should avoid spaces in front of/after parenthesis.
19524 \begin_layout Enumerate
19528 You should not use punctuation in front of/after quotes.
19531 \begin_layout Enumerate
19534 Double space found.
19537 \begin_layout Enumerate
19540 You should put punctuation outside inner/inside display math mode.
19543 \begin_layout Enumerate
19546 You ought to not use primitive \SpecialChar TeX
19547 in \SpecialChar LaTeX
19551 \begin_layout Enumerate
19554 You should remove spaces in front of
19555 \begin_inset Quotes eld
19563 \begin_inset Quotes erd
19569 \begin_layout Enumerate
19572 \begin_inset Quotes eld
19580 \begin_inset Quotes erd
19583 is normally not followed by
19584 \begin_inset Quotes eld
19592 \begin_inset Quotes erd
19598 \begin_layout Standard
19599 In later versions of \SpecialChar LyX
19600 , we hope to provide a more complete interface to this
19601 tool (and it's smaller cousin
19605 ) to exploit the full power of it.
19606 But it's not exactly useless as it is now: go try it on one of your existing
19607 documents of a certain length and be surprised.
19610 \begin_layout Section
19611 Version Control in \SpecialChar LyX
19615 \begin_layout Standard
19618 Lars Gullik Bjønnes
19625 \begin_layout Subsection
19629 \begin_layout Standard
19631 supports some of the most basic RCS/CVS/SVN/GIT commands.
19632 If you need something a bit more sophisticated you will have to do that
19633 manually in a terminal.
19636 \begin_layout Standard
19637 Also note that CVS support is not as good as subversion support so we advise
19639 A good place to start learning Subversion is SVN Book
19643 \begin_layout Plain Layout
19644 \begin_inset CommandInset href
19646 target "http://svnbook.red-bean.com/"
19656 In the case of RCS you should read
19657 \begin_inset Quotes eld
19661 \begin_inset Quotes erd
19664 (a man file, read it with
19669 This file describes all the basic features of RCS.
19670 You should especially notice the comment about a RCS directory, and the
19671 notion of a master RCS file (the file ending in
19678 \begin_layout Standard
19679 Before you begin to use the version control features in \SpecialChar LyX
19681 familiar with RCS/CVS/SVN/GIT usage.
19682 The implementation in \SpecialChar LyX
19683 assumes a recent version of the GNU RCS or CVS/SVN
19684 package — no guarantees are made for older versions.
19685 Most of the log messages are not currently displayed after operations —
19686 you can check them in the Messages pane if unsure.
19687 Regular users of version control will appreciate VC toolbar, which can
19690 View\SpecialChar menuseparator
19691 Toolbars\SpecialChar menuseparator
19693 \begin_inset space ~
19701 \begin_layout Standard
19702 For introducing your own external commands consult vc-command in the manual
19703 of \SpecialChar LyX
19707 \begin_layout Standard
19708 It is strongly recommended to store documents in uncompressed format if
19709 using version control (uncheck
19711 Document\SpecialChar menuseparator
19714 if it is checked): Uncompressed LyX documents are text files and therefore
19715 for merging two different versions by version control systems.
19716 Compressed LyX documents are binary files, which cannot be merged by version
19720 \begin_layout Subsection
19721 RCS commands in \SpecialChar LyX
19725 \begin_layout Standard
19726 The following sections describe the RCS commands supported by \SpecialChar LyX
19728 You can find them in the
19730 File\SpecialChar menuseparator
19732 \begin_inset space ~
19739 was tested against RCS 5.7/5.8.
19742 \begin_layout Subsubsection
19748 \begin_layout Standard
19749 If your document is not under revision control, this is the only item shown
19751 And if it is under revision control, the
19755 item is not visible.
19759 \begin_layout Standard
19760 This command registers your document with RCS (unless you are under the
19761 directory managed by CVS)\SpecialChar endofsentence
19762 You are asked interactively to supply an initial
19763 description of the document.
19764 The document is now set in Read-Only mode and you have to
19767 \begin_inset space ~
19771 \begin_inset space ~
19775 \begin_inset space ~
19780 , before making any changes to it.
19781 A document under revision control has a
19782 \begin_inset Quotes eld
19785 [RCS:<version> <locker>]
19786 \begin_inset Quotes erd
19789 item tagged to the filename in the minibuffer.
19792 \begin_layout Standard
19793 RCS command that is run:
19795 ci -q -u -i -t-"<initial description>" <file-name>
19798 \begin_layout Standard
19803 to understand the switches.
19807 \begin_layout Subsubsection
19813 \begin_layout Standard
19814 When you are finished editing a file, you check in your changes.
19815 When you do this, you are asked for a description of the changes.
19816 This is stored in the history log.
19817 The version number is bumped, your changes are applied to the master RCS
19818 file, the document is unlocked and set to Read-Only mode.
19821 \begin_layout Standard
19824 ci -q -u -m"<description>" <file-name>
19827 \begin_layout Subsubsection
19833 \begin_layout Standard
19834 By doing this you lock the document so that only you can edit it.
19835 This will also make the document Read-Write only for you.
19836 You will usually continue editing for a while and when you are finished
19837 you check in your changes.
19838 The status line is changed to reflect that you have locked the file.
19841 \begin_layout Standard
19844 co -q -l <file-name>
19847 \begin_layout Subsubsection
19850 Revert To Repository Version
19853 \begin_layout Standard
19854 This will discard all changes made to the document since the last check
19856 You get a warning before changes are discarded.
19859 \begin_layout Standard
19862 co -f -u<version> <file-name>
19865 \begin_layout Subsubsection
19871 \begin_layout Standard
19872 This will create a copy of the current document.
19873 Since RCS does not support copy operations natively, the version history
19874 is not preserved, and the copy is added as a new file.
19875 It requires a clean document without any changes since the last checkin.
19876 You are asked for a file name and a description of the copy operation.
19877 After that the copy is created, both locally and in the repository.
19878 If the parent directories of the copied and original document differ, all
19879 relative paths of included files of the copy are adjusted (like in
19881 File\SpecialChar menuseparator
19886 Finally, the copy is loaded instead of the original document.
19889 \begin_layout Labeling
19890 \labelwidthstring 00.00.0000
19892 \begin_inset space ~
19896 \begin_inset space ~
19900 \begin_inset Newline newline
19904 \begin_inset Flex Code
19907 \begin_layout Plain Layout
19910 \begin_inset Quotes eld
19914 \begin_inset Quotes erd
19923 \begin_inset Flex Code
19926 \begin_layout Plain Layout
19929 \begin_inset Quotes eld
19933 \begin_inset Quotes erd
19942 \begin_inset Newline newline
19946 \begin_inset Flex Code
19949 \begin_layout Plain Layout
19953 \begin_inset Quotes eld
19957 \begin_inset Quotes erd
19968 \begin_layout Subsubsection
19974 \begin_layout Standard
19975 This makes as if the last check in never happened.
19976 No changes are made to the document loaded into \SpecialChar LyX
19977 , but the last version
19978 is removed from the master RCS file.
19981 \begin_layout Standard
19984 rcs -o<version> <file-name>
19987 \begin_layout Subsubsection
19993 \begin_layout Standard
19994 This shows the complete history of the RCS document.
19999 is shown in a browser.
20007 \begin_layout Subsubsection
20011 \begin_layout Standard
20013 supports RCS version number, author name, date and time of last commit.
20014 All those are extracted from
20016 rlog -r <file-name>
20020 \begin_inset CommandInset ref
20022 reference "subsec:VCS-Revision-Information"
20029 \begin_layout Subsection
20030 CVS commands in \SpecialChar LyX
20034 \begin_layout Standard
20035 A subset of CVS operations is supported by \SpecialChar LyX
20037 You can find the commands in the
20039 File\SpecialChar menuseparator
20041 \begin_inset space ~
20047 The version control system SVN is more powerful, so please use it instead
20048 of CVS if possible.
20051 \begin_layout Subsubsection
20057 \begin_layout Standard
20058 If you start from scratch with CVS you have to create your repository and
20059 checkout the working copy with external tools.
20060 If you're using a client-server setup you may need to login before doing
20061 the first repository checkout.
20064 \begin_layout Standard
20065 If your documents are under revision control and others are using the same
20066 repository problems arise when different changes to the same document at
20067 the same location happen.
20068 Standard CVS repositories don't operate with a file locking mechanism.
20069 This may be surprising, but conflicts only occur if people disagree on
20070 the proper content of the same part of a document.
20071 So, if co-workers are used to communicate regularly, these conflicts occur
20073 If they don't communicate they have a fundamental problem anyway.
20074 Nevertheless some people like to work with so called
20075 \begin_inset Quotes eld
20079 \begin_inset Quotes erd
20083 If they do so the working copy of all files is readonly when checked out
20084 first and the user starts editing after using a special command to make
20085 the working copy writable.
20086 When the changes are checked in the working copy returns to readonly state.
20087 With \SpecialChar LyX
20088 one has to edit the
20089 \begin_inset Flex Code
20092 \begin_layout Plain Layout
20098 file and add the line
20099 \begin_inset Flex Code
20102 \begin_layout Plain Layout
20108 to work with reserved checkouts.
20109 The benefit is the possibility to see who is using a writable copy of some
20111 It's not guaranteed only one user makes a copy writable.
20114 \begin_layout Standard
20116 tries to guess if you're using reserved or non-reserved checkouts.
20117 If your working copy is readonly or it is writable and an additional copy
20118 of your document exists in the CVS/Base sub-directory a reserved otherwise
20119 a non-reserved checkout is assumed.
20120 When a reserved checkout is detected you have to use
20121 \begin_inset Flex Noun
20124 \begin_layout Plain Layout
20130 to make your working copy writable if it's readonly.
20132 \begin_inset Flex Noun
20135 \begin_layout Plain Layout
20141 operation is possible and that makes your working copy readonly again after
20142 transferring your changes to the repository.
20145 \begin_layout Standard
20146 More information about CVS can be found here
20147 \begin_inset Flex URL
20150 \begin_layout Plain Layout
20152 http://www.nongnu.org/cvs
20158 \begin_inset Flex URL
20161 \begin_layout Plain Layout
20163 http://ximbiot.com/cvs
20171 \begin_layout Standard
20176 to understand the sub-commands and the switches mentioned below.
20179 \begin_layout Subsubsection
20185 \begin_layout Standard
20186 If your document is not under revision control, this is the only item shown
20188 And if it is under revision control, the
20192 item is not visible.
20196 \begin_layout Standard
20197 This command registers in CVS your document
20198 \begin_inset Flex Strong
20201 \begin_layout Plain Layout
20209 in the case you have already the documents directory under CVS control
20215 This means you have to create or checkout the archive by yourself using
20217 (In case you forget that step \SpecialChar LyX
20218 registers the document with RCS.)
20221 \begin_layout Standard
20222 Then you are asked interactively to supply an initial description of the
20224 Don't forget that registered file is not yet checked in.
20227 \begin_layout Standard
20228 CVS command that is run:
20230 cvs -q add -m"<entered message>" "<file-name>"
20233 \begin_layout Standard
20238 above and for all other CVS commands is an abbreviation for
20239 \begin_inset Quotes eld
20242 change the current working directory to file location and use the file name
20243 without path component as argument
20244 \begin_inset Quotes erd
20250 \begin_layout Subsubsection
20256 \begin_layout Standard
20257 When you are finished editing a file, you commit your changes.
20258 When you do this and you had changed the document, you are asked for a
20259 description of the changes.
20260 After that changes are written to the repository.
20261 In case you didn't change the document and a reserved checkout is detected
20262 the reservation made on
20263 \begin_inset Flex Noun
20266 \begin_layout Plain Layout
20275 \begin_layout Labeling
20276 \labelwidthstring 00.00.0000
20278 \begin_inset space ~
20282 \begin_inset space ~
20286 \begin_inset Newline newline
20290 \begin_inset Flex Code
20293 \begin_layout Plain Layout
20296 -q commit -m"<description>" "<file-name>"
20302 \begin_inset Newline newline
20306 \begin_inset Flex Code
20309 \begin_layout Plain Layout
20320 \begin_layout Subsubsection
20326 \begin_layout Standard
20327 When you are sharing a repository with others, you may have to incorporate
20328 their changes into your working copy.
20331 \begin_layout Standard
20334 cvs -q update "<file-name>"
20337 \begin_layout Standard
20338 If a readonly checkout is detected the working copy is made writable and
20342 \begin_layout Standard
20345 cvs -q edit "<file-name>"
20348 \begin_layout Subsubsection
20351 Revert To Repository Version
20354 \begin_layout Standard
20355 This will discard all changes made to the document since the last check
20357 You get a warning before changes are discarded.
20358 Firstly the file is deleted, secondly CVS update command is run.
20361 \begin_layout Standard
20364 cvs -q update "<file-name>"
20367 \begin_layout Standard
20368 If a reserved checkout is detected and the working copy has no changes only
20369 the reservation is undone.
20372 \begin_layout Standard
20375 cvs -q unedit "<file-name>"
20378 \begin_layout Subsubsection
20384 \begin_layout Standard
20385 This will create a copy of the current document.
20386 Since CVS does not support copy operations natively, the version history
20387 is not preserved, and the copy is added as a new file.
20388 It requires a clean document without any changes since the last checkin.
20389 You are asked for a file name and a description of the copy operation.
20390 After that the copy is created, both locally and in the repository.
20391 If the parent directories of the copied and original document differ, all
20392 relative paths of included files of the copy are adjusted (like in
20394 File\SpecialChar menuseparator
20399 Finally, the copy is loaded instead of the original document.
20402 \begin_layout Labeling
20403 \labelwidthstring 00.00.0000
20405 \begin_inset space ~
20409 \begin_inset space ~
20413 \begin_inset Newline newline
20417 \begin_inset Flex Code
20420 \begin_layout Plain Layout
20423 \begin_inset Quotes eld
20427 \begin_inset Quotes erd
20436 \begin_inset Flex Code
20439 \begin_layout Plain Layout
20442 \begin_inset Quotes eld
20446 \begin_inset Quotes erd
20455 \begin_inset Newline newline
20459 \begin_inset Flex Code
20462 \begin_layout Plain Layout
20466 \begin_inset Quotes eld
20470 \begin_inset Quotes erd
20481 \begin_layout Subsubsection
20487 \begin_layout Standard
20488 This will rename the current document.
20489 Since CVS does not support rename operations natively, the version history
20490 is not preserved, the renamed document is added as a new file, and the
20491 original document is deleted.
20492 It requires a clean document without any changes since the last checkin.
20493 You are asked for a file name and a description of the rename operation.
20494 After that the document is renamed, both locally and in the repository.
20495 If the parent directories of the new and old file names differ, all relative
20496 paths of included files are adjusted (like in
20498 File\SpecialChar menuseparator
20503 Finally, the document is reloaded using the new name.
20506 \begin_layout Labeling
20507 \labelwidthstring 00.00.0000
20509 \begin_inset space ~
20513 \begin_inset space ~
20517 \begin_inset Newline newline
20521 \begin_inset Flex Code
20524 \begin_layout Plain Layout
20527 \begin_inset Quotes eld
20531 \begin_inset Quotes erd
20540 \begin_inset Flex Code
20543 \begin_layout Plain Layout
20546 \begin_inset Quotes eld
20550 \begin_inset Quotes erd
20559 \begin_inset Newline newline
20563 \begin_inset Flex Code
20566 \begin_layout Plain Layout
20570 \begin_inset Quotes eld
20574 \begin_inset Quotes erd
20583 \begin_inset Newline newline
20587 \begin_inset Flex Code
20590 \begin_layout Plain Layout
20594 \begin_inset Quotes eld
20598 \begin_inset Quotes erd
20609 \begin_layout Subsubsection
20610 Update of the local directory checkout from repository
20613 \begin_layout Standard
20614 Once your documents gets more complex, containing sub-documents and pictures,
20616 \begin_inset Flex Code
20619 \begin_layout Plain Layout
20625 files and so on using version control becomes more complicated.
20627 supports updating the whole tree in which resides the document.
20628 This become especially useful once you cooperate with people which neither
20629 have detailed knowledge about CVS usage nor they have ambition to commit
20630 additional material to the repository.
20631 You have to organize the files structure so that all external files are
20632 in the same directory or subdirectories of the document.
20633 It's good practice anyway to store multipart documents in an extra directory.
20636 \begin_layout Standard
20638 \begin_inset Flex Code
20641 \begin_layout Plain Layout
20642 Update local directory from repository
20647 command updates the whole directory.
20648 If local changes are detected user is warned before update starts.
20649 In case of merge conflicts both versions of the conflicting document parts
20650 are placed in the final document.
20651 You have to review and correct the result of the merge.
20652 You'll find the conflicts enclosed in pairs of
20653 \begin_inset Flex Code
20656 \begin_layout Plain Layout
20663 \begin_inset Flex Code
20666 \begin_layout Plain Layout
20673 \begin_inset Flex Code
20676 \begin_layout Plain Layout
20683 The first part is your version as before the update operation with the
20684 document name prepended.
20685 The second one is the repository version with the version number after
20687 \begin_inset Flex Code
20690 \begin_layout Plain Layout
20699 \begin_layout Labeling
20700 \labelwidthstring 00.00.0000
20702 \begin_inset space ~
20706 \begin_inset space ~
20710 \begin_inset Newline newline
20714 \begin_inset Flex Code
20717 \begin_layout Plain Layout
20725 (Ask if changes are detected.)
20726 \begin_inset Newline newline
20730 \begin_inset Flex Code
20733 \begin_layout Plain Layout
20734 cd $path; cvs -q update
20744 \begin_layout Standard
20746 \begin_inset Flex Code
20749 \begin_layout Plain Layout
20755 stands for the path to the document.
20758 \begin_layout Subsubsection
20764 \begin_layout Standard
20765 This shows the complete history of the CVS document.
20768 cvs log "<file-name>"
20770 is shown in a browser.
20773 \begin_layout Subsubsection
20777 \begin_layout Standard
20779 supports CVS version number, author name, date and time of last commit.
20780 All those are extracted from
20782 cvs log -r <file-name>
20786 \begin_inset CommandInset ref
20788 reference "subsec:VCS-Revision-Information"
20795 \begin_layout Subsection
20796 SVN commands in \SpecialChar LyX
20800 \begin_layout Standard
20801 SVN is now partially supported by \SpecialChar LyX
20803 You can find the commands in the
20805 File\SpecialChar menuseparator
20807 \begin_inset space ~
20813 Please note that if you use password protected access to repository via
20814 ssh, you will be asked in terminal window.
20816 was tested against SVN 1.5, 1.6, 1.7 and 1.8
20820 \begin_layout Plain Layout
20821 Most of the commands will work with 1.4 too, see
20822 \begin_inset CommandInset ref
20824 reference "subsec:SVN-Repo-Update"
20829 There seems to be currently unresolved permissions problem under SVN 1.8
20830 with reverting changes when file is locked.
20838 \begin_layout Subsubsection
20844 \begin_layout Standard
20845 If your document is not under revision control, this is the only item shown
20847 And if it is under revision control, the
20851 item is not visible.
20854 \begin_layout Standard
20855 This command registers in SVN your document ONLY in case you have already
20856 the documents directory under SVN control (in particular
20861 This means you have to checkout the archive by yourself.
20864 \begin_layout Standard
20865 Then you are asked interactively to supply an initial description of the
20867 Don't forget that registered file is not yet commited.
20870 \begin_layout Standard
20871 SVN command that is run:
20874 \begin_inset Quotes eld
20878 \begin_inset Quotes erd
20884 \begin_layout Standard
20889 to understand the switches.
20892 \begin_layout Subsubsection
20898 \begin_layout Standard
20899 When you are finished editing a file, you commit your changes.
20900 When you do this, you are asked for a description of the changes.
20901 After that changes are commited.
20904 \begin_layout Standard
20909 \begin_layout Plain Layout
20910 In case locking is not enabled.
20912 \begin_inset CommandInset ref
20914 reference "subsec:SVN-File-Locking"
20925 svn commit -q -m"<description>" <file-name>
20928 \begin_layout Subsubsection
20934 \begin_layout Standard
20935 Updates the changes of this file from the repository.
20936 Be sure you understand SVN merging and conflicts resolving before using
20937 this function, because all conflicts has to be resolved manually by you!
20940 \begin_layout Standard
20945 \begin_layout Plain Layout
20953 svn update --non-interactive
20954 \begin_inset Quotes eld
20958 \begin_inset Quotes erd
20964 \begin_layout Subsubsection
20967 Revert To Repository Version
20970 \begin_layout Standard
20971 This will discard all changes made to the document since the last check
20973 You get a warning before changes are discarded.
20976 \begin_layout Standard
20980 \begin_inset Quotes eld
20984 \begin_inset Quotes erd
20990 \begin_layout Subsubsection
20996 \begin_layout Standard
20997 This will create a copy of the current document including the version history.
20998 It requires a clean document without any changes since the last checkin.
20999 You are asked for a file name and a description of the copy operation.
21000 After that the copy is created, both locally and in the repository.
21001 If the parent directories of the copied and original document differ, all
21002 relative paths of included files of the copy are adjusted (like in
21004 File\SpecialChar menuseparator
21009 Finally, the copy is loaded instead of the original document.
21012 \begin_layout Labeling
21013 \labelwidthstring 00.00.0000
21015 \begin_inset space ~
21019 \begin_inset space ~
21023 \begin_inset Newline newline
21027 \begin_inset Flex Code
21030 \begin_layout Plain Layout
21034 \begin_inset Quotes eld
21038 \begin_inset Quotes erd
21042 \begin_inset Quotes eld
21046 \begin_inset Quotes erd
21055 \begin_inset Newline newline
21059 \begin_inset Flex Code
21062 \begin_layout Plain Layout
21071 \begin_layout Subsubsection
21077 \begin_layout Standard
21078 This will rename the current document including the version history.
21079 It requires a clean document without any changes since the last checkin.
21080 You are asked for a file name and a description of the rename operation.
21081 After that the document is renamed, both locally and in the repository.
21082 If the parent directories of the new and old file names differ, all relative
21083 paths of included files are adjusted (like in
21085 File\SpecialChar menuseparator
21090 Finally, the document is reloaded using the new name.
21093 \begin_layout Labeling
21094 \labelwidthstring 00.00.0000
21096 \begin_inset space ~
21100 \begin_inset space ~
21104 \begin_inset Newline newline
21108 \begin_inset Flex Code
21111 \begin_layout Plain Layout
21115 \begin_inset Quotes eld
21119 \begin_inset Quotes erd
21123 \begin_inset Quotes eld
21127 \begin_inset Quotes erd
21136 \begin_inset Newline newline
21140 \begin_inset Flex Code
21143 \begin_layout Plain Layout
21152 \begin_layout Subsubsection
21153 \begin_inset CommandInset label
21155 name "subsec:SVN-Repo-Update"
21159 Update of the local directory checkout from repository
21163 \begin_layout Plain Layout
21164 Note that this command will work only with subversion
21165 \begin_inset Formula $\geqq1.5$
21176 \begin_layout Standard
21177 All the commands above have one shortcomming - they deal with the current
21179 Once your document contains pictures, includes external
21180 \begin_inset Flex Code
21183 \begin_layout Plain Layout
21189 files and so on administration becomes more complicated.
21191 now supports updating the whole tree in which resides the document
21195 \begin_layout Plain Layout
21196 One need to organize the files structure so that all external files are
21197 in the same directory or subdirectories of the document.
21204 This become especially useful once you cooperate with people which neither
21205 know about subversion management nor they have ambition to commit additional
21206 material to the repository.
21210 \begin_layout Standard
21211 \begin_inset Flex Code
21214 \begin_layout Plain Layout
21215 Update local directory from repository
21220 command updates the whole directory and in case of merge conflicts local
21221 version of the files are left, so no unintended data loss occurs.
21222 If local changes are detected user is warned before update starts.
21225 \begin_layout Labeling
21226 \labelwidthstring 00.00.0000
21228 \begin_inset space ~
21232 \begin_inset space ~
21236 \begin_inset Newline newline
21240 \begin_inset Flex Code
21243 \begin_layout Plain Layout
21249 (Ask if changes are detected.)
21250 \begin_inset Newline newline
21254 \begin_inset Flex Code
21257 \begin_layout Plain Layout
21258 svn update –accept mine-full $path
21266 \begin_layout Standard
21268 \begin_inset Flex Code
21271 \begin_layout Plain Layout
21277 stands for the path to the document.
21280 \begin_layout Subsubsection
21286 \begin_layout Standard
21287 This shows the complete history of the SVN document.
21291 \begin_inset Quotes eld
21295 \begin_inset Quotes erd
21300 is shown in a browser.
21303 \begin_layout Subsubsection
21305 \begin_inset CommandInset label
21307 name "subsec:SVN-File-Locking"
21314 \begin_layout Standard
21315 The file exchange through various revision control systems brings the problem
21316 of merge conflicts in case two different users try to edit the same (parts
21318 When such a conflict happens it needs manual resolving and one reasonable
21319 alternative is to provide some kind of locking mechanism, which guarantees
21320 that only one user is allowed to edit file at the given time.
21323 \begin_layout Standard
21324 SVN has two such mechanisms to provide mutual exclusivity for file access
21325 - locks and automatic setting of write permissions (see sec.
21327 \begin_inset CommandInset ref
21329 reference "subsec:Automatical-Locking-Property"
21334 \begin_inset Flex Code
21337 \begin_layout Plain Layout
21347 \begin_layout Plain Layout
21348 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
21354 If this property is detected for a given document \SpecialChar LyX
21355 starts to use SVN locks
21356 for document editing automatically and the whole check-in/out mechanism
21357 switches to the same regimen as for RCS.
21358 This in particular means there are two different modes of file use in \SpecialChar LyX
21362 \begin_layout Itemize
21364 The loaded file is in the read-only mode.
21365 For editing on needs to check-out.
21370 consists of updating from the repository and gaining write lock.
21371 If the lock is not possible to obtain, we remain in unlocked state.
21374 \begin_layout Itemize
21376 The loaded file is in the 'normal' edit mode.
21377 No other user is allowed to edit the file.
21382 consists of commiting changes and releasing write-lock.
21383 If no changes have been made to the document, no commit will be produced
21387 \begin_layout Plain Layout
21388 Don't be puzzled by the fact that you will be asked for commit message anyway.
21393 and only the write-lock will be released.
21396 \begin_layout Standard
21400 \begin_layout Labeling
21401 \labelwidthstring 00.00.0000
21404 svn commit -q -m"<description>" "<file-name>"
21405 \begin_inset Newline newline
21408 svn unlock "<file-name>"
21411 \begin_layout Labeling
21412 \labelwidthstring 00.00.0000
21415 svn update "<file-name>"
21416 \begin_inset Newline newline
21419 svn lock "<file-name>"
21422 \begin_layout Subsubsection
21425 \begin_inset CommandInset label
21427 name "subsec:Automatical-Locking-Property"
21433 Automatic Locking Property
21436 \begin_layout Standard
21437 The above mentioned automatic setting of write permissions of the .lyx file
21440 File\SpecialChar menuseparator
21442 \begin_inset space ~
21445 Control\SpecialChar menuseparator
21446 Toggle locking property
21449 This command is active only when the file is not locked on the svn server
21451 you need to check-out before proceeding).
21454 \begin_layout Labeling
21455 \labelwidthstring 00.00.0000
21457 \begin_inset space ~
21463 \begin_layout Labeling
21464 \labelwidthstring 00.00.0000
21467 svn propset svn:needs-lock ON "<file-name>"
21470 \begin_layout Labeling
21471 \labelwidthstring 00.00.0000
21474 svn propdel svn:needs-lock "<file-name>"
21477 \begin_layout Subsubsection
21478 \begin_inset CommandInset label
21480 name "subsec:VCS-Revision-Information"
21484 Revision Information in Documents
21487 \begin_layout Standard
21488 There are more possibilities how to activate revision information in our
21492 \begin_layout Itemize
21495 \begin_inset Separator latexpar
21502 \begin_layout Itemize
21503 tree revision information (
21504 \begin_inset Flex Code
21507 \begin_layout Plain Layout
21514 The result is the output of the
21515 \begin_inset Flex Code
21518 \begin_layout Plain Layout
21524 command, the following table gives you an idea, how to read the results.
21527 \begin_layout Standard
21529 \begin_inset Tabular
21530 <lyxtabular version="3" rows="6" columns="2">
21531 <features tabularvalignment="middle">
21532 <column alignment="center" valignment="top">
21533 <column alignment="center" valignment="top">
21535 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21538 \begin_layout Plain Layout
21544 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21547 \begin_layout Plain Layout
21555 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21558 \begin_layout Plain Layout
21564 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21567 \begin_layout Plain Layout
21568 mixed revision working copy
21575 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21578 \begin_layout Plain Layout
21584 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21587 \begin_layout Plain Layout
21588 modified working copy
21595 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21598 \begin_layout Plain Layout
21604 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21607 \begin_layout Plain Layout
21608 switched working copy
21615 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21618 \begin_layout Plain Layout
21624 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21627 \begin_layout Plain Layout
21628 partial working copy, from a sparse checkout
21635 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21638 \begin_layout Plain Layout
21644 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21647 \begin_layout Plain Layout
21648 mixed revision, modified, switched working copy
21661 \begin_layout Itemize
21662 file revision information.
21663 The result comes from parsing the output of
21664 \begin_inset Flex Code
21667 \begin_layout Plain Layout
21669 \begin_inset space ~
21673 \begin_inset space ~
21677 \begin_inset space ~
21686 Supported flags are:
21687 \begin_inset Separator latexpar
21694 \begin_layout Itemize
21695 version number of the last commit (
21696 \begin_inset Flex Code
21699 \begin_layout Plain Layout
21708 \begin_layout Itemize
21709 author of the last commit (
21710 \begin_inset Flex Code
21713 \begin_layout Plain Layout
21722 \begin_layout Itemize
21723 date of the last commit (
21724 \begin_inset Flex Code
21727 \begin_layout Plain Layout
21736 \begin_layout Itemize
21737 time of the last commit (
21738 \begin_inset Flex Code
21741 \begin_layout Plain Layout
21751 \begin_layout Standard
21752 You can obtain this info via InsetInfo (e.g.
21754 \begin_inset Flex Code
21757 \begin_layout Plain Layout
21758 info-insert buffer vcs-date
21764 The information will be available only when you have the file stored under
21765 svn managment (i.e.
21767 \begin_inset Flex Code
21770 \begin_layout Plain Layout
21776 directory is available with your document).
21780 \begin_layout Itemize
21781 Another—a hacking one—possibility is to use svn keywords
21785 \begin_layout Plain Layout
21786 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
21792 In short – you set file keywords property (e.g.
21795 svn propset svn:keywords 'Rev' file.lyx
21797 ) and then paste keyword \SpecialChar TeX
21802 \begin_layout Plain Layout
21803 This is an easy way how to ensure that \SpecialChar LyX
21804 won't break the line in the middle
21810 tag in your document (e.g.
21815 \begin_layout Plain Layout
21823 This way svn client will automatically substitute revision number (e.g.
21828 \begin_layout Plain Layout
21835 ) after each update and commit.
21836 There are more problems with this approach.
21837 Firstly, the '$' character is used in \SpecialChar TeX
21838 world for math equations, so any
21839 occurence of math formula
21840 \begin_inset Formula $Rev$
21844 \begin_inset Formula $Rev:59$
21847 in your \SpecialChar LyX
21849 Similarly for other keywords like Id, Date, Author, etc.
21850 Secondly svn output is dependent on your locales, so its very easy that
21851 svn would produce some problematic strings once Date is used.
21852 Thirdly you get the whole 'Rev: 59' string in your document instead of
21854 Until subversion implements user's custom keywords it will be hard to use
21855 this approach reliably or let \SpecialChar LyX
21856 to support it directly.
21859 \begin_layout Subsection
21860 SVN and Windows Environment
21863 \begin_layout Quote
21864 My inclination is to say that if the user cannot figure out the command
21865 line operations on their own fairly quickly, they would be well advised
21866 to use TortoiseSVN.
21872 \begin_layout Subsubsection
21876 \begin_layout Standard
21877 In addition to installing \SpecialChar LyX
21878 , and having access to a Subversion repository,
21879 the user will need to install the Subversion client program.
21880 A Windows installer for the client program is available from
21881 \begin_inset CommandInset href
21884 target "http://www.collab.net/nonav/downloads/subversion/"
21889 The user may also want to install
21890 \begin_inset CommandInset href
21893 target "http://tortoisesvn.tigris.org/"
21897 , which integrates Subversion operations into the context (rightclick) menu
21898 of Windows Explorer.
21899 Operations done outside \SpecialChar LyX
21900 will typically be more convenient using the Explorer
21902 Note that TortoiseSVN is not a replacement for the client program, which
21903 is what \SpecialChar LyX
21907 \begin_layout Subsubsection
21908 Bringing a document under Subversion control
21911 \begin_layout Standard
21912 Before a \SpecialChar LyX
21913 document can be brought under version control in Subversion, its
21914 parent directory needs to be under version control.
21915 If the document is being added to a project already in the repository,
21916 this is accomplished by checking the project out to the directory where
21917 the new document will be placed.
21918 If the project itself is not yet under version control (for instance, if
21919 this document starts a new project), the directory must be imported into
21921 This is done outside \SpecialChar LyX
21923 Both import and checkout are easily accomplished from the Explorer context
21924 menu using TortoiseSVN, or alternatively can be done using the command
21925 line client at a DOS prompt.
21926 The procedure for importing the project using TortoiseSVN is described
21927 below, assuming an existing repository and a new project being started
21935 For information on using the Subversion client program, run
21942 \begin_layout Enumerate
21949 in Windows Explorer, right click it, and select
21951 TortoiseSVN\SpecialChar menuseparator
21955 If necessary, adjust the URL for the repository, then click OK.
21958 \begin_layout Enumerate
21959 Right click the level of the repository under which you want to place the
21960 new project folder (typically the top level) and click
21964 Supply a name for the project folder and click OK.
21965 Add a message for the log file if desired, then click OK again.
21966 The new project folder should appear in the repository.
21967 Finally, click OK again to exit the repository browser.
21970 \begin_layout Enumerate
21971 Once again right click
21977 , this time selecting SVN Checkout\SpecialChar ldots
21978 Select the URL of the project folder
21979 you just created in the repository, and set the checkout directory to
21987 You will be warned about a non-empty folder; click OK to proceed.
21988 You should now have a
21999 \begin_layout Enumerate
22000 Create or open your document in \SpecialChar LyX
22003 File\SpecialChar menuseparator
22005 \begin_inset space ~
22008 Control\SpecialChar menuseparator
22012 Add a log message and click OK to commit the document to version control.
22015 \begin_layout Standard
22016 From this point onward, you should have full functionality in the
22018 File\SpecialChar menuseparator
22020 \begin_inset space ~
22026 You also have the option of checking the document in and out, viewing its
22028 using the TortoiseSVN context menu in Windows Explorer or the Subversion
22029 client program from a command prompt.
22032 \begin_layout Subsubsection
22033 SSH tunnel used with SVN under Windows
22036 \begin_layout Standard
22037 Compared with Linux setting up an svn client to communicate over ssh under
22038 Windows is a rather troublesome task.
22039 We will at least offer some hints how to setup the client side but prior
22040 knowledge about ssh and the Windows command line is needed, also be prepared
22041 for a great deal of frustration\SpecialChar ldots
22045 \begin_layout Enumerate
22046 Get an svn client for windows, as described in the previous sections.
22047 When it is a fresh install run some svn command (e.g.
22049 \begin_inset Flex Code
22052 \begin_layout Plain Layout
22058 ) to create config files, which you will need to change later on.
22061 \begin_layout Enumerate
22062 Choose an ssh client for Windows.
22063 There are several possibilities, we will use the one from Putty tools
22067 \begin_layout Plain Layout
22068 \begin_inset Flex URL
22071 \begin_layout Plain Layout
22073 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
22084 You will need to set the connection up so that the client doesn't ask for
22085 any password from you.
22086 To keep things easy we will use only keys without any additional password
22088 \begin_inset Separator latexpar
22095 \begin_layout Enumerate
22097 \begin_inset Flex Code
22100 \begin_layout Plain Layout
22107 Save your private .ppk key file and put the public one on the server side.
22108 If the SVN server runs on Linux, note that the format of the public key
22109 is not compatible with Linux openssh and you will need to direcly copy-paste
22112 Public key for pasting into OpenSSH authorized_keys file
22114 :” edit field into the server's
22115 \begin_inset Flex Code
22118 \begin_layout Plain Layout
22119 ~/.ssh/authorized_keys
22125 \begin_inset Flex Code
22128 \begin_layout Plain Layout
22137 \begin_layout Enumerate
22139 \begin_inset Flex Code
22142 \begin_layout Plain Layout
22149 In the SVN config file
22153 \begin_layout Plain Layout
22154 Exact path depends on Windows version, usually somewhere around
22155 \begin_inset Flex Code
22158 \begin_layout Plain Layout
22161 Documents and Settings
22175 \begin_inset Flex Code
22178 \begin_layout Plain Layout
22193 , section [tunnels], setup ssh command, e.g.
22195 \begin_inset Flex Code
22198 \begin_layout Plain Layout
22199 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
22208 \begin_layout Plain Layout
22209 It will usually take a lot of time to get exact command right and it depends
22211 For example do not have some remote server saved as a default session in
22213 If things fail, try to connect via plink without SVN first.
22222 \begin_layout Enumerate
22223 Checkout the SVN archive, e.
22224 \begin_inset space \thinspace{}
22228 \begin_inset Newline newline
22232 \begin_inset Flex Code
22235 \begin_layout Plain Layout
22236 svn co svn+ssh://user@server/repository_path
22244 \begin_layout Subsubsection
22245 End-of-Line Conversions
22248 \begin_layout Standard
22249 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
22251 use different line endings inside the .lyx files.
22252 This is not a problem as far as \SpecialChar LyX
22253 functionality is concerned, but the commit
22254 diffs will be huge and merge-conflicts prone.
22255 Fortunately SVN itself knows
22259 \begin_layout Plain Layout
22260 \begin_inset Flex URL
22263 \begin_layout Plain Layout
22265 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
22275 how to deal with CR/LF problems when switching .lyx files to the
22276 \begin_inset Flex Code
22279 \begin_layout Plain Layout
22289 \begin_layout Plain Layout
22291 \begin_inset Flex Code
22294 \begin_layout Plain Layout
22295 svn propset svn:eol-style native FILE_NAME
22308 \begin_layout Subsection
22309 GIT commands in \SpecialChar LyX
22313 \begin_layout Standard
22314 A minimal subset of GIT commands is now supported by \SpecialChar LyX
22316 You can find the commands in the
22318 File\SpecialChar menuseparator
22320 \begin_inset space ~
22326 Please note that if you use password protected access to repository via
22327 ssh, you will be asked in terminal window.
22329 was tested against GIT 1.7.
22333 \begin_layout Plain Layout
22334 Windows users please note that you need to ensure that git is on the path.
22335 This can be set from within \SpecialChar LyX
22338 Tools\SpecialChar menuseparator
22339 Preferences\SpecialChar menuseparator
22340 Paths\SpecialChar menuseparator
22351 \begin_layout Standard
22352 One big difference of GIT and the other supported version control systems
22353 is the distributed nature of GIT: With traditional version control systems
22354 there is one central server which hosts the repository.
22355 Users commit their changes to the server, and get updates made by other
22357 With GIT, users commit to a local repository.
22358 The local repository can be synchronized with one or more remote repositories
22360 \begin_inset Flex Code
22363 \begin_layout Plain Layout
22370 \begin_inset Flex Code
22373 \begin_layout Plain Layout
22381 does not interact in any way with remote GIT repositories.
22382 It works exclusively with the local repository in a very similar way as
22383 with a central CVS or SVN repository.
22384 If you use remote GIT repositories you need to do the
22385 \begin_inset Flex Code
22388 \begin_layout Plain Layout
22395 \begin_inset Flex Code
22398 \begin_layout Plain Layout
22404 operations with your favourite GIT client.
22407 \begin_layout Subsubsection
22413 \begin_layout Standard
22414 If your document is not under revision control, this is the only item shown
22416 And if it is under revision control, the
22420 item is not visible.
22423 \begin_layout Standard
22424 This command registers in GIT your document ONLY in case you have already
22425 the documents directory under GIT control (in particular
22430 This means you have to checkout the archive by yourself.
22433 \begin_layout Standard
22434 Then you are asked interactively to supply an initial description of the
22436 Don't forget that registered file is not yet commited.
22439 \begin_layout Standard
22440 GIT command that is run:
22443 \begin_inset Quotes eld
22447 \begin_inset Quotes erd
22453 \begin_layout Standard
22458 to understand the switches.
22461 \begin_layout Subsubsection
22467 \begin_layout Standard
22468 When you are finished editing a file, you commit your changes.
22469 When you do this, you are asked for a description of the changes.
22470 After that changes are commited.
22473 \begin_layout Standard
22476 git commit -q -m"<description>" <file-name>
22479 \begin_layout Subsubsection
22482 Revert To Repository Version
22485 \begin_layout Standard
22486 This will discard all changes made to the document since the last check
22488 You get a warning before changes are discarded.
22491 \begin_layout Standard
22495 \begin_inset Quotes eld
22499 \begin_inset Quotes erd
22505 \begin_layout Subsubsection
22511 \begin_layout Standard
22512 This will rename the current document including the version history.
22513 It requires a clean document without any changes since the last checkin.
22514 You are asked for a file name and a description of the rename operation.
22515 After that the document is renamed, both locally and in the repository.
22516 If the parent directories of the new and old file names differ, all relative
22517 paths of included files are adjusted (like in
22519 File\SpecialChar menuseparator
22524 Finally, the document is reloaded using the new name.
22527 \begin_layout Labeling
22528 \labelwidthstring 00.00.0000
22530 \begin_inset space ~
22534 \begin_inset space ~
22538 \begin_inset Newline newline
22542 \begin_inset Flex Code
22545 \begin_layout Plain Layout
22549 \begin_inset Quotes eld
22553 \begin_inset Quotes erd
22557 \begin_inset Quotes eld
22561 \begin_inset Quotes erd
22570 \begin_inset Newline newline
22574 \begin_inset Flex Code
22577 \begin_layout Plain Layout
22586 \begin_layout Subsubsection
22592 \begin_layout Standard
22593 This shows the complete history of the GIT document.
22597 \begin_inset Quotes eld
22601 \begin_inset Quotes erd
22606 is shown in a browser.
22609 \begin_layout Subsubsection
22613 \begin_layout Standard
22615 supports GIT hash number of the last commit to the file, author name, date
22616 and time of last commit.
22617 All those are extracted from
22619 git log -n 1 --pretty=format:%H%n%an%n%ai
22622 Tree version information is obtained via
22624 git describe --abbrev --dirty --long
22628 \begin_inset CommandInset ref
22630 reference "subsec:VCS-Revision-Information"
22637 \begin_layout Subsection
22641 \begin_layout Standard
22642 With the recent addition of the vc-command function \SpecialChar LyX
22643 power users are allowed
22644 to create their own commands for revision control.
22647 \begin_layout Standard
22648 As an example you can see how two TortoiseSVN commands could be integrated
22652 \begin_layout Description
22654 \begin_inset Flex Code
22657 \begin_layout Plain Layout
22658 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
22666 \begin_layout Description
22668 \begin_inset Flex Code
22671 \begin_layout Plain Layout
22672 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
22680 \begin_layout Subsection
22681 Version control and Document comparison
22684 \begin_layout Standard
22685 One of the typical uses of version control is to inspect the changes between
22686 revisions, usually by creating
22687 \begin_inset Flex Code
22690 \begin_layout Plain Layout
22697 While this is useful for plain text files, it is much less useful in the
22698 case of \SpecialChar LyX
22699 files, which have more a complicated structure.
22700 Hence we provide binding to the Document comparison feature.
22701 There are two ways of calling this feature - either by direct call of
22702 \begin_inset Flex Code
22705 \begin_layout Plain Layout
22712 function (for details see \SpecialChar LyX
22713 functions manual) or by icon/menu item
22714 \begin_inset Flex Noun
22717 \begin_layout Plain Layout
22718 Compare with older revision...
22724 One can either compare two chosen revisions of the document or he can simply
22725 compare the current version of edited text with older revisions (where
22727 \begin_inset Flex Noun
22730 \begin_layout Plain Layout
22736 ' revisions back means comparison of the edited file with last commited
22741 \begin_layout Standard
22742 This feature is supported for SVN and RCS though due to the more complicated
22743 versioning scheme of RCS there is a constraint – when addressing the revisions
22744 in dialog, numbers always point to the last number in RCS revision number,
22747 We don't currently support GIT addressing of revisions, one can just compare
22748 edited document with its revision X steps backs, where X is addressed as
22752 \begin_layout Section
22753 Literate Programming
22756 \begin_layout Standard
22761 (kayvan@sylvan.com)
22765 original documentation written by
22767 Edmar Wienskoski Jr.
22770 (edmar-w-jr@technologist.com)
22773 \begin_layout Subsection
22777 \begin_layout Standard
22778 The main purpose of this documentation is to show you how to use \SpecialChar LyX
22780 programming, where it is assumed that you are familiar with this programming
22781 technique, and know what
22782 \begin_inset Quotes eld
22786 \begin_inset Quotes erd
22790 \begin_inset Quotes eld
22794 \begin_inset Quotes erd
22798 If that is not the case, please follow the web links provided in the following
22800 There is a lot of good documentation out there covering old development
22801 history to the latest tools tips.
22804 \begin_layout Standard
22805 It is also assumed that you are familiar with \SpecialChar LyX
22806 itself to a point that you
22807 are comfortable changing your \SpecialChar LyX
22808 preferences, and X resources file.
22809 If that is not the case please refer to other \SpecialChar LyX
22810 documentation to cover your
22814 \begin_layout Subsection
22815 Literate Programming
22818 \begin_layout Standard
22819 From the Literate Programming FAQ:
22822 \begin_layout Quotation
22823 Literate programming is the combination of documentation and source together
22824 in a fashion suited for reading by human beings.
22825 In fact, literate programs should be enjoyable reading, even inviting!
22826 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
22827 and documentation in a single file.
22828 Literate programming tools then parse the file to produce either readable
22829 documentation or compilable source.
22830 The WEB style of literate programming was created by D.
22831 \begin_inset space \thinspace{}
22835 Knuth during the development of his \SpecialChar TeX
22836 typesetting software.
22840 \begin_layout Standard
22841 Another excerpt says:
22844 \begin_layout Quotation
22847 How is literate programming different from verbose commenting?
22850 \begin_layout Quotation
22851 There are three distinguishing characteristics.
22852 In order of importance, they are:
22853 \begin_inset Separator latexpar
22860 \begin_layout Itemize
22861 flexible order of elaboration
22864 \begin_layout Itemize
22865 automatic support for browsing
22868 \begin_layout Itemize
22869 typeset documentation, especially diagrams and mathematics
22873 \begin_layout Standard
22874 Now that I sparked your curiosity, take a look in the references.
22877 \begin_layout Subsubsection
22881 \begin_layout Standard
22882 The complete Literate Programming FAQ can be found at:
22885 \begin_layout Quote
22886 Literate Programming FAQ
22887 \begin_inset Flex URL
22890 \begin_layout Plain Layout
22892 http://www.literateprogramming.com/lpfaq.pdf
22900 \begin_layout Standard
22901 The FAQ lists 23 (twenty three!) different literate programming tools.
22902 Where some are specialized or
22903 \begin_inset Quotes eld
22907 \begin_inset Quotes erd
22910 for particular programming languages, while other have general scope.
22915 for my own use for several reasons:
22918 \begin_layout Itemize
22919 It can generate the documentation either in \SpecialChar LaTeX
22923 \begin_layout Itemize
22924 It has a open architecture, i.
22925 \begin_inset space \thinspace{}
22929 \begin_inset space \space{}
22932 it is easy to plug in new filters and to perform special processing that
22937 \begin_layout Itemize
22938 There is a good selection of filters available already (the HTML is one
22942 \begin_layout Itemize
22946 \begin_layout Standard
22947 The Noweb web page can be found at:
22950 \begin_layout Quote
22952 \begin_inset Flex URL
22955 \begin_layout Plain Layout
22957 http://www.cs.virginia.edu/~nr/noweb/
22965 \begin_layout Standard
22966 Starting from there you can reach many other interesting links and even
22967 some literate program examples.
22970 \begin_layout Subsection
22972 and Literate Programming with Noweb
22975 \begin_layout Standard
22976 The \SpecialChar LyX
22977 support for Literate Programming is provided by using the generic \SpecialChar LyX
22979 converters mechanism.
22980 This support is provided in a
22981 \begin_inset Quotes eld
22985 \begin_inset Quotes erd
22989 \begin_inset space \thinspace{}
22993 \begin_inset space \space{}
22996 you will be able to use this new \SpecialChar LyX
22997 feature with some other literate programming
22998 tool of your choice by just changing your \SpecialChar LyX
23002 \begin_layout Subsubsection
23003 Generating documents and code (weaving and tangling)
23006 \begin_layout Paragraph
23007 Using the noweb module
23010 \begin_layout Standard
23011 If you have installed Noweb and \SpecialChar LyX
23012 successfully, whenever you open a new document,
23013 after you have chosen its document class, use the Document->Settings menu
23015 \begin_inset Quotes eld
23019 \begin_inset Quotes erd
23023 If Noweb is correctly installed, when you click on the
23024 \begin_inset Quotes eld
23028 \begin_inset Quotes erd
23031 link, you will see the
23032 \begin_inset Quotes eld
23036 \begin_inset Quotes erd
23039 module in the available list and you can add it to your document.
23042 \begin_layout Paragraph
23046 \begin_layout Standard
23048 enables you to write code with a layout named
23049 \begin_inset Flex Noun
23052 \begin_layout Plain Layout
23059 Noweb delimits chunks like this:
23062 \begin_layout LyX-Code
23066 \begin_layout LyX-Code
23070 \begin_layout LyX-Code
23074 \begin_layout LyX-Code
23078 \begin_layout LyX-Code
23082 \begin_layout Standard
23083 The problem is that whatever is written in between the << and the
23087 must be taken literally, i.
23088 \begin_inset space \thinspace{}
23092 \begin_inset space \space{}
23096 should be prevented from making any special interpretation of what has
23098 This is also handled by
23099 \begin_inset Flex Noun
23102 \begin_layout Plain Layout
23108 , that works like a normal paragraph but has a free spacing capability.
23111 \begin_layout Standard
23112 As a special note, you can also use the
23113 \begin_inset Quotes eld
23117 \begin_inset Quotes erd
23120 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
23124 \begin_layout LyX-Code
23128 \begin_layout LyX-Code
23129 def some_function(args):
23132 \begin_layout LyX-Code
23133 "This is the doc string for this function."
23136 \begin_layout LyX-Code
23137 print "My args: ", args
23140 \begin_layout LyX-Code
23141 @ %def some_function
23144 \begin_layout Standard
23145 For an example of this usage and the resulting cross-reference output, look
23146 at the Literate python program in
23148 LIBDIR/examples/listerrors.lyx
23150 which should make this all clear.
23153 \begin_layout Paragraph
23154 Generating the documentation
23157 \begin_layout Standard
23158 At this point you already have a new document file with a proper document
23159 class, and with some code and text on it.
23160 How do I print it? The answer is simple, you select
23162 View\SpecialChar menuseparator
23166 Just like you would do for a plain document.
23167 No special procedure is required.
23170 \begin_layout Standard
23171 To help orientate you, I will now explain what happens inside \SpecialChar LyX
23175 \begin_layout Enumerate
23178 Update\SpecialChar menuseparator
23181 menu option is chosen, a \SpecialChar LaTeX
23184 \begin_inset Separator latexpar
23191 \begin_layout Standard
23192 If the document is of any literate class the generated file will be named
23193 with an extension name defined by the
23194 \begin_inset Quotes eld
23198 \begin_inset Quotes erd
23201 format (defined in the Preferences panel), otherwise the file will have
23210 \begin_layout Enumerate
23211 Note that the only difference so far is in the name of the file, no special
23212 processing is required by \SpecialChar LyX
23214 Given that you formatted the code using the
23215 \begin_inset Flex Noun
23218 \begin_layout Plain Layout
23224 layout that, by itself, takes care of the business.
23227 \begin_layout Enumerate
23228 If the document is of any literate class \SpecialChar LyX
23229 will then use the internal \SpecialChar LyX
23231 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
23236 \begin_layout Plain Layout
23237 The converters are defined in the
23239 Tools\SpecialChar menuseparator
23243 \begin_inset Quotes eld
23247 \begin_inset Quotes erd
23259 manual for general information about converters.
23264 to generate the \SpecialChar LaTeX
23266 \begin_inset Separator latexpar
23273 \begin_layout Standard
23274 Otherwise it will just skip this step.
23278 \begin_layout Enumerate
23279 Finally, \SpecialChar LaTeX
23280 is invoked and the regular post processing continues as in a plain
23284 \begin_layout Standard
23285 Independence from a particular
23286 \begin_inset Quotes eld
23290 \begin_inset Quotes erd
23293 is easily achieved by changing the commands that are run by the various
23297 \begin_layout Paragraph
23298 Generating the code
23301 \begin_layout Standard
23302 When the build menu option is chosen or the corresponding button in the
23303 toolbar is pressed, a \SpecialChar LaTeX
23304 file is generated just like step 1 above.
23305 Next, \SpecialChar LyX
23311 This converter needs to be defined by the user and is not installed by
23312 default, though the Program format is.
23313 This converter (like any other converter) will have two parts:
23316 \begin_layout Enumerate
23317 The converter program itself.
23318 This program performs the conversion from the one format to the other (in
23319 this case, from the Noweb format to the Program pseudo-format).
23322 \begin_layout Enumerate
23323 The error log parser.
23324 This is a program whose sole purpose is to rewrite error messages in a
23325 format that \SpecialChar LyX
23327 This makes it possible for \SpecialChar LyX
23328 to place error boxes in the right places in
23332 \begin_layout Standard
23333 The first part, the
23334 \begin_inset Quotes eld
23338 \begin_inset Quotes erd
23341 setting, should be set to
23342 \begin_inset Newline newline
23346 \begin_inset Quotes eld
23354 \begin_inset Quotes erd
23358 \begin_inset Newline newline
23361 This basically means that \SpecialChar LyX
23363 \begin_inset Quotes eld
23367 \begin_inset Quotes erd
23370 (a program or script) with the name of the Noweb file (normally a file
23371 in the \SpecialChar LyX
23372 temp directory) and the directory path of the original \SpecialChar LyX
23377 \begin_layout Standard
23378 This is an implementation of
23379 \begin_inset Quotes eld
23383 \begin_inset Quotes erd
23386 that you can place in a directory on your path:
23389 \begin_layout Standard
23390 \begin_inset VSpace defskip
23396 \begin_layout Standard
23397 \begin_inset Newpage pagebreak
23403 \begin_layout Standard
23409 \begin_layout Standard
23415 \begin_layout Standard
23418 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
23421 \begin_layout Standard
23422 \begin_inset VSpace defskip
23428 \begin_layout Standard
23429 The next part of the converter setting is the
23430 \begin_inset Quotes eld
23434 \begin_inset Quotes erd
23437 which is to be set to
23438 \begin_inset Newline newline
23442 \begin_inset Quotes eld
23447 parselog=$$s/scripts/listerrors
23450 \begin_inset Quotes erd
23454 \begin_inset Newline newline
23457 This will run any errors that are generated by the
23458 \begin_inset Quotes eld
23462 \begin_inset Quotes erd
23465 process through the
23466 \begin_inset Quotes eld
23470 \begin_inset Quotes erd
23476 \begin_layout Standard
23477 The build will normally take place in \SpecialChar LyX
23478 's temporary directory, so the files
23479 produced by the conversion will be in that directory.
23481 will copy out what it regards as the `main' file, but the
23485 conversion may produce several files, and so most of these would then be
23486 deleted when \SpecialChar LyX
23488 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
23489 the build-script chunk can place the generated files in that location.
23492 \begin_layout Paragraph
23493 Build instructions in the document
23496 \begin_layout Standard
23497 The last piece of the integration between \SpecialChar LyX
23499 \begin_inset Quotes eld
23503 \begin_inset Quotes erd
23507 Generally, the instructions for building your program should be embedded
23508 in a chunk of its own.
23510 \begin_inset Quotes eld
23514 \begin_inset Quotes erd
23517 above uses the notangle command to look for this chunk (called
23518 \begin_inset Quotes eld
23522 \begin_inset Quotes erd
23525 ) and runs its contents through
23526 \begin_inset Quotes eld
23530 \begin_inset Quotes erd
23536 \begin_layout Standard
23537 Typically, such a chunk would look something like this:
23540 \begin_layout LyX-Code
23544 \begin_layout LyX-Code
23546 \begin_inset Newline newline
23549 if [ -z "${NOWEB_SOURCE}" ]
23550 \begin_inset Newline newline
23556 \begin_layout LyX-Code
23557 NOWEB_SOURCE=myfile.nw
23558 \begin_inset Newline newline
23562 \begin_inset Newline newline
23566 code to extract files ...
23567 use NOWEB_OUTPUT_DIR here ...]
23568 \begin_inset Newline newline
23572 code to compile files ...]
23573 \begin_inset Newline newline
23579 \begin_layout Standard
23582 LIBDIR/examples/listerrors.lyx
23586 LIBDIR/examples/Literate.lyx
23588 which implement two versions of the
23589 \begin_inset Quotes eld
23593 \begin_inset Quotes erd
23596 program for some illustrations of how all of these pieces go together or
23599 LIBDIR/examples/noweb2lyx.lyx.
23602 Interestingly, these three files show off the language-indepence of the
23604 literate programming support since they are written in Python, C and Perl
23608 \begin_layout Subsubsection
23609 Configuring \SpecialChar LyX
23613 \begin_layout Standard
23614 All the Literate Programming support is configured by the
23616 Tools\SpecialChar menuseparator
23620 \begin_inset Quotes eld
23624 \begin_inset Quotes erd
23628 The important parts are:
23631 \begin_layout Description
23633 \begin_inset space ~
23637 \begin_inset Quotes eld
23641 \begin_inset Quotes erd
23645 \begin_inset space ~
23648 format Set up via the File Formats tab, this is where the Noweb-specific
23658 , the file extension is set to
23663 This tells \SpecialChar LyX
23664 to create a file with a
23668 extension in the first step of the conversion process.
23671 \begin_layout Description
23673 \begin_inset space ~
23681 \begin_inset space ~
23684 format This is an empty format whose sole purpose is to be the endpoint
23685 of a conversion (which then allows us to set up a converter for it).
23688 \begin_layout Description
23698 This converter performs the
23699 \begin_inset Quotes eld
23703 \begin_inset Quotes erd
23706 of the literate document.
23707 For Noweb, it is set to
23708 \begin_inset Quotes eld
23713 noweave -delay -index $$i > $$o
23716 \begin_inset Quotes erd
23722 \begin_layout Description
23732 \begin_inset Quotes eld
23736 \begin_inset Quotes erd
23740 As stated above, the Converter is set to
23741 \begin_inset Quotes eld
23749 \begin_inset Quotes erd
23752 , with Flags set to
23753 \begin_inset Newline newline
23757 \begin_inset Quotes eld
23762 parselog=$$s/scripts/listerrors
23765 \begin_inset Quotes erd
23771 \begin_layout Subsubsection
23775 \begin_layout Standard
23776 There is also a new function implemented in the \SpecialChar LyX
23778 \begin_inset Quotes eld
23781 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
23785 \begin_layout Standard
23786 When debugging code with ddd/gdb, it is possible to invoke a text editor
23787 at the current execution position with a single key stroke.
23788 The default ddd configuration for that is shift-ctrl-V.
23789 It happens that you can define the editor command line invocation in ddd
23792 Edit\SpecialChar menuseparator
23793 Preferences\SpecialChar menuseparator
23796 dialog and changing the "Edit Sources" entry.
23799 \begin_layout Standard
23800 I take advantage of the newly created \SpecialChar LyX
23801 server function and this ddd feature,
23803 \begin_inset Quotes eld
23807 \begin_inset Quotes erd
23813 \begin_layout Standard
23814 \begin_inset VSpace defskip
23820 \begin_layout Standard
23823 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
23826 \begin_layout Standard
23827 \begin_inset VSpace defskip
23833 \begin_layout Standard
23834 With this, whenever you are using ddd and find a point in the program that
23835 you want to edit, you just press shift-ctrl-V (in the ddd window), and
23836 ddd will forward this information to \SpecialChar LyX
23837 through the \SpecialChar LyX
23838 server and then the
23840 window will show the same file with the cursor at the same position ddd
23842 No more guessing or long scrolling to locate a point in the program back
23846 \begin_layout Standard
23847 Note however that you must enable the \SpecialChar LyX
23848 server to get this feature working
23849 (it is disabled by default).
23850 You can enable it in
23862 ) by entering in the
23868 \begin_inset Quotes eld
23873 /home/<your-home-directory>/.lyx/lyxpipe
23876 \begin_inset Quotes erd
23882 \begin_layout Standard
23883 Read the \SpecialChar LyX
23884 server documentation in the
23886 Customization Manual
23888 for further information.
23891 \begin_layout Subsubsection
23895 \begin_layout Standard
23896 There are six new buttons that can be added to your \SpecialChar LyX
23898 Five of these buttons are short cuts to layout styles:
23921 The last one is a short cut to the
23922 \begin_inset Quotes eld
23926 \begin_inset Quotes erd
23933 \begin_layout Standard
23935 has a range of buttons that are available for tool bar customization.
23936 In my toolbar I like to combine the six short cuts above with two more:
23941 \SpecialChar menuseparator
23946 \SpecialChar menuseparator
23953 Document\SpecialChar menuseparator
23954 View\SpecialChar menuseparator
23958 Here is how it looks like:
23961 \begin_layout LyX-Code
23965 \begin_layout LyX-Code
23969 \begin_layout LyX-Code
23970 Icon "layout Standard"
23973 \begin_layout LyX-Code
23974 Icon "layout Section"
23977 \begin_layout LyX-Code
23978 Icon "layout \SpecialChar LaTeX
23982 \begin_layout LyX-Code
23983 Icon "layout \SpecialChar LyX
23987 \begin_layout LyX-Code
23988 Icon "layout Chunk"
23991 \begin_layout LyX-Code
23995 \begin_layout LyX-Code
23999 \begin_layout LyX-Code
24000 Icon "buffer-typeset"
24003 \begin_layout LyX-Code
24004 Icon "build-program"
24007 \begin_layout LyX-Code
24011 \begin_layout LyX-Code
24015 \begin_layout LyX-Code
24019 \begin_layout LyX-Code
24023 \begin_layout LyX-Code
24027 \begin_layout Subsubsection
24028 Colors customization
24031 \begin_layout Standard
24032 There are a number of colors in \SpecialChar LyX
24033 that can be customized in
24038 One of the things that bothers people is the \SpecialChar LaTeX
24040 The default color is red, since the chunks uses \SpecialChar LaTeX
24041 font, and there is a lot
24042 of chunks in literate documents, you may get tired of seeing everything
24044 You can change it by going to the tabs
24053 \begin_layout Standard
24054 The next thing is the visible presence of the newline character in the screen.
24055 You can choose the color of this particular character and make it blend
24057 I recommend you choosing a color that is close to the background but not
24058 equal, that way you still can see it is there, but it is not bothering
24062 \begin_layout Subsection
24067 \begin_layout Standard
24076 is documented in the
24080 example file and in the Sweave manual (menu
24082 Help\SpecialChar menuseparator
24088 \begin_layout Chapter
24092 \begin_layout Standard
24093 You can do everything with \SpecialChar LyX
24094 that you can do with \SpecialChar LaTeX
24096 However, \SpecialChar LyX
24097 cannot support every \SpecialChar LaTeX
24099 But you can always use \SpecialChar TeX
24101 This chapter shows you some more special things you might want to use.
24102 For other special things you can do with figures, tables, floats, boxes
24103 and notes, have a look at the
24106 \begin_inset space ~
24114 \begin_layout Section
24115 Multiple Text Columns
24118 \begin_layout Standard
24119 This feature is independent of the option
24121 Two-column document
24123 in the document settings under
24128 If you want to have 2
24129 \begin_inset space ~
24132 columns for the whole document, it is recommended to use the
24134 Two-column document
24137 For all other cases use this feature.
24140 \begin_layout Standard
24141 To use multiple text columns in your document, you have to load the module
24148 Document\SpecialChar menuseparator
24149 Settings\SpecialChar menuseparator
24152 ) and must have the \SpecialChar LaTeX
24160 \begin_layout Standard
24161 Footnotes within multiple columns will be placed at the bottom of the page
24162 and not under each column.
24163 Within the different columns you can use everything, with the limitation
24164 that for floats you need to use the float option
24171 \begin_layout Subsection
24175 \begin_layout Standard
24176 If you want to have 2
24177 \begin_inset space ~
24180 columns in your text, insert a multicolumn inset via the menu
24182 Insert\SpecialChar menuseparator
24184 \begin_inset space ~
24187 Insets\SpecialChar menuseparator
24189 \begin_inset space ~
24194 where the columns should start.
24195 Write all text that should be printed in 2
24196 \begin_inset space ~
24199 columns into this inset.
24202 \begin_layout Standard
24203 Here is an example:
24206 \begin_layout Standard
24208 \begin_inset Flex Multiple Columns
24211 \begin_layout Plain Layout
24216 The Adventure of the Empty House
24219 \begin_inset Newline newline
24222 by Sir Arthur Conan Doyle
24225 \begin_layout Plain Layout
24228 It was in the spring of the year 1894 that all London was interested, and
24229 the fashionable world dismayed, by the murder of the Honourable Ronald
24230 Adair under most unusual and inexplicable circumstances.
24231 The public has already learned those particulars of the crime which came
24232 out in the police investigation, but a good deal was suppressed upon that
24233 occasion, since the case for the prosecution was so overwhelmingly strong
24234 that it was not necessary to bring forward all the facts.
24235 Only now, at the end of nearly ten years, am I allowed to supply those
24236 missing links which make up the whole of that remarkable chain.
24237 The crime was of interest in itself, but that interest was as nothing to
24238 me compared to the inconceivable sequel, which afforded me the greatest
24239 shock and surprise of any event in my adventurous life.
24240 Even now, after this long interval, I find myself thrilling as I think
24241 of it, and feeling once more that sudden flood of joy, amazement, and increduli
24242 ty which utterly submerged my mind.
24243 Let me say to that public, which has shown some interest in those glimpses
24244 which I have occasionally given them of the thoughts and actions of a very
24245 remarkable man, that they are not to blame me if I have not shared my knowledge
24246 with them, for I should have considered it my first duty to do so, had
24247 I not been barred by a positive prohibition from his own lips, which was
24248 only withdrawn upon the third of last month.
24256 \begin_layout Standard
24257 To get 3 or more columns, set the cursor into the multicolumn inset and
24260 Insert\SpecialChar menuseparator
24262 \begin_inset space ~
24266 \begin_inset space ~
24272 The number of the desired columns is written into that inset (for 3
24273 \begin_inset space ~
24277 \begin_inset Quotes eld
24281 \begin_inset Quotes erd
24285 \begin_inset Newline newline
24288 Here is an example with 3
24289 \begin_inset space ~
24295 \begin_layout Standard
24296 \begin_inset Flex Multiple Columns
24299 \begin_layout Plain Layout
24302 \begin_inset Argument 1
24305 \begin_layout Plain Layout
24311 It can be imagined that my close intimacy with Sherlock Holmes had interested
24312 me deeply in crime, and that after his disappearance I never failed to
24313 read with care the various problems which came before the public.
24314 And I even attempted, more than once, for my own private satisfaction,
24315 to employ his methods in their solution, though with indifferent success.
24316 There was none, however, which appealed to me like this tragedy of Ronald
24318 As I read the evidence at the inquest, which led up to a verdict of willful
24319 murder against some person or persons unknown, I realized more clearly
24320 than I had ever done the loss which the community had sustained by the
24321 death of Sherlock Holmes.
24322 There were points about this strange business which would, I was sure,
24323 have specially appealed to him, and the efforts of the police would have
24324 been supplemented, or more probably anticipated, by the trained observation
24325 and the alert mind of the first criminal agent in Europe.
24326 All day, as I drove upon my round, I turned over the case in my mind and
24327 found no explanation which appeared to me to be adequate.
24328 At the risk of telling a twice-told tale, I will recapitulate the facts
24329 as they were known to the public at the conclusion of the inquest.
24337 \begin_layout Standard
24338 You can have up to 10
24339 \begin_inset space ~
24342 columns if you want to, but that might not be very pleasant for the readers
24346 \begin_layout Standard
24347 \begin_inset Newpage newpage
24353 \begin_layout Subsection
24354 Columns inside Columns
24357 \begin_layout Standard
24358 You can also have columns inside columns:
24361 \begin_layout Standard
24362 \begin_inset Flex Multiple Columns
24365 \begin_layout Plain Layout
24368 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
24369 at that time governor of one of the Australian colonies.
24370 Adair's mother had returned from Australia to undergo the operation for
24371 cataract, and she, her son Ronald, and her daughter Hilda were living together
24375 \begin_layout Plain Layout
24376 \begin_inset Flex Multiple Columns
24379 \begin_layout Plain Layout
24382 The youth moved in the best society–had, so far as was known, no enemies
24383 and no particular vices.
24384 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
24385 had been broken off by mutual consent some months before, and there was
24386 no sign that it had left any very profound feeling behind it.
24387 For the rest {sic} the man's life moved in a narrow and conventional circle,
24388 for his habits were quiet and his nature unemotional.
24389 Yet it was upon this easy-going young aristocrat that death came, in most
24390 strange and unexpected form, between the hours of ten and eleven-twenty
24391 on the night of March 30, 1894.
24399 \begin_layout Plain Layout
24402 Ronald Adair was fond of cards–playing continually, but never for such stakes
24404 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
24405 It was shown that, after dinner on the day of his death, he had played
24406 a rubber of whist at the latter club.
24407 He had also played there in the afternoon.
24412 The evidence of those who had played with him– Mr.
24413 Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
24414 and that there was a fairly equal fall of the cards.
24415 Adair might have lost five pounds, but not more.
24416 His fortune was a considerable one, and such a loss could not in any way
24418 He had played nearly every day at one club or other, but he was a cautious
24419 player, and usually rose a winner.
24420 It came out in evidence that, in partnership with Colonel Moran, he had
24421 actually won as much as four hundred and twenty pounds in a sitting, some
24422 weeks before, from Godfrey Milner and Lord Balmoral.
24423 So much for his recent history as it came out at the inquest.
24431 \begin_layout Subsection
24435 \begin_layout Standard
24436 The examples in this section show some more special features of multiple
24440 \begin_layout Standard
24441 For more features of multiple columns, have a look at the documentation
24442 of the \SpecialChar LaTeX
24448 \begin_inset CommandInset citation
24457 \begin_layout Subsubsection
24461 \begin_layout Standard
24462 To add a preface text for multiple columns, set the cursor into the multicolumn
24463 inset and use the menu
24465 Insert\SpecialChar menuseparator
24469 Write your preface text into that inset.
24470 \begin_inset Newline newline
24473 This is an example with some preface text:
24476 \begin_layout Standard
24477 \begin_inset VSpace bigskip
24483 \begin_layout Standard
24484 \begin_inset Flex Multiple Columns
24487 \begin_layout Plain Layout
24488 \begin_inset Argument 2
24491 \begin_layout Plain Layout
24492 And the story continues and continues and continues and continues\SpecialChar ldots
24500 On the evening of the crime, he returned from the club exactly at ten.
24501 His mother and sister were out spending the evening with a relation.
24502 The servant deposed that she heard him enter the front room on the second
24503 floor, generally used as his sitting-room.
24504 She had lit a fire there, and as it smoked she had opened the window.
24505 No sound was heard from the room until eleven-twenty, the hour of the return
24506 of Lady Maynooth and her daughter.
24507 Desiring to say good-night, she attempted to enter her son's room.
24508 The door was locked on the inside, and no answer could be got to their
24509 cries and knocking.
24510 Help was obtained, and the door forced.
24511 The unfortunate young man was found lying near the table.
24512 His head had been horribly mutilated by an expanding revolver bullet, but
24513 no weapon of any sort was to be found in the room.
24521 \begin_layout Standard
24522 You can also use a section heading as the preface if you use a section command
24523 as \SpecialChar TeX
24525 For example the command
24528 \begin_layout Standard
24533 subsection{subsection title}
24536 \begin_layout Standard
24537 creates a subsection.
24538 In this example the preface is a subsubsection:
24541 \begin_layout Standard
24542 \begin_inset Flex Multiple Columns
24545 \begin_layout Plain Layout
24546 \begin_inset Argument 2
24549 \begin_layout Plain Layout
24553 \begin_layout Plain Layout
24562 This is a subsubsection heading as a preface
24566 \begin_layout Plain Layout
24580 A minute examination of the circumstances served only to make the case more
24582 In the first place, no reason could be given why the young man should have
24583 fastened the door upon the inside.
24584 There was the possibility that the murderer had done this, and had afterwards
24585 escaped by the window.
24586 The drop was at least twenty feet, however, and a bed of crocuses in full
24588 Neither the flowers nor the earth showed any sign of having been disturbed,
24589 nor were there any marks upon the narrow strip of grass which separated
24590 the house from the road.
24591 Apparently, therefore, it was the young man himself who had fastened the
24593 But how did he come by his death? No one could have climbed up to the window
24594 without leaving traces.
24595 Suppose a man had fired through the window, he would indeed be a remarkable
24596 shot who could with a revolver inflict so deadly a wound.
24597 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
24598 a hundred yards of the house.
24599 No one had heard a shot.
24607 \begin_layout Standard
24608 If there is less vertical space than 6
24609 \begin_inset space ~
24612 text lines is left on the page at the beginning of the multiple columns,
24613 a page break will be inserted before the multiple columns.
24614 Depending on the number of lines of the preface text, you might want to
24616 This is done by setting the cursor into the mulitcolumn inset behind the
24617 preface (if there is any) and using the menu
24619 Insert\SpecialChar menuseparator
24621 \begin_inset space ~
24625 \begin_inset space ~
24629 \begin_inset space ~
24635 Insert into that inset the amount of space like e.
24636 \begin_inset space \thinspace{}
24640 \begin_inset space \space{}
24644 \begin_inset Quotes eld
24648 \begin_inset Quotes erd
24652 \begin_inset Newline newline
24655 In this example the space is set to 7
24656 \begin_inset space ~
24659 text lines by using
24660 \begin_inset Quotes eld
24666 \begin_inset Quotes erd
24675 needs to be inserted as \SpecialChar TeX
24679 \begin_layout Standard
24680 \begin_inset Flex Multiple Columns
24683 \begin_layout Plain Layout
24684 \begin_inset Argument 3
24687 \begin_layout Plain Layout
24692 \begin_layout Plain Layout
24708 On the evening of the crime, he returned from the club exactly at ten.
24709 His mother and sister were out spending the evening with a relation.
24710 The servant deposed that she heard him enter the front room on the second
24711 floor, generally used as his sitting-room.
24712 She had lit a fire there, and as it smoked she had opened the window.
24713 No sound was heard from the room until eleven-twenty, the hour of the return
24714 of Lady Maynooth and her daughter.
24715 Desiring to say good-night, she attempted to enter her son's room.
24716 The door was locked on the inside, and no answer could be got to their
24717 cries and knocking.
24718 Help was obtained, and the door forced.
24719 The unfortunate young man was found lying near the table.
24720 His head had been horribly mutilated by an expanding revolver bullet, but
24721 no weapon of any sort was to be found in the room.
24729 \begin_layout Subsubsection
24733 \begin_layout Standard
24734 The amount of space before and after multiple columns can be changed by
24735 changing the length
24742 For example the command
24745 \begin_layout Standard
24755 \begin_layout Standard
24756 in \SpecialChar TeX
24757 Code changes its value to 3
24758 \begin_inset space \thinspace{}
24762 The change must be made before the multiple columns' start.
24763 The predefined value is 13
24764 \begin_inset space \thinspace{}
24770 \begin_layout Standard
24778 \begin_inset space \thinspace{}
24784 \begin_layout Standard
24788 \begin_layout Plain Layout
24794 multicolsep}{2.5cm}
24802 \begin_layout Standard
24803 \begin_inset Flex Multiple Columns
24806 \begin_layout Plain Layout
24809 All day I turned these facts over in my mind, endeavouring to hit upon some
24810 theory which could reconcile them all, and to find that line of least resistanc
24811 e which my poor friend had declared to be the starting-point of every investigat
24813 I confess that I made little progress.
24814 In the evening I strolled across the Park, and found myself about six o'clock
24815 at the Oxford Street end of Park Lane.
24816 A group of loafers upon the pavements, all staring up at a particular window,
24817 directed me to the house which I had come to see.
24818 A tall, thin man with coloured glasses, whom I strongly suspected of being
24819 a plain-clothes detective, was pointing out some theory of his own, while
24820 the others crowded round to listen to what he said.
24821 I got as near him as I could, but his observations seemed to me to be absurd,
24822 so I withdrew again in some disgust.
24823 As I did so I struck against an elderly, deformed man, who had been behind
24824 me, and I knocked down several books which he was carrying.
24832 \begin_layout Standard
24833 \begin_inset Note Greyedout
24836 \begin_layout Plain Layout
24841 The values you set with
24847 will be used for all following multiple columns until you change them again.
24855 \begin_layout Standard
24859 \begin_layout Plain Layout
24871 \begin_inset Note Note
24874 \begin_layout Plain Layout
24875 go back to the default
24883 \begin_layout Standard
24884 \begin_inset Newpage newpage
24890 \begin_layout Subsubsection
24894 \begin_layout Standard
24895 A column break can be forced by inserting the command
24901 as \SpecialChar TeX
24902 Code to that position in the text where the column should be broken.
24903 Note that this leads in most cases to whitespace in the text.
24904 \begin_inset Newline newline
24907 Here is an example:
24910 \begin_layout Standard
24911 \begin_inset Flex Multiple Columns
24914 \begin_layout Plain Layout
24917 \begin_inset Quotes eld
24920 You're surprised to see me, sir,
24921 \begin_inset Quotes erd
24924 said he, in a strange, croaking voice.
24927 \begin_layout Plain Layout
24930 I acknowledged that I was.
24933 \begin_layout Plain Layout
24936 \begin_inset Quotes eld
24939 Well, I've a conscience, sir, and when I chanced to see you go into this
24940 house, as I came hobbling after you, I thought to myself, I'll just step
24941 in and see that kind gentleman, and tell him that if I was a bit gruff
24942 in my manner there was not any harm meant, and that I am much obliged to
24943 him for picking up my books.
24944 \begin_inset Quotes erd
24950 \begin_layout Plain Layout
24953 \begin_inset Quotes eld
24956 You make too much of a trifle,
24957 \begin_inset Quotes erd
24962 \begin_inset Quotes eld
24965 May I ask how you knew who I was?
24966 \begin_inset Quotes erd
24969 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
24973 \begin_layout Plain Layout
24985 \begin_layout Plain Layout
24988 \begin_inset Quotes eld
24991 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
24992 you'll find my little bookshop at the corner of Church Street, and very
24993 happy to see you, I am sure.
24994 Maybe you collect yourself, sir.
24998 \begin_inset space ~
25011 –a bargain, every one of them.
25012 With five volumes you could just fill that gap on that second shelf.
25013 It looks untidy, does it not, sir?
25014 \begin_inset Quotes erd
25025 \begin_layout Subsubsection
25029 \begin_layout Standard
25030 The width of the columns is automatically calculated, but you can modify
25031 the space between the columns.
25032 This is done by changing the length
25039 Its predefined value is 10
25040 \begin_inset space \thinspace{}
25044 Here is an example where
25051 \begin_inset space \thinspace{}
25057 \begin_layout Standard
25061 \begin_layout Plain Layout
25075 \begin_layout Standard
25076 \begin_inset Flex Multiple Columns
25079 \begin_layout Plain Layout
25082 My observations of No.
25083 \begin_inset space \space{}
25086 427 Park Lane did little to clear up the problem in which I was interested.
25087 The house was separated from the street by a low wall and railing, the
25088 whole not more than five feet high.
25089 It was perfectly easy, therefore, for anyone to get into the garden, but
25090 the window was entirely inaccessible, since there was no water pipe or
25091 anything which could help the most active man to climb it.
25092 More puzzled than ever, I retraced my steps to Kensington.
25093 I had not been in my study five minutes when the maid entered to say that
25094 a person desired to see me.
25095 To my astonishment it was none other than my strange old book collector,
25096 his sharp, wizened face peering out from a frame of white hair, and his
25097 precious volumes, a dozen of them at least, wedged under his right arm.
25105 \begin_layout Standard
25109 \begin_layout Plain Layout
25121 \begin_inset Note Note
25124 \begin_layout Plain Layout
25125 go back to the default
25133 \begin_layout Subsubsection
25137 \begin_layout Standard
25138 Between the columns a rule with a width of the length
25145 If this rule width is set to 0
25146 \begin_inset space \thinspace{}
25149 pt (this is the default), the rule is suppressed.
25150 In the following example the rule is 2
25151 \begin_inset space \thinspace{}
25157 \begin_layout Standard
25161 \begin_layout Plain Layout
25167 columnseprule}{2pt}
25175 \begin_layout Standard
25176 \begin_inset Flex Multiple Columns
25179 \begin_layout Plain Layout
25182 \begin_inset Quotes eld
25185 You're surprised to see me, sir,
25186 \begin_inset Quotes erd
25189 said he, in a strange, croaking voice.
25192 \begin_layout Plain Layout
25195 I acknowledged that I was.
25198 \begin_layout Plain Layout
25201 \begin_inset Quotes eld
25204 Well, I've a conscience, sir, and when I chanced to see you go into this
25205 house, as I came hobbling after you, I thought to myself, I'll just step
25206 in and see that kind gentleman, and tell him that if I was a bit gruff
25207 in my manner there was not any harm meant, and that I am much obliged to
25208 him for picking up my books.
25209 \begin_inset Quotes erd
25215 \begin_layout Plain Layout
25218 \begin_inset Quotes eld
25221 You make too much of a trifle,
25222 \begin_inset Quotes erd
25227 \begin_inset Quotes eld
25230 May I ask how you knew who I was?
25231 \begin_inset Quotes erd
25237 \begin_layout Plain Layout
25240 \begin_inset Quotes eld
25243 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25244 you'll find my little bookshop at the corner of Church Street, and very
25245 happy to see you, I am sure.
25246 Maybe you collect yourself, sir.
25250 \begin_inset space ~
25263 –a bargain, every one of them.
25264 With five volumes you could just fill that gap on that second shelf.
25265 It looks untidy, does it not, sir?
25266 \begin_inset Quotes erd
25277 \begin_layout Standard
25278 \begin_inset VSpace defskip
25284 \begin_layout Standard
25285 The rule can be colored by redefining the command
25292 This is done by inserting the command
25293 \begin_inset Newline newline
25302 columnseprulecolor}{
25307 \begin_inset Newline newline
25310 as \SpecialChar TeX
25311 Code before the multicolumn inset.
25316 in this command by a color of your choice.
25317 You can use all pre- and self-defined colors.
25325 \begin_inset space ~
25330 for more information about pre- and self-defined colors.
25331 To go back to the default color insert the command
25332 \begin_inset Newline newline
25341 columnseprulecolor}{
25346 \begin_inset Newline newline
25349 Here is the example with a cyan rule and 1
25350 \begin_inset space \thinspace{}
25353 cm column separation:
25356 \begin_layout Standard
25360 \begin_layout Plain Layout
25369 \begin_layout Plain Layout
25375 columnseprulecolor}{
25385 \begin_layout Standard
25386 \begin_inset Flex Multiple Columns
25389 \begin_layout Plain Layout
25392 \begin_inset Quotes eld
25395 You're surprised to see me, sir,
25396 \begin_inset Quotes erd
25399 said he, in a strange, croaking voice.
25402 \begin_layout Plain Layout
25405 I acknowledged that I was.
25408 \begin_layout Plain Layout
25411 \begin_inset Quotes eld
25414 Well, I've a conscience, sir, and when I chanced to see you go into this
25415 house, as I came hobbling after you, I thought to myself, I'll just step
25416 in and see that kind gentleman, and tell him that if I was a bit gruff
25417 in my manner there was not any harm meant, and that I am much obliged to
25418 him for picking up my books.
25419 \begin_inset Quotes erd
25425 \begin_layout Plain Layout
25428 \begin_inset Quotes eld
25431 You make too much of a trifle,
25432 \begin_inset Quotes erd
25437 \begin_inset Quotes eld
25440 May I ask how you knew who I was?
25441 \begin_inset Quotes erd
25447 \begin_layout Plain Layout
25450 \begin_inset Quotes eld
25453 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25454 you'll find my little bookshop at the corner of Church Street, and very
25455 happy to see you, I am sure.
25456 Maybe you collect yourself, sir.
25460 \begin_inset space ~
25473 –a bargain, every one of them.
25474 With five volumes you could just fill that gap on that second shelf.
25475 It looks untidy, does it not, sir?
25476 \begin_inset Quotes erd
25487 \begin_layout Standard
25491 \begin_layout Plain Layout
25497 columnseprule}{0pt}
25500 \begin_layout Plain Layout
25506 columnseprulecolor}{
25514 \begin_inset Note Note
25517 \begin_layout Plain Layout
25518 go back to the default
25526 \begin_layout Section
25527 Non-standard Paragraph Shapes
25530 \begin_layout Standard
25533 as well as any other text processor uses by default rectangular paragraphs.
25534 For special cases like for example posters, invitation cards or poems you
25535 can modify the paragraph shape to one of your choice.
25536 This can be done by using the \SpecialChar LaTeX
25541 which is loaded by using in the document settings the module
25543 Custom paragraph shapes
25548 \begin_layout Subsection
25552 \begin_layout Standard
25557 provides the following shapes:
25560 \begin_layout Standard
25561 \begin_inset Tabular
25562 <lyxtabular version="3" rows="13" columns="3">
25563 <features booktabs="true" islongtable="true" longtabularalignment="center">
25564 <column alignment="center" valignment="middle" width="16col%">
25565 <column alignment="center" valignment="middle" width="40col%">
25566 <column alignment="center" valignment="middle" width="35col%">
25567 <row endhead="true">
25568 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25571 \begin_layout Plain Layout
25577 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25580 \begin_layout Plain Layout
25586 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
25589 \begin_layout Plain Layout
25597 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25600 \begin_layout Plain Layout
25606 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25609 \begin_layout Plain Layout
25610 Circle with circular hole (in the size of a CD/DVD)
25615 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25618 \begin_layout Plain Layout
25619 Cannot be scaled, take care there is not too much text
25626 <cell alignment="center" valignment="top" topline="true" usebox="none">
25629 \begin_layout Plain Layout
25635 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25638 \begin_layout Plain Layout
25644 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25647 \begin_layout Plain Layout
25648 Fragile, calculation might fail
25655 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25658 \begin_layout Plain Layout
25664 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25667 \begin_layout Plain Layout
25668 Rhomboid (symbolizing a
25669 \begin_inset Quotes eld
25673 \begin_inset Quotes erd
25681 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25684 \begin_layout Plain Layout
25692 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25695 \begin_layout Plain Layout
25701 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25704 \begin_layout Plain Layout
25710 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25713 \begin_layout Plain Layout
25721 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25724 \begin_layout Plain Layout
25730 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25733 \begin_layout Plain Layout
25739 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25742 \begin_layout Plain Layout
25750 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25753 \begin_layout Plain Layout
25759 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25762 \begin_layout Plain Layout
25763 Nut for bolt (hexagon with circular hole)
25768 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25771 \begin_layout Plain Layout
25779 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25782 \begin_layout Plain Layout
25788 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25791 \begin_layout Plain Layout
25797 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25800 \begin_layout Plain Layout
25808 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25811 \begin_layout Plain Layout
25817 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25820 \begin_layout Plain Layout
25826 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
25829 \begin_layout Plain Layout
25837 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25840 \begin_layout Plain Layout
25846 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25849 \begin_layout Plain Layout
25855 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25858 \begin_layout Plain Layout
25866 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25869 \begin_layout Plain Layout
25875 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25878 \begin_layout Plain Layout
25879 Normal/reversed rain drop
25884 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25887 \begin_layout Plain Layout
25888 Fragile, calculation might fail
25895 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25898 \begin_layout Plain Layout
25905 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25908 \begin_layout Plain Layout
25909 The \SpecialChar TeX
25915 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25918 \begin_layout Plain Layout
25926 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25929 \begin_layout Plain Layout
25931 \begin_inset Newline newline
25939 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25942 \begin_layout Plain Layout
25943 Triangles in different orientations
25948 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
25951 \begin_layout Plain Layout
25965 \begin_layout Standard
25966 To use a shape for your paragraph, simply select it in \SpecialChar LyX
25968 for environments in the toolbar.
25971 \begin_layout Standard
25972 \begin_inset Newpage newpage
25978 \begin_layout Standard
25979 Here is an example paragraph in the shape of a nut:
25982 \begin_layout Standard
25983 \begin_inset VSpace bigskip
25992 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
25993 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
25995 At vero eos et accusam et justo duo dolores et ea rebum.
25996 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
25998 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
25999 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26003 \begin_layout Standard
26004 \begin_inset VSpace bigskip
26010 \begin_layout Standard
26011 \begin_inset Note Greyedout
26014 \begin_layout Plain Layout
26019 : shapepar paragraphs cannot run over a page break.
26027 \begin_layout Standard
26028 \begin_inset VSpace bigskip
26034 \begin_layout Standard
26039 takes care that the shape will always be preserved, no matter how much
26040 text is in the paragraph.
26041 Therefore the paragraph size changes with the amount of contained text.
26042 This can lead to paragraph sizes exceeding the page margins.
26043 To demonstrate the size scaling, here is the same example paragraph but
26044 with twice as much text:
26047 \begin_layout Standard
26048 \begin_inset Newpage newpage
26057 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26058 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26060 At vero eos et accusam et justo duo dolores et ea rebum.
26061 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26063 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26064 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26066 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26067 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26069 At vero eos et accusam et justo duo dolores et ea rebum.
26070 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26072 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26073 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26077 \begin_layout Standard
26078 \begin_inset VSpace bigskip
26084 \begin_layout Standard
26085 An exception is the shape
26090 It cannot be scaled because it must fit the size of a CD/DVD.
26091 Therefore the amount of text that fits into the shape is limited.
26092 \begin_inset Newline newline
26103 shape are fragile, meaning that the calculation of their size can fail,
26104 depending on the amount of text.
26105 You will then get the \SpecialChar LaTeX
26107 \begin_inset Quotes eld
26110 Arithmetic overflow
26111 \begin_inset Quotes erd
26115 In this case one can try to remove or add some text; if nothing works one
26116 has to use another shape.
26119 \begin_layout Standard
26120 \begin_inset VSpace bigskip
26126 \begin_layout Standard
26127 For shapes with tips you will maybe see that \SpecialChar LaTeX
26128 's hyphenation routine fails
26129 for text in the tips.
26130 Therefore it is often necessary to add hyphenation points
26135 arg "specialchar-insert hyphenation"
26140 ) to the corresponding text parts.
26143 \begin_layout Standard
26144 \begin_inset VSpace bigskip
26150 \begin_layout Standard
26151 Shapepar paragraphs are either always centered or placed on the page so
26152 that their left border touches the left page margin.
26153 You can therefore not use the paragraph dialog to align such paragraphs.
26154 A solution is to put the paragraph into a minipage or parbox and align
26156 The problem is hereby to find the right width for the box.
26157 Because if it is too wide and you center the box, the paragraph is not
26158 centered too because it sticks at the left side of the box.
26159 So you might have to play a bit with the width until it fits.
26160 Here are two heart-shaped paragraphs, the first one is not aligned, the
26161 second one is right-aligned:
26164 \begin_layout Standard
26165 \begin_inset Newpage newpage
26171 \begin_layout Heart
26175 Lo\SpecialChar softhyphen
26176 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26177 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26179 At vero eos et accusam et justo duo dolores et ea rebum.
26180 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26184 \begin_layout Standard
26185 \begin_inset VSpace bigskip
26191 \begin_layout Standard
26194 \begin_inset Box Frameless
26204 height_special "totalheight"
26209 backgroundcolor "none"
26212 \begin_layout Heart
26216 Lo\SpecialChar softhyphen
26217 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26218 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26220 At vero eos et accusam et justo duo dolores et ea rebum.
26221 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26230 \begin_layout Subsection
26234 \begin_layout Standard
26235 You can define any shape you want.
26236 Doing this manually is a lot of work because every coordinate must be specified.
26237 But there is a way to let the computer calculate the coordinates:
26240 \begin_layout Enumerate
26241 Install the program
26242 \begin_inset CommandInset href
26245 target "http://www.ctan.org/tex-archive/graphics/jpgfdraw"
26252 \begin_layout Enumerate
26259 TeX/LaTeX\SpecialChar menuseparator
26260 Settings\SpecialChar menuseparator
26263 and select the font size you are using in your document.
26264 For example this document uses the size 12
26265 \begin_inset space \thinspace{}
26271 \begin_layout Enumerate
26275 \begin_layout Enumerate
26278 TeX/LaTeX\SpecialChar menuseparator
26281 to export the shape to coordinates.
26282 In the appearing dialog use either the outline of your shape for the coordinate
26283 s or the path itself.
26287 \begin_layout Plain Layout
26288 For more information see
26289 \begin_inset CommandInset href
26291 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
26303 \begin_layout Standard
26304 The coordinates are written into a \SpecialChar TeX
26306 To use it for your \SpecialChar LyX
26310 \begin_layout Enumerate
26311 Place the cursor before the first character of your paragraph (or into a
26315 \begin_layout Enumerate
26316 Open in \SpecialChar LyX
26319 Insert\SpecialChar menuseparator
26320 File\SpecialChar menuseparator
26322 \begin_inset space ~
26327 , select the file and use
26336 \begin_layout Standard
26337 \begin_inset VSpace defskip
26343 \begin_layout Standard
26344 \begin_inset Note Greyedout
26347 \begin_layout Plain Layout
26352 : The changed shape only applies to the current paragraph; everything is
26353 reset to normal for the next paragraph.
26354 Therefore the shape definition file must be input into every paragraph
26355 with the desired shape.
26363 \begin_layout Standard
26364 \begin_inset VSpace bigskip
26370 \begin_layout Standard
26371 Here is an example:
26374 \begin_layout Standard
26375 \begin_inset VSpace bigskip
26381 \begin_layout Standard
26382 \begin_inset CommandInset include
26384 filename "SpecialParagraphShape.tex"
26390 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26391 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26393 At vero eos et accusam et justo duo dolores et ea rebum.
26394 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26396 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26397 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26401 \begin_layout Standard
26402 \begin_inset VSpace bigskip
26408 \begin_layout Standard
26413 to draw complexer shapes in
26417 you can draw the shape in a program of your choice and import the resulting
26423 Then you only need to draw a line or spline along the outline of the image.
26426 \begin_layout Standard
26427 \begin_inset VSpace bigskip
26433 \begin_layout Standard
26436 Custom paragraph shapes
26438 also provides the two commands
26446 which can be used to define custom shapes coordinate by coordinate.
26450 \begin_layout Plain Layout
26451 These commands are internally used for all shapes described here.
26456 For information how these styles are used and about further customization
26457 possibilities, have a look at the documentation of the package
26462 \begin_inset CommandInset citation
26471 \begin_layout Bibliography
26472 \begin_inset CommandInset bibitem
26473 LatexCommand bibitem
26478 Documentation of the \SpecialChar LaTeX
26480 \begin_inset CommandInset href
26483 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
26490 \begin_layout Bibliography
26491 \begin_inset CommandInset bibitem
26492 LatexCommand bibitem
26497 Documentation of the \SpecialChar LaTeX
26499 \begin_inset CommandInset href
26502 target "http://mirrors.ctan.org/macros/latex/contrib/shapepar/shapepar.pdf"