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
2153 \begin_layout Enumerate
2154 rescale the figure so it fits.
2157 \begin_layout Enumerate
2158 trim down the table so it fits.
2162 \begin_layout Enumerate
2163 If something else is wrong with the output, and you didn't try to pull anything
2164 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2167 \begin_layout Standard
2168 If all this doesn't help—well, then
2172 you might have found a bug in \SpecialChar LyX
2177 \begin_layout Chapter
2181 \begin_layout Section
2182 Customizing Bibliographies with Bib\SpecialChar TeX
2186 \begin_layout Standard
2187 The most basic information about how to use Bib\SpecialChar TeX
2188 with \SpecialChar LyX
2192 Bibliography databases (Bib\SpecialChar TeX
2200 The following subsections explain special bibliography features supported
2205 \begin_layout Subsection
2206 Alternative Citation Styles
2209 \begin_layout Standard
2210 Standard Bib\SpecialChar TeX
2212 \begin_inset space \thinspace{}
2216 \begin_inset space \space{}
2220 \begin_inset Quotes eld
2224 \begin_inset Quotes erd
2227 ) to refer to a cited work.
2228 However, in many scientific disciplines, other citation styles are in use.
2229 The most common one is the author-year style (e.
2230 \begin_inset space \thinspace{}
2234 \begin_inset space \space{}
2238 \begin_inset Quotes eld
2242 \begin_inset Quotes erd
2247 supports two packages that provide this style,
2248 \begin_inset Flex Code
2251 \begin_layout Plain Layout
2258 \begin_inset Flex Code
2261 \begin_layout Plain Layout
2268 Both packages have their pros and cons, which cannot be listed in detail.
2269 If you only want to have simple author-year (or author-numerical) style,
2270 or if you want to use one of the countless style files for
2271 \begin_inset Flex Code
2274 \begin_layout Plain Layout
2280 , then the established
2281 \begin_inset Flex Code
2284 \begin_layout Plain Layout
2290 package is probably your choice.
2291 If you need special features like short title references, ibidem etc., you
2293 \begin_inset Flex Code
2296 \begin_layout Plain Layout
2305 \begin_layout Standard
2306 The handling of both packages in \SpecialChar LyX
2307 is basically the same.
2309 \begin_inset Flex Noun
2312 \begin_layout Plain Layout
2313 Document\SpecialChar menuseparator
2320 \begin_inset Flex Noun
2323 \begin_layout Plain Layout
2330 \begin_inset Flex Noun
2333 \begin_layout Plain Layout
2340 \begin_inset Flex Noun
2343 \begin_layout Plain Layout
2350 With both packages, you will get some extra features in the citation dialog
2351 and you can select the style of the reference (
2352 \begin_inset Quotes eld
2356 \begin_inset Quotes erd
2360 \begin_inset Quotes eld
2364 \begin_inset Quotes erd
2368 \begin_inset Quotes eld
2372 \begin_inset Quotes erd
2376 \begin_inset Quotes eld
2380 \begin_inset Quotes erd
2384 Note that both packages need specifically designed style files.
2385 They both ship their own, but there are lots of additional style files,
2386 and there is even an interactive style file builder
2390 \begin_layout Plain Layout
2392 \begin_inset Flex URL
2395 \begin_layout Plain Layout
2397 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2408 \begin_inset Flex Code
2411 \begin_layout Plain Layout
2420 \begin_layout Subsection
2421 Sectioned Bibliographies
2424 \begin_layout Standard
2425 Sometimes you might need to divide your bibliography into several sections.
2426 If you are for instance a historian, the possibility to separate sources
2427 and scientific works is most likely a
2428 \begin_inset Quotes eld
2432 \begin_inset Quotes erd
2436 Unfortunately, Bib\SpecialChar TeX
2437 itself does not allow you to do this.
2438 But with the help of some \SpecialChar LaTeX
2439 packages, Bib\SpecialChar TeX
2440 can be extended to fit your needs.
2443 \begin_layout Standard
2445 provides native support for one of these packages,
2453 \begin_layout Plain Layout
2455 \begin_inset Flex URL
2458 \begin_layout Plain Layout
2460 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2470 The advantage of this package (compared to other packages like
2474 ) is that you don't need to define new citation commands.
2475 Instead, you need to prepare different bibliographic databases which include
2476 the entries for the different sections of the bibliography.
2477 For example: If you want to divide your bibliography into the sections
2479 \begin_inset Quotes eld
2483 \begin_inset Quotes erd
2487 \begin_inset Quotes eld
2491 \begin_inset Quotes erd
2494 , you first need to create two bibliographic databases, e.
2495 \begin_inset space \thinspace{}
2499 \begin_inset space \space{}
2503 \begin_inset Flex Code
2506 \begin_layout Plain Layout
2513 \begin_inset Flex Code
2516 \begin_layout Plain Layout
2526 \begin_layout Standard
2528 \begin_inset Flex Noun
2531 \begin_layout Plain Layout
2532 Document\SpecialChar menuseparator
2539 \begin_inset Flex Noun
2542 \begin_layout Plain Layout
2549 \begin_inset Flex Noun
2552 \begin_layout Plain Layout
2553 Sectioned bibliography
2559 Now you can insert multiple Bib\SpecialChar TeX
2560 bibliographies, one for each section of
2562 Returning to our example: Insert the Bib\SpecialChar TeX
2564 \begin_inset Flex Code
2567 \begin_layout Plain Layout
2573 and a second one for the database
2574 \begin_inset Flex Code
2577 \begin_layout Plain Layout
2584 You are free to use the same or different styles for each section.
2585 Additionally, you can choose if the bibliography section should contain
2587 \begin_inset Quotes eld
2590 all cited references
2591 \begin_inset Quotes erd
2594 of the specified database(s) (which is the default),
2595 \begin_inset Quotes eld
2598 all uncited references
2599 \begin_inset Quotes erd
2603 \begin_inset Quotes eld
2607 \begin_inset Quotes erd
2611 This might be useful if you would like to separate your bibliography into
2613 \begin_inset Quotes eld
2617 \begin_inset Quotes erd
2621 \begin_inset Quotes eld
2625 \begin_inset Quotes erd
2629 \begin_inset Quotes eld
2633 \begin_inset Quotes erd
2637 The titles for the sections can be added as ordinary sections or subsections.
2639 \begin_inset Flex Code
2642 \begin_layout Plain Layout
2648 removes the bibliography title, you have to manually re-add that, too (as
2649 a chapter* or section*, for instance).
2652 \begin_layout Subsection
2653 Multiple Bibliographies
2656 \begin_layout Standard
2657 Multiple bibliographies, e.
2658 \begin_inset space \thinspace{}
2662 \begin_inset space \space{}
2665 a bibliography for each section or chapter of the document, are not supported
2666 by Bib\SpecialChar TeX
2669 \begin_inset Flex Code
2672 \begin_layout Plain Layout
2678 package, which is used for the creation of sectioned bibliographies in
2680 (see the previous section), provides an easy way to solve this task, if
2681 you are willing to use some
2682 \begin_inset Flex Noun
2685 \begin_layout Plain Layout
2693 \begin_inset space ~
2697 \begin_inset CommandInset ref
2699 reference "sec:Inserting-TeX-Code"
2707 \begin_layout Plain Layout
2708 An alternative approach is to use the
2709 \begin_inset Flex Code
2712 \begin_layout Plain Layout
2719 \begin_inset Flex Code
2722 \begin_layout Plain Layout
2728 package, respectively.
2736 \begin_layout Standard
2738 \begin_inset Flex Noun
2741 \begin_layout Plain Layout
2742 Document\SpecialChar menuseparator
2749 \begin_inset Flex Noun
2752 \begin_layout Plain Layout
2759 \begin_inset Flex Noun
2762 \begin_layout Plain Layout
2763 Sectioned bibliography
2769 In the document, you have to enclose the sections, which shall contain
2770 their own bibliography (including the Bib\SpecialChar TeX
2771 bibliography itself), between
2773 \begin_inset Flex Code
2776 \begin_layout Plain Layout
2785 \begin_inset Flex Code
2788 \begin_layout Plain Layout
2796 (those commands have to be inserted as \SpecialChar TeX
2798 The bibliography will contain all references that have been cited in the
2800 \begin_inset Flex Code
2803 \begin_layout Plain Layout
2814 If you are using this approach, then every citation reference has to be
2816 \begin_inset Flex Code
2819 \begin_layout Plain Layout
2827 \begin_inset Flex Code
2830 \begin_layout Plain Layout
2839 \begin_layout Section
2843 \begin_layout Subsection
2847 \begin_layout Standard
2848 When you are working on a large file with many sections, it is often convenient
2849 to break up the document into several files, or perhaps you have something
2850 where a table may change from time to time, but the preceding text does
2852 In these cases, you should seriously consider using multipart documents.
2853 For example, scientific papers often have five major sections: the introduction
2854 , observations, results, discussion, and conclusion.
2855 Each of these could be its own separate \SpecialChar LyX
2857 \begin_inset Quotes eld
2861 \begin_inset Quotes erd
2864 file which contains the title, authors, abstract, references, etc., plus
2865 the five included files.
2866 It is important to note that each of these files is a full \SpecialChar LyX
2868 can be formatted and printed on its own, as well as included in a master
2870 Each of these files must have the same document class, however—don't attempt
2871 to mix book classes with article classes.
2872 You may also include \SpecialChar LaTeX
2873 files; however, these files must not have their own
2875 \begin_inset space \thinspace{}
2879 \begin_inset space \space{}
2882 everything up to and including the
2883 \begin_inset Flex Code
2886 \begin_layout Plain Layout
2895 \begin_inset Flex Code
2898 \begin_layout Plain Layout
2906 line must be deleted) or else errors will be generated when you try to
2910 \begin_layout Standard
2912 allows you to include files quite easily with
2913 \begin_inset Flex Noun
2916 \begin_layout Plain Layout
2917 Insert\SpecialChar menuseparator
2919 \begin_inset space ~
2928 When you click on this selection a small box is inserted into the file
2929 at the current cursor location.
2930 Clicking on the box raises a dialog which allows you to select the file
2931 to be included, and the method of its inclusion.
2935 \begin_layout Standard
2936 The file selection box should by now be obvious.
2937 The three inclusion methods are
2938 \begin_inset Quotes eld
2942 \begin_inset Quotes erd
2946 \begin_inset Quotes eld
2950 \begin_inset Quotes erd
2954 \begin_inset Quotes eld
2958 \begin_inset Quotes erd
2962 The difference between
2963 \begin_inset Quotes eld
2967 \begin_inset Quotes erd
2971 \begin_inset Quotes eld
2975 \begin_inset Quotes erd
2978 is really only meaningful to \SpecialChar LaTeX
2979 perts, but the practical difference is that
2981 \begin_inset Quotes eld
2985 \begin_inset Quotes erd
2988 are typeset beginning on a new page, while files that are
2989 \begin_inset Quotes eld
2993 \begin_inset Quotes erd
2996 are typeset starting on the current page.
2999 \begin_layout Standard
3000 Generally, the master file is converted into a full \SpecialChar LaTeX
3001 file before typesetting,
3002 while the included files are converted to \SpecialChar LaTeX
3003 files that do not have all the
3004 preamble information.
3007 \begin_layout Standard
3009 \begin_inset Quotes eld
3013 \begin_inset Quotes erd
3016 included file allows you to include a file typeset exactly as it appears
3018 \begin_inset space \thinspace{}
3022 \begin_inset space \space{}
3026 \begin_inset Flex Code
3029 \begin_layout Plain Layout
3035 mode, with the characters set in a fixed-width typewriter font.
3036 Normally, spaces in this file are invisible, though two consecutive spaces
3037 are conserved, unlike \SpecialChar LyX
3038 's normal treatment of spaces.
3039 However, setting the
3040 \begin_inset Flex Noun
3043 \begin_layout Plain Layout
3045 \begin_inset space ~
3049 \begin_inset space ~
3053 \begin_inset space ~
3061 checkbox typesets a mark to unambiguously define the presence of a space.
3065 \begin_layout Subsection
3066 Cross-References Between Files
3069 \begin_layout Standard
3070 \begin_inset Box Shadowbox
3080 height_special "totalheight"
3085 backgroundcolor "none"
3088 \begin_layout Plain Layout
3089 This section is somewhat out of date.
3090 Need to describe default master documents and how children are opened when
3100 \begin_layout Standard
3101 It is possible to set up cross-references between the different files.
3102 First, open all the files in question: let's call them A and B in a two
3103 file example, where B is included in A.
3104 Let's say you insert a label in A, then want to reference it in B.
3105 Open the cross-reference dialog whilst in document B, and you can select
3107 \begin_inset Quotes eld
3111 \begin_inset Quotes erd
3117 \begin_layout Subsection
3118 Bibliography Lists in all Subdocuments
3121 \begin_layout Standard
3122 \begin_inset Box Frameless
3132 height_special "totalheight"
3137 backgroundcolor "none"
3140 \begin_layout Plain Layout
3141 This section also needs updating.
3142 There is now material about this on the wiki, and it could be copied here.
3150 \begin_layout Standard
3151 Copy the bibliography list with all entries to all subdocuments and transform
3153 This way \SpecialChar LyX
3155 \begin_inset Flex Code
3158 \begin_layout Plain Layout
3164 -files and you can easily insert references without making the bibliography
3168 \begin_layout Standard
3169 As the bibliography list is in a comment, \SpecialChar LaTeX
3170 won't use it and the references
3171 will look like this: [?], instead of like this: [1].
3172 One solution is to use the \SpecialChar LaTeX
3174 \begin_inset Flex Code
3177 \begin_layout Plain Layout
3183 that will only include comments by processing the files separately.
3184 To do this, add in the \SpecialChar LaTeX
3185 preamble of every subdocument the following:
3188 \begin_layout LyX-Code
3194 \begin_layout LyX-Code
3197 includecomment{comment}
3200 \begin_layout Standard
3202 \begin_inset Flex URL
3205 \begin_layout Plain Layout
3207 http://wiki.lyx.org/FAQ/Unsorted#toc31
3215 \begin_layout Section
3220 \begin_layout Standard
3221 Users sometimes need to be able to
3222 \begin_inset Quotes eld
3226 \begin_inset Quotes erd
3230 file together with all the images (and other files) on which it depends,
3231 either for sending to a publisher or for sharing with a co-author.
3233 2.0 includes a Python script (
3234 \begin_inset Flex Code
3237 \begin_layout Plain Layout
3243 ) that automates this process.
3244 To use it, you must have either the
3245 \begin_inset Flex Code
3248 \begin_layout Plain Layout
3255 \begin_inset Flex Code
3258 \begin_layout Plain Layout
3264 python modules installed on your system.
3265 By default, the script prefers the
3266 \begin_inset Flex Code
3269 \begin_layout Plain Layout
3276 \begin_inset Flex Code
3279 \begin_layout Plain Layout
3285 format on Unix-like systems and the
3286 \begin_inset Flex Code
3289 \begin_layout Plain Layout
3298 \begin_layout Standard
3300 's configuration process will set the script up to export a `\SpecialChar LyX
3302 and this format will then be available under
3303 \begin_inset Flex Code
3306 \begin_layout Plain Layout
3307 File\SpecialChar menuseparator
3316 \begin_layout Standard
3317 Independently of the platform, the generation of a particular archive format
3318 can be forced by adding either the
3319 \begin_inset Flex Code
3322 \begin_layout Plain Layout
3329 \begin_inset Flex Code
3332 \begin_layout Plain Layout
3339 \begin_inset Flex Code
3342 \begin_layout Plain Layout
3349 \begin_inset Flex Code
3352 \begin_layout Plain Layout
3358 format) switch to the
3359 \begin_inset Flex Code
3362 \begin_layout Plain Layout
3364 \SpecialChar menuseparator
3372 \begin_inset Flex Code
3375 \begin_layout Plain Layout
3376 Tools\SpecialChar menuseparator
3377 Preferences\SpecialChar menuseparator
3378 File Handling\SpecialChar menuseparator
3385 (Make sure you add the switch after the script name, not before it.)
3388 \begin_layout Section
3389 Fancy Headers and Footers
3392 \begin_layout Standard
3393 The default page layout is rather plain; for an
3394 \begin_inset Flex Code
3397 \begin_layout Plain Layout
3403 document class, all you get is a centered page number at the bottom of
3405 This document uses KOMA-script's book class, so it appears to be a bit
3407 But to really put on a show, you need to set the document page style to
3409 \begin_inset Quotes eld
3413 \begin_inset Quotes erd
3416 , as mentioned in the
3421 This section describes the \SpecialChar LaTeX
3422 code you need to insert in your \SpecialChar LaTeX
3424 order to get the desired effects.
3427 \begin_layout Standard
3428 For more information on fancy headers, see the
3429 \begin_inset Flex Code
3432 \begin_layout Plain Layout
3438 package documentation.
3440 \begin_inset Flex URL
3443 \begin_layout Plain Layout
3445 http://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
3453 \begin_layout Standard
3454 The page header is divided into three fields, not surprisingly labeled
3455 \begin_inset Quotes eld
3459 \begin_inset Quotes erd
3463 \begin_inset Quotes eld
3467 \begin_inset Quotes erd
3471 \begin_inset Quotes eld
3475 \begin_inset Quotes erd
3479 The footer is also divided into these three fields.
3480 The \SpecialChar LaTeX
3481 commands to set these fields in the simplest manner are
3482 \begin_inset Flex Code
3485 \begin_layout Plain Layout
3494 \begin_inset Flex Code
3497 \begin_layout Plain Layout
3506 \begin_inset Flex Code
3509 \begin_layout Plain Layout
3518 \begin_inset Flex Code
3521 \begin_layout Plain Layout
3530 Suppose you wish to put your name in the upper left hand corner of each
3532 Simply insert the following command in the preamble:
3535 \begin_layout Standard
3544 \begin_layout Standard
3545 You will now see your name in the upper left.
3546 If a field has a default entry that you would like to get rid of (often
3547 the page number appears in the central footer) simply include a command
3548 with a blank argument, e.
3549 \begin_inset space \thinspace{}
3555 \begin_layout Standard
3563 \begin_layout Standard
3564 Let's get really fancy: lets put the section number with the word
3565 \begin_inset Quotes eld
3569 \begin_inset Quotes erd
3573 \begin_inset space \thinspace{}
3577 \begin_inset space \space{}
3580 Section 3) in the upper left, the page number (e.
3581 \begin_inset space \thinspace{}
3585 \begin_inset space \space{}
3588 Page 4) in the upper right, your name in the lower left, and the date in
3590 The following commands should now appear in the preamble:
3593 \begin_layout Standard
3603 \begin_layout Standard
3611 \begin_layout Standard
3621 \begin_layout Standard
3630 \begin_layout Standard
3638 \begin_layout Standard
3648 \begin_layout Standard
3650 \begin_inset Flex Code
3653 \begin_layout Plain Layout
3662 \begin_inset Flex Code
3665 \begin_layout Plain Layout
3673 access \SpecialChar LaTeX
3674 's section and page counters, and so print out the current section
3677 \begin_inset Flex Code
3680 \begin_layout Plain Layout
3688 simply prints out today's date.
3691 \begin_layout Standard
3692 The thicknesses of the horizontal rules drawn beneath the header and above
3693 the footer can also be modified.
3694 If you don't want one of the rules, set its thickness to 0.
3695 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
3701 \begin_inset Flex Code
3704 \begin_layout Plain Layout
3709 headrulewidth}{0.4pt}
3715 \begin_inset Flex Code
3718 \begin_layout Plain Layout
3723 footrulewidth}{0.4pt}
3728 to set the thicknesses.
3731 \begin_layout Standard
3732 You can switch the header/footer settings on and off for individual pages
3734 \begin_inset Flex Code
3737 \begin_layout Plain Layout
3740 thispagestyle{empty}
3746 \begin_inset Flex Code
3749 \begin_layout Plain Layout
3752 thispagestyle{plain}
3758 \begin_inset Flex Code
3761 \begin_layout Plain Layout
3764 thispagestyle{fancy}
3770 Simply insert them in the text on the page you want changed and mark them
3773 In fact, title pages are marked as plain by default, while following pages
3774 are marked fancy when using the global fancy setting.
3777 \begin_layout Standard
3778 As a final example, it is possible to include an image in the header or
3780 Suppose you want to put a company logo in the upper lefthand corner.
3781 You might try something like
3784 \begin_layout Standard
3793 includegraphics{logo.eps}}}
3796 \begin_layout Standard
3798 (you may need to preface this with
3799 \begin_inset Flex Code
3802 \begin_layout Plain Layout
3806 usepackage{graphics}
3811 if you don't include graphics elsewhere in your document).
3814 \begin_layout Section
3815 Itemize Bullet Selection
3816 \begin_inset CommandInset label
3825 \begin_layout Standard
3831 \begin_layout Subsection
3835 \begin_layout Standard
3837 provides 216 bullet shapes that can be accessed from a simple dialog.
3838 Using this dialog you can easily specify what bullet shape to use at each
3839 level of an itemized list.
3840 These settings are document-wide so you won't be able to specify different
3841 sets of bullets for different paragraphs.
3845 \begin_layout Plain Layout
3846 Well, actually you can but you'll have to do it by hand.
3854 \begin_layout Subsection
3858 \begin_layout Standard
3859 Open the dialog by selecting the
3860 \begin_inset Flex Noun
3863 \begin_layout Plain Layout
3864 Document\SpecialChar menuseparator
3870 menu item and then select the
3871 \begin_inset Flex Noun
3874 \begin_layout Plain Layout
3883 \begin_layout Standard
3884 The dialog provides you with a table of bullet shapes.
3885 A column of buttons on the left of the table provides access to the six
3886 different panels of bullet shapes.
3887 The row of buttons across the top is used to select which bullet depth
3889 A text entry under the table shows the currently selected bullet shape's
3891 equivalent and this can be edited if desired.
3892 If you do modify the text you will also need to specify any needed packages
3893 in the \SpecialChar LaTeX
3897 \begin_layout Standard
3898 The six panels are divided up by the packages they require.
3899 The following table shows the mappings from button name to \SpecialChar LaTeX
3903 \begin_layout Standard
3905 \begin_inset Tabular
3906 <lyxtabular version="3" rows="7" columns="2">
3907 <features tabularvalignment="middle">
3908 <column alignment="center" valignment="top" width="0pt">
3909 <column alignment="center" valignment="top" width="0pt">
3911 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3914 \begin_layout Plain Layout
3929 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3932 \begin_layout Plain Layout
3949 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3952 \begin_layout Plain Layout
3967 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3970 \begin_layout Plain Layout
3979 base \SpecialChar LaTeX
3987 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3990 \begin_layout Plain Layout
4005 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4008 \begin_layout Plain Layout
4025 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4028 \begin_layout Plain Layout
4043 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4046 \begin_layout Plain Layout
4063 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4066 \begin_layout Plain Layout
4081 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4084 \begin_layout Plain Layout
4101 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4104 \begin_layout Plain Layout
4119 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4122 \begin_layout Plain Layout
4139 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4142 \begin_layout Plain Layout
4157 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4160 \begin_layout Plain Layout
4183 \begin_layout Standard
4185 doesn't stop you using bullets from packages you don't have.
4186 If you get errors from \SpecialChar LaTeX
4187 when you try to view or print the file, then it
4188 is likely you are missing a package.
4192 \begin_layout Plain Layout
4194 doesn't restrict your use since you may be editing locally and exporting
4203 \begin_layout Subsection
4207 \begin_layout Standard
4208 Select which bullet depth you want to change then select the bullet shape
4210 Any changes will not be visible in \SpecialChar LyX
4211 , but are visible when viewing the document.
4214 \begin_layout Standard
4215 You can reset a bullet shape to the default simply by clicking your right
4216 mouse button on the appropriate bullet depth button.
4220 \begin_layout Plain Layout
4225 want to have multiple sets of paragraphs with different sets of bullets
4226 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
4228 The bullet selection dialog can help though because it provides you with
4229 the \SpecialChar LaTeX
4230 code for a wide range of bullet shapes.
4231 To make your own custom paragraphs you have the following options:
4234 \begin_layout Plain Layout
4238 \begin_layout Plain Layout
4254 \begin_layout Plain Layout
4258 \begin_layout Plain Layout
4280 \begin_layout Itemize
4281 Use the \SpecialChar LaTeX
4283 \begin_inset Flex Code
4286 \begin_layout Plain Layout
4294 to specify a new bullet shape for a given depth.
4295 You'll also need to save the current bullet shape so you can restore it
4297 In this itemized list the following \SpecialChar LaTeX
4298 code was used to change the bullet
4299 used for the first depth.
4303 \begin_layout LyX-Code
4313 \begin_layout LyX-Code
4330 \begin_layout Itemize
4331 Note that the itemize depth is specified in Roman numerals as part of the
4341 \begin_layout Itemize
4345 \begin_layout Plain Layout
4358 Specify each individual entry by starting each item with the bullet shape
4359 enclosed in square brackets and set as
4360 \begin_inset Flex Noun
4363 \begin_layout Plain Layout
4371 For example, this item was started with
4372 \begin_inset Flex Code
4375 \begin_layout Plain Layout
4390 \begin_layout Plain Layout
4394 \begin_layout Plain Layout
4410 \begin_layout Plain Layout
4411 You'll also need to revert the labelitem back to its previous setting for
4412 the global bullet shape settings to remain in effect.
4413 The way used here was:
4416 \begin_layout LyX-Code
4431 \begin_layout Chapter
4433 and the World Wide Web
4436 \begin_layout Standard
4438 has long supported the export of documents to various web-friendly formats,
4440 Before verson 2.0, however, HTML export was always accomplished by the use
4441 of external converters.
4445 \begin_layout Plain Layout
4446 For details on the use of external converters with \SpecialChar LyX
4451 section of the Customization manual.
4456 These fall into two large groups: there are converters that use \SpecialChar LaTeX
4458 intermediate format, such as
4459 \begin_inset Flex Code
4462 \begin_layout Plain Layout
4469 \begin_inset Flex Code
4472 \begin_layout Plain Layout
4479 \begin_inset Flex Code
4482 \begin_layout Plain Layout
4488 , relying upon \SpecialChar LyX
4489 to produce the \SpecialChar LaTeX
4490 ; and there is a converter that works directly
4493 \begin_inset Flex Code
4496 \begin_layout Plain Layout
4504 All of these have different advantages and disadvantages.
4508 \begin_layout Standard
4509 The \SpecialChar LaTeX
4510 -based converters have the advantage that, in principle, they know everythin
4511 g about the exported document that \SpecialChar LaTeX
4513 Such converters do not care, for example, if a certain block of code was
4514 produced by \SpecialChar LyX
4515 or was Evil Red Text.
4516 These converters know about
4517 \begin_inset Flex Code
4520 \begin_layout Plain Layout
4526 files, counters, and references, and can often make use of the
4527 \begin_inset Flex Code
4530 \begin_layout Plain Layout
4536 files generated by Bib\SpecialChar TeX
4538 On the other hand, \SpecialChar LaTeX
4539 is a very hard language to parse—it is sometimes said
4540 that only \SpecialChar TeX
4541 itself understands \SpecialChar TeX
4542 —and \SpecialChar LaTeX
4543 -based converters will often choke on
4544 what seem to be quite simple constructs; complex ones can throw them completely
4545 , and as of this writing, for example, the
4549 manual will not export with
4550 \begin_inset Flex Code
4553 \begin_layout Plain Layout
4559 , though the others will.
4560 The other issue concerns how math is handled.
4561 These converters typically convert the formulae into little pictures that
4562 are then linked from the HTML document.
4563 Since these are actually generated by \SpecialChar LaTeX
4564 , they are accurate.
4565 But they do not scale well, and just getting them to look as if they are
4566 actually meant to be in your document—so that the font sizes seem to be
4567 roughly the same—can be a challenge.
4570 \begin_layout Standard
4572 \begin_inset Flex Code
4575 \begin_layout Plain Layout
4583 \begin_inset CommandInset href
4585 name "http://elyxer.nongnu.org/"
4586 target "http://elyxer.nongnu.org/"
4590 ) solves some of these problems.
4591 In particular, the formulae it produces scale perfectly, since it renders
4592 math using a combination of HTML and CSS rather than converting the formulae
4594 But even moderately complex formula are rendered less well than with
4595 \begin_inset Flex Code
4598 \begin_layout Plain Layout
4604 ; this reflects the limitations of HTML.
4608 \begin_layout Plain Layout
4610 \begin_inset Flex Code
4613 \begin_layout Plain Layout
4620 can also use jsMath and MathJax for equations, but this setting is only
4621 available globally and requires one to have access to a server that runs
4627 More importantly (as of version 1.1.1, at least),
4628 \begin_inset Flex Code
4631 \begin_layout Plain Layout
4638 has limited support for math macros and no support for user-defined paragraph
4639 or character styles.
4640 These limitations make
4641 \begin_inset Flex Code
4644 \begin_layout Plain Layout
4651 unsuitable for many of the documents \SpecialChar LyX
4653 In principle, of course, these problems could be solved, but the \SpecialChar LyX
4655 have decided to follow a different path and have made \SpecialChar LyX
4657 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
4658 , DocBook, and plaintext.
4661 \begin_layout Standard
4662 As of this writing, XHTML output remains under development and should probably
4664 \begin_inset Quotes eld
4668 \begin_inset Quotes erd
4675 \begin_layout Plain Layout
4677 \begin_inset Flex Code
4680 \begin_layout Plain Layout
4681 development/HTML.notes
4686 , which can be found in the \SpecialChar LyX
4688 \begin_inset CommandInset href
4690 name "accessed online"
4691 target "http://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
4695 , usually contains up-to-date information about the state of XHTML output.
4696 See also the list of XHTML bugs on
4697 \begin_inset CommandInset href
4699 name "the bug tracker"
4700 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"
4709 Still, the developers have chosen this approach because it has several
4710 potential advantages over the other two.
4713 \begin_layout Standard
4714 These advantages are primarily due to the fact that the XHTML output routines,
4715 since they are part of \SpecialChar LyX
4716 , know everything \SpecialChar LyX
4717 knows about the document being
4722 \begin_layout Plain Layout
4723 Another advantage is that, since these routines are internal to \SpecialChar LyX
4725 immune to changes in \SpecialChar LyX
4726 's file format, or to changes in the semantics of
4732 So they know about the table of contents (as displayed in the outline),
4733 about the counters associated with different paragraph styles, and about
4734 user-defined styles.
4735 The XHTML output routines know what \SpecialChar LyX
4736 knows about internationalization,
4737 too, so they will output
4738 \begin_inset Quotes eld
4742 \begin_inset Quotes erd
4746 \begin_inset Quotes eld
4754 \begin_inset Quotes erd
4757 , depending upon the language in effect at the time.
4761 \begin_layout Standard
4762 Quite generally, the output routines know what \SpecialChar LyX
4763 knows about document layout,
4764 that is, about how the document is to be rendered on screen.
4765 We use this information when we output the document as XHTML.
4766 In particular, \SpecialChar LyX
4771 generates CSS style information corresponding to the layout information
4772 it uses to render the document on screen: if section headings are supposed
4773 to be sans-serif and bold as seen in \SpecialChar LyX
4774 , then (by default) they will be sans-seri
4775 f and bold when viewed in a web browser, too.
4776 And this is true not just for pre-defined styles, like Section, but for
4777 any style, including user-defined styles.
4778 Indeed, the XHTML output routines make no distinction between user-defined
4779 paragraph and character styles and \SpecialChar LyX
4780 's own pre-defined styles: in each case,
4781 everything \SpecialChar LyX
4782 knows about the styles is contained in the layout files.
4783 And much the same is true as regards pre-defined textual insets, such as
4784 footnotes, and various custom insets.
4788 \begin_layout Standard
4789 The result is that XHTML output can be customized and extended in exactly
4790 the same way \SpecialChar LaTeX
4791 output can be customized and extended: through layout files
4793 See chapter five of the
4797 manual for the details.
4800 \begin_layout Standard
4801 The remainder of this chapter contains more detailed information on XHTML
4802 output, its limitations, and ways to work around those limitations.
4805 \begin_layout Section
4806 Math Output in XHTML
4809 \begin_layout Standard
4811 offers four choices for how math is rendered.
4812 These have various advantages and disadvantages:
4815 \begin_layout Itemize
4817 \begin_inset Newline newline
4820 MathML is a dialect of XML designed specifically for mathematics on the
4821 web, and it typically renders very well in browsers that support it.
4822 The disadvantage is that not all browsers support MathML, and support is
4823 not complete even in the Gecko-based browsers, such as Firefox.
4824 \begin_inset Newline newline
4828 is unable to render a formula as MathML—for example, if the formula
4830 \begin_inset Flex Code
4833 \begin_layout Plain Layout
4839 package or ERT—then it will instead output the formula as an image.
4843 \begin_layout Itemize
4845 \begin_inset Newline newline
4849 \begin_inset Flex Code
4852 \begin_layout Plain Layout
4858 outputs math as HTML, styled by CSS.
4862 \begin_layout Plain Layout
4864 has borrowed some of the CSS for its HTML output from
4865 \begin_inset Flex Code
4868 \begin_layout Plain Layout
4879 For simple formulae, this can work quite well, though with more complicated
4880 formulae it tends to break down.
4881 Still, this method has the advantage that it is very widely supported and
4882 so it may be appropriate for documents that contain only a little, fairly
4884 \begin_inset Newline newline
4887 If Lyx is unable to render a formula as HTML—for example, if the formula
4889 \begin_inset Flex Code
4892 \begin_layout Plain Layout
4898 package or ERT—then it will instead output the formula as an image.
4902 \begin_layout Itemize
4904 \begin_inset Newline newline
4908 \begin_inset Flex Code
4911 \begin_layout Plain Layout
4918 will output formulae as images, the very same images, in fact, that are
4919 used for instant preview.
4923 \begin_layout Plain Layout
4924 Instant preview does
4928 have to be on for images to be output, however.
4933 The advantage to this method is that the images are simply generated by
4935 , so they are very accurate.
4936 The disadvantage, as mentioned earlier, is that these are bitmapped images,
4937 so they do not scale terribly well, and one cannot copy them, etc.
4938 (As of this writing, there are also problems about equation numbering.
4940 \begin_inset CommandInset href
4943 target "http://www.lyx.org/trac/ticket/6894"
4948 \begin_inset Newline newline
4951 The size of the images can be controlled by setting the
4952 \begin_inset Quotes eld
4956 \begin_inset Quotes erd
4960 \begin_inset Flex Noun
4963 \begin_layout Plain Layout
4964 Document\SpecialChar menuseparator
4965 Settings\SpecialChar menuseparator
4975 \begin_layout Plain Layout
4976 For those who want to know, this controls the resolution of the image in
4977 dots per inch and is based upon a default of 75 dpi.
4983 \begin_inset Newline newline
4987 for some reason fails to create an image for a formula (e.g., if a required
4989 package is not installed), then it will fall back to outputing the raw
4994 \begin_layout Itemize
4997 \begin_inset Newline newline
5000 Finally, \SpecialChar LyX
5001 will happily output math as \SpecialChar LaTeX
5003 As well as being the output of last resort, this method can be used with
5005 \begin_inset CommandInset href
5008 target "http://www.math.union.edu/~dpvc/jsMath/"
5012 , which uses JavaScript to render \SpecialChar LaTeX
5013 embedded in HTML documents.
5015 wraps the \SpecialChar LaTeX
5017 \begin_inset Flex Code
5020 \begin_layout Plain Layout
5026 (for inline formulas) or
5027 \begin_inset Flex Code
5030 \begin_layout Plain Layout
5036 (for displayed formulas) with
5037 \begin_inset Flex Code
5040 \begin_layout Plain Layout
5046 , as is required for jsMath.
5049 \begin_layout Standard
5050 One of these output methods must be selected under
5051 \begin_inset Flex Noun
5054 \begin_layout Plain Layout
5055 Document\SpecialChar menuseparator
5056 Settings\SpecialChar menuseparator
5063 By default, \SpecialChar LyX
5065 This is a document-wide setting, therefore.
5068 \begin_layout Standard
5069 Eventually, \SpecialChar LyX
5070 will offer the user the option to select an alternate output
5071 method for a particular inset, say, one that isn't being rendered very
5076 \begin_layout Plain Layout
5077 That said, since \SpecialChar LyX
5078 falls back to images if the inset contains ERT, then one
5079 can force output as an image by putting some harmless ERT into the math,
5081 \begin_inset Formula $a=b\relax$
5092 \begin_layout Section
5093 Bibliography and Citations
5096 \begin_layout Standard
5097 XHTML output fully supports bibliographies and citations.
5101 \begin_layout Standard
5102 Citation labels are generated by the same machinery that generates \SpecialChar LyX
5104 labels, so the labels will look in the output much as they do in \SpecialChar LyX
5107 If you are using numerical citations, then \SpecialChar LyX
5108 will output numerical labels,
5109 such as [1] or [17], rather than simply showing the citation key in square
5110 brackets, as it does on-screen.
5111 If you are using author-year citations, then \SpecialChar LyX
5112 will add lowercase letters
5113 to the years, just as Bib\SpecialChar TeX
5114 does, if it finds more than one citation for
5115 a given author-year combination.
5116 The labels will be printed with the bibliography entries.
5117 Note that there is, at present, no way to customize the appearance of the
5118 labels, for example, to choose between square brackets and parentheses.
5121 \begin_layout Standard
5122 Bibliography output is handled by the same machinery that handles the presentati
5123 on of reference information in the citation dialog, so you will see in the
5124 XHTML output pretty much what you would see if you were to look at a given
5125 entry in the citation dialog.
5126 The formatting can be customized in your layout file or, preferably, in
5132 manual for the details.
5135 \begin_layout Standard
5136 The main defect at present is that cross-referenced information is printed
5137 with every entry with which it is associated.
5138 So you can see things like this:
5143 \begin_inset Quotes eld
5146 Context and Logical Form
5147 \begin_inset Quotes erd
5152 Language in Context: Selected Essays
5154 (Oxford: Oxford University Press, 2007), pp.
5160 \begin_inset Quotes eld
5163 Semantics in Context
5164 \begin_inset Quotes erd
5169 Language in Context: Selected Essays
5171 (Oxford: Oxford University Press, 2007), pp.
5175 \begin_layout Standard
5176 This should be fixed before long.
5179 \begin_layout Standard
5180 There is no support at present for sectioned bibliographies.
5181 If you have multiple bibliographies, then \SpecialChar LyX
5182 will print the same bibliography
5186 \begin_layout Section
5190 \begin_layout Standard
5192 will happily export indexes as XHTML, but with certain limitations at the
5196 \begin_layout Standard
5197 Index export will be most reliable when you do not attempt to use the fancy
5198 constructs that are described in the section on indexes in the
5206 \begin_layout Plain Layout
5207 The main issue here is that \SpecialChar LyX
5208 itself does not really handle these.
5209 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
5215 We'll describe how they are handled using the subsection headings from
5219 \begin_layout Itemize
5220 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
5221 makes an effort to support these,
5222 but the entries must be separated by
5223 \begin_inset Quotes eld
5227 \begin_inset Quotes erd
5230 , that is, there must be spaces around the exclamation point.
5231 This is because it is otherwise too difficult to check for escaped exclamation
5232 points, ones in math, and so forth.
5235 \begin_layout Itemize
5236 Page Ranges: There is no support at all for page ranges, since these make
5237 no sense with XHMTL.
5238 Instead, you will just get two index entries, one at either end.
5241 \begin_layout Itemize
5242 Cross-referencing: There is no support for cross-referencing.
5244 finds an entry containing the
5245 \begin_inset Quotes eld
5248 |see\SpecialChar ldots
5250 \begin_inset Quotes erd
5253 construct, it is just dropped, and the rest is treated as an ordinary index
5257 \begin_layout Itemize
5258 Index Entry Order: \SpecialChar LyX
5259 does support attempts to fix the sorting order.
5260 It will take what is before the first `@' it finds and use that for sorting,
5261 taking what follows the first `@' to be the actual entry.
5262 At present, \SpecialChar LyX
5263 does not check for escaped `@', so do not try to index email
5267 \begin_layout Itemize
5268 Index Entry Layout: You can format entries by using the text style dialog,
5269 or by using any other method available within \SpecialChar LyX
5271 There is no support for constructs like:
5272 \begin_inset Quotes eld
5276 \begin_inset Quotes erd
5280 Indeed, if \SpecialChar LyX
5281 finds a pipe symbol, `|', in an entry, it will delete it and
5282 everything that follows it.
5285 \begin_layout Itemize
5286 Multiple Indexes: There is no support for multiple indexes.
5287 Rather, all index entries will be printed as one large index.
5288 To avoid our printing several versions of the index, we print only the
5289 main index, so make sure you have one.
5292 \begin_layout Section
5293 Nomenclature and Glossary
5296 \begin_layout Standard
5297 There is at present no support for glossaries.
5298 Adding it would be fairly trivial, and welcome.
5301 \begin_layout Chapter
5302 The \SpecialChar LyX
5306 \begin_layout Section
5310 \begin_layout Standard
5311 The `\SpecialChar LyX
5312 server' allows other programs to talk to \SpecialChar LyX
5313 , invoke \SpecialChar LyX
5314 commands, and retrieve
5315 information about the \SpecialChar LyX
5317 This is only intended for advanced users, but they should find it useful.
5318 It is by writing to the \SpecialChar LyX
5319 server, for example, that bibliography managers,
5320 such as JabRef, are able to
5321 \begin_inset Quotes eld
5325 \begin_inset Quotes erd
5328 citations to \SpecialChar LyX
5332 \begin_layout Section
5333 Starting the \SpecialChar LyX
5337 \begin_layout Standard
5338 The \SpecialChar LyX
5339 server works through the use of a pair of named pipes.
5340 These are usually located in
5341 \begin_inset Flex Code
5344 \begin_layout Plain Layout
5350 , (except on Windows, where
5354 named pipes are special objects located in
5355 \begin_inset Flex Code
5358 \begin_layout Plain Layout
5370 ) and have the names
5371 \begin_inset Quotes eld
5375 \begin_inset Flex Code
5378 \begin_layout Plain Layout
5385 \begin_inset Quotes erd
5389 \begin_inset Quotes eld
5393 \begin_inset Flex Code
5396 \begin_layout Plain Layout
5403 \begin_inset Quotes erd
5407 External programs write into
5408 \begin_inset Flex Code
5411 \begin_layout Plain Layout
5417 and read back data from
5418 \begin_inset Flex Code
5421 \begin_layout Plain Layout
5428 The stem of the pipe names can be defined in the
5429 \begin_inset Flex Noun
5432 \begin_layout Plain Layout
5433 Tools\SpecialChar menuseparator
5440 \begin_inset Flex Code
5443 \begin_layout Plain Layout
5444 "/home/myhome/lyxpipe"
5450 \begin_inset Flex Code
5453 \begin_layout Plain Layout
5467 on Windows (where any working path instead of lyxpipe can be used, for
5469 \begin_inset Flex Code
5472 \begin_layout Plain Layout
5495 configure this manually in order for the server to start.
5498 \begin_layout Standard
5501 \begin_inset Flex Code
5504 \begin_layout Plain Layout
5511 \begin_inset Flex Code
5514 \begin_layout Plain Layout
5520 ' to create the pipes.
5521 If one of the pipes already exists, \SpecialChar LyX
5522 will assume that another \SpecialChar LyX
5524 is already running and will not start the server.
5525 On POSIX (Unix like) systems, if for some other reason, an unused
5526 \begin_inset Quotes eld
5530 \begin_inset Quotes erd
5533 pipe is left in existence when \SpecialChar LyX
5534 closes, then \SpecialChar LyX
5535 will try to delete it.
5536 If this fails for some reason, you will need to delete the pipes manually
5537 and then restart \SpecialChar LyX
5539 On Windows, pipes are deleted by the OS on program termination or crash,
5541 \begin_inset Quotes eld
5545 \begin_inset Quotes erd
5548 pipes should not be possible.
5551 \begin_layout Standard
5552 To have several \SpecialChar LyX
5553 processes with servers at the same time, you have to use
5554 different configurations, perhaps by using separate user directories, each
5556 \begin_inset Flex Code
5559 \begin_layout Plain Layout
5565 file, for each process.
5568 \begin_layout Standard
5569 If you are developing a client program, you might find it useful to enable
5570 debugging information from the \SpecialChar LyX
5572 Do this by starting \SpecialChar LyX
5574 \begin_inset Flex Code
5577 \begin_layout Plain Layout
5586 \begin_layout Standard
5587 You can find a complete example client written in C++ in the source distribution
5589 \begin_inset Flex Code
5592 \begin_layout Plain Layout
5593 development/lyxserver/server_monitor.cpp
5601 \begin_layout Standard
5602 Another useful tool is the command-line based client found in
5603 \begin_inset Flex Code
5606 \begin_layout Plain Layout
5607 src/client/lyxclient
5615 \begin_layout Section
5616 Normal communication
5619 \begin_layout Standard
5620 To issue a \SpecialChar LyX
5621 call, the client writes a line of ASCII text into the input
5623 This line has the following format:
5640 \begin_layout Description
5641 clientname is a name that the client can choose arbitrarily.
5642 Its only use is that \SpecialChar LyX
5643 will echo it if it sends an answer—so a client can
5644 dispatch results from different requesters.
5647 \begin_layout Description
5648 function is the function you want \SpecialChar LyX
5650 It is the same as the commands you'd use in the minibuffer.
5653 \begin_layout Description
5654 argument is an optional argument which is meaningful only to some functions
5656 \begin_inset Quotes eld
5660 \begin_inset Quotes erd
5663 LFUN will insert the argument as text at the cursor position).
5666 \begin_layout Standard
5667 The answer from \SpecialChar LyX
5668 will arrive in the output pipe and be of the form
5685 \begin_layout Standard
5694 are just echoed from the command request, while
5698 is more or less useful information filled according to how the command
5699 execution worked out.
5700 Some commands, such as
5701 \begin_inset Quotes eld
5705 \begin_inset Quotes erd
5708 , will return information about the internal state of \SpecialChar LyX
5710 return an empty data-response.
5711 This means that the command execution went fine.
5714 \begin_layout Standard
5715 In case of errors, the response from \SpecialChar LyX
5733 \begin_layout Standard
5738 should contain an explanation of why the command failed.
5741 \begin_layout Standard
5745 \begin_layout LyX-Code
5746 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
5747 \begin_inset Newline newline
5750 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
5751 \begin_inset Newline newline
5754 read a <~/.lyxpipe.out
5755 \begin_inset Newline newline
5761 \begin_layout Subsection
5762 AppleScript (Mac OS X)
5765 \begin_layout Standard
5766 Since \SpecialChar LyX
5767 2.1, \SpecialChar LyX
5768 supports basic interactions with AppleScript for normal communicatio
5769 n through the command run.
5770 This command takes a direct argument (the
5774 to perform) and an optional argument.
5775 It either returns the output of the function or triggers an error with
5776 the error message and code.
5779 \begin_layout Standard
5783 \begin_layout LyX-Code
5784 tell application "\SpecialChar LyX
5788 \begin_layout LyX-Code
5792 \begin_layout LyX-Code
5793 -- Stores the current file name into f
5796 \begin_layout LyX-Code
5797 set f to (run "server-get-filename" with argument "")
5800 \begin_layout LyX-Code
5801 on error the error_message number the error_number
5804 \begin_layout LyX-Code
5805 display dialog "Error: " & the error_number & ".
5809 \begin_layout LyX-Code
5810 & the error_message buttons {"OK"} default button 1
5813 \begin_layout LyX-Code
5817 \begin_layout LyX-Code
5821 \begin_layout Section
5825 \begin_layout Standard
5827 can notify clients of events going on asynchronously.
5828 Currently it will only do this if the user binds a key sequence with the
5830 \begin_inset Quotes eld
5834 \begin_inset Quotes erd
5838 The format of the string \SpecialChar LyX
5839 sends is as follows:
5843 \begin_inset Flex Code
5846 \begin_layout Plain Layout
5857 \begin_layout Standard
5862 is the printed representation of the key sequence that was actually typed
5866 \begin_layout Standard
5867 This mechanism can be used to extend \SpecialChar LyX
5868 's command set and implement macros.
5869 Bind some key sequence to
5870 \begin_inset Quotes eld
5874 \begin_inset Quotes erd
5878 Then start a client that listens on the output pipe, dispatches the command
5879 according to the sequence, and starts a function that may use \SpecialChar LyX
5882 requests to issue a command or a series of commands to \SpecialChar LyX
5886 \begin_layout Section
5887 The simple \SpecialChar LyX
5891 \begin_layout Standard
5893 implements a simple protocol that can be used for session management.
5894 All messages are of the form
5907 \begin_layout Standard
5913 \begin_inset Quotes eld
5917 \begin_inset Quotes erd
5921 \begin_inset Quotes eld
5925 \begin_inset Quotes erd
5930 \begin_inset Quotes eld
5934 \begin_inset Quotes erd
5937 is received from a client, \SpecialChar LyX
5938 will report back to inform the client that
5939 it's listening to it's messages, while
5940 \begin_inset Quotes eld
5944 \begin_inset Quotes erd
5947 sent from \SpecialChar LyX
5948 will inform clients that \SpecialChar LyX
5952 \begin_layout Section
5953 Reverse DVI/PDF search
5956 \begin_layout Standard
5957 Some DVI/PDF viewers
5961 \begin_layout Plain Layout
5962 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
5963 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
5972 facility (also called
5977 This means that you can tell \SpecialChar LyX
5978 to put the cursor to a specific line in the
5979 document by clicking at the respective position in the DVI/PDF output.
5980 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
5982 This is done via the \SpecialChar LyX
5983 server either by using the named pipe (
5987 ), or the UNIX domain socket (
5991 ) that \SpecialChar LyX
5992 creates in its temporary directory (this is the way the
5993 \begin_inset Flex Code
5996 \begin_layout Plain Layout
6002 program communicates with \SpecialChar LyX
6004 In some cases, you need a helper script that mediates between the viewer
6005 and \SpecialChar LyX
6006 , in others, the viewer can communicate with \SpecialChar LyX
6008 This depends on the selected viewer and on your operating system.
6009 The same applies to the way viewers need to be configured and the way the
6010 reverse search is actually performed.
6011 In what follows, we will thus describe how to setup reverse search for
6013 Before we turn to this, though, we will explain what needs to be done generally
6014 to enable reverse search in the DVI/PDF output.
6017 \begin_layout Subsection
6019 \begin_inset CommandInset label
6021 name "subsec:rev-search"
6028 \begin_layout Standard
6029 In most cases \SpecialChar LyX
6030 will do the work for you by enabling the option
6031 \begin_inset Flex Noun
6034 \begin_layout Plain Layout
6035 Synchronize with Output
6041 \begin_inset Flex Noun
6044 \begin_layout Plain Layout
6045 Document\SpecialChar menuseparator
6046 Settings\SpecialChar menuseparator
6053 In such a case \SpecialChar LyX
6054 will automatically insert the necessary Sync\SpecialChar TeX
6056 PDF) or load the srcltx package (for DVI) respectively.
6057 This option can be easily reached also on
6058 \begin_inset Flex Code
6061 \begin_layout Plain Layout
6070 \begin_layout Standard
6071 If you need a different setting, you can select or input a custom macro
6072 from the drop down box just below
6073 \begin_inset Flex Noun
6076 \begin_layout Plain Layout
6077 Document\SpecialChar menuseparator
6078 Settings\SpecialChar menuseparator
6079 Output\SpecialChar menuseparator
6080 Synchronize with Output
6088 \begin_layout Standard
6089 Note that the method
6090 \begin_inset Flex Code
6093 \begin_layout Plain Layout
6101 enables gzip compression.
6102 If your viewer does not support it, you should instead use
6103 \begin_inset Flex Code
6106 \begin_layout Plain Layout
6117 \begin_layout Standard
6118 Please also note that including the
6119 \begin_inset Flex Code
6122 \begin_layout Plain Layout
6129 \begin_inset Flex Code
6132 \begin_layout Plain Layout
6138 sometimes has an undesired impact on the typesetting.
6139 Thus, you should switch output synchronization off for the final typesetting
6141 \begin_inset Flex Code
6144 \begin_layout Plain Layout
6151 \begin_inset Flex Code
6154 \begin_layout Plain Layout
6164 \begin_layout Standard
6165 In case you need some more special settings that are not covered by the
6166 automatic settings, read the next section about how to set up output synchroniz
6168 If the automatic setup suits your needs, you can readily jump to section
6169 \begin_inset space ~
6173 \begin_inset CommandInset ref
6175 reference "subsec:configuring-viewers"
6179 , where the necessary configuration steps in your viewer – needed both with
6180 the automatic and the manual setup – are described.
6183 \begin_layout Subsection
6187 \begin_layout Standard
6189 provides several different methods for reverse search.
6190 Some are built-in in the
6191 \begin_inset Flex Code
6194 \begin_layout Plain Layout
6200 program, some are provided by external packages.
6201 Your choice depends on whether your \SpecialChar LaTeX
6202 distribution already provides a given
6203 method (the built-in methods are rather new) and whether your viewer can
6205 The available methods are described in the following.
6208 \begin_layout Subsubsection*
6209 Built-in DVI-search via src-specials (DVI only)
6212 \begin_layout Standard
6213 This method provides the DVI file with the necessary information for reverse
6215 It is available in \SpecialChar LaTeX
6216 since quite some time (any somewhat recent \SpecialChar LaTeX
6218 should include it), and it works reliably.
6219 To enable it, change the
6220 \begin_inset Flex Noun
6223 \begin_layout Plain Layout
6234 \begin_inset Flex Noun
6237 \begin_layout Plain Layout
6248 \begin_inset Flex Noun
6251 \begin_layout Plain Layout
6252 Preferences\SpecialChar menuseparator
6253 File Handling\SpecialChar menuseparator
6260 \begin_inset Flex Code
6263 \begin_layout Plain Layout
6264 latex -src-specials $$i
6270 If this doesn't work, check if your \SpecialChar TeX
6271 engine needs different options (the
6272 syntax might differ in some distributions).
6275 \begin_layout Subsubsection*
6276 External Packages (PDFSync and scrltx)
6279 \begin_layout Standard
6288 provide reverse search facility for PDF output (via pdflatex) and DVI output,
6290 In order to enable it, load the packages in the \SpecialChar LyX
6294 \begin_layout Itemize
6295 \begin_inset Flex Code
6298 \begin_layout Plain Layout
6306 for reverse PDF search,
6309 \begin_layout Itemize
6310 \begin_inset Flex Code
6313 \begin_layout Plain Layout
6316 usepackage[active]{srcltx}
6321 for reverse DVI search.
6324 \begin_layout Standard
6325 If you want to be able to perform both DVI and PDF reverse searches, you
6326 can also insert in the preamble the following lines
6329 \begin_layout LyX-Code
6333 \begin_inset Newline newline
6339 \begin_inset Newline newline
6345 \begin_inset Newline newline
6351 \begin_inset Newline newline
6356 usepackage[active]{srcltx}
6357 \begin_inset Newline newline
6365 \begin_layout Standard
6366 This way, you can preview the file as either DVI or PDF (pdflatex) and the
6367 right package will be used.
6370 \begin_layout Standard
6371 Note that PDFSync might affect the output layout of your document.
6372 It is therefore advised to disable PDFsync for final documents.
6375 \begin_layout Subsubsection*
6376 Built-in reverse search via Sync\SpecialChar TeX
6380 \begin_layout Standard
6382 \begin_inset Flex Code
6385 \begin_layout Plain Layout
6391 have built-in support for both PDF and DVI reverse search.
6394 Sync\SpecialChar TeX
6397 facility is basically the result of the integration of the PDFSync package
6398 to the pdftex program and its merge with the
6403 You need at least \SpecialChar TeX
6404 Live 2008 or a recent Mik\SpecialChar TeX
6405 distribution in order to use
6410 \begin_layout Plain Layout
6411 For some reason, Mik\SpecialChar TeX
6412 does not understand/obey the command \SpecialChar LyX
6414 the preamble when you check the "Enable Forward/Reverse Search" button
6415 in the toolbar and does not generate the necessary info.
6418 \begin_layout Plain Layout
6419 The generation of the required info can be forced by changing the converter
6421 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
6422 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
6423 the -synctex=1 switch).
6428 Also note that only a few PDF viewers (Okular and Qpdfview on Unix, Skim
6429 on the Mac, SumatraPDF on Windows) already provide Sync\SpecialChar TeX
6433 \begin_layout Standard
6434 To enable Sync\SpecialChar TeX
6435 for DVI output, change the
6436 \begin_inset Flex Noun
6439 \begin_layout Plain Layout
6450 \begin_inset Flex Noun
6453 \begin_layout Plain Layout
6464 \begin_inset Flex Noun
6467 \begin_layout Plain Layout
6468 Preferences\SpecialChar menuseparator
6469 File Handling\SpecialChar menuseparator
6476 \begin_inset Flex Code
6479 \begin_layout Plain Layout
6480 latex -synctex=1 $$i
6485 , and for PDF output, change the
6486 \begin_inset Flex Noun
6489 \begin_layout Plain Layout
6494 (pdflatex) -> PDF (pdflatex)
6500 \begin_inset Flex Code
6503 \begin_layout Plain Layout
6504 pdflatex -synctex=1 $$i
6510 Check the documentation of your viewer whether the viewer needs to be configure
6511 d for the use with Sync\SpecialChar TeX
6516 \begin_layout Plain Layout
6517 Note that the option
6518 \begin_inset Flex Code
6521 \begin_layout Plain Layout
6527 option enables gzip compression.
6528 If your viewer does not support it, you should instead use
6529 \begin_inset Flex Code
6532 \begin_layout Plain Layout
6546 \begin_layout Subsection
6547 Configuring and using specific viewers
6548 \begin_inset CommandInset label
6550 name "subsec:configuring-viewers"
6557 \begin_layout Subsubsection*
6558 Xdvi (all platforms)
6561 \begin_layout Standard
6563 \begin_inset Flex Code
6566 \begin_layout Plain Layout
6572 , you don't need to do anything else for performing a reverse DVI search,
6574 already provides the necessary hooks for automatically using the
6575 \begin_inset Flex Code
6578 \begin_layout Plain Layout
6585 Just setup your document as described above (reverse search is triggered
6586 by Ctrl-click or Alt-click on Mac OSX, respectively).
6589 \begin_layout Standard
6590 However, if for whatever reason you want to use the named pipe instead of
6591 the socket for communicating with \SpecialChar LyX
6592 , simply change the DVI viewer in
6593 \begin_inset Flex Noun
6596 \begin_layout Plain Layout
6597 Preferences\SpecialChar menuseparator
6598 File Handling\SpecialChar menuseparator
6608 \begin_layout Plain Layout
6609 On Mac OSX you have to use
6610 \begin_inset Flex Code
6613 \begin_layout Plain Layout
6614 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
6625 \begin_inset Flex Code
6628 \begin_layout Plain Layout
6629 xdvi -editor "lyxeditor.sh %f %l"
6635 \begin_inset Flex Code
6638 \begin_layout Plain Layout
6644 is a suitable script.
6645 For example, a minimal shell script is the following one:
6648 \begin_layout LyX-Code
6650 \begin_inset Newline newline
6653 LYXPIPE="/path/to/lyxpipe"
6654 \begin_inset Newline newline
6657 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
6658 \begin_inset Newline newline
6661 echo "$COMMAND" > "${LYXPIPE}".in || exit
6662 \begin_inset Newline newline
6665 read TMP < "${LYXPIPE}".out || exit
6668 \begin_layout Standard
6670 \begin_inset Flex Code
6673 \begin_layout Plain Layout
6679 is the LyXServer pipe path specified in
6680 \begin_inset Flex Noun
6683 \begin_layout Plain Layout
6684 Preferences\SpecialChar menuseparator
6694 \begin_layout Plain Layout
6696 \begin_inset Flex Code
6699 \begin_layout Plain Layout
6705 folder of a source distribution you can find a
6706 \begin_inset Flex Code
6709 \begin_layout Plain Layout
6715 script which is able to locate the
6719 based on your preferences.
6727 \begin_layout Subsubsection*
6731 \begin_layout Standard
6733 \begin_inset Flex Code
6736 \begin_layout Plain Layout
6737 /Applications/MacDviX_Folder/calleditor.script
6742 , add the following lines:
6745 \begin_layout LyX-Code
6746 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
6747 \begin_inset Newline newline
6753 \begin_layout Standard
6754 Modify the lines accordingly if you install \SpecialChar LyX
6755 somewhere else than in the
6756 Applications folder.
6759 \begin_layout Standard
6760 Reverse search is triggered by Alt-click (OPTION-click).
6763 \begin_layout Subsubsection*
6767 \begin_layout Standard
6769 \begin_inset Flex Code
6772 \begin_layout Plain Layout
6773 open -a Skim.app $$i
6778 to the viewer setting in
6779 \begin_inset Flex Noun
6782 \begin_layout Plain Layout
6783 Preferences\SpecialChar menuseparator
6784 File Handling\SpecialChar menuseparator
6785 File formats\SpecialChar menuseparator
6792 \begin_inset Flex Noun
6795 \begin_layout Plain Layout
6796 Skim\SpecialChar menuseparator
6797 Preferences\SpecialChar menuseparator
6804 \begin_inset Flex Noun
6807 \begin_layout Plain Layout
6813 preset and enter command
6814 \begin_inset Flex Noun
6817 \begin_layout Plain Layout
6818 /Applications/\SpecialChar LyX
6819 .app/Contents/MacOS/lyxeditor
6827 \begin_layout Standard
6828 Reverse search is triggered by COMMAND-SHIFT-click
6831 \begin_layout Subsubsection*
6835 \begin_layout Standard
6837 \begin_inset Flex Noun
6840 \begin_layout Plain Layout
6841 Settings\SpecialChar menuseparator
6842 Configure Okular\SpecialChar menuseparator
6849 \begin_inset Quotes eld
6853 \begin_inset Quotes erd
6857 \begin_inset Flex Code
6860 \begin_layout Plain Layout
6869 \begin_layout Standard
6870 Reverse search is triggered by SHIFT-click.
6873 \begin_layout Subsubsection*
6877 \begin_layout Standard
6878 Qpdfview supports Sync\SpecialChar TeX
6879 since version 0.3.5.
6881 \begin_inset Flex Noun
6884 \begin_layout Plain Layout
6885 Edit\SpecialChar menuseparator
6886 Settings\SpecialChar menuseparator
6892 , click on the input field of the
6893 \begin_inset Quotes eld
6897 \begin_inset Quotes erd
6900 item and add the command
6901 \begin_inset Flex Code
6904 \begin_layout Plain Layout
6913 \begin_layout Standard
6914 Reverse search is triggered by double-click.
6917 \begin_layout Subsubsection*
6921 \begin_layout Standard
6922 Launch yap, choose its
6923 \begin_inset Flex Noun
6926 \begin_layout Plain Layout
6927 View\SpecialChar menuseparator
6934 \begin_inset Quotes eld
6938 \begin_inset Quotes erd
6943 \begin_inset Quotes eld
6946 New\SpecialChar ldots
6948 \begin_inset Quotes erd
6951 button and, in the window that opens, enter
6952 \begin_inset Quotes eld
6957 \begin_inset Quotes erd
6960 (or any other name you like) in the
6961 \begin_inset Quotes eld
6965 \begin_inset Quotes erd
6969 Now click on the button labeled
6970 \begin_inset Quotes eld
6975 \begin_inset Quotes erd
6978 to open a file dialog and navigate to the directory containing the batch
6980 \begin_inset Flex Code
6983 \begin_layout Plain Layout
6991 \begin_inset Flex Code
6994 \begin_layout Plain Layout
7000 and then specify the program arguments as
7001 \begin_inset Flex Code
7004 \begin_layout Plain Layout
7012 \begin_inset Flex Code
7015 \begin_layout Plain Layout
7021 wrapper is used for communicating with \SpecialChar LyX
7029 \begin_layout LyX-Code
7031 \begin_inset Newline newline
7034 echo LYXCMD:revdvi:server-goto-file-row:%1 %2>
7043 \begin_inset Newline newline
7057 \begin_layout Standard
7058 Make sure that the \SpecialChar LyX
7059 Server pipe path you specified in \SpecialChar LyX
7061 \begin_inset Flex Code
7064 \begin_layout Plain Layout
7078 , otherwise change the
7079 \begin_inset Flex Code
7082 \begin_layout Plain Layout
7088 wrapper accordingly.
7091 \begin_layout Standard
7092 In yap, reverse search is triggered by double-click.
7095 \begin_layout Subsubsection*
7096 SumatraPDF (Windows)
7099 \begin_layout Standard
7100 In order to use SumatraPDF for inverse search, enter
7101 \begin_inset Flex Code
7104 \begin_layout Plain Layout
7105 SumatraPDF -inverse-search "lyxeditor.bat %f %l"
7110 in the viewer setting in
7111 \begin_inset Flex Noun
7114 \begin_layout Plain Layout
7115 Preferences\SpecialChar menuseparator
7116 File Handling\SpecialChar menuseparator
7117 File formats\SpecialChar menuseparator
7124 \begin_inset Flex Code
7127 \begin_layout Plain Layout
7133 is the previous wrapper.
7134 If SumatraPDF.exe is not in your command PATH, use its full file name.
7137 \begin_layout Standard
7138 Reverse search is triggered by double-click.
7141 \begin_layout Subsubsection*
7145 \begin_layout Standard
7146 First of all, make sure that yap is your default DVI viewer in the Windows
7147 environment, then launch it, choose its
7148 \begin_inset Flex Noun
7151 \begin_layout Plain Layout
7152 View\SpecialChar menuseparator
7159 \begin_inset Quotes eld
7163 \begin_inset Quotes erd
7168 \begin_inset Quotes eld
7171 New\SpecialChar ldots
7173 \begin_inset Quotes erd
7176 button and, in the window that opens, enter
7177 \begin_inset Quotes eld
7182 \begin_inset Quotes erd
7185 (or any other name you like) in the
7186 \begin_inset Quotes eld
7190 \begin_inset Quotes erd
7194 Now click on the button labeled
7195 \begin_inset Quotes eld
7200 \begin_inset Quotes erd
7203 to open a file dialog and navigate to the directory containing the
7204 \begin_inset Flex Code
7207 \begin_layout Plain Layout
7213 program (which is installed by default on Cygwin along with the \SpecialChar LyX
7216 \begin_inset Flex Code
7219 \begin_layout Plain Layout
7225 and then specify the program arguments as
7226 \begin_inset Flex Code
7229 \begin_layout Plain Layout
7236 In this way, you will be using the
7240 for communicating with \SpecialChar LyX
7242 If, for whatever reason, you want to use the
7247 \begin_inset Flex Code
7250 \begin_layout Plain Layout
7256 option and be sure to specify the \SpecialChar LyX
7257 Server pipe path in the \SpecialChar LyX
7261 \begin_layout Standard
7262 In yap, reverse search is triggered by double-click.
7265 \begin_layout Subsubsection*
7269 \begin_layout Standard
7270 In order to use SumatraPDF for inverse search, enter
7271 \begin_inset Flex Code
7274 \begin_layout Plain Layout
7275 SumatraPDF -inverse-search "lyxeditor -g %f %l"
7280 in the viewer setting in
7281 \begin_inset Flex Noun
7284 \begin_layout Plain Layout
7285 Preferences\SpecialChar menuseparator
7286 File Handling\SpecialChar menuseparator
7287 File formats\SpecialChar menuseparator
7294 If SumatraPDF.exe is not in your command PATH, use its full posix path.
7296 \begin_inset Flex Code
7299 \begin_layout Plain Layout
7305 enables communication via the
7311 \begin_inset Flex Code
7314 \begin_layout Plain Layout
7320 option if you want to use the
7324 , and be sure to specify the \SpecialChar LyX
7325 Server pipe path in the \SpecialChar LyX
7329 \begin_layout Standard
7330 Reverse search is triggered by double-click.
7333 \begin_layout Section
7337 \begin_layout Standard
7338 Forward search is, as the name implies, in a sense the
7339 \begin_inset Quotes eld
7343 \begin_inset Quotes erd
7347 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
7349 If forward search is set up (as described in what follows), you can put
7350 the cursor anywhere in your \SpecialChar LyX
7352 \begin_inset Flex Noun
7355 \begin_layout Plain Layout
7356 Navigate\SpecialChar menuseparator
7363 \begin_inset Flex Noun
7366 \begin_layout Plain Layout
7372 in the context menu via right mouse click), and then the viewer will jump
7373 to that position as well.
7374 This implies, of course, that your viewer supports this function.
7377 \begin_layout Standard
7378 To make forward search possible, you first need to provide the generated
7379 output PDF/DVI file with additional information about the \SpecialChar TeX
7381 This can be done via the methods described in the section
7382 \begin_inset CommandInset ref
7384 reference "subsec:rev-search"
7391 \begin_layout Standard
7392 Additionally, you need to configure \SpecialChar LyX
7393 for using your viewers in
7394 \begin_inset Flex Noun
7397 \begin_layout Plain Layout
7398 Tools\SpecialChar menuseparator
7399 Preferences\SpecialChar menuseparator
7400 Output\SpecialChar menuseparator
7407 We provide a range of tested configurations for some viewers, which you
7408 can select from the drop down list.
7409 If none of these configurations suits you, you have to find out and enter
7410 a suitable configuration yourself.
7411 The definition syntax uses the following placeholders:
7414 \begin_layout Itemize
7416 \begin_inset Flex Code
7419 \begin_layout Plain Layout
7428 \begin_layout Itemize
7430 \begin_inset Flex Code
7433 \begin_layout Plain Layout
7439 : name of the (temporary) exported .tex file (without path)
7442 \begin_layout Itemize
7444 \begin_inset Flex Code
7447 \begin_layout Plain Layout
7453 : name of the (temporary) exported .tex file (including path)
7456 \begin_layout Itemize
7458 \begin_inset Flex Code
7461 \begin_layout Plain Layout
7467 : name of the exported output file (either dvi or pdf, depending on which
7468 one exists in the temporary directory)
7471 \begin_layout Standard
7472 Note that only some of the viewers provide full forward search functionality,
7473 among them yap, xdvi, okular
7477 \begin_layout Plain Layout
7478 You might want to set
7479 \begin_inset Flex Code
7482 \begin_layout Plain Layout
7489 \begin_inset Flex Noun
7492 \begin_layout Plain Layout
7493 Tools\SpecialChar menuseparator
7494 Preferences\SpecialChar menuseparator
7495 File Handling\SpecialChar menuseparator
7497 \begin_inset space ~
7510 , qpdfview and SumatraPDF
7514 \begin_layout Plain Layout
7515 SumatraPDF can also use DDE commands through the external program CMCDDE
7517 \begin_inset CommandInset href
7519 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
7529 While many of the widespread PDF viewers (most notably Adobe Reader) do
7530 not support forward search at all, some other viewers – e.
7531 \begin_inset space \thinspace{}
7535 evince and xpdf – allow at least to reload the document and jump to a specific
7536 page of the file, so you can at least navigate
7537 \begin_inset Quotes eld
7541 \begin_inset Quotes erd
7545 This latter functionality is provided by an external call of synctex (see
7546 the predefined example configurations).
7550 \begin_layout Standard
7551 Forward search works both with DVI and PDF output.
7553 simply checks which preview format you have used before (i.
7554 \begin_inset space \thinspace{}
7557 e., which format is already there in the temporary directory) and chooses
7558 the appropriate configuration for the respective format.
7561 \begin_layout Chapter
7562 Special Document Classes
7565 \begin_layout Section
7569 \begin_layout Standard
7575 \begin_layout Subsection
7579 \begin_layout Standard
7580 This section describes how \SpecialChar LyX
7581 can be used to write articles for submission
7582 to the scientific journal
7584 Astronomy and Astrophysics
7587 \begin_inset Flex URL
7590 \begin_layout Plain Layout
7592 http://www.edpsciences.fr/aa/
7597 ) using Version 5.01 of the document class
7602 This package can be downloaded from the ftp site
7605 \begin_layout Standard
7606 \begin_inset VSpace medskip
7612 \begin_layout Standard
7614 \begin_inset Flex URL
7617 \begin_layout Plain Layout
7619 ftp://ftp.edpsciences.org/pub/aa/readme.html
7627 \begin_layout Standard
7628 \begin_inset VSpace medskip
7634 \begin_layout Standard
7635 A manual comes together with that package, and this text is not meant to
7636 replace the original manual but is merely a short guide in how to realize
7637 the correct form of your paper.
7641 \begin_layout Standard
7642 Please note that the publisher of the journal was changed from Springer
7643 to EDP Sciences starting January 1, 2001.
7644 That change involved also some slight changes to the style files, namely
7645 the removal of the thesaurus command.
7646 The \SpecialChar LyX
7647 class aa supports the newest version of these style files, V 5.01.
7648 If you have an older version installed, please upgrade.
7649 For compatibility, the old (version 4) layout has been kept as
7654 Please refer to the comments in
7657 Dir/layouts/aapaper.layout
7662 \begin_layout Subsection
7666 \begin_layout Standard
7667 It is recommended you start from the example template distributed with \SpecialChar LyX
7669 If you are not using a template, note the following settings:
7672 \begin_layout Itemize
7679 Document\SpecialChar menuseparator
7682 dialog (OK, that one was obvious).
7685 \begin_layout Itemize
7686 Don't change the option
7689 \begin_inset space ~
7699 The whole layout is done by the macros, you shouldn't change anything.
7702 \begin_layout Subsection
7706 \begin_layout Standard
7707 First thing to enter is the header information.
7708 It consists of seven entries, of which some are optional.
7712 \begin_layout Itemize
7720 \begin_layout Itemize
7728 \begin_layout Itemize
7736 \begin_layout Itemize
7744 \begin_layout Itemize
7749 : [optional] if more than one author: whom to contact for offprint requests.
7752 \begin_layout Itemize
7757 : [optional] mail address for contacts.
7760 \begin_layout Itemize
7768 Received: <date>; Accepted <date>
7771 \begin_layout Standard
7772 There is no need to issue the
7778 command, this is done automatically by \SpecialChar LyX
7779 when the header is finished.
7780 Although the order of the single header entries doesn't matter it is advised
7781 to keep the above sequence, just to get the best optics and meets the layout
7782 of the real document.
7785 \begin_layout Standard
7786 If you want to place footnotes in the header block, e.
7787 \begin_inset space \thinspace{}
7791 \begin_inset space \space{}
7794 to state your present address, just use the standard footnote via the menu
7797 Insert\SpecialChar menuseparator
7802 will automagically use the term
7811 \begin_layout Standard
7812 In addition to these topics, the macros use three additional \SpecialChar LaTeX
7814 have no counterpart in \SpecialChar LyX
7818 \begin_layout Itemize
7825 to separate different names for more than one author and institute, respectivel
7829 \begin_layout Itemize
7836 to mark corresponding author/institute pairs.
7837 The institutes are numbered sequentially as they appear in the
7841 field, so you have to put a marker to each author.
7844 \begin_layout Itemize
7851 to supply an email address for fast contact.
7854 \begin_layout Standard
7855 In all cases, the appropriate command has to be entered in \SpecialChar LyX
7863 \begin_layout Subsection
7867 \begin_layout Standard
7868 The abstract should immediately follow the header block.
7869 With version 5 the abstract environment was changed to a command, and there
7870 is now a resctriction to only one paragraph.
7871 In addition, it should contain an entry with the keywords.
7872 This is not yet implemented for \SpecialChar LyX
7873 , therefore you have to enter the \SpecialChar LaTeX
7881 by hand and mark it as \SpecialChar LaTeX
7883 Refer to the example paper.
7886 \begin_layout Subsection
7887 Supported environments
7890 \begin_layout Standard
7891 The A&A paper layout supports the following environments for structuring
7895 \begin_layout Itemize
7901 \begin_layout Itemize
7907 \begin_layout Itemize
7913 \begin_layout Itemize
7919 \begin_layout Itemize
7925 \begin_layout Itemize
7931 \begin_layout Itemize
7937 \begin_layout Itemize
7943 \begin_layout Itemize
7949 \begin_layout Itemize
7955 \begin_layout Itemize
7961 \begin_layout Itemize
7968 \begin_layout Subsection
7969 Commands not supported by \SpecialChar LyX
7973 \begin_layout Standard
7974 Some commands are not yet supported by the
7978 layout for \SpecialChar LyX
7980 Some have already been mentioned.
7981 For the sake of completeness, they are listed all together here:
7984 \begin_layout Itemize
7992 \begin_layout Itemize
8000 \begin_layout Itemize
8008 \begin_layout Itemize
8016 \begin_layout Itemize
8024 \begin_layout Itemize
8032 \begin_layout Itemize
8040 \begin_layout Itemize
8048 \begin_layout Standard
8049 If you want to use any of these commands, you have to enter them yourself.
8052 Do not forget to mark them as \SpecialChar LaTeX
8056 \begin_layout Subsection
8057 Figure and Table Floats
8060 \begin_layout Standard
8062 provides support for the necessary float environments
8064 figure, figure*, table
8070 , therefore we won't tell much about it here.
8074 \begin_inset space ~
8080 Just remember that tables should be left-aligned.
8081 For that, select the table and change the alignment in
8083 Edit\SpecialChar menuseparator
8085 \begin_inset space ~
8091 \begin_layout Standard
8092 There is only one special thing: the figures with caption besides the figure.
8093 To create such a figure, you have to do the following:
8096 \begin_layout Enumerate
8097 Create a wide figure float:
8099 Insert\SpecialChar menuseparator
8100 Float\SpecialChar menuseparator
8103 , then right click in the figure and select
8106 \begin_inset space ~
8114 \begin_layout Enumerate
8115 Enter your caption text.
8118 \begin_layout Enumerate
8123 to move the cursor above the caption.
8126 \begin_layout Enumerate
8130 \begin_layout Enumerate
8131 Position the cursor behind the figure and insert a horizontal fill:
8133 Insert\SpecialChar menuseparator
8135 \begin_inset space ~
8138 Character\SpecialChar menuseparator
8140 \begin_inset space ~
8148 \begin_layout Enumerate
8149 Switch to \SpecialChar LaTeX
8153 \begin_inset space ~
8161 \begin_layout Enumerate
8171 Do not close the brace!
8174 \begin_layout Enumerate
8175 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
8180 \begin_inset space ~
8192 \begin_layout Standard
8193 Also, refer to the figures in the example paper.
8196 \begin_layout Subsection
8200 \begin_layout Standard
8201 For submission, the paper has to be formated in a special double-spacing
8203 For this purpose, you have to give the option
8207 to the documentclass.
8208 This must be done using the extra class options field in the
8210 Document\SpecialChar menuseparator
8214 Just enter the string
8221 \begin_layout Subsection
8225 \begin_layout Standard
8230 directory contains an example paper written with \SpecialChar LyX
8232 It is the example paper from the original macro package, translated to
8235 Use it for inspiration, and compare the original \SpecialChar LaTeX
8236 code with \SpecialChar LyX
8240 \begin_layout Section
8245 \begin_layout Standard
8251 \begin_layout Subsection
8255 \begin_layout Standard
8257 is a set of macros produced by the American Astronomical Society to
8258 facilitate electronic manuscript submission to the three journals they
8259 publish: the Astrophysical Journal (including the Letters and Supplement),
8260 the Astronomical Journal, and the Publications of the Astronomical Society
8263 has proven to be an excellent tool for generating these documents, especially
8264 given its equation, citation, and figure handling capabilities.
8266 requires version 5.0 (or higher) of these macros; preferably 5.2, which
8267 is the version described here, or higher.
8268 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
8269 2.09 and are fundamentally
8270 incompatible with \SpecialChar LyX
8272 The AAS\SpecialChar TeX
8273 package may be downloaded from the AAS\SpecialChar TeX
8277 \begin_layout Standard
8278 \begin_inset VSpace medskip
8284 \begin_layout Standard
8286 \begin_inset Flex URL
8289 \begin_layout Plain Layout
8291 https://aas.org/aastex/aastex-downloads
8299 \begin_layout Standard
8300 \begin_inset VSpace medskip
8306 \begin_layout Standard
8307 A complete user guide is contained in that package and you should familiarize
8308 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
8311 will not reduce the need to figure out all the AAS\SpecialChar TeX
8312 commands, it will only
8313 reduce the drudgery of typing everything in.
8314 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
8316 completely to the requirements of the journal to which you are submitting
8320 \begin_layout Subsection
8321 Starting a New Paper
8324 \begin_layout Standard
8325 I strongly suggest that you start with the AAS\SpecialChar TeX
8329 File\SpecialChar menuseparator
8336 , enter the new file name, then choose the
8341 This will show the most common fields found in a manuscript.
8342 Simply overwrite the existing text (including the brackets,
8346 ) with the correct information.
8347 Many of the AAS\SpecialChar TeX
8348 commands and environments can be implemented directly in
8350 , but some cannot: most noticeably
8362 , which should stick out like a sore thumb if you actually just opened the
8364 For commands such as these, the \SpecialChar LaTeX
8365 code must be entered directly and marked
8367 Such commands are referred to as \SpecialChar TeX
8368 code, or Evil Red Text.
8369 I tried to minimize the amount of \SpecialChar TeX
8370 code needed in an AAS\SpecialChar TeX
8372 there is still a bit more required than any of us would like.
8375 \begin_layout Subsection
8376 Finishing Your Paper
8379 \begin_layout Standard
8380 When the paper is finished to your satisfaction and previews/prints correctly,
8382 \begin_inset Quotes eld
8386 \begin_inset Quotes erd
8389 actions which need to be done before you submit it to the journals.
8393 \begin_layout Enumerate
8394 Export your paper as a \SpecialChar LaTeX
8397 File\SpecialChar menuseparator
8398 Export\SpecialChar menuseparator
8406 \begin_layout Enumerate
8411 file with your favorite text editor
8415 \begin_layout Enumerate
8416 remove the comment lines before the
8425 \begin_layout Enumerate
8430 usepackage...{fontenc}
8432 line if it appears (usually just after
8447 \begin_layout Enumerate
8448 remove everything between (and including) the
8460 commands, except for any commands you specifically put into the \SpecialChar LaTeX
8462 (which should appear immediately after the
8463 \begin_inset Quotes eld
8466 User specified \SpecialChar LaTeX
8468 \begin_inset Quotes erd
8479 \begin_layout Enumerate
8480 Run the resulting file through \SpecialChar LaTeX
8481 to make sure it still processes correctly.
8484 \begin_layout Enumerate
8485 Reread the journal requirements to make sure your filenames and formats
8489 \begin_layout Enumerate
8493 \begin_layout Subsection
8494 Comments On Specific Commands
8497 \begin_layout Standard
8498 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
8505 ) gives a good description of each.
8506 Thus it's probably easiest for me to go down the list as found in the guide
8507 and offer comments where necessary.
8508 So let's begin \SpecialChar ldots
8512 \begin_layout Subsubsection
8513 Things that work as expected
8516 \begin_layout Standard
8517 Because they work as you might expect, I simply list them and the section
8618 begin{thebibliography}
8626 (2.13.2), all the cite commands and their variations (2.13.2), the generic
8627 graphicx figure commands (2.14.1),
8651 (2.15.4, amongst other places),
8678 \begin_layout Standard
8679 The following style options also work correctly:
8700 Simply put them in the
8706 Layout\SpecialChar menuseparator
8712 \begin_layout Subsubsection
8713 Things that work, but require more comment
8716 \begin_layout Standard
8717 The following items work, but require a little more discussion:
8720 \begin_layout Itemize
8721 These items are reserved for use by the journal editors, but you can put
8722 them into the \SpecialChar LaTeX
8723 preamble if you feel compelled to do so:
8756 \begin_layout Itemize
8757 These items may be placed in the \SpecialChar LaTeX
8758 preamble, and are included as blanks in
8780 \begin_layout Itemize
8787 (2.3) – can only be used
8788 \begin_inset Quotes eld
8792 \begin_inset Quotes erd
8795 , not in the middle of a paragraph.
8796 Use \SpecialChar TeX
8797 code if you need to embed it.
8800 \begin_layout Itemize
8807 (2.3) – will have extra {} after it.
8808 This should not cause an error.
8811 \begin_layout Itemize
8818 (2.6) – can only be used
8819 \begin_inset Quotes eld
8823 \begin_inset Quotes erd
8826 , not in the middle of a paragraph.
8827 Use \SpecialChar TeX
8828 code if you need to embed it.
8831 \begin_layout Itemize
8838 (2.8) – can't insert a cross-reference tag, you must type the tag name by
8842 \begin_layout Itemize
8856 \begin_layout Itemize
8863 (2.9) – will have extra {} after it.
8864 This should not cause an error.
8867 \begin_layout Itemize
8874 (2.11) – will have extra {} after it.
8875 This should not cause an error.
8878 \begin_layout Itemize
8885 (2.14.2) – you can insert an optional filename argument by placing the cursor
8886 at the beginning of the text and selecting
8888 Insert\SpecialChar menuseparator
8893 \begin_inset Quotes eld
8897 \begin_inset Quotes erd
8900 inserts an optional argument of the type needed by
8907 Hopefully it will be renamed someday.
8910 \begin_layout Itemize
8923 for the catalog ID optional parameter
8926 \begin_layout Itemize
8939 for the catalog ID optional parameter
8942 \begin_layout Subsubsection
8943 Things not implemented, use \SpecialChar TeX
8947 \begin_layout Standard
8970 setcounter{equation}
8972 (2.12), Journal name abbreviations (2.13.4),
9008 (2.15.4, insert it as the first element in the lefthand cell after where
9010 Don't use any of \SpecialChar LyX
9011 's rules in the table),
9023 (2.15.5), much of Misc (2.17, except
9074 \begin_layout Subsubsection
9075 Things that cannot be implemented
9078 \begin_layout Standard
9080 at least in any meaningful sort of way, so I suggest ignoring them.
9081 They are the references environment (2.13.3), and the deluxetable environment
9083 If you really, really need to use deluxetable, I suggest editing it in
9084 a separate file with a text editor, then using
9086 Insert\SpecialChar menuseparator
9088 \begin_inset space ~
9093 to include it in your \SpecialChar LyX
9099 file to see an example of this.
9102 \begin_layout Subsection
9103 FAQs, Tips, Tricks, and Other Ruminations
9106 \begin_layout Subsubsection
9107 Getting \SpecialChar LyX
9108 and AAS\SpecialChar TeX
9112 \begin_layout Standard
9113 It can be a bit tricky to get \SpecialChar LyX
9114 to recognize a new layout and document class.
9115 When all else fails, do this:
9118 \begin_layout Enumerate
9119 Make certain that \SpecialChar LaTeX
9120 can find AAS\SpecialChar TeX
9122 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
9124 directory completely unrelated to \SpecialChar LaTeX
9125 or AAS\SpecialChar TeX
9126 and run \SpecialChar LaTeX
9134 \begin_layout Enumerate
9139 appears in \SpecialChar LyX
9147 \begin_layout Enumerate
9150 Tools\SpecialChar menuseparator
9154 , then restart \SpecialChar LyX
9158 \begin_layout Enumerate
9159 Open a regular new file, not from a template.
9160 Does AAS\SpecialChar TeX
9161 appear in the class list in
9163 Document\SpecialChar menuseparator
9169 \begin_layout Standard
9170 If you get a warning from an existing AAS\SpecialChar TeX
9171 document about not being able
9172 to find the AAS\SpecialChar TeX
9173 layout or a message about
9174 \begin_inset Quotes eld
9177 You should not mix title layouts with normal ones
9178 \begin_inset Quotes erd
9181 , things haven't been installed correctly.
9184 \begin_layout Subsubsection
9186 error processing a table
9189 \begin_layout Standard
9191 , by default, attempts to center the table caption/title.
9192 This seems to produce a bad interaction in AAS\SpecialChar TeX
9193 so you should click somewhere
9194 in the caption/title, then select
9196 Edit\SpecialChar menuseparator
9198 \begin_inset space ~
9212 This took care of it for me.
9215 \begin_layout Subsubsection
9219 \begin_layout Standard
9220 A couple of things: 1) I have noticed some funny spacing in the reference
9221 entries in the text.
9222 When you enter the bibliography item data, make sure their is
9226 space between the last author and the parenthesis setting off the year;
9230 \begin_inset space \thinspace{}
9234 \begin_inset space \space{}
9248 2) Entering the references at all is not obvious.
9249 The easiest thing is to start typing your first reference at the end of
9250 the document, then mark it as type
9255 That will put a small gray box in front of what you just typed.
9256 Click on the box to fill in the rest of the information.
9257 For new references, go to the end of an existing reference and press return.
9258 That will create a new line with its own box, etc.
9261 \begin_layout Subsubsection
9265 \begin_layout Standard
9266 Even though AAS\SpecialChar TeX
9267 provides its own figure commands (
9273 , for example), I much prefer \SpecialChar LaTeX
9274 's standard figure commands (with the default
9283 \begin_inset space ~
9286 commands as \SpecialChar TeX
9287 code into a Figure Float box if you desire, but I never have
9288 much luck getting the layout right.
9289 With the standard graphics, \SpecialChar LyX
9294 usepackage{graphicx}
9296 command into the \SpecialChar LaTeX
9297 preamble and handle the figures in the standard \SpecialChar LaTeX2e
9299 interspersing the figures in the text.
9300 I believe ApJ accepts figures exactly this way now; AJ might still use
9302 \begin_inset Quotes eld
9305 stack everything at the end
9306 \begin_inset Quotes erd
9312 \begin_layout Subsubsection
9313 Things I could have done, but didn't
9316 \begin_layout Standard
9318 \begin_inset Quotes eld
9322 \begin_inset Quotes erd
9325 things I could have implemented, but chose not to.
9326 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
9328 even though it is double-spaced in the paper manuscript.
9329 Also, I chose not to make separate layouts for the preprint and preprint2
9331 Since I assume you will spend most of your time in the plain manuscript
9332 mode anyway, I decided not to chew up more disk space with this.
9336 \begin_layout Subsection
9340 \begin_layout Standard
9341 Your mileage may vary.
9342 I've now had papers published by both ApJ and AJ that have had 98% of the
9343 effort done in \SpecialChar LyX
9344 ; the last 2% was the \SpecialChar LaTeX
9345 post-processing and a few cleanups.
9346 I have had no trouble with the submission process, and I'm sure the journals
9347 were never aware that there might be a difference.
9348 So, go forth and publish!
9351 \begin_layout Section
9352 AMS \SpecialChar LaTeX
9356 \begin_layout Standard
9366 \begin_layout Standard
9367 \begin_inset VSpace bigskip
9373 \begin_layout Standard
9375 The AMS \SpecialChar LaTeX
9376 layouts are set up to conform to suggested styles for mathematical
9377 papers to be submitted to American Mathematical Society publications.
9378 The layouts are not tailored to a specific journal, but easily can be.
9379 You should refer to the AMS documentation for specific instructions for
9380 each journal (usually it will entail only changing a single line in the
9383 That documentation is available on the Web at
9384 \begin_inset Flex URL
9387 \begin_layout Plain Layout
9395 \begin_inset Flex URL
9398 \begin_layout Plain Layout
9400 ftp://ftp.ams.org/pub/tex/amslatex/
9406 These layouts are appropriate, and useful, for any mathematical writing.
9410 \begin_layout Standard
9411 There are two basic AMS \SpecialChar LaTeX
9415 \begin_layout Itemize
9416 amsart: The standard AMS article format.
9419 \begin_layout Itemize
9420 amsbook: the standard AMS book (really, monograph) format.
9424 \begin_layout Standard
9425 The layouts themselves contain only the minimum necessary to use the AMS
9427 They do not, in particular, contain any of the `theorem' environments used
9428 for setting theorems, lemmas, and the like.
9429 These are contained, instead, in the
9430 \begin_inset Flex Code
9433 \begin_layout Plain Layout
9439 module, which is loaded by default when you select one of the AMS classes.
9440 (It can also be used with other classes and can be removed, if you would
9441 rather use something else.) Less commonly used environments are in the
9442 \begin_inset Flex Code
9445 \begin_layout Plain Layout
9446 Theorems (AMS-Extended)
9451 module, which must be loaded manually.
9454 \begin_layout Standard
9455 By default, theorems and the like are numbered consecutively throughout
9456 the document, but this may be modified by loading the module
9457 \begin_inset Flex Code
9460 \begin_layout Plain Layout
9461 Theorems (Order by Section)
9466 or, if you are using
9467 \begin_inset Flex Code
9470 \begin_layout Plain Layout
9477 \begin_inset Flex Code
9480 \begin_layout Plain Layout
9481 Theorems (Order by Chapter)
9487 These will number the results as
9488 \begin_inset Formula $n.m$
9491 , where the first number refers to the section (or chapter) and the second
9492 refers to the total number of results so far in that section (or chapter).
9493 Many environments are also available unnumbered.
9494 These are indicated by an asterisk at the end.
9495 If you happen to want
9499 unnumbered results, the module
9500 \begin_inset Flex Code
9503 \begin_layout Plain Layout
9509 provides that option.
9512 \begin_layout Standard
9513 Note that these modules do not
9517 to be used with the AMS classes.
9518 It is perfectly possible to use the
9519 \begin_inset Flex Code
9522 \begin_layout Plain Layout
9528 module, and the others mentioned, with other classes, such as
9529 \begin_inset Flex Code
9532 \begin_layout Plain Layout
9539 \begin_inset Flex Code
9542 \begin_layout Plain Layout
9549 \begin_inset Flex Code
9552 \begin_layout Plain Layout
9561 \begin_layout Subsection
9562 What these layouts provide
9565 \begin_layout Standard
9566 There is a long list of included environments provided by these layouts.
9567 In AMS-\SpecialChar LaTeX
9568 , there is, in fact, an opportunity to define an unlimited variety
9569 of `theorem' environments.
9570 However, the AMS recommends the environments that are available in \SpecialChar LyX
9575 \begin_layout Standard
9576 The following environments—as well as the standard environments, such as
9578 \begin_inset Flex Noun
9581 \begin_layout Plain Layout
9588 \begin_inset Flex Noun
9591 \begin_layout Plain Layout
9598 \begin_inset Flex Noun
9601 \begin_layout Plain Layout
9608 \begin_inset Flex Noun
9611 \begin_layout Plain Layout
9618 \begin_inset Flex Noun
9621 \begin_layout Plain Layout
9628 \begin_inset Flex Code
9631 \begin_layout Plain Layout
9638 \begin_inset Flex Code
9641 \begin_layout Plain Layout
9650 \begin_layout Description
9651 Address This should be the author's permanent address.
9654 \begin_layout Description
9656 \begin_inset space ~
9659 Address This should be the author's temporary address at the time of submission,
9660 if different from the Address.
9663 \begin_layout Description
9664 Email Author's e-mail address
9667 \begin_layout Description
9668 URL Author's Web address, if desired.
9671 \begin_layout Description
9672 Keywords Key words or phrases used to identify specific topics discussed
9676 \begin_layout Description
9677 Subjectclass These refer to the AMS Subject Classifications, published and
9680 Mathematical Reviews
9683 These are also available online at the AMS cites listed above.
9686 \begin_layout Description
9690 \begin_layout Description
9694 \begin_layout Description
9698 \begin_layout Standard
9699 The following environments are provided by both the
9700 \begin_inset Flex Code
9703 \begin_layout Plain Layout
9710 \begin_inset Flex Code
9713 \begin_layout Plain Layout
9719 modules, in the latter case in both starred (unnumbered) and unstarred
9720 (numbered) versions.
9721 These same environments are provided only in the starred versions by the
9723 \begin_inset Flex Code
9726 \begin_layout Plain Layout
9735 \begin_layout Theorem
9736 This is typically used for the statements of major results.
9740 \begin_layout Corollary*
9741 This is used for statements which follow fairly directly from previous statement
9743 Again, these can be major results.
9748 These are smaller results needed to prove other statements.
9751 \begin_layout Proposition
9752 These are less major results which (hopefully) add to the general theory
9756 \begin_layout Conjecture
9757 These are statements provided without justification, which the author does
9758 not know how to prove, but which seem to be true (to the author, at least).
9761 \begin_layout Definition*
9762 Guess what this is for.
9763 The font is different for this environment than for the previous ones.
9767 \begin_layout Example*
9768 Used for examples illustrating proven results.
9771 \begin_layout Problem
9772 It's not really known what this is for.
9773 You should figure it out.
9776 \begin_layout Exercise*
9777 Write a description for this one.
9780 \begin_layout Remark
9781 This environment is also a type of theorem, usually a lesser sort of observation.
9784 \begin_layout Claim*
9785 Often used in the course of giving a proof of a larger result.
9789 Generally, these are used to break up long arguments, using specific instances
9795 The numbering scheme for cases is on its own, not together with other numbered
9801 At the end of this environment, a QED symbol (usually a square, but it can
9802 vary with different styles) is placed.
9803 If you want to have other environments within this one—for example, Case
9804 environments—and have the QED symbol appear only after them, then the other
9805 environments need to be nested within the proof environment.
9808 Nesting Environments
9814 for information on nesting.
9817 \begin_layout Standard
9818 And these environments are provided by
9819 \begin_inset Flex Code
9822 \begin_layout Plain Layout
9823 Theorems (AMS-Extended)
9831 \begin_layout Criterion*
9832 A required condition.
9835 \begin_layout Algorithm*
9836 A general procedure to be used.
9839 \begin_layout Axiom*
9840 This is a property or statement taken as true within the system being discussed.
9843 \begin_layout Condition*
9844 Sometimes used to state a condition assumed within the present context of
9849 Similar to a Remark.
9852 \begin_layout Notation*
9853 Used for the explanation of, yes, notation.
9856 \begin_layout Summary
9857 Do we really need to tell you?
9860 \begin_layout Acknowledgement*
9864 \begin_layout Conclusion*
9865 Sometimes used at the end of a long train of argument.
9869 Used in a way similar to Proposition, though perhaps lower on the scale.
9872 \begin_layout Standard
9873 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
9876 They need to be available on your system in order to use these environments.
9879 \begin_layout Section
9887 \begin_layout Standard
9893 \begin_layout Subsection
9897 \begin_layout Standard
9898 These are the layout files for some of the journals of the American Geophysical
9900 It is assumed that you have both the AGU's own class files and AGUplus
9901 installed (everything to be found at
9902 \begin_inset Flex URL
9905 \begin_layout Plain Layout
9907 http://publications.agu.org/files/2013/08/AGU-LaTeX.zip
9915 \begin_layout Subsection
9919 \begin_layout Standard
9929 They are still called this in the \SpecialChar LyX
9930 GUI, though their \SpecialChar LaTeX
9943 \begin_layout Standard
9944 Newly defined styles are
9981 These are mostly manuscript attributes and defined in the AGU class documentati
9985 \begin_layout Standard
9986 I suspect this is still badly incomplete.
9989 \begin_layout Subsection
9993 \begin_layout Standard
10010 \begin_layout Subsection
10014 \begin_layout Itemize
10017 Journal of Geophysical Research
10026 \begin_layout Standard
10027 Add your own, it isn't so hard! Look at the
10038 \begin_layout Subsection
10039 Bugs and things to remember
10042 \begin_layout Standard
10043 In order to use the new layouts, you must remember to do the following for
10047 \begin_layout Enumerate
10053 This can be done in the
10055 Layout\SpecialChar menuseparator
10060 Document\SpecialChar menuseparator
10064 (AGU articles are always in English, right? So
10068 choose a language.)
10071 \begin_layout Enumerate
10076 into the document's
10081 (Yes, this is a bug.)
10084 \begin_layout Enumerate
10085 Make sure you use the
10089 bibliography style, by entering
10093 into the second field of the Bib\SpecialChar TeX
10095 None of the standard styles will do.
10098 \begin_layout Section
10102 \begin_layout Standard
10108 \begin_layout Subsection
10112 \begin_layout Standard
10113 Broadway is for writing plays.
10114 The format is more decorative than Hollywood, and much less standardized.
10115 This format should be suitable for workshops.
10118 \begin_layout Subsection
10122 \begin_layout Standard
10123 The same as in Hollywood.
10126 \begin_layout Subsection
10130 \begin_layout Standard
10135 names as labels then cross-reference the label to insert the name.
10136 The cross-reference dialog will show the current cast of characters.
10139 \begin_layout Subsection
10140 Paper size and Margins
10143 \begin_layout Standard
10144 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
10147 \begin_layout Subsection
10151 \begin_layout Standard
10152 The following environments are available.
10153 You can use broadway.bind to get the bind keys shown at the right.
10156 \begin_layout Itemize
10160 \begin_inset Newline newline
10165 You should not have to use this, but it is here for anything that does not
10169 \begin_layout Itemize
10173 \begin_inset space \hfill{}
10177 \begin_inset Newline newline
10182 Used to describe stage setting and the action.
10183 First use of speaker names in all CAPs.
10186 \begin_layout Itemize
10190 \begin_inset space \hfill{}
10194 \begin_inset Newline newline
10199 Automatically numbered.
10200 On screen it will be arabic, but will print as Roman.
10203 \begin_layout Itemize
10207 \begin_inset space \hfill{}
10211 \begin_inset Newline newline
10221 It is just centered text.
10224 \begin_layout Itemize
10228 \begin_inset space \hfill{}
10232 \begin_inset Newline newline
10237 Not automatically numbered.
10238 You supply the number.
10239 This is because I couldn't figure out how.
10242 \begin_layout Itemize
10246 \begin_inset space \hfill{}
10250 \begin_inset Newline newline
10255 A special case of Narrative to describe the setting and action as the curtain
10259 \begin_layout Itemize
10263 \begin_inset space \hfill{}
10267 \begin_inset Newline newline
10272 The speaker's (actor's) title, centered in all CAPS.
10275 \begin_layout Itemize
10279 \begin_inset space \hfill{}
10283 \begin_inset Newline newline
10288 Instructions to the speaker.
10289 The parentheses are automatically inserted.
10290 The ( will appear on screen, but both will be in the printed play.
10291 This environment is only used within
10298 \begin_layout Itemize
10302 \begin_inset space \hfill{}
10306 \begin_inset Newline newline
10311 What the Speaker says.
10314 \begin_layout Itemize
10318 \begin_inset space \hfill{}
10322 \begin_inset Newline newline
10327 The curtain comes down.
10330 \begin_layout Itemize
10334 \begin_inset space \hfill{}
10340 \begin_layout Itemize
10344 \begin_inset space \hfill{}
10350 \begin_layout Itemize
10354 \begin_inset space \hfill{}
10360 \begin_layout Standard
10364 \begin_layout Section
10368 \begin_layout Standard
10373 can be used to type letters according to German conventions.
10374 A template file is included in
10376 .../lyx/share/templates
10378 for you to use as a starting point.
10381 \begin_layout Section
10389 \begin_layout Standard
10395 \begin_layout Subsection
10399 \begin_layout Standard
10400 This is the layout file for the European Geophysical Society journals.
10405 can be downloaded from the web site of the EGS under
10406 \begin_inset Flex URL
10409 \begin_layout Plain Layout
10419 \begin_layout Subsection
10423 \begin_layout Standard
10426 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
10434 The current layout file is unfortunately very unmodular and would benefit
10435 from using the various
10442 \begin_layout Section
10446 \begin_layout Standard
10447 See the \SpecialChar LyX
10453 It contains all infos you need.
10456 \begin_layout Section
10459 Foil\SpecialChar TeX
10463 \begin_inset CommandInset label
10472 \begin_layout Standard
10478 \begin_layout Subsection
10482 \begin_layout Standard
10483 This section describes how to use \SpecialChar LyX
10484 to make slides for overhead projectors.
10485 There are two document classes that can do this: the default slides class
10488 Foil\SpecialChar TeX
10492 This section documents the latter.
10495 \begin_layout Standard
10496 I'm going to say this again, nice and clear, so that there's no misunderstanding
10500 \begin_layout Standard
10501 \begin_inset VSpace bigskip
10507 \begin_layout Standard
10511 This section documents the class
10512 \begin_inset Quotes eld
10520 \begin_inset Quotes erd
10528 \begin_layout Standard
10529 \begin_inset VSpace bigskip
10535 \begin_layout Standard
10536 If you're looking for the documentation for
10537 \begin_inset Quotes eld
10545 \begin_inset Quotes erd
10548 , check out section
10549 \begin_inset space ~
10553 \begin_inset CommandInset ref
10555 reference "sec:slitex"
10560 If your machine doesn't have the
10568 installed, you'll probably have to use the default
10572 class, which isn't quite as good as
10577 \begin_layout Standard
10582 class is designed for use with version
10583 \begin_inset space ~
10591 class file which is now an integral part of \SpecialChar LaTeX2e
10595 \begin_layout Subsection
10599 \begin_layout Standard
10600 Obviously, to use this document class, you need to select
10611 \begin_inset space ~
10617 There are some settings in the
10620 \begin_inset space ~
10625 dialog that you should know about that are specific to this class:
10628 \begin_layout Itemize
10629 Don't change the options
10640 \begin_inset space ~
10646 They're ignored by the
10653 \begin_layout Itemize
10654 The default font size is 20
10655 \begin_inset space \thinspace{}
10658 pt with the other options being 17
10659 \begin_inset space \thinspace{}
10663 \begin_inset space \thinspace{}
10667 \begin_inset space \thinspace{}
10673 \begin_layout Itemize
10674 The default font is
10682 but all math equations are still typeset in the usual roman font.
10685 \begin_layout Itemize
10688 Foil\SpecialChar TeX
10691 supports A4 and Letter paper sizes as well as a special size for working
10693 \begin_inset space \thinspace{}
10697 It doesn't support A5, B5, legal or executive paper sizes.
10700 \begin_layout Itemize
10701 Don't bother changing the
10705 settings because they are ignored anyway.
10706 All floats appear where they are defined in the text.
10709 \begin_layout Itemize
10714 setting behaves a bit differently for this class.
10717 Foil\SpecialChar TeX
10720 provides extensive footer and header capabilities including a user-defined
10723 \begin_inset space ~
10727 \begin_inset CommandInset ref
10729 reference "sec:foilfoot"
10734 The title page is treated differently to all other pages in the document
10743 has the logo centered at the bottom of the page (if one is defined).
10744 The possible page style choices and what they do are as follows:
10748 \begin_layout Labeling
10749 \labelwidthstring MMMMMMM
10756 The final output contains no page numbers, or other headers or footers
10757 (except footnotes of course).
10761 \begin_layout Labeling
10762 \labelwidthstring MMMMMMM
10769 The final output contains page numbers centered at the bottom of the page.
10770 No other headings or footers (other than footnotes).
10773 \begin_layout Labeling
10774 \labelwidthstring MMMMMMM
10779 Page numbers in lower right corner.
10780 Additional headers and footers are also shown.
10781 This is also the default.
10784 \begin_layout Labeling
10785 \labelwidthstring MMMMMMM
10790 Gives you access to the
10794 package although its use with
10796 Foil\SpecialChar TeX
10799 is discouraged by the writer of the
10801 Foil\SpecialChar TeX
10804 package because of some potential page layout clashes.
10808 \begin_layout Subsubsection
10812 \begin_layout Standard
10813 The following options may be used in the extra class options in the
10815 Document\SpecialChar menuseparator
10821 \begin_layout Labeling
10822 \labelwidthstring MMMMMMx
10827 This sets up the page layout for 7.33
10828 \begin_inset space \thinspace{}
10832 \begin_inset space \thinspace{}
10835 in paper, which is about the same aspect ratio as a 35
10836 \begin_inset space \thinspace{}
10839 mm slide, making it a bit easier to work with this medium.
10842 \begin_layout Labeling
10843 \labelwidthstring MMMMMMx
10848 Places a rule across the page below the header on every page except the
10852 \begin_layout Labeling
10853 \labelwidthstring MMMMMMx
10858 Places a rule across the page above the footer on every page except the
10862 \begin_layout Labeling
10863 \labelwidthstring MMMMMMx
10868 This is automatically set each time you create a new
10875 Foil\SpecialChar TeX
10878 to use the dvips driver to rotate those pages that are set as landscape
10882 \begin_layout Labeling
10883 \labelwidthstring MMMMMMx
10888 Simply changes the page dimensions to those of a landscape page but doesn't
10890 Thus if you use this option you need to use an external program to rotate
10891 each page or feed your paper through your printer as landscape.
10892 Note that this option effectively reverses the roles of the
10900 environments (don't worry these are described in the next section).
10903 \begin_layout Labeling
10904 \labelwidthstring MMMMMMx
10909 Equation numbers on the left.
10912 \begin_layout Labeling
10913 \labelwidthstring MMMMMMx
10918 Flush-left equations.
10921 \begin_layout Subsection
10922 Supported Environments
10925 \begin_layout Standard
10926 Most of the environments commonly supported in other classes are also supported
10932 There are several additional environments provided by
10934 Foil\SpecialChar TeX
10937 as well as a couple added by \SpecialChar LyX
10939 The following environments are shared with other classes:
10942 \begin_layout Standard
10943 \begin_inset Flex Multiple Columns
10946 \begin_layout Itemize
10952 \begin_layout Itemize
10958 \begin_layout Itemize
10964 \begin_layout Itemize
10970 \begin_layout Itemize
10976 \begin_layout Itemize
10983 \begin_layout Itemize
10989 \begin_layout Itemize
10995 \begin_layout Itemize
11001 \begin_layout Itemize
11007 \begin_layout Itemize
11013 \begin_layout Itemize
11019 \begin_layout Itemize
11025 \begin_layout Itemize
11031 \begin_layout Itemize
11037 \begin_layout Itemize
11043 \begin_layout Itemize
11049 \begin_layout Itemize
11060 \begin_layout Standard
11061 That is, all the major environments apart from the sectioning environments.
11062 Since foils are essentially self-contained sections, with a title and body,
11065 Foil\SpecialChar TeX
11068 provides specific commands for starting new foils and these are:
11071 \begin_layout Itemize
11077 \begin_layout Itemize
11083 \begin_layout Standard
11085 also provides slightly modified versions of these two environments called:
11088 \begin_layout Itemize
11094 \begin_layout Itemize
11097 ShortRotatefoilhead
11100 \begin_layout Standard
11101 and the differences will be explained in the next section.
11104 \begin_layout Standard
11105 Since foils are often used in presenting ideas or new theorems and such
11108 Foil\SpecialChar TeX
11111 also provides a comprehensive box of goodies for presenting them:
11114 \begin_layout Standard
11115 \begin_inset Flex Multiple Columns
11118 \begin_layout Itemize
11124 \begin_layout Itemize
11130 \begin_layout Itemize
11136 \begin_layout Itemize
11142 \begin_layout Itemize
11148 \begin_layout Itemize
11154 \begin_layout Itemize
11160 \begin_layout Itemize
11166 \begin_layout Itemize
11172 \begin_layout Itemize
11178 \begin_layout Itemize
11189 \begin_layout Standard
11190 The starred versions are unnumbered while the unstarred versions are numbered.
11191 There are also two list environments added by \SpecialChar LyX
11195 \begin_layout Itemize
11201 \begin_layout Itemize
11207 \begin_layout Standard
11210 Foil\SpecialChar TeX
11213 provides some powerful header and footer capabilities that are best set
11214 in the preamble although they may be set at any point in a document.
11215 If you want to change these settings in your document the best place to
11216 do so is at the very top of a foil, i.
11217 \begin_inset space \thinspace{}
11223 \begin_inset space \space{}
11228 straight after the foilhead.
11231 \begin_layout Standard
11232 For this purpose, the following command styles are provided [
11239 \begin_layout Standard
11240 \begin_inset Flex Multiple Columns
11243 \begin_layout Itemize
11247 \begin_inset space ~
11253 \begin_layout Itemize
11259 \begin_layout Itemize
11263 \begin_inset space ~
11269 \begin_layout Itemize
11273 \begin_inset space ~
11279 \begin_layout Itemize
11283 \begin_inset space ~
11290 \begin_layout Plain Layout
11291 \begin_inset space ~
11303 \begin_layout Standard
11304 There are also a few commands provided by
11306 Foil\SpecialChar TeX
11309 that aren't directly supported by \SpecialChar LyX
11310 but I'll tell you what they do and how
11311 to use them in section
11312 \begin_inset space ~
11316 \begin_inset CommandInset ref
11318 reference "sec:unsuppfoils"
11325 \begin_layout Subsection
11326 Building a Set of Foils
11329 \begin_layout Standard
11330 This section will give a simple introduction to using the different environments
11331 to build a set of foils.
11332 If you want to see an example set of foils, take a look at the
11336 file you find in \SpecialChar LyX
11344 \begin_layout Subsubsection
11345 Give It a Title Page
11348 \begin_layout Standard
11349 Unlike other classes that provide
11369 creates the title on a page of its own.
11370 If you leave out the
11374 environment \SpecialChar LaTeX
11375 will substitute the current date (every time you regenerate
11379 \begin_layout Subsubsection
11383 \begin_layout Standard
11384 As I mentioned earlier, there are four ways of starting a new foil.
11385 For portrait foils you should use
11394 The difference between these two environments is the amount of space between
11395 the title of the foil (the foilhead) and the body of the foil.
11398 \begin_layout Standard
11399 Landscape foils are generated using the
11405 ShortRotatefoilhead
11408 Again the only difference is the spacing between foilhead and body.
11409 Both of the short versions have 0.5
11410 \begin_inset space ~
11413 inches less separation between the foilhead and the body.
11417 \begin_layout Standard
11418 One problem with the support for landscape foils is the requirement that
11419 you have to use the
11423 driver to generate the PostScript output otherwise the foils won't be rotated.
11424 It is possible to get landscape foils even if you haven't got the
11428 driver provided you can feed your foils sideways through your printer ;-)
11431 \begin_layout Subsubsection
11432 Theorems, Lemmas, Proofs and more
11435 \begin_layout Standard
11436 Due to a small bug in \SpecialChar LyX
11437 you can't have two of the same type of these environments
11438 directly following each other.
11439 They must be separated by something.
11440 If you try, you will just be extending the previous environment as if you
11441 had merged the two environments together.
11442 So, how do you get around this problem? The simplest option is to insert
11443 some text between the two environments or add a
11448 environment between the two with just a
11449 \begin_inset Quotes eld
11457 \begin_inset Quotes erd
11461 This will force \SpecialChar LyX
11462 to produce two separate environments and hence the correct
11465 An example is provided in the example file included with the \SpecialChar LyX
11467 Remember, this problem only occurs if you are trying to place two of the
11468 same type of theorem-like environments one directly after the other.
11471 \begin_layout Subsubsection
11475 \begin_layout Standard
11476 You get all the commonly supported list styles found in other classes as
11477 well as two new ones.
11478 I'll only describe the new ones here.
11479 If you want to find out more about the other list environments check out
11485 If you intend to use itemized lists you might also want to read about the
11489 \begin_inset space ~
11493 \begin_inset space ~
11498 dialog described above in section
11499 \begin_inset space ~
11503 \begin_inset CommandInset ref
11505 reference "sec:bullet"
11512 \begin_layout Standard
11513 The two new list styles,
11521 , are designed to make it easier for you to create lists of do's and don'ts
11522 or right and wrong by providing dedicated environments that use a tick
11523 or a cross as the label of the list.
11524 These lists are in fact dedicated variants of the
11529 They do however require that you have the
11533 packages installed.
11536 \begin_layout Subsubsection
11540 \begin_layout Standard
11543 Foil\SpecialChar TeX
11546 redefines the floating tables and figures so that they appear exactly where
11547 they are in the text rather than pushing them to the top of the page or
11548 to some user specified location.
11549 In fact if you change the float placement settings they are simply ignored.
11552 \begin_layout Subsubsection
11553 Page Headers and Footers
11554 \begin_inset CommandInset label
11556 name "sec:foilfoot"
11563 \begin_layout Standard
11567 \begin_inset space ~
11576 are two commands used to control the left-footer text string.
11577 The first is meant to allow you to include a graphic logo on your foils
11579 \begin_inset Quotes eld
11584 Foil\SpecialChar TeX
11588 \begin_inset Quotes erd
11592 While the second is meant to provide a classification for the audience,
11596 \begin_inset space \thinspace{}
11602 \begin_inset space \space{}
11606 It is empty by default.
11609 \begin_layout Standard
11610 The remaining page corners can be filled by
11613 \begin_inset space ~
11618 (which defaults to page numbers),
11621 \begin_inset space ~
11629 \begin_inset space ~
11637 \begin_layout Subsection
11640 Foil\SpecialChar TeX
11644 \begin_inset CommandInset label
11646 name "sec:unsuppfoils"
11653 \begin_layout Standard
11654 All the commands mentioned below need to be set in a
11664 within another environment.
11667 \begin_layout Subsubsection
11671 \begin_layout Standard
11672 All lengths are adjusted using the
11695 should be replaced by the name given to the length you want to change and
11700 is the length value.
11701 All lengths should be specified in units of length such as inches (
11713 ) or relative to some document or font-based length such as
11723 \begin_layout Standard
11724 It's possible to change the spacing between a foilhead and the body of the
11725 foil by adjusting the length specified by
11732 For example, to make
11737 \begin_inset space \space{}
11740 in closer to their bodies put the following in the preamble:
11746 foilheadskip}{-0.5in}
11749 \begin_layout Standard
11750 The spacings around floats can be adjusted by setting these lengths:
11753 \begin_layout Labeling
11754 \labelwidthstring MMMMMMMMMMM
11761 Separation between the text and the top of the float
11764 \begin_layout Labeling
11765 \labelwidthstring MMMMMMMMMMM
11772 Separation between the float and the caption
11775 \begin_layout Labeling
11776 \labelwidthstring MMMMMMMMMMM
11783 Separation between the caption and the following text
11786 \begin_layout Labeling
11787 \labelwidthstring MMMMMMMMMMM
11794 You can make the captions narrower than the surrounding text by adjusting
11796 Best done relative to
11805 \begin_layout Standard
11806 There are also several title page related lengths that you may find useful
11807 if you have a long title or several authors:
11810 \begin_layout Labeling
11811 \labelwidthstring MMMMMMMMMMM
11818 Separation from headers to
11823 \begin_layout Labeling
11824 \labelwidthstring MMMMMMMMMMM
11842 \begin_layout Labeling
11843 \labelwidthstring MMMMMMMMMMM
11857 \begin_layout Labeling
11858 \labelwidthstring MMMMMMMMMMM
11874 \begin_layout Labeling
11875 \labelwidthstring MMMMMMMMMMM
11891 \begin_layout Standard
11892 The last length related command affects all the list environments.
11903 a list environment then all the vertical spacing between the list items
11905 Note that this is a command not a length so it doesn't require
11911 like the stuff mentioned above.
11914 \begin_layout Subsubsection
11915 Headers and Footers
11918 \begin_layout Standard
11931 commands control whether the logo in the
11935 definition appear on a given page.
11942 in the preamble then none of the foils will have the logo on them.
11943 If you don't want the logo on a particular page place the
11949 directly after the foilhead of that page and the
11955 directly after the next foilhead.
11958 \begin_layout Standard
11959 If you decide to use the
11963 page style setting in the
11966 \begin_inset space ~
11971 dialog you should probably add
11981 to your preamble so headers and footers on landscape pages are correctly
11982 placed when rotated.
11983 This is due to some clashes between the page layouts provided by the
11994 \begin_layout Section
11995 Hollywood (Hollywood spec scripts)
11998 \begin_layout Standard
12004 \begin_layout Subsection
12008 \begin_layout Standard
12009 Getting the format of a Hollywood script right is a
12010 \begin_inset Quotes eld
12014 \begin_inset Quotes erd
12017 It is designed to make the readers focus on content and to be easy and
12018 familiar for the actors to read.
12019 Each page of a script should be one minute of film.
12020 Nothing goes in a script that you cannot see or hear on screen.
12021 The courier 12 pt font should be used throughout.
12025 \begin_layout Subsection
12029 \begin_layout Standard
12030 Speakers' lines should NEVER break in mid-sentence.
12031 If a speaker's lines continue over a page break, repeat the
12035 title followed by (Cont'd).
12038 \begin_layout Subsection
12042 \begin_layout Standard
12047 names as labels then cross-reference the label to insert the name.
12048 The cross-reference dialog will show the current cast of characters.
12049 You can use this to insert the speaker name in narratives also.
12052 \begin_layout Subsection
12053 Paper size and Margins
12056 \begin_layout Standard
12057 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12060 \begin_layout Subsection
12064 \begin_layout Standard
12065 The following environments are available.
12066 You can use hollywood.bind to get the bind keys shown at the right.
12069 \begin_layout Itemize
12073 \begin_inset Newline newline
12078 Used where nothing else works.
12082 \begin_layout Itemize
12088 \begin_inset space \hfill{}
12096 \begin_inset Newline newline
12099 Usually followed by something like
12100 \begin_inset Quotes eld
12103 on Sally waking up.
12104 \begin_inset Quotes erd
12110 \begin_layout Itemize
12114 \begin_inset space \hfill{}
12118 \begin_inset Newline newline
12123 Introduces a new INTERIOR camera set-up.
12124 Always followed by DAY or NIGHT, or something similar to define the lighting
12126 Everthing on this line in CAPS.
12129 \begin_layout Itemize
12133 \begin_inset space \hfill{}
12137 \begin_inset Newline newline
12142 Introduces a new EXTERIOR camera set-up.
12143 Everthing on this line in CAPS.
12146 \begin_layout Itemize
12150 \begin_inset space \hfill{}
12154 \begin_inset Newline newline
12159 The character speaking.
12162 \begin_layout Itemize
12166 \begin_inset space \hfill{}
12170 \begin_inset Newline newline
12175 Instructions to the speaker.
12176 The () are automatically inserted, but only the ( will show in \SpecialChar LyX
12178 Both will be printed.
12181 \begin_layout Itemize
12185 \begin_inset space \hfill{}
12189 \begin_inset Newline newline
12201 \begin_layout Itemize
12205 \begin_inset space \hfill{}
12209 \begin_inset Newline newline
12214 Camera movement instruction.
12216 \begin_inset space \thinspace{}
12220 \begin_inset space \space{}
12226 \begin_layout Itemize
12230 \begin_inset space \hfill{}
12236 \begin_layout Itemize
12240 \begin_inset space \hfill{}
12246 \begin_layout Itemize
12250 \begin_inset space \hfill{}
12256 \begin_layout Itemize
12260 \begin_inset space \hfill{}
12266 \begin_layout Subsection
12270 \begin_layout Itemize
12274 \begin_layout Itemize
12278 \begin_layout Itemize
12280 \begin_inset space \thinspace{}
12287 \begin_layout Itemize
12292 \begin_layout Itemize
12293 PAN — camera movement
12296 \begin_layout Itemize
12297 INSERT — cut to close-up of
12300 \begin_layout Section
12304 \begin_layout Standard
12307 Panayotis Papasotiriou
12310 \begin_layout Subsection
12314 \begin_layout Standard
12315 The ijmpc package is a set of macros that facilitates electronic manuscript
12318 International Journal of Modern Physics C
12321 Similarly, the ijmpd package is for creating manuscripts to be submitted
12324 International Journal of Modern Physics D
12327 Both journals are published by World Scientific.
12328 The corresponding document classes are named
12337 These files, together with instructions for the authors, can be downloaded
12339 \begin_inset Flex URL
12342 \begin_layout Plain Layout
12344 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
12350 \begin_inset Flex URL
12353 \begin_layout Plain Layout
12355 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
12361 Both packages are modified versions of the standard
12362 \begin_inset Quotes eld
12366 \begin_inset Quotes erd
12369 package, and they are almost (but not exactly) identical.
12370 Most of their features are supported by \SpecialChar LyX
12372 I have used \SpecialChar LyX
12373 successfully to write articles submitted to both journals
12374 without any problem.
12377 \begin_layout Subsection
12381 \begin_layout Standard
12382 As usual, the easiest way to write a paper is to start with a template.
12385 File\SpecialChar menuseparator
12401 This will give an (almost) empty document that includes the most common
12402 fields found in a manuscript.
12403 Simply overwrite the existing text (including the brackets,
12408 You should keep in mind the following remarks.
12411 \begin_layout Enumerate
12413 won't let you change the font size and the page style of the document,
12414 because such modifications are not allowed by both packages.
12417 \begin_layout Enumerate
12418 The language of the document should not be changed.
12419 Before previewing your paper, be sure that the babel package is not used.
12420 To do this, click on
12422 Tools\SpecialChar menuseparator
12433 checkbox in the language settings, and click on
12441 , if you wish to make this change permanent).
12444 \begin_layout Enumerate
12446 \begin_inset Quotes eld
12450 \begin_inset Quotes erd
12453 style must be used to define keywords.
12456 \begin_layout Enumerate
12457 The ijmpc package provides a style named
12458 \begin_inset Quotes eld
12461 Classification Codes
12462 \begin_inset Quotes erd
12465 , which can be used to define classification codes, such as PACS numbers.
12466 Note that this facility is not supported by the ijmpd package.
12469 \begin_layout Enumerate
12470 Several new environments are available:
12471 \begin_inset Quotes eld
12475 \begin_inset Quotes erd
12479 \begin_inset Quotes eld
12483 \begin_inset Quotes erd
12487 \begin_inset Quotes eld
12491 \begin_inset Quotes erd
12495 \begin_inset Quotes eld
12499 \begin_inset Quotes erd
12503 \begin_inset Quotes eld
12507 \begin_inset Quotes erd
12511 \begin_inset Quotes eld
12515 \begin_inset Quotes erd
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 Their use is more or less obvious.
12585 supports all these environments; it will use the proper label, text style,
12586 and numbering scheme for each of them.
12589 \begin_layout Enumerate
12590 Both packages use basic citations; the natbib package should not be used.
12591 In \SpecialChar LyX
12592 , citation references are shown as usual; in the output, citations are
12593 shown as superscripts.
12594 If you want to use a citation as normal text, you should use the
12599 \begin_inset space \thinspace{}
12603 \begin_inset space \space{}
12607 \begin_inset Quotes eld
12611 \begin_inset space \space{}
12621 \begin_inset Quotes erd
12627 \begin_layout Enumerate
12629 \begin_inset Quotes eld
12633 \begin_inset Quotes erd
12636 section in both packages.
12637 To put acknowledgments, just use the
12638 \begin_inset Quotes eld
12642 \begin_inset Quotes erd
12648 \begin_layout Enumerate
12649 Appendices may be added to the paper,
12653 the Acknowledgments and
12659 provides a special environment, called
12660 \begin_inset Quotes eld
12664 \begin_inset Quotes erd
12667 which marks the beginning of the appendices.
12668 This environment should be left blank; it just sends a \SpecialChar LaTeX
12669 command, but nothing
12671 In \SpecialChar LyX
12673 \begin_inset Quotes eld
12677 \begin_inset Quotes erd
12680 is printed with blue letters, as a signal that all sections after that
12681 point are appendices.
12682 To write an appendix, use the
12683 \begin_inset Quotes eld
12687 \begin_inset Quotes erd
12692 will number each appendix with capital letters, as required by both journals.
12694 \begin_inset Quotes eld
12698 \begin_inset Quotes erd
12705 be present before the first appendix; if not, all appendices will be numbered
12706 as normal sections in the output.
12709 \begin_layout Enumerate
12710 The ijmpc and the ijmpd packages use the
12714 command to implement table captions.
12715 As a result, a table created by \SpecialChar LyX
12716 is printed correctly, but its caption
12718 However, you can use some \SpecialChar TeX
12719 code to overcome this problem, so that captions
12720 are printed as expected.
12721 To do so, create a float table as usual, remove the caption, and replace
12722 it with the \SpecialChar TeX
12733 (sic); you must also the \SpecialChar TeX
12738 immediately after the tabular material.
12739 Study the example table included in the template files to see how this
12740 trick is implemented.
12741 Alternatively, If you need table captions, you should implement the whole
12746 file, then include this file to the \SpecialChar LyX
12749 Insert\SpecialChar menuseparator
12750 File\SpecialChar menuseparator
12752 \begin_inset space ~
12758 Details on how to create a table float can be found in the files
12766 , included in the corresponding packages.
12769 \begin_layout Subsection
12770 Preparing a paper for submission
12773 \begin_layout Standard
12774 Before you submit your paper you must export the \SpecialChar LyX
12775 document as a \SpecialChar LaTeX
12778 File\SpecialChar menuseparator
12779 Export\SpecialChar menuseparator
12787 \begin_layout Plain Layout
12788 Actually you have the choice between \SpecialChar LaTeX
12789 (plain) and pdflatex.
12790 If you intend to use pdflatex to prepare the paper, you should use the
12791 pdflatex option so that included graphics are converted to PDF format,
12792 ready for use by pdflatex.
12797 , then make the following changes to the resulting
12804 \begin_layout Enumerate
12805 Remove the comment lines before the
12814 \begin_layout Enumerate
12815 Remove everything between (and including) the
12827 commands, except for any commands you specifically put into the \SpecialChar LaTeX
12831 \begin_layout Standard
12836 file should be saved and processed through \SpecialChar LaTeX
12837 as many times as necessary.
12838 You may also want to check the resulting
12845 \begin_layout Subsection
12846 Use of \SpecialChar TeX
12850 \begin_layout Standard
12851 The use of \SpecialChar TeX
12852 code is reduced to two commands, which must be placed at the
12853 top of the document.
12854 If you started writing your paper by using the
12862 template, the \SpecialChar TeX
12863 code needed is already in its place; you usually don't need
12865 You may only modify the first \SpecialChar TeX
12866 code to specify the information printed
12867 to the top of odd and even pages (authors' names and short paper's title,
12869 This \SpecialChar TeX
12870 code must have the form
12874 markboth{Authors' Names}{Short Paper's Title}
12879 \begin_layout Section
12883 \begin_layout Standard
12889 \begin_layout Subsection
12893 \begin_layout Standard
12894 The iopart package provides a document class to create electronic manuscript
12895 submission to the journals published by the Institute of Physics.
12896 Instructions for the authors how to create a paper using the iopart class
12897 can be downloaded together with the iopart package from the site
12898 \begin_inset Flex URL
12901 \begin_layout Plain Layout
12903 ftp://ftp.iop.org/pub/journals/latex2e
12911 \begin_layout Subsection
12915 \begin_layout Standard
12916 The easiest way to write a paper is to start with the file
12920 that is available in \SpecialChar LyX
12921 's examples files folder.
12922 Open this file, save it under a new name, and start writing.
12923 The example file explains how to use the special text environments.
12924 Here are the most important advices:
12927 \begin_layout Itemize
12928 To be able to compile your document to a PDF, PS, or DVI, ensure that the
12931 Use AMS math package
12933 in the document settings under
12940 \begin_layout Itemize
12943 The title environment defines the kind of your paper.
12944 So use one of the following environments for the title:
12948 \begin_layout Itemize
12957 \begin_layout Itemize
12966 \begin_layout Itemize
12972 for a Topical review
12975 \begin_layout Itemize
12984 \begin_layout Itemize
12993 \begin_layout Itemize
12999 for a Paper (same as Title)
13002 \begin_layout Itemize
13008 for a Preliminary communication
13011 \begin_layout Itemize
13017 for a Rapid communication
13020 \begin_layout Itemize
13026 for a Letter to the editor
13030 \begin_layout Itemize
13033 All title environments except of
13037 can have an optional short title.
13040 \begin_layout Itemize
13041 There is a general title environment
13045 which is not directly supported by the \SpecialChar LyX
13047 This can be used as \SpecialChar TeX
13048 code when your document doesn't fit into one of the
13052 \begin_layout Standard
13053 For more informations like hints for special table and formula formatting,
13054 look at the IOP author guidelines.
13057 \begin_layout Section
13061 \begin_layout Standard
13064 Panayotis Papasotiriou
13067 \begin_layout Subsection
13071 \begin_layout Standard
13072 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
13073 that facilitates electronic manuscript submission to the journals they
13075 Most known of them (at least in my domain of interest) are
13077 Astrophysics and Space Science
13083 , but there are many others (see a complete list at
13084 \begin_inset Flex URL
13087 \begin_layout Plain Layout
13089 http://www.wkap.nl/jrnllist.htm/JRNLHOME
13095 The Kluwer package may be downloaded from the site
13096 \begin_inset Flex URL
13099 \begin_layout Plain Layout
13101 http://www.wkap.nl/kaphtml.htm/STYLEFILES
13107 A complete user guide is contained in that package (but it can also be
13108 downloaded separately).
13111 \begin_layout Standard
13113 supports many features of the package but not everything.
13114 However, the \SpecialChar TeX
13115 code needed is reduced to some
13116 \begin_inset Quotes eld
13120 \begin_inset Quotes erd
13123 commands of the package (see
13124 \begin_inset space ~
13128 \begin_inset CommandInset ref
13130 reference "subsec:kluwer_peculiarities"
13135 I have recently used \SpecialChar LyX
13136 to write an article submitted to the
13138 Astrophysics and Space Science
13140 without any problem.
13143 \begin_layout Subsection
13147 \begin_layout Standard
13148 The easiest way to write a paper is to start with the Kluwer template file.
13151 File\SpecialChar menuseparator
13163 This will give an (almost) empty document that includes the most common
13164 fields found in a manuscript and a short description of their use.
13165 As in most templates, simply overwrite the existing text (including the
13170 ) with the correct information.
13173 \begin_layout Subsection
13174 Preparing a paper for submission
13177 \begin_layout Standard
13178 As in the AAS\SpecialChar TeX
13179 package, before you submit your paper to a journal you must
13181 \begin_inset Quotes eld
13185 \begin_inset Quotes erd
13191 \begin_layout Enumerate
13192 Export your paper as a \SpecialChar LaTeX
13194 To do this, click on
13196 File\SpecialChar menuseparator
13197 Export\SpecialChar menuseparator
13205 \begin_layout Enumerate
13210 file with a text editor and make the following changes
13214 \begin_layout Enumerate
13215 remove the comment lines before the
13224 \begin_layout Enumerate
13225 remove everything between (and including) the
13237 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13241 \begin_layout Standard
13250 \begin_layout Enumerate
13255 file through \SpecialChar LaTeX
13256 as many times as necessary (usually up to three).
13259 \begin_layout Enumerate
13265 \begin_inset space \thinspace{}
13269 \begin_inset space \space{}
13276 , and check if everything is OK (it should, if you didn't make any mistake).
13279 \begin_layout Subsection
13280 \begin_inset Quotes eld
13284 \begin_inset Quotes erd
13287 of the Kluwer package
13288 \begin_inset CommandInset label
13290 name "subsec:kluwer_peculiarities"
13297 \begin_layout Standard
13298 The Kluwer package has the following
13299 \begin_inset Quotes eld
13303 \begin_inset Quotes erd
13309 \begin_layout Enumerate
13310 It is possible to write multiple articles in the same \SpecialChar LaTeX
13315 \begin_layout Plain Layout
13316 I can't imagine any good reason to do this.
13322 Each article must be included in the environment
13323 \begin_inset Quotes eld
13327 \begin_inset Quotes erd
13331 Unfortunately, this environment cannot be omitted, even if you write just
13333 Therefore, each article starts with the command
13339 and, obviously, ends with the command
13346 Although this can be implemented in \SpecialChar LyX
13347 , I didn't included it, since it looks
13348 ugly and can confuse the novice user.
13349 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
13352 \begin_inset Quotes eld
13357 \begin_inset Quotes erd
13363 \begin_layout Enumerate
13364 Information given at the beginning of the article (i.
13365 \begin_inset space \thinspace{}
13369 \begin_inset space \space{}
13372 title, subtitle, author, institution, running title, running author, abstract
13373 and keywords) must be included in an environment called
13374 \begin_inset Quotes eld
13378 \begin_inset Quotes erd
13382 This is not implemented in \SpecialChar LyX
13383 , so you must enter title, subtitle etc.
13384 \begin_inset space ~
13387 between two \SpecialChar TeX
13403 \begin_layout Enumerate
13404 According to the user manual, the label of each bibliography item must be
13428 \begin_layout Standard
13433 template takes care of all these
13434 \begin_inset Quotes eld
13438 \begin_inset Quotes erd
13442 If you start a new paper using this template you don't need to do anything
13447 \begin_layout Enumerate
13448 don't delete the \SpecialChar TeX
13449 code included in the template, and
13452 \begin_layout Enumerate
13453 copy the example bibliography item included in the template and modify it
13454 as necessary to enter new bibliography items.
13457 \begin_layout Section
13461 \begin_layout Standard
13467 \begin_layout Subsection
13471 \begin_layout Standard
13472 The \SpecialChar LyX
13475 article (koma-script)
13479 report (koma-script)
13497 correspond to the \SpecialChar LaTeX
13515 \begin_inset space ~
13518 of the Koma-Script family.
13519 They are replacements for the standard document classes
13535 , resp., and fit better to European typography conventions in a number of
13539 \begin_layout Itemize
13540 Standard character size is 11pt in
13542 article (koma-script)
13546 report (koma-script)
13554 letter (koma-script)
13559 \begin_layout Itemize
13560 Headings, labels of the description environment, and a number of elements
13563 letter (koma-script)
13565 document class are set in a bold sans serif font.
13569 \begin_layout Plain Layout
13570 There is a big difference between the bold sans serif old cm fonts and new
13571 ec fonts, especially in the appearance of headings.
13572 In comparison, the ec bold sans serif fonts look a bit thin.
13573 Here the \SpecialChar LaTeX
13582 helps to produce the
13583 \begin_inset Quotes eld
13587 \begin_inset Quotes erd
13590 appearance when using the ec fonts.
13595 The numbering of chapter headings is made in the same way as the numbering
13596 of section headings, that is without the extra line
13597 \begin_inset Quotes eld
13600 Chapter\SpecialChar ldots
13602 \begin_inset Quotes erd
13606 In addition, the appearance of the headings can be modified by using a
13607 number of options (in \SpecialChar LyX
13608 to be entered in the field
13611 \begin_inset space ~
13618 Layout\SpecialChar menuseparator
13625 \begin_layout Itemize
13626 The main means in the Koma-Script document classes to design the type area
13635 (in \SpecialChar LyX
13636 to be entered in the extra class options field in the dialog
13638 Document\SpecialChar menuseparator
13642 They make a clearer modification of page margins possible as do the options
13645 Document\SpecialChar menuseparator
13652 \begin_layout Itemize
13653 The \SpecialChar LaTeX
13654 document classes of the Koma-Script family define a number of additional
13656 Those part of it which makes sense in \SpecialChar LyX
13657 is implemented in corresponding
13661 \begin_layout Standard
13662 Detailed descriptions of the \SpecialChar LaTeX
13663 document classes of the Koma-Script family
13664 can be found in the Koma-Script documentation
13675 \begin_layout Subsection
13676 article (koma-script), report (koma-script), and book (koma-script)
13679 \begin_layout Standard
13680 The document classes
13682 article (koma-script)
13686 report (koma-script)
13696 are implemented in the layout files
13709 They contain all the paragraph types of the corresponding standard document
13722 , resp., partly modified, with the exception of the \SpecialChar LyX
13727 -type, which is replaced by the new
13731 -type having the same functionality.
13736 -Type there is a number of new paragraph types added.
13743 letter (koma-script)
13748 \begin_layout Itemize
13757 : are equivalents to
13765 , resp., additionally inserting an entry in the table of contents.
13774 are not contained in
13776 article (koma-script)
13781 \begin_layout Itemize
13790 : behave exactly as
13798 , resp., additionally clearing running heads.
13803 is not contained in
13805 article (koma-script)
13811 \begin_layout Plain Layout
13824 report (koma-script)
13826 , but since this is identical to
13830 , is has not been implemented in \SpecialChar LyX
13839 \begin_layout Itemize
13844 : generates a heading directly above the following paragraph in the standard
13845 character size without affecting the structure of the document.
13848 \begin_layout Itemize
13857 are special captions which respect the different space settings needed
13858 for captions placed above or below an element (if you follow strict typographic
13859 rules, you might want to place table captions always above the table).
13860 You can also use the class option
13864 , which will switch
13877 You need at least Koma-Script version 2.8q to use this.
13880 \begin_layout Itemize
13885 : can be used to set a bonmot, e.
13886 \begin_inset space \thinspace{}
13890 \begin_inset space \space{}
13893 at the beginning of a chapter.
13894 If you use the optional argument (
13896 Insert\SpecialChar menuseparator
13898 \begin_inset space ~
13903 ), you can insert the dictum's author there.
13904 Dictum and author are separated by a line.
13905 You need at least Koma-Script version 2.8q to use this.
13910 is not contained in
13912 article (koma-script)
13917 \begin_layout Standard
13918 The following types, together with the standard types
13930 , form the title area of the document.
13931 They must be entered ahead of the first
13932 \begin_inset Quotes eld
13936 \begin_inset Quotes erd
13943 \begin_layout Plain Layout
13944 The corresponding \SpecialChar LaTeX
13945 commands must appear before the
13956 When such a type is used more than once, the latter usage overwrites the
13957 former one, that means, for every type only the latest usage is valid.
13958 The order of the different types however has, like
13970 , no effect on the appearance of the produced document.
13973 \begin_layout Itemize
13978 : produces a centered paragraph above the ordinary title (
13990 ) for the subject of the document.
13993 \begin_layout Itemize
13998 : produces a centered paragraph below the ordinary title (
14010 ) for the publishers' name.
14013 \begin_layout Itemize
14020 report (koma-script)
14026 produces a centered paragraph on its own page behind the title page, or
14029 article (koma-script)
14031 produces a centered paragraph below the ordinary title (
14047 ) for a dedication.
14050 \begin_layout Itemize
14055 : produces a left aligned paragraph above the ordinary title (
14071 ) for a document`s head.
14074 \begin_layout Itemize
14079 : produces in a double-sided print in
14081 report (koma-script)
14087 a left-aligned paragraph at the top of the title page`s back or has no
14088 effect in a single-sided print or in
14090 article (koma-script)
14095 \begin_layout Itemize
14100 : produces in a double-sided print in
14102 report (koma-script)
14108 a left-aligned paragraph at the bottom of the title page`s back or has
14109 no effect in a single-sided print or in
14111 article (koma-script)
14116 \begin_layout Itemize
14121 : produces a special
14122 \begin_inset Quotes eld
14126 \begin_inset Quotes erd
14129 page ahead of the actual document containing a paragraph without special
14133 \begin_layout Standard
14134 The layout files for the document classes
14136 article (koma-script)
14140 report (koma-script)
14146 do include the file
14151 This is thought of as a place to define your own types.
14156 in your personal layout directory and edit the file!
14159 \begin_layout Subsection
14160 letter (koma-script)
14163 \begin_layout Standard
14167 letter (koma-script)
14169 is implemented in the layout file
14174 It contains all the paragraph types of the corresponding standard document
14179 , partly modified, with the exception of the \SpecialChar LyX
14193 type, which is replaced by the new
14198 In addition, it contains, in contrast to the standard document class, the
14217 Furthermore, there are a number of new letter specific types.
14220 \begin_layout Standard
14221 The appearance of the letter produced by this document class can be controlled
14222 by a number of \SpecialChar LaTeX
14223 commands, which you can put in the \SpecialChar LaTeX
14228 \begin_layout Plain Layout
14229 For example, the standard appearance of the letter`s heading, consisting
14230 of name and address, is quite self-willed.
14232 \begin_inset Quotes eld
14236 \begin_inset Quotes erd
14239 heading is produced by the following \SpecialChar LaTeX
14240 commands in the preamble:
14243 \begin_layout LyX-Code
14253 \begin_layout LyX-Code
14269 \begin_layout LyX-Code
14279 \begin_layout LyX-Code
14299 A detailed German description of such \SpecialChar LaTeX
14300 commands can be found in the Koma-Script
14306 With it, the letter's author can produce his personal letter layout.
14309 \begin_layout Standard
14318 define the beginning of the letter and must be used in every letter.
14319 To emphasize them in the \SpecialChar LyX
14320 document class, they are marked with the letter
14330 \begin_inset space ~
14333 in the left margin.
14334 It is possible to write any number of letters in one file.
14339 type produces a new letter using the same addressee and a
14343 type produces a new addressee.
14360 are ordinary paragraph types and can also be used several times in one
14361 and the same letter.
14364 \begin_layout Itemize
14369 : produces a paragraph for the addressee and implicitly defines the beginning
14373 \begin_layout Itemize
14378 : produces a paragraph for the form of address and implicitly produces a
14382 \begin_layout Itemize
14387 : produces a paragraph for a close.
14390 \begin_layout Itemize
14395 : produces a paragraph for a postscript.
14398 \begin_layout Itemize
14403 : produces a paragraph for a distribution list.
14406 \begin_layout Itemize
14411 : produces a paragraph for enclosures.
14414 \begin_layout Standard
14455 are input types provided with a label to enter information, which will
14456 be processed by the document class.
14460 \begin_layout Plain Layout
14461 It could be seen as a matter of inconsequence, that the types
14469 described above are not such input types as well.
14470 Because of the special meaning of those types, however, I have implemented
14471 them as ordinary paragraph types with a one letter mark in the left margin.
14472 Moreover, it would affect my feeling of symmetry, if the
14480 type had such a serious different appearance.
14485 The types must be used ahead of the corresponding
14492 \begin_layout Standard
14493 An implementation of these types in a WYSIWYG fashion does not seem to make
14494 sense, because the real appearance of the produced letter does not only
14495 depend on the usage of the particular type, but also on other factors.
14496 For example, a signature entered in the
14500 type will in the standard behavior appear in the produced letter only,
14501 when in the same letter also a
14506 The entered value of the
14510 type will in the standard behavior not appear in the produced letter at
14512 The possibility to design the letter`s heading freely is already indicated
14513 in a footnote above.
14516 \begin_layout Standard
14517 The input types can also be used as empty paragraphs.
14518 This makes sense e.
14519 \begin_inset space \thinspace{}
14523 \begin_inset space \space{}
14535 type is not used at all, in the standard behavior the value of the
14539 type is used as signature, whereas if an empty
14543 type is used, no signature value is defined.
14546 \begin_layout Standard
14547 By using the input types it is possible to write a letter template, containing
14548 filled input types with your personal dates (name, address, etc.) and empty
14549 input types for other dates you want to enter.
14552 \begin_layout Itemize
14557 : sender's name, in the standard behavior appears as a centered paragraph
14558 in small caps in the letter`s heading.
14561 \begin_layout Itemize
14566 : sender's signature, in the standard behavior appears below the
14575 type is used, the value of the
14579 type appears instead.
14582 \begin_layout Itemize
14587 : sender's address, in the standard behavior appears in a centered paragraph
14588 in the letter`s heading below the sender's name.
14591 \begin_layout Itemize
14596 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
14607 \begin_layout Itemize
14612 : place of the letter`s making.
14615 \begin_layout Itemize
14620 : date of the letter`s making.
14629 , in the standard behavior, produce the place and the date in a right-aligned
14630 line below the addressee's field.
14635 type is used, neither place nor date appear, independent of the value of
14645 type is used, the date of the letter `s production is used.
14648 \begin_layout Itemize
14653 : sender`s back address, in the standard behavior appears above the addressee's
14654 field in a small sans serif font.
14657 \begin_layout Itemize
14662 : special mail information, in the standard behavior appears underlined
14663 above the addressee's field below the back address.
14666 \begin_layout Itemize
14671 : additional information, in the standard behavior appears on right side
14672 below the addressee`s field.
14675 \begin_layout Itemize
14680 : the letter's title, in the standard behavior appears in a big, bold, sans
14681 serif font above the subject.
14684 \begin_layout Itemize
14689 : the letter's subject, in the standard behavior appears in a bold font
14697 \begin_layout Standard
14718 produce a business letter like line above the
14722 line containing the fields
14723 \begin_inset Quotes eld
14727 \begin_inset Quotes erd
14731 \begin_inset Quotes eld
14735 \begin_inset Quotes erd
14739 \begin_inset Quotes eld
14743 \begin_inset Quotes erd
14747 \begin_inset Quotes eld
14751 \begin_inset Quotes erd
14755 \begin_inset Quotes eld
14759 \begin_inset Quotes erd
14763 \begin_inset Quotes eld
14767 \begin_inset Quotes erd
14771 For the date field, the value of the
14777 \begin_inset Quotes eld
14780 business letter types
14781 \begin_inset Quotes erd
14784 is used, the value of the
14788 type however does not appear, but only the \SpecialChar LaTeX
14796 The ordinary output of place and date in a right-aligned line below the
14797 addressee`s field is suppressed.
14798 The types are implemented as input types provided with a label and must
14799 be used ahead of the corresponding
14806 \begin_layout Itemize
14814 \begin_layout Itemize
14822 \begin_layout Itemize
14830 \begin_layout Itemize
14838 \begin_layout Itemize
14846 \begin_layout Subsection
14847 The new letter class: letter (koma-script v.2)
14850 \begin_layout Standard
14856 \begin_layout Standard
14857 \begin_inset VSpace medskip
14863 \begin_layout Standard
14865 Koma-Script version 2.8 has introduced a new letter class
14869 which supersedes the now unsupported
14874 It has — on the \SpecialChar LaTeX
14875 side — a completely new interface and is not compatible
14876 with the old class.
14877 Therefore, \SpecialChar LyX
14878 supports both, though it is recommended you use the new class.
14881 \begin_layout Standard
14882 This class covers the same functionality as
14884 letter (koma-script),
14887 The basic items are
14891 (receiver's address, same as
14895 in the old layout),
14908 will start a new letter (i.
14909 \begin_inset space \thinspace{}
14913 \begin_inset space \space{}
14916 you can write several letters per document).
14917 New elements are sender's
14933 and the possibility to use a
14939 Insert\SpecialChar menuseparator
14945 \begin_layout Standard
14946 The biggest improvement is, though, that the letter's layout is configurable
14947 to meet almost any needs.
14948 This can be done via the preamble or with a special style file (Letter
14949 Class Option, extension
14953 ), that will be read in as a class option.
14957 \begin_layout Plain Layout
14958 The KOMA package comes with some default
14963 There is, for instance, a
14967 file that follows german typesetting rules, or a
14971 that provides the default layout of the old
14976 The latter can be loaded with the class option
14982 Layout\SpecialChar menuseparator
14983 Document\SpecialChar menuseparator
14995 template that is included in \SpecialChar LyX
14997 A detailed description is to be found in the Koma-Script documentation
15005 \begin_layout Subsection
15009 \begin_layout Standard
15010 Visualizing the Koma-Script document classes in \SpecialChar LyX
15011 , the \SpecialChar LyX
15012 internals cause some
15016 \begin_layout Itemize
15017 The chapter number of a
15021 type appears on a line of its own above the chapter heading instead of
15022 appearing in the same line ahead of it.
15023 The cause for that is the \SpecialChar LyX
15024 internal behavior for the labeltype
15028 in the layout file.
15031 \begin_layout Itemize
15032 The headings of the types
15040 are only put in the
15041 \begin_inset Quotes eld
15045 \begin_inset Quotes erd
15049 table of contents, but not in the \SpecialChar LyX
15050 table of contents (
15052 Document\SpecialChar menuseparator
15054 \begin_inset space ~
15058 \begin_inset space ~
15066 \begin_layout Itemize
15067 The paragraphs in a
15071 document class appear in a skip separation mode, not indented.
15072 This is the standard behavior, no special \SpecialChar LaTeX
15073 commands are needed for that.
15076 Document\SpecialChar menuseparator
15079 dialog the corresponding radio button indicates
15088 value always has the effect that extra \SpecialChar LaTeX
15089 commands are inserted in the document
15090 to produce the gap, which is not what is wanted in this case.
15093 \begin_layout Section
15097 \begin_layout Standard
15103 \begin_layout Subsection
15107 \begin_layout Standard
15108 Memoir is a very powerful and constantly evolving class.
15109 It has been designed with regard to fictional and non-fictional literature.
15110 Its aim is to let the user have maximum control over the typesetting of
15112 Memoir is based on the standard book class, but it can also emulate the
15113 article class (see below).
15116 \begin_layout Standard
15117 Peter Wilson, the developer of Memoir, is known as the author of lots of
15118 useful packages in the \SpecialChar LaTeX
15120 Most of them have been merged with Memoir.
15121 Therefore, it is much easier to layout the table of contents, appendices,
15122 chapter designs and such.
15124 , though, does not support all of these goodies natively.
15125 Some of them might be added to forthcoming releases
15129 \begin_layout Plain Layout
15130 You are invited to send suggestions to
15131 \begin_inset Flex URL
15134 \begin_layout Plain Layout
15136 lyx-devel@lists.lyx.org
15146 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
15148 Of course you can still use all features with the help of some native \SpecialChar LaTeX
15150 commands (\SpecialChar TeX
15155 \begin_layout Plain Layout
15160 \begin_layout Plain Layout
15170 \begin_inset space ~
15174 \begin_inset CommandInset ref
15176 reference "sec:Inserting-TeX-Code"
15186 In this section, we can only list those features that are natively supported
15187 by \SpecialChar LyX
15189 For detailed descriptions (and for the rest of features) we recommend you
15190 have a look at the detailed manual of the Memoir class
15194 \begin_layout Plain Layout
15199 \begin_layout Plain Layout
15209 \begin_inset Flex URL
15212 \begin_layout Plain Layout
15214 CTAN:/macros/latex/memoir/memman.pdf
15224 , which is not only a user guide for the class, but also both a comprehensive
15225 description on good typesetting and a superb example for good typesetting
15229 \begin_layout Subsection
15230 Basic features and restrictions
15233 \begin_layout Standard
15234 Memoir supports basically all features of the standard book classes.
15235 There are, however, some differences, as follows:
15238 \begin_layout Description
15240 \begin_inset space ~
15243 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
15246 \begin_layout Description
15248 \begin_inset space ~
15251 style: The fancy page style is not supported, due to a command clash between
15252 Memoir and the fancyhdr package (they both define a command with the same
15253 name, which confuses \SpecialChar LaTeX
15255 Instead, Memoir comes with a number of its own page styles (see
15257 Layout\SpecialChar menuseparator
15258 Document\SpecialChar menuseparator
15260 \begin_inset space ~
15266 If you want to use these for the chapter pages, you have to use the command
15273 in the main text or in preamble (e.
15274 \begin_inset space \thinspace{}
15278 \begin_inset space \space{}
15285 chapterstyle{companion}
15290 \begin_layout Description
15291 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
15292 optional argument in the standard classes.
15293 With this, you can specify an alternative version of the title for the
15294 table of contents and the headers (for instance, if the title is too long).
15295 In \SpecialChar LyX
15296 , you can do this via
15298 Insert\SpecialChar menuseparator
15300 \begin_inset space ~
15305 at the beginning of a chapter/section.
15306 Memoir features a second optional argument and thus separates the table
15307 of contents from the header.
15308 You can define three variants of a title with this: one for the main text,
15309 one for the table of contents, and one for the headers.
15310 Simply insert two optional arguments if you need this feature, the first
15311 one containing the short title for the Table of Contents, the second one
15312 containing an alternative short title for the headers.
15315 \begin_layout Description
15316 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
15317 of contents, the list of figures and the list of table start a new page
15319 Memoir does not follow this route.
15320 You have to insert a page break yourself, if you want to have one.
15323 \begin_layout Description
15324 Titlepage: For some unknown reason, Memoir uses pagination on the title
15325 page (in the standard classes, title pages are
15326 \begin_inset Quotes eld
15330 \begin_inset Quotes erd
15334 If you want an empty title page, type
15338 aliaspagestyle{title}{empty}
15343 \begin_layout Description
15344 Article: With the class option
15350 Layout\SpecialChar menuseparator
15351 Document\SpecialChar menuseparator
15353 \begin_inset space ~
15358 ), you can emulate article style.
15359 That is, counters (footnotes, figures, tables etc.) will not be reset on
15360 new chapters, chapters don't start a new page (but are—in contrary to
15361 \begin_inset Quotes eld
15365 \begin_inset Quotes erd
15368 article classes—still allowed), parts, though, use their own page, as in
15372 \begin_layout Description
15373 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
15374 font commands, which have been used in the old \SpecialChar LaTeX
15376 \begin_inset space \thinspace{}
15380 \begin_inset space \space{}
15396 It produces an error and stops \SpecialChar LaTeX
15397 whenever such a command appears.
15402 reallows the commands and spits out warnings instead (which does at least
15403 not stop \SpecialChar LaTeX
15405 Since a lot of packages and particularly Bib\SpecialChar TeX
15406 style files are still using
15407 those commands, we have decided to use this option by default.
15410 \begin_layout Subsection
15414 \begin_layout Standard
15415 We will only describe the features supported by \SpecialChar LyX
15416 (which is not much currently).
15417 Please consult the Memoir manual
15421 \begin_layout Plain Layout
15426 \begin_layout Plain Layout
15436 \begin_inset Flex URL
15439 \begin_layout Plain Layout
15441 CTAN:/macros/latex/memoir/memman.pdf
15454 \begin_layout Description
15455 Abstract: You may wonder why an abstract is an extra feature.
15456 Well, it is in book class.
15457 Usually books don't have abstracts.
15458 Memoir, however, has.
15459 You can use it wherever and how often you like.
15462 \begin_layout Description
15463 Chapterprecis: You may know this older typesetting style: The contents of
15464 a chapter are summarized below the title and also in the table of contents
15466 \begin_inset space \thinspace{}
15470 \begin_inset space \space{}
15475 Our hero arrives in Troia; he loses some friends; he finds others
15478 Chapterprecis does exactly this.
15479 It is therefore only sensible below a chapter.
15482 \begin_layout Description
15483 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
15484 The epigraph environment provides an elegant way of typesetting such a
15486 The motto itself (text) and its author (source) are divided by a short
15488 Unfortunately, we have to fool \SpecialChar LyX
15489 a bit here again, since the environment
15490 needs two arguments (text and source).
15491 In this case, we have to use curly brackets (in \SpecialChar TeX
15492 mode) between the two
15503 <author of the slogan>.
15506 \begin_layout Description
15507 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
15508 complex figurative poems).
15510 can only support a few of them.
15511 One is poemtitle, which is a centered title for poems, which will also
15512 be added to the table of contents (verse is the standard environment for
15514 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
15516 because they have to be nested inside regular verse environments, which
15517 is not possible with \SpecialChar LyX
15521 \begin_layout Description
15522 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
15525 \begin_layout Section
15526 Article (mwart), book (mwbk) and report (mwrep)
15527 \begin_inset Argument status
15530 \begin_layout Plain Layout
15543 \begin_layout Standard
15549 \begin_layout Standard
15550 The \SpecialChar LyX
15567 correspond to the \SpecialChar LaTeX
15581 They are replacements for the standard document classes
15593 , resp., and fit better to Polish typography conventions in a number of points.
15597 \begin_layout Standard
15601 \begin_layout Itemize
15602 Unnumbered titles (with star, e.
15603 \begin_inset space \thinspace{}
15607 \begin_inset space \space{}
15614 ) are added into table of contents,
15617 \begin_layout Itemize
15618 Additional page styles:
15622 \begin_layout Description
15623 uheadings header with separated lines,
15626 \begin_layout Description
15627 myheadings custom header, contents headers via commands:
15642 \begin_layout Description
15643 myuheadings custom header with separated lines,
15646 \begin_layout Description
15647 outer page number is placed on outer side of page
15651 \begin_layout Itemize
15656 \begin_layout Description
15657 rmheadings serif titles — default,
15660 \begin_layout Description
15661 sfheadings sansserif titles,
15664 \begin_layout Description
15665 authortitle on title page first placed is author next title — default,
15668 \begin_layout Description
15669 titleauthor on title page first placed is title next author,
15672 \begin_layout Description
15673 withmarginpar reserve place on page for margins.
15677 \begin_layout Section
15681 \begin_layout Standard
15686 provides an alternative to the standard
15691 It provides similar functionality, but you might prefer this layout with
15692 sans serif sections, headings, and more.
15695 \begin_layout Section
15696 Rev\SpecialChar TeX
15700 \begin_layout Standard
15706 \begin_layout Standard
15707 \begin_inset VSpace bigskip
15713 \begin_layout Standard
15718 \begin_inset space ~
15723 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
15725 \begin_inset Formula $\beta$
15728 release of May, 1999) class.
15731 \begin_layout Standard
15737 textclass, which works with Rev\SpecialChar TeX
15739 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
15741 That means that it doesn't interact very well with \SpecialChar LyX
15742 , which requires \SpecialChar LaTeX2e
15744 it has been kludged to work.
15745 Since Rev\SpecialChar TeX
15746 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
15751 Rev\SpecialChar TeX
15753 \begin_inset space ~
15758 textclass should also be pretty easy to use.
15761 \begin_layout Standard
15762 These documents are supposed to be used in
15766 to the Rev\SpecialChar TeX
15767 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
15769 and assume you'll know what to put in the preamble if necessary.
15772 \begin_layout Subsection
15776 \begin_layout Standard
15777 All you need to do is install Rev\SpecialChar TeX
15778 4, as described in the package's README
15780 The package can be found at The Rev\SpecialChar TeX
15782 \begin_inset Flex URL
15785 \begin_layout Plain Layout
15787 http://publish.aps.org/revtex4/
15793 Install it somewhere that \SpecialChar LaTeX
15795 Test it by trying to \SpecialChar LaTeX
15796 a short Rev\SpecialChar TeX
15797 4 document in some random directory (i.
15798 \begin_inset space \thinspace{}
15802 \begin_inset space \space{}
15805 not the directory where you installed the class file.) Then, if you reconfigure
15807 , it will find the class file and let you use the Rev\SpecialChar TeX
15811 \begin_layout Standard
15812 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
15821 \begin_inset space ~
15826 template, found in the templates directory.
15829 \begin_layout Subsection
15833 \begin_layout Standard
15834 Optional arguments to
15841 \begin_inset Quotes eld
15845 \begin_inset Quotes erd
15849 \begin_inset Quotes eld
15853 \begin_inset Quotes erd
15859 \begin_inset space ~
15867 \begin_inset space ~
15873 Remember that in Rev\SpecialChar TeX
15874 , at least one optional argument is required!
15877 \begin_layout Standard
15878 Other preamble matter, like
15885 \begin_inset space ~
15892 \begin_inset space ~
15897 dialog, also as usual.
15900 \begin_layout Subsection
15904 \begin_layout Standard
15905 The layouts basically correspond to the commands in Rev\SpecialChar TeX
15907 For example, the Email layout corresponds to
15914 Note that (at least as of Rev\SpecialChar TeX
15923 layouts are exactly equivalent, so you shouldn't need to use both.
15927 \begin_layout Plain Layout
15928 In case you're curious, both were included so that
15932 would be able to translate both
15952 \begin_layout Subsection
15956 \begin_layout Standard
15957 There are a couple of important unique aspects of Rev\SpecialChar TeX
15958 4 which might cause
15959 bugs that will be even more confusing in \SpecialChar LyX
15963 \begin_layout Standard
15964 In Rev\SpecialChar TeX
15982 The \SpecialChar LyX
15983 equivalent is that there is a separate Thanks layout.
15988 write footnotes in the
15992 layout, or weird things may happen.
15993 See the Rev\SpecialChar TeX
15994 4 documentation for more details.
15997 \begin_layout Standard
16001 \begin_inset space ~
16009 \begin_inset space ~
16018 layouts must be placed
16026 layout and the corresponding
16043 , the \SpecialChar LaTeX
16047 \begin_layout Subsection
16051 \begin_layout Standard
16052 The main problem with this layout is that you can't use the optional arguments
16053 to layouts like Email and Title.
16054 (The problem is not unique to this layout; you can't use optional arguments
16055 to the Section layouts either.) This means that after you export that file
16056 to \SpecialChar LaTeX
16057 (which you'll need to do eventually to send it in to APS), you'll need
16058 to edit the \SpecialChar LaTeX
16059 file with a text editor to add the optional arguments to set,
16061 \begin_inset space \thinspace{}
16065 \begin_inset space \space{}
16068 the running title for the page headers.
16069 Lacking these layouts makes the
16075 (and the equivalent
16081 ) useless, so the corresponding layouts don't exist, and will have to be
16086 \begin_layout Plain Layout
16091 actually, \SpecialChar LyX
16092 1.3.0 supports some forms of optional arguments, but this layout
16093 has not been updated yet to take advantage of it.
16101 \begin_layout Section
16102 Springer Journals (
16109 \begin_layout Standard
16115 \begin_layout Subsection
16119 \begin_layout Standard
16120 These are the layout files for some of the journal formats used by Springer
16121 Verlag and listed on
16122 \begin_inset Flex URL
16125 \begin_layout Plain Layout
16127 http://www.springer.de/author/tex/help-journals.html
16132 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
16134 It is a modular system: the things common to all journals are implemented
16139 , which journal-specific layout files (such as, e.
16140 \begin_inset space \thinspace{}
16144 \begin_inset space \space{}
16151 for Journal of Geodesy) can include.
16154 \begin_layout Standard
16155 This means that implementing support for any other Springer journal on this
16156 list is as simple as writing your own
16164 file following the outline given in
16172 \begin_layout Standard
16173 It is reasonably well tested only for the Journal of Geodesy.
16182 come with the standard \SpecialChar LyX
16184 Install the relevant class file (downloaded from Springer) in a proper
16185 directory, reconfigure \SpecialChar LaTeX
16186 (in the te\SpecialChar TeX
16191 , as root if necessary — doesn't \SpecialChar LyX
16192 take care of this?), reconfigure \SpecialChar LyX
16197 \begin_layout Subsection
16201 \begin_layout Standard
16202 A large number of theorem-like styles —
16214 \begin_layout Standard
16217 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
16218 _Title, Author_Running, Institute,
16219 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
16222 See the Springer class file documentation for details.
16225 \begin_layout Subsection
16229 \begin_layout Itemize
16241 \begin_layout Itemize
16244 Probability Theory and Related Fields
16250 — Jean-Marc Lasgouttes
16253 \begin_layout Standard
16254 Add your own, it isn't so hard!
16257 \begin_layout Subsection
16261 \begin_layout Standard
16262 These files are partly based on the older
16266 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
16268 file from Springer.
16273 layout, are now defunct.
16274 Jean-Marc Lasgouttes helped out big in making me find my way around the
16276 layout file mechanism.
16279 \begin_layout Subsection
16283 \begin_layout Standard
16285 But probably less than in the old hacked-\SpecialChar LaTeX
16293 \begin_layout Standard
16295 \begin_inset space \thinspace{}
16298 g.: does not display the number for theorem-like layouts, just #.
16301 \begin_layout Section
16304 Sli\SpecialChar TeX
16308 \begin_inset CommandInset label
16317 \begin_layout Standard
16325 \begin_layout Subsection
16329 \begin_layout Standard
16330 This section describes how to use \SpecialChar LyX
16331 to make slides for overhead projectors.
16332 There are two document classes that can do this: the default slides class
16335 Foil\SpecialChar TeX
16339 This section documents the former.
16342 \begin_layout Standard
16343 I'm going to say this again, nice and clear, so that there's no misunderstanding
16347 \begin_layout Standard
16348 \begin_inset VSpace bigskip
16354 \begin_layout Standard
16358 This section documents the class
16359 \begin_inset Quotes eld
16367 \begin_inset Quotes erd
16375 \begin_layout Standard
16376 \begin_inset VSpace bigskip
16382 \begin_layout Standard
16383 If you're looking for the documentation for
16384 \begin_inset Quotes eld
16389 slides (Foil\SpecialChar TeX
16393 \begin_inset Quotes erd
16396 , check out section
16397 \begin_inset space ~
16401 \begin_inset CommandInset ref
16403 reference "sec:foiltex"
16413 \begin_inset Quotes eld
16418 slides (Foil\SpecialChar TeX
16422 \begin_inset Quotes erd
16425 ] is actually somewhat better than the default
16433 \begin_layout Plain Layout
16435 or so I've been told repeatedly by its advocates.
16436 Having never used it, I have no idea if this claim is true or not.
16441 which this section documents.
16444 \begin_layout Standard
16445 This class is the \SpecialChar LaTeX2e
16446 improvement of the old
16448 Sli\SpecialChar TeX
16452 Every \SpecialChar LaTeX2e
16453 distribution includes this class [which I'll just refer to as
16454 \begin_inset Quotes eld
16462 \begin_inset Quotes erd
16465 from now on], so you're bound to have it.
16466 As I noted earlier, there are other classes, such as
16470 , which also produce slides for overhead projectors and do a better job
16472 However, there are some things which
16476 can do which the others can't, such as generate overlays.
16477 Read on to learn more!
16480 \begin_layout Subsection
16482 \begin_inset CommandInset label
16484 name "sec:slidesetup"
16491 \begin_layout Standard
16492 Obviously, to use this document class, you need to select
16493 \begin_inset Quotes eld
16501 \begin_inset Quotes erd
16504 from the class list in the
16506 Document\SpecialChar menuseparator
16510 There are some other special things you should know about this class:
16513 \begin_layout Itemize
16514 Don't bother changing the options
16519 They're not supported by the
16526 \begin_layout Itemize
16530 \begin_inset space ~
16535 behaves a bit differently for this class.
16536 The possible choices and what they do are as follows:
16540 \begin_layout Description
16545 The final output contains page numbers in the lower right corner.
16548 \begin_layout Description
16557 , but also prints out any time markers you've put in.
16558 This is the default.
16561 \begin_layout Description
16566 The final output contains no page numbers, time markers, or alignment markers.
16570 \begin_layout Itemize
16575 class has an extra option:
16581 \begin_inset Quotes eld
16589 \begin_inset Quotes erd
16592 in the extra class options.
16596 \begin_layout Standard
16597 Using this options allows you to add time markers to
16603 \begin_inset space ~
16607 \begin_inset CommandInset ref
16609 reference "sec:slideNote"
16617 \begin_layout Standard
16618 You can also use the template file
16619 \begin_inset Quotes eld
16627 \begin_inset Quotes erd
16630 to automatically set up a document to use the
16636 File\SpecialChar menuseparator
16638 \begin_inset space ~
16642 \begin_inset space ~
16647 to open your new document].
16648 The template file also contains some examples of the special paragraph
16649 environments used by this class.
16650 I'll describe those next.
16653 \begin_layout Subsection
16654 Paragraph Environments
16657 \begin_layout Subsubsection
16658 Supported Environments
16661 \begin_layout Standard
16662 The first thing you'll notice when you start up a new
16666 document is the font size and type: it's the equivalent of the size
16667 \begin_inset Quotes eld
16675 \begin_inset Quotes erd
16681 \begin_inset space ~
16687 This is also what's used in the output.
16689 \begin_inset Quotes eld
16693 \begin_inset Quotes erd
16696 to remind you that this is a slide.
16697 Your final slides will use a larger font; ergo, you'll have less space.
16698 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
16701 \begin_layout Standard
16702 The next thing that becomes obvious is the changes to the paragraph environment
16703 pull-down box [at the far-left end of the toolbar].
16704 Most of the paragraph environments you're used to seeing are missing.
16705 There are also five new ones.
16710 class itself only supports certain paragraph environments:
16713 \begin_layout Itemize
16719 \begin_layout Itemize
16725 \begin_layout Itemize
16731 \begin_layout Itemize
16737 \begin_layout Itemize
16743 \begin_layout Itemize
16749 \begin_layout Itemize
16755 \begin_layout Itemize
16761 \begin_layout Itemize
16767 \begin_layout Itemize
16774 \begin_layout Itemize
16780 \begin_layout Standard
16781 All of the other standard environments, including the section-heading environmen
16782 ts, aren't used in the
16789 \begin_layout Standard
16790 On the other hand, you'll notice the following new environments:
16793 \begin_layout Itemize
16799 \begin_layout Itemize
16805 \begin_layout Itemize
16811 \begin_layout Itemize
16817 \begin_layout Itemize
16823 \begin_layout Standard
16824 These five are kind of quirky, due to a
16825 \begin_inset Quotes eld
16829 \begin_inset Quotes erd
16832 in \SpecialChar LyX
16834 You see, \SpecialChar LyX
16835 doesn't permit you to nest any other paragraph environment into
16836 an empty environment.
16837 Now, that's fine and dandy, but it means that you wouldn't be able to start
16838 a slide with anything except plain text.
16839 To deal with this, I've performed a little
16840 \begin_inset Quotes eld
16845 \begin_inset Quotes erd
16851 \begin_layout Subsubsection
16852 Quirks of the New Environments
16853 \begin_inset CommandInset label
16855 name "sec:slideQuirk"
16862 \begin_layout Standard
16863 All five of the new paragraph environments are somewhat quirky due to inherent
16864 limitiations in the current version of \SpecialChar LyX
16866 As I just mentioned, \SpecialChar LyX
16867 forbids environments that begin with another environment.
16868 To get around this, the
16872 environment isn't a paragraph environment as described in the
16880 \begin_layout Standard
16881 You should consider
16894 \begin_inset Quotes eld
16897 pseudo-environments.
16898 \begin_inset Quotes erd
16901 They look like a section heading or a
16902 \begin_inset Quotes eld
16910 \begin_inset Quotes erd
16913 but really begin a [and, if necessary, end the previous] paragraph environment.
16923 \begin_inset Quotes eld
16927 \begin_inset Quotes erd
16930 These two perform some action.
16933 \begin_layout Standard
16934 A common feature of all five environments,
16954 , is a rather long-ish label.
16955 The text following this label — ordinarily the contents of the paragraph
16956 environment — is utterly irrelevant for
16978 completely ignores it.
16979 In fact, you can leave these five environments completely empty.
16983 \begin_layout Standard
16988 to put any text after the rather long-ish label, you might want to.
16989 This could be a short description of the contents of the
16994 In that case, enter your descriptive comment and hit
16998 as you normally would.
17001 \begin_layout Standard
17002 If, on the other hand, you don't want to enter any descriptive text, you'll
17003 hit another \SpecialChar LyX
17006 , like nature, abhors a vacuum, and will not let you start a new paragraph
17007 environment until you put something in the old one.
17011 \begin_layout Itemize
17012 Start entering the text that will
17040 \begin_layout Itemize
17041 Now move to the beginning of that paragraph.
17045 \begin_layout Itemize
17054 \begin_layout Itemize
17055 Finally, change this new, empty paragraph to a
17079 \begin_layout Standard
17080 Some future version of \SpecialChar LyX
17081 will, hopefully, resolve this quirkiness\SpecialChar ldots
17085 \begin_layout Subsection
17086 Making a Presentation with
17099 \begin_layout Subsubsection
17107 \begin_layout Standard
17108 If you're expecting this section to teach you how to actually make a presentatio
17109 n, you'll be sorely disappointed.
17110 Naturally, I'll describe all of the ways the
17114 class can assist you in preparing the materials for a presentation.
17115 Filling in the contents, however, is up to you.
17120 the \SpecialChar LyX
17124 \begin_layout Standard
17129 environment [in the manner described in section
17130 \begin_inset space ~
17134 \begin_inset CommandInset ref
17136 reference "sec:slideQuirk"
17140 ] tells \SpecialChar LyX
17141 to begin a new slide [duh].
17142 The label for this environment/
17143 \begin_inset Quotes erd
17147 \begin_inset Quotes erd
17151 \begin_inset Quotes eld
17155 \begin_inset Quotes erd
17158 in cool blue, followed by the label,
17159 \begin_inset Quotes eld
17163 \begin_inset Quotes erd
17167 Any text or paragraph environments that follow this one go on the new slide.
17171 \begin_layout Standard
17172 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
17174 (this can be specified in the
17179 In fact, you'll want to, once you finish entering the contents of one slide.
17180 If you've entered more text than can physically fit on a slide, the extra
17181 overflows onto a new slide.
17182 I don't recommend doing this, however, since the overflow slide won't have
17183 any page number on it.
17184 Furthermore, it may interfere with any
17188 you've made to accompany the oversized
17195 \begin_layout Standard
17204 environments work the same way as the
17209 They both create an
17210 \begin_inset Quotes eld
17214 \begin_inset Quotes erd
17217 followed by a label [
17218 \begin_inset Quotes eld
17222 \begin_inset Quotes erd
17226 \begin_inset Quotes eld
17230 \begin_inset Quotes erd
17234 The color is a stunning magenta instead of blue, and the
17235 \begin_inset Quotes eld
17239 \begin_inset Quotes erd
17242 will look different, in style and in length.
17243 The label fonts of all three also differ from one another.
17246 \begin_layout Standard
17251 , if the contents of a
17259 exceed the physical size of a slide or sheet of paper, the extra will overflow
17261 Again, you should avoid this.
17262 It defeats the whole purpose of
17273 \begin_layout Subsubsection
17283 \begin_layout Standard
17288 is a slide that sits atop another slide.
17289 Perhaps you wish to discuss a figure on the main
17293 before displaying the text associated with it.
17294 One way to accomplish this is tape a flap of dark paper over the part of
17299 you want to display later.
17300 This method fails, however, if you wish to overlap one graph with another,
17302 You would then have to fumble while speaking to align the two separate,
17307 s to align the two graphs.
17312 environment in both cases makes life much easier.
17315 \begin_layout Standard
17320 receives the page number of its
17321 \begin_inset Quotes eld
17325 \begin_inset Quotes erd
17333 \begin_inset Quotes eld
17341 \begin_inset Quotes erd
17348 \begin_layout Plain Layout
17349 Presumably, mutliple
17354 \begin_inset Quotes eld
17362 \begin_inset Quotes erd
17366 \begin_inset Quotes eld
17374 \begin_inset Quotes erd
17378 \begin_inset Quotes eld
17386 \begin_inset Quotes erd
17390 \begin_inset space ~
17393 appended to the page number of the parent
17403 Clearly, you want the contents of both the
17411 to each fit on a single physical slide! You should probably consider an
17417 \begin_inset Quotes eld
17421 \begin_inset Quotes erd
17429 Indeed, the \SpecialChar LyX
17434 class provides a visual cue for this: the label at the start of an
17438 is shorter than that at the start of a
17443 Lastly, when you generate printable output, you'll find alignment markers
17444 in all four corners of both the
17448 page and its parent
17453 These will assist you in lining up the two physical slides.
17456 \begin_layout Standard
17457 The major problem in overlaying two slides is aligning the contents of the
17458 two transparencies.
17459 How much space should you leave for that graph on the second slide? Worse
17460 still, what if you want a graph and a sentence on second slide, but there
17461 is text on the main transparency that goes in between them? You could try
17462 and insert vertical space of the right size.
17463 The better way is to use
17474 \begin_layout Standard
17475 As their names imply,
17483 are two command-like paragraph environments that make all subsequent text
17484 invisible and visible, respectively.
17486 \begin_inset space ~
17490 \begin_inset CommandInset ref
17492 reference "sec:slideQuirk"
17496 that you don't place anything
17500 these two environments, however.
17505 , it inserts a centered, sky-blue label into the page reading
17506 \begin_inset Quotes eld
17509 <Invisible Text Follows>
17510 \begin_inset Quotes erd
17514 For paragraphs following this label, the parts of the
17522 ; it doesn't matter which] where they would be contain instead blank space.
17526 \begin_layout Standard
17531 , the corresponding centered label is
17532 \begin_inset Quotes eld
17535 <Visible Text Follows>
17536 \begin_inset Quotes erd
17540 Paragraphs following this label behave normally.
17541 Note that the beginning of a new
17553 automatically shuts off an
17558 It's therefore not necessary to use
17569 \begin_layout Standard
17570 By now, it should be obvious how to create overlay transparencies using
17571 the proper combination of
17590 \begin_layout Enumerate
17595 , including everything that will appear on it, whether on the main slide
17603 \begin_layout Enumerate
17604 Before each figure or paragraph that will appear only on the
17613 If necessary, insert a
17617 environment after the
17624 \begin_layout Enumerate
17629 immediately following the
17636 \begin_layout Enumerate
17637 Copy the contents of this
17648 \begin_layout Enumerate
17653 , change all of the
17664 \begin_layout Standard
17666 You've just made an
17673 \begin_layout Standard
17674 There's one problem with the way I've designed the \SpecialChar LyX
17679 class: you can't make text in the middle of a paragraph invisible, nor
17680 make text in the middle of an invisible paragraph visible again.
17681 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
17686 \begin_layout Plain Layout
17687 The commands of interest are:
17690 \begin_layout Itemize
17695 invisible \SpecialChar ldots
17699 \begin_layout Itemize
17704 visible \SpecialChar ldots
17708 \begin_layout Plain Layout
17710 and need to be marked as \SpecialChar TeX
17713 \begin_inset Quotes eld
17717 \begin_inset Quotes erd
17720 you wish to change goes in between the brackets [and after the
17733 If you don't know how to mark text as \SpecialChar TeX
17734 , see the appropriate section of
17747 \begin_layout Subsubsection
17757 \begin_inset CommandInset label
17759 name "sec:slideNote"
17766 \begin_layout Standard
17775 is associated with a
17776 \begin_inset Quotes eld
17780 \begin_inset Quotes erd
17788 Here, too, the \SpecialChar LyX
17793 class provides visual cues.
17798 is shorter than that of a
17802 [yet longer than that of an
17806 ] and, like the label of an
17810 is shockingly magenta.
17811 Additionally, the printed
17815 has the page number of its
17816 \begin_inset Quotes eld
17820 \begin_inset Quotes erd
17828 \begin_inset Quotes eld
17836 \begin_inset Quotes erd
17840 \begin_inset Quotes eld
17848 \begin_inset Quotes erd
17852 \begin_inset Quotes eld
17860 \begin_inset Quotes erd
17864 You can have multiple
17868 s associated with a single
17880 , you'll probably want to break up long
17884 s so that they fit on a single sheet of paper.
17887 \begin_layout Standard
17892 is obvious: it contains anything additional you might want to say about
17898 It could also be used as a sheet of reminders for a particular
17903 In the case of the latter, you might want to make use of time markers.
17904 Currently, the \SpecialChar LyX
17910 \begin_inset Quotes eld
17914 \begin_inset Quotes erd
17917 support for time markers, a
17919 Sli\SpecialChar TeX
17923 So, you'll have to resort to using the \SpecialChar LaTeX
17927 \begin_layout Standard
17928 To use time markers, you'll need to specify the extra class option
17929 \begin_inset Quotes eld
17937 \begin_inset Quotes erd
17941 \begin_inset space ~
17945 \begin_inset CommandInset ref
17947 reference "sec:slidesetup"
17952 This option turns on timing marks, which will appear in the lower-left-hand
17958 To set what appears in the time marker, you use the \SpecialChar LaTeX
17960 \begin_inset Quotes eld
17970 \begin_inset Quotes erd
17974 \begin_inset Quotes eld
17984 \begin_inset Quotes erd
17988 The arguments of both commands are time measured in seconds.
17990 \begin_inset Quotes eld
18000 \begin_inset Quotes erd
18003 sets the time marker to a given time.
18005 \begin_inset Quotes eld
18015 \begin_inset Quotes erd
18018 increments the time marker by the specified amount.
18019 Using time markers and
18023 s in this fashion, you can remind yourself how much time to spend on a particula
18031 \begin_layout Standard
18032 There's one last feature to describe.
18033 Clearly, you'd like to print out all of your
18041 s on transparencies while printing all of your
18058 with which it is associated.
18059 What's a person to do?
18062 \begin_layout Standard
18063 Luckily, there are two \SpecialChar LaTeX
18064 commands that allow you to select what to print
18066 Both must be placed into the preamble of your document.
18068 \begin_inset Quotes eld
18080 \begin_inset Quotes erd
18083 will cause the output to contain only the
18092 Correspondingly, the command
18093 \begin_inset Quotes eld
18105 \begin_inset Quotes erd
18108 prevents the output of anything but
18113 I'd advise placing both commands in the preamble and initially comment
18115 You can then preview your entire presentation as you write.
18116 When you're done writing, you can then uncomment one of the two to select
18117 what you want to print.
18118 I like to uncomment
18119 \begin_inset Quotes eld
18131 \begin_inset Quotes erd
18134 , print to a file with
18135 \begin_inset Quotes eld
18143 \begin_inset Quotes erd
18146 in its name, comment it back out, then uncomment
18147 \begin_inset Quotes eld
18159 \begin_inset Quotes erd
18163 \begin_inset Quotes eld
18171 \begin_inset Quotes erd
18175 I can then send either file to a printer, loading transparencies or plain
18176 paper as appropriate.
18179 \begin_layout Standard
18180 You can also provide other arguments to the
18181 \begin_inset Quotes eld
18191 \begin_inset Quotes erd
18195 \begin_inset Quotes eld
18205 \begin_inset Quotes erd
18209 See a good \SpecialChar LaTeX
18213 \begin_layout Subsection
18218 Class Template File
18221 \begin_layout Standard
18222 I have also provided a template file,
18223 \begin_inset Quotes eld
18231 \begin_inset Quotes erd
18239 To use it, begin your new presentation with
18241 File\SpecialChar menuseparator
18243 \begin_inset space ~
18247 \begin_inset space ~
18253 Your new \SpecialChar LyX
18254 presentation file will contain an example
18275 additionally contain an example of the use of
18284 Lastly, the preamble will contain:
18287 \begin_layout LyX-Code
18288 % Uncomment to print out only slides and overlays
18291 \begin_layout LyX-Code
18295 \begin_layout LyX-Code
18301 \begin_inset Newline newline
18307 \begin_layout LyX-Code
18308 % Uncomment to print out only notes
18311 \begin_layout LyX-Code
18315 \begin_layout LyX-Code
18323 \begin_layout Standard
18324 One final thing: I created this class to support the \SpecialChar LaTeX2e
18326 \begin_inset Quotes eld
18331 Sli\SpecialChar TeX
18335 \begin_inset Quotes erd
18338 class, one of the built-in \SpecialChar LaTeX2e
18340 Neither I nor the rest of the \SpecialChar LyX
18341 Team endorse or oppose the use of this built-in
18343 It's here if you want it or need it.
18344 There exist other \SpecialChar LaTeX2e
18345 classes for creating presentations, such as the
18350 \begin_inset space ~
18354 \begin_inset CommandInset ref
18356 reference "sec:foiltex"
18361 \begin_inset Quotes eld
18369 \begin_inset Quotes erd
18372 package [present on some \SpecialChar TeX
18374 The latter is not yet supported under \SpecialChar LyX
18379 \begin_layout Plain Layout
18380 Perhaps you can take on the task\SpecialChar ldots
18386 I know nothing about these other classes.
18387 Try them out to see what sort of alternative they provide.
18390 \begin_layout Chapter
18392 Features needing Extra Software
18395 \begin_layout Section
18396 Checking \SpecialChar TeX
18400 \begin_layout Standard
18406 \begin_layout Subsection
18410 \begin_layout Standard
18419 \begin_layout Plain Layout
18424 is not yet available when you are using the \SpecialChar LaTeX
18425 distribution MiK\SpecialChar TeX
18431 , you'll find in the
18438 \begin_inset space ~
18449 \begin_inset Newline newline
18453 \begin_inset CommandInset href
18455 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
18462 \begin_layout Standard
18465 Chk\SpecialChar TeX
18468 package is a program that was written by
18469 \begin_inset Flex Noun
18472 \begin_layout Plain Layout
18474 \begin_inset space ~
18482 in frustration because some constructs in \SpecialChar LaTeX
18483 are sometimes non-intuitive,
18484 and easy to forget.
18485 The program runs over your \SpecialChar LaTeX
18486 file, checks the integrity of the file, and
18487 flags some common errors.
18488 In other technical words, it is
18492 for \SpecialChar LaTeX
18496 \begin_layout Standard
18497 Well, what is a syntax checker doing in \SpecialChar LyX
18498 which is supposed to produce correct
18500 anyways? The answer is simple: Just as
18504 not only checks the
18508 of C programs, but also does
18512 checks for type-errors,
18514 Chk\SpecialChar TeX
18517 catches some common
18521 errors, in addition to the syntactical ones.
18524 Chk\SpecialChar TeX
18527 is capable of detecting several common errors, such as
18530 \begin_layout Itemize
18531 Ellipsis detection:
18532 \begin_inset Newline newline
18535 Use \SpecialChar ldots
18539 \begin_layout Itemize
18540 No space in front of/after parenthesis:
18541 \begin_inset Newline newline
18547 \begin_layout Itemize
18548 Enforcement of normal space after common abbreviations:
18549 \begin_inset Newline newline
18553 \begin_inset space \thinspace{}
18557 \begin_inset space \space{}
18560 is too wide spacing.
18563 \begin_layout Itemize
18564 Enforcement of end-of-sentence space when the last sentence ends with a
18566 \begin_inset Newline newline
18570 And this is wrong spacing.
18573 \begin_layout Itemize
18574 Space in front of labels and similar commands:
18575 \begin_inset Newline newline
18578 The label should stick right up to the text to avoid falling to a wrong
18581 \begin_inset CommandInset label
18591 \begin_layout Plain Layout
18592 This footnote is in danger of falling off to a wrong page
18597 The label is separated too much.
18600 \begin_layout Itemize
18601 Space in front of references, instead of hard spaces:
18602 \begin_inset Newline newline
18605 If you have bad luck, the text will break right between the referenced text
18606 and reference number, and that's a pity.
18608 \begin_inset CommandInset ref
18610 reference "sec:chktex"
18617 \begin_layout Itemize
18619 \begin_inset Quotes eld
18623 \begin_inset Quotes erd
18627 \begin_inset Formula $\times$
18631 \begin_inset Newline newline
18634 2x2 looks cheap compared to
18635 \begin_inset Formula $2\times2$
18641 \begin_layout Standard
18642 and more \SpecialChar ldots
18643 It is an invaluable tool when you are
18644 \begin_inset Quotes eld
18648 \begin_inset Quotes erd
18651 your document before printing, and you should run it right after the obligatory
18652 spelling check, and before you go fine tuning the typesetting.
18655 \begin_layout Subsection
18659 \begin_layout Standard
18660 If you have the program installed, usage is as simple as choosing
18662 Tools\SpecialChar menuseparator
18664 \begin_inset space ~
18670 This will make \SpecialChar LyX
18671 generate a \SpecialChar LaTeX
18672 file of your document, start
18674 Chk\SpecialChar TeX
18677 to check it, and then make \SpecialChar LyX
18679 \begin_inset Quotes eld
18683 \begin_inset Quotes erd
18686 with the warnings from
18688 Chk\SpecialChar TeX
18691 , if there were any.
18692 The warnings will be placed close to the point of the mistake, and you
18693 can quickly find them by using the
18695 Navigate\SpecialChar menuseparator
18698 menu item, or the shortcut key
18707 Open the error boxes by clicking on them with the mouse, or use the shortcut
18716 bindings, or the corresponding
18725 Read the warning and correct the mistake, if it is a mistake.
18726 If you have trouble understanding what the warning is about, you can safely
18728 Remember that there is a hidden layer between the document on screen and
18729 the technical details in invoking
18731 Chk\SpecialChar TeX
18734 , and this gap can make some warnings seem arcane or just plain silly.
18737 \begin_layout Standard
18738 This document is an excellent testing bed for the feature, and it should
18739 provide quite a few warnings for you to fiddle with.
18740 Since computers are only so smart, expect most of the warnings to be false
18744 \begin_layout Subsection
18745 How to fine tune it
18748 \begin_layout Standard
18749 Sometimes, you'll find that
18751 Chk\SpecialChar TeX
18754 makes more noise than suits your mood.
18755 Then you can choose not to use it, wait until your mood changes, or try
18758 Chk\SpecialChar TeX
18761 to get better along with you.
18764 \begin_layout Standard
18767 Chk\SpecialChar TeX
18774 very configurable and extensible, you should not expect to solve all problems
18777 Chk\SpecialChar TeX
18780 in \SpecialChar LyX
18782 Since \SpecialChar LyX
18783 has to generate a somewhat special \SpecialChar LaTeX
18784 file to be able to match the
18785 line numbers from the
18787 Chk\SpecialChar TeX
18794 \begin_layout Plain Layout
18795 You can inspect the specific output from
18801 Document\SpecialChar menuseparator
18804 \begin_inset space ~
18818 to the internal document structure, some of the warnings will not appear
18820 There are two things you can do about this:
18823 \begin_layout Itemize
18826 Chk\SpecialChar TeX
18829 invocation command line in
18830 \begin_inset Flex Noun
18833 \begin_layout Plain Layout
18834 Tools\SpecialChar menuseparator
18835 Preferences\SpecialChar menuseparator
18836 Output\SpecialChar menuseparator
18837 LaTeX\SpecialChar menuseparator
18845 Chk\SpecialChar TeX
18848 installation configuration file (usually with the file
18853 See below to learn what warnings can be enabled and disabled on the command
18857 \begin_layout Itemize
18858 Export your document as a raw \SpecialChar LaTeX
18861 File\SpecialChar menuseparator
18862 Export\SpecialChar menuseparator
18871 Invoked in this way, it can be a hassle to find the corresponding place
18872 in the document inside \SpecialChar LyX
18873 , but with a little patience, you should be able
18877 \begin_layout Standard
18878 Here follows the warning messages that can be enabled and disabled in
18887 to disable a warning, and
18891 to enable a warning.
18892 The emphasized entries are disabled by default, because the default is
18895 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
18900 \begin_layout Standard
18901 Notice that you should only use the options that enable and disable warnings,
18902 because \SpecialChar LyX
18903 relies on some of the other command line parameters to be set
18904 in a specific way to have a chance to communicate with
18911 \begin_layout Enumerate
18915 Command terminated with space.
18918 \begin_layout Enumerate
18921 Non-breaking space (
18922 \begin_inset Quotes eld
18930 \begin_inset Quotes erd
18933 ) should have been used.
18936 \begin_layout Enumerate
18940 You should enclose the previous parenthesis with
18941 \begin_inset Quotes eld
18949 \begin_inset Quotes erd
18955 \begin_layout Enumerate
18958 Italic correction (
18959 \begin_inset Quotes eld
18969 \begin_inset Quotes erd
18972 ) found in non-italic buffer.
18975 \begin_layout Enumerate
18978 Italic correction (
18979 \begin_inset Quotes eld
18989 \begin_inset Quotes erd
18992 ) found more than once.
18995 \begin_layout Enumerate
18999 No italic correction (
19000 \begin_inset Quotes eld
19010 \begin_inset Quotes erd
19016 \begin_layout Enumerate
19020 \begin_inset Quotes eld
19028 \begin_inset Quotes erd
19032 \begin_inset Quotes eld
19040 \begin_inset Quotes erd
19046 \begin_layout Enumerate
19049 Wrong length of dash may have been used.
19052 \begin_layout Enumerate
19056 \begin_inset Quotes eld
19064 \begin_inset Quotes erd
19068 \begin_inset Quotes eld
19076 \begin_inset Quotes erd
19082 \begin_layout Enumerate
19086 \begin_inset Quotes eld
19094 \begin_inset Quotes erd
19100 \begin_layout Enumerate
19104 \begin_inset Quotes eld
19112 \begin_inset Quotes erd
19115 to achieve an ellipsis.
19118 \begin_layout Enumerate
19121 Inter-word spacing (
19122 \begin_inset Quotes eld
19132 \begin_inset Quotes eld
19135 ) should perhaps be used.
19138 \begin_layout Enumerate
19141 Inter-sentence spacing (
19142 \begin_inset Quotes eld
19152 \begin_inset Quotes erd
19155 ) should perhaps be used.
19158 \begin_layout Enumerate
19161 Could not find argument for command.
19164 \begin_layout Enumerate
19168 \begin_inset Quotes eld
19176 \begin_inset Quotes erd
19182 \begin_layout Enumerate
19185 Math mode still on at end of \SpecialChar LaTeX
19189 \begin_layout Enumerate
19193 \begin_inset Quotes eld
19201 \begin_inset Quotes erd
19204 doesn't match the number of
19205 \begin_inset Quotes eld
19213 \begin_inset Quotes erd
19219 \begin_layout Enumerate
19222 You should use either
19225 \begin_inset Quotes eld
19233 \begin_inset Quotes erd
19238 as an alternative to
19239 \begin_inset Quotes eld
19247 \begin_inset Quotes erd
19253 \begin_layout Enumerate
19260 " (ASCII 39) instead of "
19267 \begin_layout Enumerate
19270 User-specified pattern found.
19273 \begin_layout Enumerate
19276 This command might not be intended.
19279 \begin_layout Enumerate
19286 \begin_layout Enumerate
19304 \begin_layout Enumerate
19307 Delete this space to maintain correct page references.
19310 \begin_layout Enumerate
19314 You might wish to put this between a pair of
19315 \begin_inset Quotes eld
19323 \begin_inset Quotes erd
19329 \begin_layout Enumerate
19332 You ought to remove spaces in front of punctuation.
19335 \begin_layout Enumerate
19338 Could not execute \SpecialChar LaTeX
19342 \begin_layout Enumerate
19351 in front of small punctuation.
19354 \begin_layout Enumerate
19362 may look prettier here.
19365 \begin_layout Enumerate
19369 Multiple spaces detected in output.
19372 \begin_layout Enumerate
19375 This text may be ignored.
19378 \begin_layout Enumerate
19384 \begin_inset Quotes eld
19389 to begin quotation, not
19396 \begin_layout Enumerate
19403 to end quotation, not
19406 \begin_inset Quotes eld
19414 \begin_layout Enumerate
19420 \begin_layout Enumerate
19423 You should perhaps use
19424 \begin_inset Quotes eld
19432 \begin_inset Quotes erd
19438 \begin_layout Enumerate
19441 You should put a space in front of/after parenthesis.
19444 \begin_layout Enumerate
19447 You should avoid spaces in front of/after parenthesis.
19450 \begin_layout Enumerate
19454 You should not use punctuation in front of/after quotes.
19457 \begin_layout Enumerate
19460 Double space found.
19463 \begin_layout Enumerate
19466 You should put punctuation outside inner/inside display math mode.
19469 \begin_layout Enumerate
19472 You ought to not use primitive \SpecialChar TeX
19473 in \SpecialChar LaTeX
19477 \begin_layout Enumerate
19480 You should remove spaces in front of
19481 \begin_inset Quotes eld
19489 \begin_inset Quotes erd
19495 \begin_layout Enumerate
19498 \begin_inset Quotes eld
19506 \begin_inset Quotes erd
19509 is normally not followed by
19510 \begin_inset Quotes eld
19518 \begin_inset Quotes erd
19524 \begin_layout Standard
19525 In later versions of \SpecialChar LyX
19526 , we hope to provide a more complete interface to this
19527 tool (and it's smaller cousin
19531 ) to exploit the full power of it.
19532 But it's not exactly useless as it is now: go try it on one of your existing
19533 documents of a certain length and be surprised.
19536 \begin_layout Section
19537 Version Control in \SpecialChar LyX
19541 \begin_layout Standard
19544 Lars Gullik Bjønnes
19551 \begin_layout Subsection
19555 \begin_layout Standard
19557 supports some of the most basic RCS/CVS/SVN/GIT commands.
19558 If you need something a bit more sophisticated you will have to do that
19559 manually in a terminal.
19562 \begin_layout Standard
19563 Also note that CVS support is not as good as subversion support so we advise
19565 A good place to start learning Subversion is SVN Book
19569 \begin_layout Plain Layout
19570 \begin_inset CommandInset href
19572 target "http://svnbook.red-bean.com/"
19582 In the case of RCS you should read
19583 \begin_inset Quotes eld
19587 \begin_inset Quotes erd
19590 (a man file, read it with
19595 This file describes all the basic features of RCS.
19596 You should especially notice the comment about a RCS directory, and the
19597 notion of a master RCS file (the file ending in
19604 \begin_layout Standard
19605 Before you begin to use the version control features in \SpecialChar LyX
19607 familiar with RCS/CVS/SVN/GIT usage.
19608 The implementation in \SpecialChar LyX
19609 assumes a recent version of the GNU RCS or CVS/SVN
19610 package — no guarantees are made for older versions.
19611 Most of the log messages are not currently displayed after operations —
19612 you can check them in the Messages pane if unsure.
19613 Regular users of version control will appreciate VC toolbar, which can
19616 View\SpecialChar menuseparator
19617 Toolbars\SpecialChar menuseparator
19619 \begin_inset space ~
19627 \begin_layout Standard
19628 For introducing your own external commands consult vc-command in the manual
19629 of \SpecialChar LyX
19633 \begin_layout Standard
19634 It is strongly recommended to store documents in uncompressed format if
19635 using version control (uncheck
19637 Document\SpecialChar menuseparator
19640 if it is checked): Uncompressed LyX documents are text files and therefore
19641 for merging two different versions by version control systems.
19642 Compressed LyX documents are binary files, which cannot be merged by version
19646 \begin_layout Subsection
19647 RCS commands in \SpecialChar LyX
19651 \begin_layout Standard
19652 The following sections describe the RCS commands supported by \SpecialChar LyX
19654 You can find them in the
19656 File\SpecialChar menuseparator
19658 \begin_inset space ~
19665 was tested against RCS 5.7/5.8.
19668 \begin_layout Subsubsection
19674 \begin_layout Standard
19675 If your document is not under revision control, this is the only item shown
19677 And if it is under revision control, the
19681 item is not visible.
19685 \begin_layout Standard
19686 This command registers your document with RCS (unless you are under the
19687 directory managed by CVS)\SpecialChar endofsentence
19688 You are asked interactively to supply an initial
19689 description of the document.
19690 The document is now set in Read-Only mode and you have to
19693 \begin_inset space ~
19697 \begin_inset space ~
19701 \begin_inset space ~
19706 , before making any changes to it.
19707 A document under revision control has a
19708 \begin_inset Quotes eld
19711 [RCS:<version> <locker>]
19712 \begin_inset Quotes erd
19715 item tagged to the filename in the minibuffer.
19718 \begin_layout Standard
19719 RCS command that is run:
19721 ci -q -u -i -t-"<initial description>" <file-name>
19724 \begin_layout Standard
19729 to understand the switches.
19733 \begin_layout Subsubsection
19739 \begin_layout Standard
19740 When you are finished editing a file, you check in your changes.
19741 When you do this, you are asked for a description of the changes.
19742 This is stored in the history log.
19743 The version number is bumped, your changes are applied to the master RCS
19744 file, the document is unlocked and set to Read-Only mode.
19747 \begin_layout Standard
19750 ci -q -u -m"<description>" <file-name>
19753 \begin_layout Subsubsection
19759 \begin_layout Standard
19760 By doing this you lock the document so that only you can edit it.
19761 This will also make the document Read-Write only for you.
19762 You will usually continue editing for a while and when you are finished
19763 you check in your changes.
19764 The status line is changed to reflect that you have locked the file.
19767 \begin_layout Standard
19770 co -q -l <file-name>
19773 \begin_layout Subsubsection
19776 Revert To Repository Version
19779 \begin_layout Standard
19780 This will discard all changes made to the document since the last check
19782 You get a warning before changes are discarded.
19785 \begin_layout Standard
19788 co -f -u<version> <file-name>
19791 \begin_layout Subsubsection
19797 \begin_layout Standard
19798 This will create a copy of the current document.
19799 Since RCS does not support copy operations natively, the version history
19800 is not preserved, and the copy is added as a new file.
19801 It requires a clean document without any changes since the last checkin.
19802 You are asked for a file name and a description of the copy operation.
19803 After that the copy is created, both locally and in the repository.
19804 If the parent directories of the copied and original document differ, all
19805 relative paths of included files of the copy are adjusted (like in
19807 File\SpecialChar menuseparator
19812 Finally, the copy is loaded instead of the original document.
19815 \begin_layout Labeling
19816 \labelwidthstring 00.00.0000
19818 \begin_inset space ~
19822 \begin_inset space ~
19826 \begin_inset Newline newline
19830 \begin_inset Flex Code
19833 \begin_layout Plain Layout
19836 \begin_inset Quotes eld
19840 \begin_inset Quotes erd
19849 \begin_inset Flex Code
19852 \begin_layout Plain Layout
19855 \begin_inset Quotes eld
19859 \begin_inset Quotes erd
19868 \begin_inset Newline newline
19872 \begin_inset Flex Code
19875 \begin_layout Plain Layout
19879 \begin_inset Quotes eld
19883 \begin_inset Quotes erd
19894 \begin_layout Subsubsection
19900 \begin_layout Standard
19901 This makes as if the last check in never happened.
19902 No changes are made to the document loaded into \SpecialChar LyX
19903 , but the last version
19904 is removed from the master RCS file.
19907 \begin_layout Standard
19910 rcs -o<version> <file-name>
19913 \begin_layout Subsubsection
19919 \begin_layout Standard
19920 This shows the complete history of the RCS document.
19925 is shown in a browser.
19933 \begin_layout Subsubsection
19937 \begin_layout Standard
19939 supports RCS version number, author name, date and time of last commit.
19940 All those are extracted from
19942 rlog -r <file-name>
19946 \begin_inset CommandInset ref
19948 reference "subsec:VCS-Revision-Information"
19955 \begin_layout Subsection
19956 CVS commands in \SpecialChar LyX
19960 \begin_layout Standard
19961 A subset of CVS operations is supported by \SpecialChar LyX
19963 You can find the commands in the
19965 File\SpecialChar menuseparator
19967 \begin_inset space ~
19973 The version control system SVN is more powerful, so please use it instead
19974 of CVS if possible.
19977 \begin_layout Subsubsection
19983 \begin_layout Standard
19984 If you start from scratch with CVS you have to create your repository and
19985 checkout the working copy with external tools.
19986 If you're using a client-server setup you may need to login before doing
19987 the first repository checkout.
19990 \begin_layout Standard
19991 If your documents are under revision control and others are using the same
19992 repository problems arise when different changes to the same document at
19993 the same location happen.
19994 Standard CVS repositories don't operate with a file locking mechanism.
19995 This may be surprising, but conflicts only occur if people disagree on
19996 the proper content of the same part of a document.
19997 So, if co-workers are used to communicate regularly, these conflicts occur
19999 If they don't communicate they have a fundamental problem anyway.
20000 Nevertheless some people like to work with so called
20001 \begin_inset Quotes eld
20005 \begin_inset Quotes erd
20009 If they do so the working copy of all files is readonly when checked out
20010 first and the user starts editing after using a special command to make
20011 the working copy writable.
20012 When the changes are checked in the working copy returns to readonly state.
20013 With \SpecialChar LyX
20014 one has to edit the
20015 \begin_inset Flex Code
20018 \begin_layout Plain Layout
20024 file and add the line
20025 \begin_inset Flex Code
20028 \begin_layout Plain Layout
20034 to work with reserved checkouts.
20035 The benefit is the possibility to see who is using a writable copy of some
20037 It's not guaranteed only one user makes a copy writable.
20040 \begin_layout Standard
20042 tries to guess if you're using reserved or non-reserved checkouts.
20043 If your working copy is readonly or it is writable and an additional copy
20044 of your document exists in the CVS/Base sub-directory a reserved otherwise
20045 a non-reserved checkout is assumed.
20046 When a reserved checkout is detected you have to use
20047 \begin_inset Flex Noun
20050 \begin_layout Plain Layout
20056 to make your working copy writable if it's readonly.
20058 \begin_inset Flex Noun
20061 \begin_layout Plain Layout
20067 operation is possible and that makes your working copy readonly again after
20068 transferring your changes to the repository.
20071 \begin_layout Standard
20072 More information about CVS can be found here
20073 \begin_inset Flex URL
20076 \begin_layout Plain Layout
20078 http://www.nongnu.org/cvs
20084 \begin_inset Flex URL
20087 \begin_layout Plain Layout
20089 http://ximbiot.com/cvs
20097 \begin_layout Standard
20102 to understand the sub-commands and the switches mentioned below.
20105 \begin_layout Subsubsection
20111 \begin_layout Standard
20112 If your document is not under revision control, this is the only item shown
20114 And if it is under revision control, the
20118 item is not visible.
20122 \begin_layout Standard
20123 This command registers in CVS your document
20124 \begin_inset Flex Strong
20127 \begin_layout Plain Layout
20135 in the case you have already the documents directory under CVS control
20141 This means you have to create or checkout the archive by yourself using
20143 (In case you forget that step \SpecialChar LyX
20144 registers the document with RCS.)
20147 \begin_layout Standard
20148 Then you are asked interactively to supply an initial description of the
20150 Don't forget that registered file is not yet checked in.
20153 \begin_layout Standard
20154 CVS command that is run:
20156 cvs -q add -m"<entered message>" "<file-name>"
20159 \begin_layout Standard
20164 above and for all other CVS commands is an abbreviation for
20165 \begin_inset Quotes eld
20168 change the current working directory to file location and use the file name
20169 without path component as argument
20170 \begin_inset Quotes erd
20176 \begin_layout Subsubsection
20182 \begin_layout Standard
20183 When you are finished editing a file, you commit your changes.
20184 When you do this and you had changed the document, you are asked for a
20185 description of the changes.
20186 After that changes are written to the repository.
20187 In case you didn't change the document and a reserved checkout is detected
20188 the reservation made on
20189 \begin_inset Flex Noun
20192 \begin_layout Plain Layout
20201 \begin_layout Labeling
20202 \labelwidthstring 00.00.0000
20204 \begin_inset space ~
20208 \begin_inset space ~
20212 \begin_inset Newline newline
20216 \begin_inset Flex Code
20219 \begin_layout Plain Layout
20222 -q commit -m"<description>" "<file-name>"
20228 \begin_inset Newline newline
20232 \begin_inset Flex Code
20235 \begin_layout Plain Layout
20246 \begin_layout Subsubsection
20252 \begin_layout Standard
20253 When you are sharing a repository with others, you may have to incorporate
20254 their changes into your working copy.
20257 \begin_layout Standard
20260 cvs -q update "<file-name>"
20263 \begin_layout Standard
20264 If a readonly checkout is detected the working copy is made writable and
20268 \begin_layout Standard
20271 cvs -q edit "<file-name>"
20274 \begin_layout Subsubsection
20277 Revert To Repository Version
20280 \begin_layout Standard
20281 This will discard all changes made to the document since the last check
20283 You get a warning before changes are discarded.
20284 Firstly the file is deleted, secondly CVS update command is run.
20287 \begin_layout Standard
20290 cvs -q update "<file-name>"
20293 \begin_layout Standard
20294 If a reserved checkout is detected and the working copy has no changes only
20295 the reservation is undone.
20298 \begin_layout Standard
20301 cvs -q unedit "<file-name>"
20304 \begin_layout Subsubsection
20310 \begin_layout Standard
20311 This will create a copy of the current document.
20312 Since CVS does not support copy operations natively, the version history
20313 is not preserved, and the copy is added as a new file.
20314 It requires a clean document without any changes since the last checkin.
20315 You are asked for a file name and a description of the copy operation.
20316 After that the copy is created, both locally and in the repository.
20317 If the parent directories of the copied and original document differ, all
20318 relative paths of included files of the copy are adjusted (like in
20320 File\SpecialChar menuseparator
20325 Finally, the copy is loaded instead of the original document.
20328 \begin_layout Labeling
20329 \labelwidthstring 00.00.0000
20331 \begin_inset space ~
20335 \begin_inset space ~
20339 \begin_inset Newline newline
20343 \begin_inset Flex Code
20346 \begin_layout Plain Layout
20349 \begin_inset Quotes eld
20353 \begin_inset Quotes erd
20362 \begin_inset Flex Code
20365 \begin_layout Plain Layout
20368 \begin_inset Quotes eld
20372 \begin_inset Quotes erd
20381 \begin_inset Newline newline
20385 \begin_inset Flex Code
20388 \begin_layout Plain Layout
20392 \begin_inset Quotes eld
20396 \begin_inset Quotes erd
20407 \begin_layout Subsubsection
20413 \begin_layout Standard
20414 This will rename the current document.
20415 Since CVS does not support rename operations natively, the version history
20416 is not preserved, the renamed document is added as a new file, and the
20417 original document is deleted.
20418 It requires a clean document without any changes since the last checkin.
20419 You are asked for a file name and a description of the rename operation.
20420 After that the document is renamed, both locally and in the repository.
20421 If the parent directories of the new and old file names differ, all relative
20422 paths of included files are adjusted (like in
20424 File\SpecialChar menuseparator
20429 Finally, the document is reloaded using the new name.
20432 \begin_layout Labeling
20433 \labelwidthstring 00.00.0000
20435 \begin_inset space ~
20439 \begin_inset space ~
20443 \begin_inset Newline newline
20447 \begin_inset Flex Code
20450 \begin_layout Plain Layout
20453 \begin_inset Quotes eld
20457 \begin_inset Quotes erd
20466 \begin_inset Flex Code
20469 \begin_layout Plain Layout
20472 \begin_inset Quotes eld
20476 \begin_inset Quotes erd
20485 \begin_inset Newline newline
20489 \begin_inset Flex Code
20492 \begin_layout Plain Layout
20496 \begin_inset Quotes eld
20500 \begin_inset Quotes erd
20509 \begin_inset Newline newline
20513 \begin_inset Flex Code
20516 \begin_layout Plain Layout
20520 \begin_inset Quotes eld
20524 \begin_inset Quotes erd
20535 \begin_layout Subsubsection
20536 Update of the local directory checkout from repository
20539 \begin_layout Standard
20540 Once your documents gets more complex, containing sub-documents and pictures,
20542 \begin_inset Flex Code
20545 \begin_layout Plain Layout
20551 files and so on using version control becomes more complicated.
20553 supports updating the whole tree in which resides the document.
20554 This become especially useful once you cooperate with people which neither
20555 have detailed knowledge about CVS usage nor they have ambition to commit
20556 additional material to the repository.
20557 You have to organize the files structure so that all external files are
20558 in the same directory or subdirectories of the document.
20559 It's good practice anyway to store multipart documents in an extra directory.
20562 \begin_layout Standard
20564 \begin_inset Flex Code
20567 \begin_layout Plain Layout
20568 Update local directory from repository
20573 command updates the whole directory.
20574 If local changes are detected user is warned before update starts.
20575 In case of merge conflicts both versions of the conflicting document parts
20576 are placed in the final document.
20577 You have to review and correct the result of the merge.
20578 You'll find the conflicts enclosed in pairs of
20579 \begin_inset Flex Code
20582 \begin_layout Plain Layout
20589 \begin_inset Flex Code
20592 \begin_layout Plain Layout
20599 \begin_inset Flex Code
20602 \begin_layout Plain Layout
20609 The first part is your version as before the update operation with the
20610 document name prepended.
20611 The second one is the repository version with the version number after
20613 \begin_inset Flex Code
20616 \begin_layout Plain Layout
20625 \begin_layout Labeling
20626 \labelwidthstring 00.00.0000
20628 \begin_inset space ~
20632 \begin_inset space ~
20636 \begin_inset Newline newline
20640 \begin_inset Flex Code
20643 \begin_layout Plain Layout
20651 (Ask if changes are detected.)
20652 \begin_inset Newline newline
20656 \begin_inset Flex Code
20659 \begin_layout Plain Layout
20660 cd $path; cvs -q update
20670 \begin_layout Standard
20672 \begin_inset Flex Code
20675 \begin_layout Plain Layout
20681 stands for the path to the document.
20684 \begin_layout Subsubsection
20690 \begin_layout Standard
20691 This shows the complete history of the CVS document.
20694 cvs log "<file-name>"
20696 is shown in a browser.
20699 \begin_layout Subsubsection
20703 \begin_layout Standard
20705 supports CVS version number, author name, date and time of last commit.
20706 All those are extracted from
20708 cvs log -r <file-name>
20712 \begin_inset CommandInset ref
20714 reference "subsec:VCS-Revision-Information"
20721 \begin_layout Subsection
20722 SVN commands in \SpecialChar LyX
20726 \begin_layout Standard
20727 SVN is now partially supported by \SpecialChar LyX
20729 You can find the commands in the
20731 File\SpecialChar menuseparator
20733 \begin_inset space ~
20739 Please note that if you use password protected access to repository via
20740 ssh, you will be asked in terminal window.
20742 was tested against SVN 1.5, 1.6, 1.7 and 1.8
20746 \begin_layout Plain Layout
20747 Most of the commands will work with 1.4 too, see
20748 \begin_inset CommandInset ref
20750 reference "subsec:SVN-Repo-Update"
20755 There seems to be currently unresolved permissions problem under SVN 1.8
20756 with reverting changes when file is locked.
20764 \begin_layout Subsubsection
20770 \begin_layout Standard
20771 If your document is not under revision control, this is the only item shown
20773 And if it is under revision control, the
20777 item is not visible.
20780 \begin_layout Standard
20781 This command registers in SVN your document ONLY in case you have already
20782 the documents directory under SVN control (in particular
20787 This means you have to checkout the archive by yourself.
20790 \begin_layout Standard
20791 Then you are asked interactively to supply an initial description of the
20793 Don't forget that registered file is not yet commited.
20796 \begin_layout Standard
20797 SVN command that is run:
20800 \begin_inset Quotes eld
20804 \begin_inset Quotes erd
20810 \begin_layout Standard
20815 to understand the switches.
20818 \begin_layout Subsubsection
20824 \begin_layout Standard
20825 When you are finished editing a file, you commit your changes.
20826 When you do this, you are asked for a description of the changes.
20827 After that changes are commited.
20830 \begin_layout Standard
20835 \begin_layout Plain Layout
20836 In case locking is not enabled.
20838 \begin_inset CommandInset ref
20840 reference "subsec:SVN-File-Locking"
20851 svn commit -q -m"<description>" <file-name>
20854 \begin_layout Subsubsection
20860 \begin_layout Standard
20861 Updates the changes of this file from the repository.
20862 Be sure you understand SVN merging and conflicts resolving before using
20863 this function, because all conflicts has to be resolved manually by you!
20866 \begin_layout Standard
20871 \begin_layout Plain Layout
20879 svn update --non-interactive
20880 \begin_inset Quotes eld
20884 \begin_inset Quotes erd
20890 \begin_layout Subsubsection
20893 Revert To Repository Version
20896 \begin_layout Standard
20897 This will discard all changes made to the document since the last check
20899 You get a warning before changes are discarded.
20902 \begin_layout Standard
20906 \begin_inset Quotes eld
20910 \begin_inset Quotes erd
20916 \begin_layout Subsubsection
20922 \begin_layout Standard
20923 This will create a copy of the current document including the version history.
20924 It requires a clean document without any changes since the last checkin.
20925 You are asked for a file name and a description of the copy operation.
20926 After that the copy is created, both locally and in the repository.
20927 If the parent directories of the copied and original document differ, all
20928 relative paths of included files of the copy are adjusted (like in
20930 File\SpecialChar menuseparator
20935 Finally, the copy is loaded instead of the original document.
20938 \begin_layout Labeling
20939 \labelwidthstring 00.00.0000
20941 \begin_inset space ~
20945 \begin_inset space ~
20949 \begin_inset Newline newline
20953 \begin_inset Flex Code
20956 \begin_layout Plain Layout
20960 \begin_inset Quotes eld
20964 \begin_inset Quotes erd
20968 \begin_inset Quotes eld
20972 \begin_inset Quotes erd
20981 \begin_inset Newline newline
20985 \begin_inset Flex Code
20988 \begin_layout Plain Layout
20997 \begin_layout Subsubsection
21003 \begin_layout Standard
21004 This will rename the current document including the version history.
21005 It requires a clean document without any changes since the last checkin.
21006 You are asked for a file name and a description of the rename operation.
21007 After that the document is renamed, both locally and in the repository.
21008 If the parent directories of the new and old file names differ, all relative
21009 paths of included files are adjusted (like in
21011 File\SpecialChar menuseparator
21016 Finally, the document is reloaded using the new name.
21019 \begin_layout Labeling
21020 \labelwidthstring 00.00.0000
21022 \begin_inset space ~
21026 \begin_inset space ~
21030 \begin_inset Newline newline
21034 \begin_inset Flex Code
21037 \begin_layout Plain Layout
21041 \begin_inset Quotes eld
21045 \begin_inset Quotes erd
21049 \begin_inset Quotes eld
21053 \begin_inset Quotes erd
21062 \begin_inset Newline newline
21066 \begin_inset Flex Code
21069 \begin_layout Plain Layout
21078 \begin_layout Subsubsection
21079 \begin_inset CommandInset label
21081 name "subsec:SVN-Repo-Update"
21085 Update of the local directory checkout from repository
21089 \begin_layout Plain Layout
21090 Note that this command will work only with subversion
21091 \begin_inset Formula $\geqq1.5$
21102 \begin_layout Standard
21103 All the commands above have one shortcomming - they deal with the current
21105 Once your document contains pictures, includes external
21106 \begin_inset Flex Code
21109 \begin_layout Plain Layout
21115 files and so on administration becomes more complicated.
21117 now supports updating the whole tree in which resides the document
21121 \begin_layout Plain Layout
21122 One need to organize the files structure so that all external files are
21123 in the same directory or subdirectories of the document.
21130 This become especially useful once you cooperate with people which neither
21131 know about subversion management nor they have ambition to commit additional
21132 material to the repository.
21136 \begin_layout Standard
21137 \begin_inset Flex Code
21140 \begin_layout Plain Layout
21141 Update local directory from repository
21146 command updates the whole directory and in case of merge conflicts local
21147 version of the files are left, so no unintended data loss occurs.
21148 If local changes are detected user is warned before update starts.
21151 \begin_layout Labeling
21152 \labelwidthstring 00.00.0000
21154 \begin_inset space ~
21158 \begin_inset space ~
21162 \begin_inset Newline newline
21166 \begin_inset Flex Code
21169 \begin_layout Plain Layout
21175 (Ask if changes are detected.)
21176 \begin_inset Newline newline
21180 \begin_inset Flex Code
21183 \begin_layout Plain Layout
21184 svn update –accept mine-full $path
21192 \begin_layout Standard
21194 \begin_inset Flex Code
21197 \begin_layout Plain Layout
21203 stands for the path to the document.
21206 \begin_layout Subsubsection
21212 \begin_layout Standard
21213 This shows the complete history of the SVN document.
21217 \begin_inset Quotes eld
21221 \begin_inset Quotes erd
21226 is shown in a browser.
21229 \begin_layout Subsubsection
21231 \begin_inset CommandInset label
21233 name "subsec:SVN-File-Locking"
21240 \begin_layout Standard
21241 The file exchange through various revision control systems brings the problem
21242 of merge conflicts in case two different users try to edit the same (parts
21244 When such a conflict happens it needs manual resolving and one reasonable
21245 alternative is to provide some kind of locking mechanism, which guarantees
21246 that only one user is allowed to edit file at the given time.
21249 \begin_layout Standard
21250 SVN has two such mechanisms to provide mutual exclusivity for file access
21251 - locks and automatic setting of write permissions (see sec.
21253 \begin_inset CommandInset ref
21255 reference "subsec:Automatical-Locking-Property"
21260 \begin_inset Flex Code
21263 \begin_layout Plain Layout
21273 \begin_layout Plain Layout
21274 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
21280 If this property is detected for a given document \SpecialChar LyX
21281 starts to use SVN locks
21282 for document editing automatically and the whole check-in/out mechanism
21283 switches to the same regimen as for RCS.
21284 This in particular means there are two different modes of file use in \SpecialChar LyX
21288 \begin_layout Itemize
21290 The loaded file is in the read-only mode.
21291 For editing on needs to check-out.
21296 consists of updating from the repository and gaining write lock.
21297 If the lock is not possible to obtain, we remain in unlocked state.
21300 \begin_layout Itemize
21302 The loaded file is in the 'normal' edit mode.
21303 No other user is allowed to edit the file.
21308 consists of commiting changes and releasing write-lock.
21309 If no changes have been made to the document, no commit will be produced
21313 \begin_layout Plain Layout
21314 Don't be puzzled by the fact that you will be asked for commit message anyway.
21319 and only the write-lock will be released.
21322 \begin_layout Standard
21326 \begin_layout Labeling
21327 \labelwidthstring 00.00.0000
21330 svn commit -q -m"<description>" "<file-name>"
21331 \begin_inset Newline newline
21334 svn unlock "<file-name>"
21337 \begin_layout Labeling
21338 \labelwidthstring 00.00.0000
21341 svn update "<file-name>"
21342 \begin_inset Newline newline
21345 svn lock "<file-name>"
21348 \begin_layout Subsubsection
21351 \begin_inset CommandInset label
21353 name "subsec:Automatical-Locking-Property"
21359 Automatic Locking Property
21362 \begin_layout Standard
21363 The above mentioned automatic setting of write permissions of the .lyx file
21366 File\SpecialChar menuseparator
21368 \begin_inset space ~
21371 Control\SpecialChar menuseparator
21372 Toggle locking property
21375 This command is active only when the file is not locked on the svn server
21377 you need to check-out before proceeding).
21380 \begin_layout Labeling
21381 \labelwidthstring 00.00.0000
21383 \begin_inset space ~
21389 \begin_layout Labeling
21390 \labelwidthstring 00.00.0000
21393 svn propset svn:needs-lock ON "<file-name>"
21396 \begin_layout Labeling
21397 \labelwidthstring 00.00.0000
21400 svn propdel svn:needs-lock "<file-name>"
21403 \begin_layout Subsubsection
21404 \begin_inset CommandInset label
21406 name "subsec:VCS-Revision-Information"
21410 Revision Information in Documents
21413 \begin_layout Standard
21414 There are more possibilities how to activate revision information in our
21418 \begin_layout Itemize
21424 \begin_layout Itemize
21425 tree revision information (
21426 \begin_inset Flex Code
21429 \begin_layout Plain Layout
21436 The result is the output of the
21437 \begin_inset Flex Code
21440 \begin_layout Plain Layout
21446 command, the following table gives you an idea, how to read the results.
21449 \begin_layout Standard
21451 \begin_inset Tabular
21452 <lyxtabular version="3" rows="6" columns="2">
21453 <features tabularvalignment="middle">
21454 <column alignment="center" valignment="top">
21455 <column alignment="center" valignment="top">
21457 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21460 \begin_layout Plain Layout
21466 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21469 \begin_layout Plain Layout
21477 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21480 \begin_layout Plain Layout
21486 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21489 \begin_layout Plain Layout
21490 mixed revision working copy
21497 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21500 \begin_layout Plain Layout
21506 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21509 \begin_layout Plain Layout
21510 modified working copy
21517 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21520 \begin_layout Plain Layout
21526 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21529 \begin_layout Plain Layout
21530 switched working copy
21537 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21540 \begin_layout Plain Layout
21546 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21549 \begin_layout Plain Layout
21550 partial working copy, from a sparse checkout
21557 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21560 \begin_layout Plain Layout
21566 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21569 \begin_layout Plain Layout
21570 mixed revision, modified, switched working copy
21583 \begin_layout Itemize
21584 file revision information.
21585 The result comes from parsing the output of
21586 \begin_inset Flex Code
21589 \begin_layout Plain Layout
21591 \begin_inset space ~
21595 \begin_inset space ~
21599 \begin_inset space ~
21608 Supported flags are:
21612 \begin_layout Itemize
21613 version number of the last commit (
21614 \begin_inset Flex Code
21617 \begin_layout Plain Layout
21626 \begin_layout Itemize
21627 author of the last commit (
21628 \begin_inset Flex Code
21631 \begin_layout Plain Layout
21640 \begin_layout Itemize
21641 date of the last commit (
21642 \begin_inset Flex Code
21645 \begin_layout Plain Layout
21654 \begin_layout Itemize
21655 time of the last commit (
21656 \begin_inset Flex Code
21659 \begin_layout Plain Layout
21669 \begin_layout Standard
21670 You can obtain this info via InsetInfo (e.g.
21672 \begin_inset Flex Code
21675 \begin_layout Plain Layout
21676 info-insert buffer vcs-date
21682 The information will be available only when you have the file stored under
21683 svn managment (i.e.
21685 \begin_inset Flex Code
21688 \begin_layout Plain Layout
21694 directory is available with your document).
21698 \begin_layout Itemize
21699 Another—a hacking one—possibility is to use svn keywords
21703 \begin_layout Plain Layout
21704 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
21710 In short – you set file keywords property (e.g.
21713 svn propset svn:keywords 'Rev' file.lyx
21715 ) and then paste keyword \SpecialChar TeX
21720 \begin_layout Plain Layout
21721 This is an easy way how to ensure that \SpecialChar LyX
21722 won't break the line in the middle
21728 tag in your document (e.g.
21733 \begin_layout Plain Layout
21741 This way svn client will automatically substitute revision number (e.g.
21746 \begin_layout Plain Layout
21753 ) after each update and commit.
21754 There are more problems with this approach.
21755 Firstly, the '$' character is used in \SpecialChar TeX
21756 world for math equations, so any
21757 occurence of math formula
21758 \begin_inset Formula $Rev$
21762 \begin_inset Formula $Rev:59$
21765 in your \SpecialChar LyX
21767 Similarly for other keywords like Id, Date, Author, etc.
21768 Secondly svn output is dependent on your locales, so its very easy that
21769 svn would produce some problematic strings once Date is used.
21770 Thirdly you get the whole 'Rev: 59' string in your document instead of
21772 Until subversion implements user's custom keywords it will be hard to use
21773 this approach reliably or let \SpecialChar LyX
21774 to support it directly.
21777 \begin_layout Subsection
21778 SVN and Windows Environment
21781 \begin_layout Quote
21782 My inclination is to say that if the user cannot figure out the command
21783 line operations on their own fairly quickly, they would be well advised
21784 to use TortoiseSVN.
21790 \begin_layout Subsubsection
21794 \begin_layout Standard
21795 In addition to installing \SpecialChar LyX
21796 , and having access to a Subversion repository,
21797 the user will need to install the Subversion client program.
21798 A Windows installer for the client program is available from
21799 \begin_inset CommandInset href
21802 target "http://www.collab.net/nonav/downloads/subversion/"
21807 The user may also want to install
21808 \begin_inset CommandInset href
21811 target "http://tortoisesvn.tigris.org/"
21815 , which integrates Subversion operations into the context (rightclick) menu
21816 of Windows Explorer.
21817 Operations done outside \SpecialChar LyX
21818 will typically be more convenient using the Explorer
21820 Note that TortoiseSVN is not a replacement for the client program, which
21821 is what \SpecialChar LyX
21825 \begin_layout Subsubsection
21826 Bringing a document under Subversion control
21829 \begin_layout Standard
21830 Before a \SpecialChar LyX
21831 document can be brought under version control in Subversion, its
21832 parent directory needs to be under version control.
21833 If the document is being added to a project already in the repository,
21834 this is accomplished by checking the project out to the directory where
21835 the new document will be placed.
21836 If the project itself is not yet under version control (for instance, if
21837 this document starts a new project), the directory must be imported into
21839 This is done outside \SpecialChar LyX
21841 Both import and checkout are easily accomplished from the Explorer context
21842 menu using TortoiseSVN, or alternatively can be done using the command
21843 line client at a DOS prompt.
21844 The procedure for importing the project using TortoiseSVN is described
21845 below, assuming an existing repository and a new project being started
21853 For information on using the Subversion client program, run
21860 \begin_layout Enumerate
21867 in Windows Explorer, right click it, and select
21869 TortoiseSVN\SpecialChar menuseparator
21873 If necessary, adjust the URL for the repository, then click OK.
21876 \begin_layout Enumerate
21877 Right click the level of the repository under which you want to place the
21878 new project folder (typically the top level) and click
21882 Supply a name for the project folder and click OK.
21883 Add a message for the log file if desired, then click OK again.
21884 The new project folder should appear in the repository.
21885 Finally, click OK again to exit the repository browser.
21888 \begin_layout Enumerate
21889 Once again right click
21895 , this time selecting SVN Checkout\SpecialChar ldots
21896 Select the URL of the project folder
21897 you just created in the repository, and set the checkout directory to
21905 You will be warned about a non-empty folder; click OK to proceed.
21906 You should now have a
21917 \begin_layout Enumerate
21918 Create or open your document in \SpecialChar LyX
21921 File\SpecialChar menuseparator
21923 \begin_inset space ~
21926 Control\SpecialChar menuseparator
21930 Add a log message and click OK to commit the document to version control.
21933 \begin_layout Standard
21934 From this point onward, you should have full functionality in the
21936 File\SpecialChar menuseparator
21938 \begin_inset space ~
21944 You also have the option of checking the document in and out, viewing its
21946 using the TortoiseSVN context menu in Windows Explorer or the Subversion
21947 client program from a command prompt.
21950 \begin_layout Subsubsection
21951 SSH tunnel used with SVN under Windows
21954 \begin_layout Standard
21955 Compared with Linux setting up an svn client to communicate over ssh under
21956 Windows is a rather troublesome task.
21957 We will at least offer some hints how to setup the client side but prior
21958 knowledge about ssh and the Windows command line is needed, also be prepared
21959 for a great deal of frustration\SpecialChar ldots
21963 \begin_layout Enumerate
21964 Get an svn client for windows, as described in the previous sections.
21965 When it is a fresh install run some svn command (e.g.
21967 \begin_inset Flex Code
21970 \begin_layout Plain Layout
21976 ) to create config files, which you will need to change later on.
21979 \begin_layout Enumerate
21980 Choose an ssh client for Windows.
21981 There are several possibilities, we will use the one from Putty tools
21985 \begin_layout Plain Layout
21986 \begin_inset Flex URL
21989 \begin_layout Plain Layout
21991 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
22002 You will need to set the connection up so that the client doesn't ask for
22003 any password from you.
22004 To keep things easy we will use only keys without any additional password
22009 \begin_layout Enumerate
22011 \begin_inset Flex Code
22014 \begin_layout Plain Layout
22021 Save your private .ppk key file and put the public one on the server side.
22022 If the SVN server runs on Linux, note that the format of the public key
22023 is not compatible with Linux openssh and you will need to direcly copy-paste
22026 Public key for pasting into OpenSSH authorized_keys file
22028 :” edit field into the server's
22029 \begin_inset Flex Code
22032 \begin_layout Plain Layout
22033 ~/.ssh/authorized_keys
22039 \begin_inset Flex Code
22042 \begin_layout Plain Layout
22051 \begin_layout Enumerate
22053 \begin_inset Flex Code
22056 \begin_layout Plain Layout
22063 In the SVN config file
22067 \begin_layout Plain Layout
22068 Exact path depends on Windows version, usually somewhere around
22069 \begin_inset Flex Code
22072 \begin_layout Plain Layout
22075 Documents and Settings
22089 \begin_inset Flex Code
22092 \begin_layout Plain Layout
22107 , section [tunnels], setup ssh command, e.g.
22109 \begin_inset Flex Code
22112 \begin_layout Plain Layout
22113 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
22122 \begin_layout Plain Layout
22123 It will usually take a lot of time to get exact command right and it depends
22125 For example do not have some remote server saved as a default session in
22127 If things fail, try to connect via plink without SVN first.
22136 \begin_layout Enumerate
22137 Checkout the SVN archive, e.
22138 \begin_inset space \thinspace{}
22142 \begin_inset Newline newline
22146 \begin_inset Flex Code
22149 \begin_layout Plain Layout
22150 svn co svn+ssh://user@server/repository_path
22158 \begin_layout Subsubsection
22159 End-of-Line Conversions
22162 \begin_layout Standard
22163 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
22165 use different line endings inside the .lyx files.
22166 This is not a problem as far as \SpecialChar LyX
22167 functionality is concerned, but the commit
22168 diffs will be huge and merge-conflicts prone.
22169 Fortunately SVN itself knows
22173 \begin_layout Plain Layout
22174 \begin_inset Flex URL
22177 \begin_layout Plain Layout
22179 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
22189 how to deal with CR/LF problems when switching .lyx files to the
22190 \begin_inset Flex Code
22193 \begin_layout Plain Layout
22203 \begin_layout Plain Layout
22205 \begin_inset Flex Code
22208 \begin_layout Plain Layout
22209 svn propset svn:eol-style native FILE_NAME
22222 \begin_layout Subsection
22223 GIT commands in \SpecialChar LyX
22227 \begin_layout Standard
22228 A minimal subset of GIT commands is now supported by \SpecialChar LyX
22230 You can find the commands in the
22232 File\SpecialChar menuseparator
22234 \begin_inset space ~
22240 Please note that if you use password protected access to repository via
22241 ssh, you will be asked in terminal window.
22243 was tested against GIT 1.7.
22247 \begin_layout Plain Layout
22248 Windows users please note that you need to ensure that git is on the path.
22249 This can be set from within \SpecialChar LyX
22252 Tools\SpecialChar menuseparator
22253 Preferences\SpecialChar menuseparator
22254 Paths\SpecialChar menuseparator
22265 \begin_layout Standard
22266 One big difference of GIT and the other supported version control systems
22267 is the distributed nature of GIT: With traditional version control systems
22268 there is one central server which hosts the repository.
22269 Users commit their changes to the server, and get updates made by other
22271 With GIT, users commit to a local repository.
22272 The local repository can be synchronized with one or more remote repositories
22274 \begin_inset Flex Code
22277 \begin_layout Plain Layout
22284 \begin_inset Flex Code
22287 \begin_layout Plain Layout
22295 does not interact in any way with remote GIT repositories.
22296 It works exclusively with the local repository in a very similar way as
22297 with a central CVS or SVN repository.
22298 If you use remote GIT repositories you need to do the
22299 \begin_inset Flex Code
22302 \begin_layout Plain Layout
22309 \begin_inset Flex Code
22312 \begin_layout Plain Layout
22318 operations with your favourite GIT client.
22321 \begin_layout Subsubsection
22327 \begin_layout Standard
22328 If your document is not under revision control, this is the only item shown
22330 And if it is under revision control, the
22334 item is not visible.
22337 \begin_layout Standard
22338 This command registers in GIT your document ONLY in case you have already
22339 the documents directory under GIT control (in particular
22344 This means you have to checkout the archive by yourself.
22347 \begin_layout Standard
22348 Then you are asked interactively to supply an initial description of the
22350 Don't forget that registered file is not yet commited.
22353 \begin_layout Standard
22354 GIT command that is run:
22357 \begin_inset Quotes eld
22361 \begin_inset Quotes erd
22367 \begin_layout Standard
22372 to understand the switches.
22375 \begin_layout Subsubsection
22381 \begin_layout Standard
22382 When you are finished editing a file, you commit your changes.
22383 When you do this, you are asked for a description of the changes.
22384 After that changes are commited.
22387 \begin_layout Standard
22390 git commit -q -m"<description>" <file-name>
22393 \begin_layout Subsubsection
22396 Revert To Repository Version
22399 \begin_layout Standard
22400 This will discard all changes made to the document since the last check
22402 You get a warning before changes are discarded.
22405 \begin_layout Standard
22409 \begin_inset Quotes eld
22413 \begin_inset Quotes erd
22419 \begin_layout Subsubsection
22425 \begin_layout Standard
22426 This will rename the current document including the version history.
22427 It requires a clean document without any changes since the last checkin.
22428 You are asked for a file name and a description of the rename operation.
22429 After that the document is renamed, both locally and in the repository.
22430 If the parent directories of the new and old file names differ, all relative
22431 paths of included files are adjusted (like in
22433 File\SpecialChar menuseparator
22438 Finally, the document is reloaded using the new name.
22441 \begin_layout Labeling
22442 \labelwidthstring 00.00.0000
22444 \begin_inset space ~
22448 \begin_inset space ~
22452 \begin_inset Newline newline
22456 \begin_inset Flex Code
22459 \begin_layout Plain Layout
22463 \begin_inset Quotes eld
22467 \begin_inset Quotes erd
22471 \begin_inset Quotes eld
22475 \begin_inset Quotes erd
22484 \begin_inset Newline newline
22488 \begin_inset Flex Code
22491 \begin_layout Plain Layout
22500 \begin_layout Subsubsection
22506 \begin_layout Standard
22507 This shows the complete history of the GIT document.
22511 \begin_inset Quotes eld
22515 \begin_inset Quotes erd
22520 is shown in a browser.
22523 \begin_layout Subsubsection
22527 \begin_layout Standard
22529 supports GIT hash number of the last commit to the file, author name, date
22530 and time of last commit.
22531 All those are extracted from
22533 git log -n 1 --pretty=format:%H%n%an%n%ai
22536 Tree version information is obtained via
22538 git describe --abbrev --dirty --long
22542 \begin_inset CommandInset ref
22544 reference "subsec:VCS-Revision-Information"
22551 \begin_layout Subsection
22555 \begin_layout Standard
22556 With the recent addition of the vc-command function \SpecialChar LyX
22557 power users are allowed
22558 to create their own commands for revision control.
22561 \begin_layout Standard
22562 As an example you can see how two TortoiseSVN commands could be integrated
22566 \begin_layout Description
22568 \begin_inset Flex Code
22571 \begin_layout Plain Layout
22572 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
22580 \begin_layout Description
22582 \begin_inset Flex Code
22585 \begin_layout Plain Layout
22586 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
22594 \begin_layout Subsection
22595 Version control and Document comparison
22598 \begin_layout Standard
22599 One of the typical uses of version control is to inspect the changes between
22600 revisions, usually by creating
22601 \begin_inset Flex Code
22604 \begin_layout Plain Layout
22611 While this is useful for plain text files, it is much less useful in the
22612 case of \SpecialChar LyX
22613 files, which have more a complicated structure.
22614 Hence we provide binding to the Document comparison feature.
22615 There are two ways of calling this feature - either by direct call of
22616 \begin_inset Flex Code
22619 \begin_layout Plain Layout
22626 function (for details see \SpecialChar LyX
22627 functions manual) or by icon/menu item
22628 \begin_inset Flex Noun
22631 \begin_layout Plain Layout
22632 Compare with older revision...
22638 One can either compare two chosen revisions of the document or he can simply
22639 compare the current version of edited text with older revisions (where
22641 \begin_inset Flex Noun
22644 \begin_layout Plain Layout
22650 ' revisions back means comparison of the edited file with last commited
22655 \begin_layout Standard
22656 This feature is supported for SVN and RCS though due to the more complicated
22657 versioning scheme of RCS there is a constraint – when addressing the revisions
22658 in dialog, numbers always point to the last number in RCS revision number,
22661 We don't currently support GIT addressing of revisions, one can just compare
22662 edited document with its revision X steps backs, where X is addressed as
22666 \begin_layout Section
22667 Literate Programming
22670 \begin_layout Standard
22675 (kayvan@sylvan.com)
22679 original documentation written by
22681 Edmar Wienskoski Jr.
22684 (edmar-w-jr@technologist.com)
22687 \begin_layout Subsection
22691 \begin_layout Standard
22692 The main purpose of this documentation is to show you how to use \SpecialChar LyX
22694 programming, where it is assumed that you are familiar with this programming
22695 technique, and know what
22696 \begin_inset Quotes eld
22700 \begin_inset Quotes erd
22704 \begin_inset Quotes eld
22708 \begin_inset Quotes erd
22712 If that is not the case, please follow the web links provided in the following
22714 There is a lot of good documentation out there covering old development
22715 history to the latest tools tips.
22718 \begin_layout Standard
22719 It is also assumed that you are familiar with \SpecialChar LyX
22720 itself to a point that you
22721 are comfortable changing your \SpecialChar LyX
22722 preferences, and X resources file.
22723 If that is not the case please refer to other \SpecialChar LyX
22724 documentation to cover your
22728 \begin_layout Subsection
22729 Literate Programming
22732 \begin_layout Standard
22733 From the Literate Programming FAQ:
22736 \begin_layout Quotation
22737 Literate programming is the combination of documentation and source together
22738 in a fashion suited for reading by human beings.
22739 In fact, literate programs should be enjoyable reading, even inviting!
22740 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
22741 and documentation in a single file.
22742 Literate programming tools then parse the file to produce either readable
22743 documentation or compilable source.
22744 The WEB style of literate programming was created by D.
22745 \begin_inset space \thinspace{}
22749 Knuth during the development of his \SpecialChar TeX
22750 typesetting software.
22754 \begin_layout Standard
22755 Another excerpt says:
22758 \begin_layout Quotation
22761 How is literate programming different from verbose commenting?
22764 \begin_layout Quotation
22765 There are three distinguishing characteristics.
22766 In order of importance, they are:
22770 \begin_layout Itemize
22771 flexible order of elaboration
22774 \begin_layout Itemize
22775 automatic support for browsing
22778 \begin_layout Itemize
22779 typeset documentation, especially diagrams and mathematics
22783 \begin_layout Standard
22784 Now that I sparked your curiosity, take a look in the references.
22787 \begin_layout Subsubsection
22791 \begin_layout Standard
22792 The complete Literate Programming FAQ can be found at:
22795 \begin_layout Quote
22796 Literate Programming FAQ
22797 \begin_inset Flex URL
22800 \begin_layout Plain Layout
22802 http://www.literateprogramming.com/lpfaq.pdf
22810 \begin_layout Standard
22811 The FAQ lists 23 (twenty three!) different literate programming tools.
22812 Where some are specialized or
22813 \begin_inset Quotes eld
22817 \begin_inset Quotes erd
22820 for particular programming languages, while other have general scope.
22825 for my own use for several reasons:
22828 \begin_layout Itemize
22829 It can generate the documentation either in \SpecialChar LaTeX
22833 \begin_layout Itemize
22834 It has a open architecture, i.
22835 \begin_inset space \thinspace{}
22839 \begin_inset space \space{}
22842 it is easy to plug in new filters and to perform special processing that
22847 \begin_layout Itemize
22848 There is a good selection of filters available already (the HTML is one
22852 \begin_layout Itemize
22856 \begin_layout Standard
22857 The Noweb web page can be found at:
22860 \begin_layout Quote
22862 \begin_inset Flex URL
22865 \begin_layout Plain Layout
22867 http://www.cs.virginia.edu/~nr/noweb/
22875 \begin_layout Standard
22876 Starting from there you can reach many other interesting links and even
22877 some literate program examples.
22880 \begin_layout Subsection
22882 and Literate Programming with Noweb
22885 \begin_layout Standard
22886 The \SpecialChar LyX
22887 support for Literate Programming is provided by using the generic \SpecialChar LyX
22889 converters mechanism.
22890 This support is provided in a
22891 \begin_inset Quotes eld
22895 \begin_inset Quotes erd
22899 \begin_inset space \thinspace{}
22903 \begin_inset space \space{}
22906 you will be able to use this new \SpecialChar LyX
22907 feature with some other literate programming
22908 tool of your choice by just changing your \SpecialChar LyX
22912 \begin_layout Subsubsection
22913 Generating documents and code (weaving and tangling)
22916 \begin_layout Paragraph
22917 Using the noweb module
22920 \begin_layout Standard
22921 If you have installed Noweb and \SpecialChar LyX
22922 successfully, whenever you open a new document,
22923 after you have chosen its document class, use the Document->Settings menu
22925 \begin_inset Quotes eld
22929 \begin_inset Quotes erd
22933 If Noweb is correctly installed, when you click on the
22934 \begin_inset Quotes eld
22938 \begin_inset Quotes erd
22941 link, you will see the
22942 \begin_inset Quotes eld
22946 \begin_inset Quotes erd
22949 module in the available list and you can add it to your document.
22952 \begin_layout Paragraph
22956 \begin_layout Standard
22958 enables you to write code with a layout named
22959 \begin_inset Flex Noun
22962 \begin_layout Plain Layout
22969 Noweb delimits chunks like this:
22972 \begin_layout LyX-Code
22976 \begin_layout LyX-Code
22980 \begin_layout LyX-Code
22984 \begin_layout LyX-Code
22988 \begin_layout LyX-Code
22992 \begin_layout Standard
22993 The problem is that whatever is written in between the << and the
22997 must be taken literally, i.
22998 \begin_inset space \thinspace{}
23002 \begin_inset space \space{}
23006 should be prevented from making any special interpretation of what has
23008 This is also handled by
23009 \begin_inset Flex Noun
23012 \begin_layout Plain Layout
23018 , that works like a normal paragraph but has a free spacing capability.
23021 \begin_layout Standard
23022 As a special note, you can also use the
23023 \begin_inset Quotes eld
23027 \begin_inset Quotes erd
23030 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
23034 \begin_layout LyX-Code
23038 \begin_layout LyX-Code
23039 def some_function(args):
23042 \begin_layout LyX-Code
23043 "This is the doc string for this function."
23046 \begin_layout LyX-Code
23047 print "My args: ", args
23050 \begin_layout LyX-Code
23051 @ %def some_function
23054 \begin_layout Standard
23055 For an example of this usage and the resulting cross-reference output, look
23056 at the Literate python program in
23058 LIBDIR/examples/listerrors.lyx
23060 which should make this all clear.
23063 \begin_layout Paragraph
23064 Generating the documentation
23067 \begin_layout Standard
23068 At this point you already have a new document file with a proper document
23069 class, and with some code and text on it.
23070 How do I print it? The answer is simple, you select
23072 View\SpecialChar menuseparator
23076 Just like you would do for a plain document.
23077 No special procedure is required.
23080 \begin_layout Standard
23081 To help orientate you, I will now explain what happens inside \SpecialChar LyX
23085 \begin_layout Enumerate
23088 Update\SpecialChar menuseparator
23091 menu option is chosen, a \SpecialChar LaTeX
23097 \begin_layout Standard
23098 If the document is of any literate class the generated file will be named
23099 with an extension name defined by the
23100 \begin_inset Quotes eld
23104 \begin_inset Quotes erd
23107 format (defined in the Preferences panel), otherwise the file will have
23116 \begin_layout Enumerate
23117 Note that the only difference so far is in the name of the file, no special
23118 processing is required by \SpecialChar LyX
23120 Given that you formatted the code using the
23121 \begin_inset Flex Noun
23124 \begin_layout Plain Layout
23130 layout that, by itself, takes care of the business.
23133 \begin_layout Enumerate
23134 If the document is of any literate class \SpecialChar LyX
23135 will then use the internal \SpecialChar LyX
23137 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
23142 \begin_layout Plain Layout
23143 The converters are defined in the
23145 Tools\SpecialChar menuseparator
23149 \begin_inset Quotes eld
23153 \begin_inset Quotes erd
23165 manual for general information about converters.
23170 to generate the \SpecialChar LaTeX
23175 \begin_layout Standard
23176 Otherwise it will just skip this step.
23180 \begin_layout Enumerate
23181 Finally, \SpecialChar LaTeX
23182 is invoked and the regular post processing continues as in a plain
23186 \begin_layout Standard
23187 Independence from a particular
23188 \begin_inset Quotes eld
23192 \begin_inset Quotes erd
23195 is easily achieved by changing the commands that are run by the various
23199 \begin_layout Paragraph
23200 Generating the code
23203 \begin_layout Standard
23204 When the build menu option is chosen or the corresponding button in the
23205 toolbar is pressed, a \SpecialChar LaTeX
23206 file is generated just like step 1 above.
23207 Next, \SpecialChar LyX
23213 This converter needs to be defined by the user and is not installed by
23214 default, though the Program format is.
23215 This converter (like any other converter) will have two parts:
23218 \begin_layout Enumerate
23219 The converter program itself.
23220 This program performs the conversion from the one format to the other (in
23221 this case, from the Noweb format to the Program pseudo-format).
23224 \begin_layout Enumerate
23225 The error log parser.
23226 This is a program whose sole purpose is to rewrite error messages in a
23227 format that \SpecialChar LyX
23229 This makes it possible for \SpecialChar LyX
23230 to place error boxes in the right places in
23234 \begin_layout Standard
23235 The first part, the
23236 \begin_inset Quotes eld
23240 \begin_inset Quotes erd
23243 setting, should be set to
23244 \begin_inset Newline newline
23248 \begin_inset Quotes eld
23256 \begin_inset Quotes erd
23260 \begin_inset Newline newline
23263 This basically means that \SpecialChar LyX
23265 \begin_inset Quotes eld
23269 \begin_inset Quotes erd
23272 (a program or script) with the name of the Noweb file (normally a file
23273 in the \SpecialChar LyX
23274 temp directory) and the directory path of the original \SpecialChar LyX
23279 \begin_layout Standard
23280 This is an implementation of
23281 \begin_inset Quotes eld
23285 \begin_inset Quotes erd
23288 that you can place in a directory on your path:
23291 \begin_layout Standard
23292 \begin_inset VSpace defskip
23298 \begin_layout Standard
23299 \begin_inset Newpage pagebreak
23305 \begin_layout Standard
23311 \begin_layout Standard
23317 \begin_layout Standard
23320 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
23323 \begin_layout Standard
23324 \begin_inset VSpace defskip
23330 \begin_layout Standard
23331 The next part of the converter setting is the
23332 \begin_inset Quotes eld
23336 \begin_inset Quotes erd
23339 which is to be set to
23340 \begin_inset Newline newline
23344 \begin_inset Quotes eld
23349 parselog=$$s/scripts/listerrors
23352 \begin_inset Quotes erd
23356 \begin_inset Newline newline
23359 This will run any errors that are generated by the
23360 \begin_inset Quotes eld
23364 \begin_inset Quotes erd
23367 process through the
23368 \begin_inset Quotes eld
23372 \begin_inset Quotes erd
23378 \begin_layout Standard
23379 The build will normally take place in \SpecialChar LyX
23380 's temporary directory, so the files
23381 produced by the conversion will be in that directory.
23383 will copy out what it regards as the `main' file, but the
23387 conversion may produce several files, and so most of these would then be
23388 deleted when \SpecialChar LyX
23390 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
23391 the build-script chunk can place the generated files in that location.
23394 \begin_layout Paragraph
23395 Build instructions in the document
23398 \begin_layout Standard
23399 The last piece of the integration between \SpecialChar LyX
23401 \begin_inset Quotes eld
23405 \begin_inset Quotes erd
23409 Generally, the instructions for building your program should be embedded
23410 in a chunk of its own.
23412 \begin_inset Quotes eld
23416 \begin_inset Quotes erd
23419 above uses the notangle command to look for this chunk (called
23420 \begin_inset Quotes eld
23424 \begin_inset Quotes erd
23427 ) and runs its contents through
23428 \begin_inset Quotes eld
23432 \begin_inset Quotes erd
23438 \begin_layout Standard
23439 Typically, such a chunk would look something like this:
23442 \begin_layout LyX-Code
23446 \begin_layout LyX-Code
23448 \begin_inset Newline newline
23451 if [ -z "${NOWEB_SOURCE}" ]
23452 \begin_inset Newline newline
23458 \begin_layout LyX-Code
23459 NOWEB_SOURCE=myfile.nw
23460 \begin_inset Newline newline
23464 \begin_inset Newline newline
23468 code to extract files ...
23469 use NOWEB_OUTPUT_DIR here ...]
23470 \begin_inset Newline newline
23474 code to compile files ...]
23475 \begin_inset Newline newline
23481 \begin_layout Standard
23484 LIBDIR/examples/listerrors.lyx
23488 LIBDIR/examples/Literate.lyx
23490 which implement two versions of the
23491 \begin_inset Quotes eld
23495 \begin_inset Quotes erd
23498 program for some illustrations of how all of these pieces go together or
23501 LIBDIR/examples/noweb2lyx.lyx.
23504 Interestingly, these three files show off the language-indepence of the
23506 literate programming support since they are written in Python, C and Perl
23510 \begin_layout Subsubsection
23511 Configuring \SpecialChar LyX
23515 \begin_layout Standard
23516 All the Literate Programming support is configured by the
23518 Tools\SpecialChar menuseparator
23522 \begin_inset Quotes eld
23526 \begin_inset Quotes erd
23530 The important parts are:
23533 \begin_layout Description
23535 \begin_inset space ~
23539 \begin_inset Quotes eld
23543 \begin_inset Quotes erd
23547 \begin_inset space ~
23550 format Set up via the File Formats tab, this is where the Noweb-specific
23560 , the file extension is set to
23565 This tells \SpecialChar LyX
23566 to create a file with a
23570 extension in the first step of the conversion process.
23573 \begin_layout Description
23575 \begin_inset space ~
23583 \begin_inset space ~
23586 format This is an empty format whose sole purpose is to be the endpoint
23587 of a conversion (which then allows us to set up a converter for it).
23590 \begin_layout Description
23600 This converter performs the
23601 \begin_inset Quotes eld
23605 \begin_inset Quotes erd
23608 of the literate document.
23609 For Noweb, it is set to
23610 \begin_inset Quotes eld
23615 noweave -delay -index $$i > $$o
23618 \begin_inset Quotes erd
23624 \begin_layout Description
23634 \begin_inset Quotes eld
23638 \begin_inset Quotes erd
23642 As stated above, the Converter is set to
23643 \begin_inset Quotes eld
23651 \begin_inset Quotes erd
23654 , with Flags set to
23655 \begin_inset Newline newline
23659 \begin_inset Quotes eld
23664 parselog=$$s/scripts/listerrors
23667 \begin_inset Quotes erd
23673 \begin_layout Subsubsection
23677 \begin_layout Standard
23678 There is also a new function implemented in the \SpecialChar LyX
23680 \begin_inset Quotes eld
23683 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
23687 \begin_layout Standard
23688 When debugging code with ddd/gdb, it is possible to invoke a text editor
23689 at the current execution position with a single key stroke.
23690 The default ddd configuration for that is shift-ctrl-V.
23691 It happens that you can define the editor command line invocation in ddd
23694 Edit\SpecialChar menuseparator
23695 Preferences\SpecialChar menuseparator
23698 dialog and changing the "Edit Sources" entry.
23701 \begin_layout Standard
23702 I take advantage of the newly created \SpecialChar LyX
23703 server function and this ddd feature,
23705 \begin_inset Quotes eld
23709 \begin_inset Quotes erd
23715 \begin_layout Standard
23716 \begin_inset VSpace defskip
23722 \begin_layout Standard
23725 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
23728 \begin_layout Standard
23729 \begin_inset VSpace defskip
23735 \begin_layout Standard
23736 With this, whenever you are using ddd and find a point in the program that
23737 you want to edit, you just press shift-ctrl-V (in the ddd window), and
23738 ddd will forward this information to \SpecialChar LyX
23739 through the \SpecialChar LyX
23740 server and then the
23742 window will show the same file with the cursor at the same position ddd
23744 No more guessing or long scrolling to locate a point in the program back
23748 \begin_layout Standard
23749 Note however that you must enable the \SpecialChar LyX
23750 server to get this feature working
23751 (it is disabled by default).
23752 You can enable it in
23764 ) by entering in the
23770 \begin_inset Quotes eld
23775 /home/<your-home-directory>/.lyx/lyxpipe
23778 \begin_inset Quotes erd
23784 \begin_layout Standard
23785 Read the \SpecialChar LyX
23786 server documentation in the
23788 Customization Manual
23790 for further information.
23793 \begin_layout Subsubsection
23797 \begin_layout Standard
23798 There are six new buttons that can be added to your \SpecialChar LyX
23800 Five of these buttons are short cuts to layout styles:
23823 The last one is a short cut to the
23824 \begin_inset Quotes eld
23828 \begin_inset Quotes erd
23835 \begin_layout Standard
23837 has a range of buttons that are available for tool bar customization.
23838 In my toolbar I like to combine the six short cuts above with two more:
23843 \SpecialChar menuseparator
23848 \SpecialChar menuseparator
23855 Document\SpecialChar menuseparator
23856 View\SpecialChar menuseparator
23860 Here is how it looks like:
23863 \begin_layout LyX-Code
23867 \begin_layout LyX-Code
23871 \begin_layout LyX-Code
23872 Icon "layout Standard"
23875 \begin_layout LyX-Code
23876 Icon "layout Section"
23879 \begin_layout LyX-Code
23880 Icon "layout \SpecialChar LaTeX
23884 \begin_layout LyX-Code
23885 Icon "layout \SpecialChar LyX
23889 \begin_layout LyX-Code
23890 Icon "layout Chunk"
23893 \begin_layout LyX-Code
23897 \begin_layout LyX-Code
23901 \begin_layout LyX-Code
23902 Icon "buffer-typeset"
23905 \begin_layout LyX-Code
23906 Icon "build-program"
23909 \begin_layout LyX-Code
23913 \begin_layout LyX-Code
23917 \begin_layout LyX-Code
23921 \begin_layout LyX-Code
23925 \begin_layout LyX-Code
23929 \begin_layout Subsubsection
23930 Colors customization
23933 \begin_layout Standard
23934 There are a number of colors in \SpecialChar LyX
23935 that can be customized in
23940 One of the things that bothers people is the \SpecialChar LaTeX
23942 The default color is red, since the chunks uses \SpecialChar LaTeX
23943 font, and there is a lot
23944 of chunks in literate documents, you may get tired of seeing everything
23946 You can change it by going to the tabs
23955 \begin_layout Standard
23956 The next thing is the visible presence of the newline character in the screen.
23957 You can choose the color of this particular character and make it blend
23959 I recommend you choosing a color that is close to the background but not
23960 equal, that way you still can see it is there, but it is not bothering
23964 \begin_layout Subsection
23969 \begin_layout Standard
23978 is documented in the
23982 example file and in the Sweave manual (menu
23984 Help\SpecialChar menuseparator
23990 \begin_layout Chapter
23994 \begin_layout Standard
23995 You can do everything with \SpecialChar LyX
23996 that you can do with \SpecialChar LaTeX
23998 However, \SpecialChar LyX
23999 cannot support every \SpecialChar LaTeX
24001 But you can always use \SpecialChar TeX
24003 This chapter shows you some more special things you might want to use.
24004 For other special things you can do with figures, tables, floats, boxes
24005 and notes, have a look at the
24008 \begin_inset space ~
24016 \begin_layout Section
24017 Multiple Text Columns
24020 \begin_layout Standard
24021 This feature is independent of the option
24023 Two-column document
24025 in the document settings under
24030 If you want to have 2
24031 \begin_inset space ~
24034 columns for the whole document, it is recommended to use the
24036 Two-column document
24039 For all other cases use this feature.
24042 \begin_layout Standard
24043 To use multiple text columns in your document, you have to load the module
24050 Document\SpecialChar menuseparator
24051 Settings\SpecialChar menuseparator
24054 ) and must have the \SpecialChar LaTeX
24062 \begin_layout Standard
24063 Footnotes within multiple columns will be placed at the bottom of the page
24064 and not under each column.
24065 Within the different columns you can use everything, with the limitation
24066 that for floats you need to use the float option
24073 \begin_layout Subsection
24077 \begin_layout Standard
24078 If you want to have 2
24079 \begin_inset space ~
24082 columns in your text, insert a multicolumn inset via the menu
24084 Insert\SpecialChar menuseparator
24086 \begin_inset space ~
24089 Insets\SpecialChar menuseparator
24091 \begin_inset space ~
24096 where the columns should start.
24097 Write all text that should be printed in 2
24098 \begin_inset space ~
24101 columns into this inset.
24104 \begin_layout Standard
24105 Here is an example:
24108 \begin_layout Standard
24110 \begin_inset Flex Multiple Columns
24113 \begin_layout Plain Layout
24118 The Adventure of the Empty House
24121 \begin_inset Newline newline
24124 by Sir Arthur Conan Doyle
24127 \begin_layout Plain Layout
24130 It was in the spring of the year 1894 that all London was interested, and
24131 the fashionable world dismayed, by the murder of the Honourable Ronald
24132 Adair under most unusual and inexplicable circumstances.
24133 The public has already learned those particulars of the crime which came
24134 out in the police investigation, but a good deal was suppressed upon that
24135 occasion, since the case for the prosecution was so overwhelmingly strong
24136 that it was not necessary to bring forward all the facts.
24137 Only now, at the end of nearly ten years, am I allowed to supply those
24138 missing links which make up the whole of that remarkable chain.
24139 The crime was of interest in itself, but that interest was as nothing to
24140 me compared to the inconceivable sequel, which afforded me the greatest
24141 shock and surprise of any event in my adventurous life.
24142 Even now, after this long interval, I find myself thrilling as I think
24143 of it, and feeling once more that sudden flood of joy, amazement, and increduli
24144 ty which utterly submerged my mind.
24145 Let me say to that public, which has shown some interest in those glimpses
24146 which I have occasionally given them of the thoughts and actions of a very
24147 remarkable man, that they are not to blame me if I have not shared my knowledge
24148 with them, for I should have considered it my first duty to do so, had
24149 I not been barred by a positive prohibition from his own lips, which was
24150 only withdrawn upon the third of last month.
24158 \begin_layout Standard
24159 To get 3 or more columns, set the cursor into the multicolumn inset and
24162 Insert\SpecialChar menuseparator
24164 \begin_inset space ~
24168 \begin_inset space ~
24174 The number of the desired columns is written into that inset (for 3
24175 \begin_inset space ~
24179 \begin_inset Quotes eld
24183 \begin_inset Quotes erd
24187 \begin_inset Newline newline
24190 Here is an example with 3
24191 \begin_inset space ~
24197 \begin_layout Standard
24198 \begin_inset Flex Multiple Columns
24201 \begin_layout Plain Layout
24204 \begin_inset Argument 1
24207 \begin_layout Plain Layout
24213 It can be imagined that my close intimacy with Sherlock Holmes had interested
24214 me deeply in crime, and that after his disappearance I never failed to
24215 read with care the various problems which came before the public.
24216 And I even attempted, more than once, for my own private satisfaction,
24217 to employ his methods in their solution, though with indifferent success.
24218 There was none, however, which appealed to me like this tragedy of Ronald
24220 As I read the evidence at the inquest, which led up to a verdict of willful
24221 murder against some person or persons unknown, I realized more clearly
24222 than I had ever done the loss which the community had sustained by the
24223 death of Sherlock Holmes.
24224 There were points about this strange business which would, I was sure,
24225 have specially appealed to him, and the efforts of the police would have
24226 been supplemented, or more probably anticipated, by the trained observation
24227 and the alert mind of the first criminal agent in Europe.
24228 All day, as I drove upon my round, I turned over the case in my mind and
24229 found no explanation which appeared to me to be adequate.
24230 At the risk of telling a twice-told tale, I will recapitulate the facts
24231 as they were known to the public at the conclusion of the inquest.
24239 \begin_layout Standard
24240 You can have up to 10
24241 \begin_inset space ~
24244 columns if you want to, but that might not be very pleasant for the readers
24248 \begin_layout Standard
24249 \begin_inset Newpage newpage
24255 \begin_layout Subsection
24256 Columns inside Columns
24259 \begin_layout Standard
24260 You can also have columns inside columns:
24263 \begin_layout Standard
24264 \begin_inset Flex Multiple Columns
24267 \begin_layout Plain Layout
24270 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
24271 at that time governor of one of the Australian colonies.
24272 Adair's mother had returned from Australia to undergo the operation for
24273 cataract, and she, her son Ronald, and her daughter Hilda were living together
24277 \begin_layout Plain Layout
24278 \begin_inset Flex Multiple Columns
24281 \begin_layout Plain Layout
24284 The youth moved in the best society–had, so far as was known, no enemies
24285 and no particular vices.
24286 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
24287 had been broken off by mutual consent some months before, and there was
24288 no sign that it had left any very profound feeling behind it.
24289 For the rest {sic} the man's life moved in a narrow and conventional circle,
24290 for his habits were quiet and his nature unemotional.
24291 Yet it was upon this easy-going young aristocrat that death came, in most
24292 strange and unexpected form, between the hours of ten and eleven-twenty
24293 on the night of March 30, 1894.
24301 \begin_layout Plain Layout
24304 Ronald Adair was fond of cards–playing continually, but never for such stakes
24306 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
24307 It was shown that, after dinner on the day of his death, he had played
24308 a rubber of whist at the latter club.
24309 He had also played there in the afternoon.
24314 The evidence of those who had played with him– Mr.
24315 Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
24316 and that there was a fairly equal fall of the cards.
24317 Adair might have lost five pounds, but not more.
24318 His fortune was a considerable one, and such a loss could not in any way
24320 He had played nearly every day at one club or other, but he was a cautious
24321 player, and usually rose a winner.
24322 It came out in evidence that, in partnership with Colonel Moran, he had
24323 actually won as much as four hundred and twenty pounds in a sitting, some
24324 weeks before, from Godfrey Milner and Lord Balmoral.
24325 So much for his recent history as it came out at the inquest.
24333 \begin_layout Subsection
24337 \begin_layout Standard
24338 The examples in this section show some more special features of multiple
24342 \begin_layout Standard
24343 For more features of multiple columns, have a look at the documentation
24344 of the \SpecialChar LaTeX
24350 \begin_inset CommandInset citation
24359 \begin_layout Subsubsection
24363 \begin_layout Standard
24364 To add a preface text for multiple columns, set the cursor into the multicolumn
24365 inset and use the menu
24367 Insert\SpecialChar menuseparator
24371 Write your preface text into that inset.
24372 \begin_inset Newline newline
24375 This is an example with some preface text:
24378 \begin_layout Standard
24379 \begin_inset VSpace bigskip
24385 \begin_layout Standard
24386 \begin_inset Flex Multiple Columns
24389 \begin_layout Plain Layout
24390 \begin_inset Argument 2
24393 \begin_layout Plain Layout
24394 And the story continues and continues and continues and continues\SpecialChar ldots
24402 On the evening of the crime, he returned from the club exactly at ten.
24403 His mother and sister were out spending the evening with a relation.
24404 The servant deposed that she heard him enter the front room on the second
24405 floor, generally used as his sitting-room.
24406 She had lit a fire there, and as it smoked she had opened the window.
24407 No sound was heard from the room until eleven-twenty, the hour of the return
24408 of Lady Maynooth and her daughter.
24409 Desiring to say good-night, she attempted to enter her son's room.
24410 The door was locked on the inside, and no answer could be got to their
24411 cries and knocking.
24412 Help was obtained, and the door forced.
24413 The unfortunate young man was found lying near the table.
24414 His head had been horribly mutilated by an expanding revolver bullet, but
24415 no weapon of any sort was to be found in the room.
24423 \begin_layout Standard
24424 You can also use a section heading as the preface if you use a section command
24425 as \SpecialChar TeX
24427 For example the command
24430 \begin_layout Standard
24435 subsection{subsection title}
24438 \begin_layout Standard
24439 creates a subsection.
24440 In this example the preface is a subsubsection:
24443 \begin_layout Standard
24444 \begin_inset Flex Multiple Columns
24447 \begin_layout Plain Layout
24448 \begin_inset Argument 2
24451 \begin_layout Plain Layout
24455 \begin_layout Plain Layout
24464 This is a subsubsection heading as a preface
24468 \begin_layout Plain Layout
24482 A minute examination of the circumstances served only to make the case more
24484 In the first place, no reason could be given why the young man should have
24485 fastened the door upon the inside.
24486 There was the possibility that the murderer had done this, and had afterwards
24487 escaped by the window.
24488 The drop was at least twenty feet, however, and a bed of crocuses in full
24490 Neither the flowers nor the earth showed any sign of having been disturbed,
24491 nor were there any marks upon the narrow strip of grass which separated
24492 the house from the road.
24493 Apparently, therefore, it was the young man himself who had fastened the
24495 But how did he come by his death? No one could have climbed up to the window
24496 without leaving traces.
24497 Suppose a man had fired through the window, he would indeed be a remarkable
24498 shot who could with a revolver inflict so deadly a wound.
24499 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
24500 a hundred yards of the house.
24501 No one had heard a shot.
24509 \begin_layout Standard
24510 If there is less vertical space than 6
24511 \begin_inset space ~
24514 text lines is left on the page at the beginning of the multiple columns,
24515 a page break will be inserted before the multiple columns.
24516 Depending on the number of lines of the preface text, you might want to
24518 This is done by setting the cursor into the mulitcolumn inset behind the
24519 preface (if there is any) and using the menu
24521 Insert\SpecialChar menuseparator
24523 \begin_inset space ~
24527 \begin_inset space ~
24531 \begin_inset space ~
24537 Insert into that inset the amount of space like e.
24538 \begin_inset space \thinspace{}
24542 \begin_inset space \space{}
24546 \begin_inset Quotes eld
24550 \begin_inset Quotes erd
24554 \begin_inset Newline newline
24557 In this example the space is set to 7
24558 \begin_inset space ~
24561 text lines by using
24562 \begin_inset Quotes eld
24568 \begin_inset Quotes erd
24577 needs to be inserted as \SpecialChar TeX
24581 \begin_layout Standard
24582 \begin_inset Flex Multiple Columns
24585 \begin_layout Plain Layout
24586 \begin_inset Argument 3
24589 \begin_layout Plain Layout
24594 \begin_layout Plain Layout
24610 On the evening of the crime, he returned from the club exactly at ten.
24611 His mother and sister were out spending the evening with a relation.
24612 The servant deposed that she heard him enter the front room on the second
24613 floor, generally used as his sitting-room.
24614 She had lit a fire there, and as it smoked she had opened the window.
24615 No sound was heard from the room until eleven-twenty, the hour of the return
24616 of Lady Maynooth and her daughter.
24617 Desiring to say good-night, she attempted to enter her son's room.
24618 The door was locked on the inside, and no answer could be got to their
24619 cries and knocking.
24620 Help was obtained, and the door forced.
24621 The unfortunate young man was found lying near the table.
24622 His head had been horribly mutilated by an expanding revolver bullet, but
24623 no weapon of any sort was to be found in the room.
24631 \begin_layout Subsubsection
24635 \begin_layout Standard
24636 The amount of space before and after multiple columns can be changed by
24637 changing the length
24644 For example the command
24647 \begin_layout Standard
24657 \begin_layout Standard
24658 in \SpecialChar TeX
24659 Code changes its value to 3
24660 \begin_inset space \thinspace{}
24664 The change must be made before the multiple columns' start.
24665 The predefined value is 13
24666 \begin_inset space \thinspace{}
24672 \begin_layout Standard
24680 \begin_inset space \thinspace{}
24686 \begin_layout Standard
24690 \begin_layout Plain Layout
24696 multicolsep}{2.5cm}
24704 \begin_layout Standard
24705 \begin_inset Flex Multiple Columns
24708 \begin_layout Plain Layout
24711 All day I turned these facts over in my mind, endeavouring to hit upon some
24712 theory which could reconcile them all, and to find that line of least resistanc
24713 e which my poor friend had declared to be the starting-point of every investigat
24715 I confess that I made little progress.
24716 In the evening I strolled across the Park, and found myself about six o'clock
24717 at the Oxford Street end of Park Lane.
24718 A group of loafers upon the pavements, all staring up at a particular window,
24719 directed me to the house which I had come to see.
24720 A tall, thin man with coloured glasses, whom I strongly suspected of being
24721 a plain-clothes detective, was pointing out some theory of his own, while
24722 the others crowded round to listen to what he said.
24723 I got as near him as I could, but his observations seemed to me to be absurd,
24724 so I withdrew again in some disgust.
24725 As I did so I struck against an elderly, deformed man, who had been behind
24726 me, and I knocked down several books which he was carrying.
24734 \begin_layout Standard
24735 \begin_inset Note Greyedout
24738 \begin_layout Plain Layout
24743 The values you set with
24749 will be used for all following multiple columns until you change them again.
24757 \begin_layout Standard
24761 \begin_layout Plain Layout
24773 \begin_inset Note Note
24776 \begin_layout Plain Layout
24777 go back to the default
24785 \begin_layout Standard
24786 \begin_inset Newpage newpage
24792 \begin_layout Subsubsection
24796 \begin_layout Standard
24797 A column break can be forced by inserting the command
24803 as \SpecialChar TeX
24804 Code to that position in the text where the column should be broken.
24805 Note that this leads in most cases to whitespace in the text.
24806 \begin_inset Newline newline
24809 Here is an example:
24812 \begin_layout Standard
24813 \begin_inset Flex Multiple Columns
24816 \begin_layout Plain Layout
24819 \begin_inset Quotes eld
24822 You're surprised to see me, sir,
24823 \begin_inset Quotes erd
24826 said he, in a strange, croaking voice.
24829 \begin_layout Plain Layout
24832 I acknowledged that I was.
24835 \begin_layout Plain Layout
24838 \begin_inset Quotes eld
24841 Well, I've a conscience, sir, and when I chanced to see you go into this
24842 house, as I came hobbling after you, I thought to myself, I'll just step
24843 in and see that kind gentleman, and tell him that if I was a bit gruff
24844 in my manner there was not any harm meant, and that I am much obliged to
24845 him for picking up my books.
24846 \begin_inset Quotes erd
24852 \begin_layout Plain Layout
24855 \begin_inset Quotes eld
24858 You make too much of a trifle,
24859 \begin_inset Quotes erd
24864 \begin_inset Quotes eld
24867 May I ask how you knew who I was?
24868 \begin_inset Quotes erd
24871 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
24875 \begin_layout Plain Layout
24887 \begin_layout Plain Layout
24890 \begin_inset Quotes eld
24893 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
24894 you'll find my little bookshop at the corner of Church Street, and very
24895 happy to see you, I am sure.
24896 Maybe you collect yourself, sir.
24900 \begin_inset space ~
24913 –a bargain, every one of them.
24914 With five volumes you could just fill that gap on that second shelf.
24915 It looks untidy, does it not, sir?
24916 \begin_inset Quotes erd
24927 \begin_layout Subsubsection
24931 \begin_layout Standard
24932 The width of the columns is automatically calculated, but you can modify
24933 the space between the columns.
24934 This is done by changing the length
24941 Its predefined value is 10
24942 \begin_inset space \thinspace{}
24946 Here is an example where
24953 \begin_inset space \thinspace{}
24959 \begin_layout Standard
24963 \begin_layout Plain Layout
24977 \begin_layout Standard
24978 \begin_inset Flex Multiple Columns
24981 \begin_layout Plain Layout
24984 My observations of No.
24985 \begin_inset space \space{}
24988 427 Park Lane did little to clear up the problem in which I was interested.
24989 The house was separated from the street by a low wall and railing, the
24990 whole not more than five feet high.
24991 It was perfectly easy, therefore, for anyone to get into the garden, but
24992 the window was entirely inaccessible, since there was no water pipe or
24993 anything which could help the most active man to climb it.
24994 More puzzled than ever, I retraced my steps to Kensington.
24995 I had not been in my study five minutes when the maid entered to say that
24996 a person desired to see me.
24997 To my astonishment it was none other than my strange old book collector,
24998 his sharp, wizened face peering out from a frame of white hair, and his
24999 precious volumes, a dozen of them at least, wedged under his right arm.
25007 \begin_layout Standard
25011 \begin_layout Plain Layout
25023 \begin_inset Note Note
25026 \begin_layout Plain Layout
25027 go back to the default
25035 \begin_layout Subsubsection
25039 \begin_layout Standard
25040 Between the columns a rule with a width of the length
25047 If this rule width is set to 0
25048 \begin_inset space \thinspace{}
25051 pt (this is the default), the rule is suppressed.
25052 In the following example the rule is 2
25053 \begin_inset space \thinspace{}
25059 \begin_layout Standard
25063 \begin_layout Plain Layout
25069 columnseprule}{2pt}
25077 \begin_layout Standard
25078 \begin_inset Flex Multiple Columns
25081 \begin_layout Plain Layout
25084 \begin_inset Quotes eld
25087 You're surprised to see me, sir,
25088 \begin_inset Quotes erd
25091 said he, in a strange, croaking voice.
25094 \begin_layout Plain Layout
25097 I acknowledged that I was.
25100 \begin_layout Plain Layout
25103 \begin_inset Quotes eld
25106 Well, I've a conscience, sir, and when I chanced to see you go into this
25107 house, as I came hobbling after you, I thought to myself, I'll just step
25108 in and see that kind gentleman, and tell him that if I was a bit gruff
25109 in my manner there was not any harm meant, and that I am much obliged to
25110 him for picking up my books.
25111 \begin_inset Quotes erd
25117 \begin_layout Plain Layout
25120 \begin_inset Quotes eld
25123 You make too much of a trifle,
25124 \begin_inset Quotes erd
25129 \begin_inset Quotes eld
25132 May I ask how you knew who I was?
25133 \begin_inset Quotes erd
25139 \begin_layout Plain Layout
25142 \begin_inset Quotes eld
25145 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25146 you'll find my little bookshop at the corner of Church Street, and very
25147 happy to see you, I am sure.
25148 Maybe you collect yourself, sir.
25152 \begin_inset space ~
25165 –a bargain, every one of them.
25166 With five volumes you could just fill that gap on that second shelf.
25167 It looks untidy, does it not, sir?
25168 \begin_inset Quotes erd
25179 \begin_layout Standard
25180 \begin_inset VSpace defskip
25186 \begin_layout Standard
25187 The rule can be colored by redefining the command
25194 This is done by inserting the command
25195 \begin_inset Newline newline
25204 columnseprulecolor}{
25209 \begin_inset Newline newline
25212 as \SpecialChar TeX
25213 Code before the multicolumn inset.
25218 in this command by a color of your choice.
25219 You can use all pre- and self-defined colors.
25227 \begin_inset space ~
25232 for more information about pre- and self-defined colors.
25233 To go back to the default color insert the command
25234 \begin_inset Newline newline
25243 columnseprulecolor}{
25248 \begin_inset Newline newline
25251 Here is the example with a cyan rule and 1
25252 \begin_inset space \thinspace{}
25255 cm column separation:
25258 \begin_layout Standard
25262 \begin_layout Plain Layout
25271 \begin_layout Plain Layout
25277 columnseprulecolor}{
25287 \begin_layout Standard
25288 \begin_inset Flex Multiple Columns
25291 \begin_layout Plain Layout
25294 \begin_inset Quotes eld
25297 You're surprised to see me, sir,
25298 \begin_inset Quotes erd
25301 said he, in a strange, croaking voice.
25304 \begin_layout Plain Layout
25307 I acknowledged that I was.
25310 \begin_layout Plain Layout
25313 \begin_inset Quotes eld
25316 Well, I've a conscience, sir, and when I chanced to see you go into this
25317 house, as I came hobbling after you, I thought to myself, I'll just step
25318 in and see that kind gentleman, and tell him that if I was a bit gruff
25319 in my manner there was not any harm meant, and that I am much obliged to
25320 him for picking up my books.
25321 \begin_inset Quotes erd
25327 \begin_layout Plain Layout
25330 \begin_inset Quotes eld
25333 You make too much of a trifle,
25334 \begin_inset Quotes erd
25339 \begin_inset Quotes eld
25342 May I ask how you knew who I was?
25343 \begin_inset Quotes erd
25349 \begin_layout Plain Layout
25352 \begin_inset Quotes eld
25355 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25356 you'll find my little bookshop at the corner of Church Street, and very
25357 happy to see you, I am sure.
25358 Maybe you collect yourself, sir.
25362 \begin_inset space ~
25375 –a bargain, every one of them.
25376 With five volumes you could just fill that gap on that second shelf.
25377 It looks untidy, does it not, sir?
25378 \begin_inset Quotes erd
25389 \begin_layout Standard
25393 \begin_layout Plain Layout
25399 columnseprule}{0pt}
25402 \begin_layout Plain Layout
25408 columnseprulecolor}{
25416 \begin_inset Note Note
25419 \begin_layout Plain Layout
25420 go back to the default
25428 \begin_layout Section
25429 Non-standard Paragraph Shapes
25432 \begin_layout Standard
25435 as well as any other text processor uses by default rectangular paragraphs.
25436 For special cases like for example posters, invitation cards or poems you
25437 can modify the paragraph shape to one of your choice.
25438 This can be done by using the \SpecialChar LaTeX
25443 which is loaded by using in the document settings the module
25445 Custom paragraph shapes
25450 \begin_layout Subsection
25454 \begin_layout Standard
25459 provides the following shapes:
25462 \begin_layout Standard
25463 \begin_inset Tabular
25464 <lyxtabular version="3" rows="13" columns="3">
25465 <features booktabs="true" islongtable="true" longtabularalignment="center">
25466 <column alignment="center" valignment="middle" width="16col%">
25467 <column alignment="center" valignment="middle" width="40col%">
25468 <column alignment="center" valignment="middle" width="35col%">
25469 <row endhead="true">
25470 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25473 \begin_layout Plain Layout
25479 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25482 \begin_layout Plain Layout
25488 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
25491 \begin_layout Plain Layout
25499 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25502 \begin_layout Plain Layout
25508 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25511 \begin_layout Plain Layout
25512 Circle with circular hole (in the size of a CD/DVD)
25517 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25520 \begin_layout Plain Layout
25521 Cannot be scaled, take care there is not too much text
25528 <cell alignment="center" valignment="top" topline="true" usebox="none">
25531 \begin_layout Plain Layout
25537 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25540 \begin_layout Plain Layout
25546 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25549 \begin_layout Plain Layout
25550 Fragile, calculation might fail
25557 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25560 \begin_layout Plain Layout
25566 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25569 \begin_layout Plain Layout
25570 Rhomboid (symbolizing a
25571 \begin_inset Quotes eld
25575 \begin_inset Quotes erd
25583 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25586 \begin_layout Plain Layout
25594 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25597 \begin_layout Plain Layout
25603 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25606 \begin_layout Plain Layout
25612 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25615 \begin_layout Plain Layout
25623 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25626 \begin_layout Plain Layout
25632 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25635 \begin_layout Plain Layout
25641 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25644 \begin_layout Plain Layout
25652 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25655 \begin_layout Plain Layout
25661 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25664 \begin_layout Plain Layout
25665 Nut for bolt (hexagon with circular hole)
25670 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25673 \begin_layout Plain Layout
25681 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25684 \begin_layout Plain Layout
25690 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25693 \begin_layout Plain Layout
25699 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25702 \begin_layout Plain Layout
25710 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25713 \begin_layout Plain Layout
25719 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25722 \begin_layout Plain Layout
25728 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
25731 \begin_layout Plain Layout
25739 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25742 \begin_layout Plain Layout
25748 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25751 \begin_layout Plain Layout
25757 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25760 \begin_layout Plain Layout
25768 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25771 \begin_layout Plain Layout
25777 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25780 \begin_layout Plain Layout
25781 Normal/reversed rain drop
25786 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25789 \begin_layout Plain Layout
25790 Fragile, calculation might fail
25797 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25800 \begin_layout Plain Layout
25807 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25810 \begin_layout Plain Layout
25811 The \SpecialChar TeX
25817 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25820 \begin_layout Plain Layout
25828 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25831 \begin_layout Plain Layout
25833 \begin_inset Newline newline
25841 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25844 \begin_layout Plain Layout
25845 Triangles in different orientations
25850 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
25853 \begin_layout Plain Layout
25867 \begin_layout Standard
25868 To use a shape for your paragraph, simply select it in \SpecialChar LyX
25870 for environments in the toolbar.
25873 \begin_layout Standard
25874 \begin_inset Newpage newpage
25880 \begin_layout Standard
25881 Here is an example paragraph in the shape of a nut:
25884 \begin_layout Standard
25885 \begin_inset VSpace bigskip
25894 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
25895 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
25897 At vero eos et accusam et justo duo dolores et ea rebum.
25898 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
25900 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
25901 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
25905 \begin_layout Standard
25906 \begin_inset VSpace bigskip
25912 \begin_layout Standard
25913 \begin_inset Note Greyedout
25916 \begin_layout Plain Layout
25921 : shapepar paragraphs cannot run over a page break.
25929 \begin_layout Standard
25930 \begin_inset VSpace bigskip
25936 \begin_layout Standard
25941 takes care that the shape will always be preserved, no matter how much
25942 text is in the paragraph.
25943 Therefore the paragraph size changes with the amount of contained text.
25944 This can lead to paragraph sizes exceeding the page margins.
25945 To demonstrate the size scaling, here is the same example paragraph but
25946 with twice as much text:
25949 \begin_layout Standard
25950 \begin_inset Newpage newpage
25959 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
25960 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
25962 At vero eos et accusam et justo duo dolores et ea rebum.
25963 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
25965 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
25966 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
25968 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
25969 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
25971 At vero eos et accusam et justo duo dolores et ea rebum.
25972 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
25974 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
25975 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
25979 \begin_layout Standard
25980 \begin_inset VSpace bigskip
25986 \begin_layout Standard
25987 An exception is the shape
25992 It cannot be scaled because it must fit the size of a CD/DVD.
25993 Therefore the amount of text that fits into the shape is limited.
25994 \begin_inset Newline newline
26005 shape are fragile, meaning that the calculation of their size can fail,
26006 depending on the amount of text.
26007 You will then get the \SpecialChar LaTeX
26009 \begin_inset Quotes eld
26012 Arithmetic overflow
26013 \begin_inset Quotes erd
26017 In this case one can try to remove or add some text; if nothing works one
26018 has to use another shape.
26021 \begin_layout Standard
26022 \begin_inset VSpace bigskip
26028 \begin_layout Standard
26029 For shapes with tips you will maybe see that \SpecialChar LaTeX
26030 's hyphenation routine fails
26031 for text in the tips.
26032 Therefore it is often necessary to add hyphenation points
26037 arg "specialchar-insert hyphenation"
26042 ) to the corresponding text parts.
26045 \begin_layout Standard
26046 \begin_inset VSpace bigskip
26052 \begin_layout Standard
26053 Shapepar paragraphs are either always centered or placed on the page so
26054 that their left border touches the left page margin.
26055 You can therefore not use the paragraph dialog to align such paragraphs.
26056 A solution is to put the paragraph into a minipage or parbox and align
26058 The problem is hereby to find the right width for the box.
26059 Because if it is too wide and you center the box, the paragraph is not
26060 centered too because it sticks at the left side of the box.
26061 So you might have to play a bit with the width until it fits.
26062 Here are two heart-shaped paragraphs, the first one is not aligned, the
26063 second one is right-aligned:
26066 \begin_layout Standard
26067 \begin_inset Newpage newpage
26073 \begin_layout Heart
26077 Lo\SpecialChar softhyphen
26078 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26079 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26081 At vero eos et accusam et justo duo dolores et ea rebum.
26082 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26086 \begin_layout Standard
26087 \begin_inset VSpace bigskip
26093 \begin_layout Standard
26096 \begin_inset Box Frameless
26106 height_special "totalheight"
26111 backgroundcolor "none"
26114 \begin_layout Heart
26118 Lo\SpecialChar softhyphen
26119 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26120 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26122 At vero eos et accusam et justo duo dolores et ea rebum.
26123 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26132 \begin_layout Subsection
26136 \begin_layout Standard
26137 You can define any shape you want.
26138 Doing this manually is a lot of work because every coordinate must be specified.
26139 But there is a way to let the computer calculate the coordinates:
26142 \begin_layout Enumerate
26143 Install the program
26144 \begin_inset CommandInset href
26147 target "http://www.ctan.org/tex-archive/graphics/jpgfdraw"
26154 \begin_layout Enumerate
26161 TeX/LaTeX\SpecialChar menuseparator
26162 Settings\SpecialChar menuseparator
26165 and select the font size you are using in your document.
26166 For example this document uses the size 12
26167 \begin_inset space \thinspace{}
26173 \begin_layout Enumerate
26177 \begin_layout Enumerate
26180 TeX/LaTeX\SpecialChar menuseparator
26183 to export the shape to coordinates.
26184 In the appearing dialog use either the outline of your shape for the coordinate
26185 s or the path itself.
26189 \begin_layout Plain Layout
26190 For more information see
26191 \begin_inset CommandInset href
26193 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
26205 \begin_layout Standard
26206 The coordinates are written into a \SpecialChar TeX
26208 To use it for your \SpecialChar LyX
26212 \begin_layout Enumerate
26213 Place the cursor before the first character of your paragraph (or into a
26217 \begin_layout Enumerate
26218 Open in \SpecialChar LyX
26221 Insert\SpecialChar menuseparator
26222 File\SpecialChar menuseparator
26224 \begin_inset space ~
26229 , select the file and use
26238 \begin_layout Standard
26239 \begin_inset VSpace defskip
26245 \begin_layout Standard
26246 \begin_inset Note Greyedout
26249 \begin_layout Plain Layout
26254 : The changed shape only applies to the current paragraph; everything is
26255 reset to normal for the next paragraph.
26256 Therefore the shape definition file must be input into every paragraph
26257 with the desired shape.
26265 \begin_layout Standard
26266 \begin_inset VSpace bigskip
26272 \begin_layout Standard
26273 Here is an example:
26276 \begin_layout Standard
26277 \begin_inset VSpace bigskip
26283 \begin_layout Standard
26284 \begin_inset CommandInset include
26286 filename "SpecialParagraphShape.tex"
26292 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26293 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26295 At vero eos et accusam et justo duo dolores et ea rebum.
26296 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26298 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26299 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26303 \begin_layout Standard
26304 \begin_inset VSpace bigskip
26310 \begin_layout Standard
26315 to draw complexer shapes in
26319 you can draw the shape in a program of your choice and import the resulting
26325 Then you only need to draw a line or spline along the outline of the image.
26328 \begin_layout Standard
26329 \begin_inset VSpace bigskip
26335 \begin_layout Standard
26338 Custom paragraph shapes
26340 also provides the two commands
26348 which can be used to define custom shapes coordinate by coordinate.
26352 \begin_layout Plain Layout
26353 These commands are internally used for all shapes described here.
26358 For information how these styles are used and about further customization
26359 possibilities, have a look at the documentation of the package
26364 \begin_inset CommandInset citation
26373 \begin_layout Bibliography
26374 \begin_inset CommandInset bibitem
26375 LatexCommand bibitem
26380 Documentation of the \SpecialChar LaTeX
26382 \begin_inset CommandInset href
26385 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
26392 \begin_layout Bibliography
26393 \begin_inset CommandInset bibitem
26394 LatexCommand bibitem
26399 Documentation of the \SpecialChar LaTeX
26401 \begin_inset CommandInset href
26404 target "http://mirrors.ctan.org/macros/latex/contrib/shapepar/shapepar.pdf"