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 or, in more recent versions,
6918 \begin_layout Subsubsection*
6922 \begin_layout Standard
6923 Launch yap, choose its
6924 \begin_inset Flex Noun
6927 \begin_layout Plain Layout
6928 View\SpecialChar menuseparator
6935 \begin_inset Quotes eld
6939 \begin_inset Quotes erd
6944 \begin_inset Quotes eld
6947 New\SpecialChar ldots
6949 \begin_inset Quotes erd
6952 button and, in the window that opens, enter
6953 \begin_inset Quotes eld
6958 \begin_inset Quotes erd
6961 (or any other name you like) in the
6962 \begin_inset Quotes eld
6966 \begin_inset Quotes erd
6970 Now click on the button labeled
6971 \begin_inset Quotes eld
6976 \begin_inset Quotes erd
6979 to open a file dialog and navigate to the directory containing the batch
6981 \begin_inset Flex Code
6984 \begin_layout Plain Layout
6992 \begin_inset Flex Code
6995 \begin_layout Plain Layout
7001 and then specify the program arguments as
7002 \begin_inset Flex Code
7005 \begin_layout Plain Layout
7013 \begin_inset Flex Code
7016 \begin_layout Plain Layout
7022 wrapper is used for communicating with \SpecialChar LyX
7030 \begin_layout LyX-Code
7032 \begin_inset Newline newline
7035 echo LYXCMD:revdvi:server-goto-file-row:%1 %2>
7044 \begin_inset Newline newline
7058 \begin_layout Standard
7059 Make sure that the \SpecialChar LyX
7060 Server pipe path you specified in \SpecialChar LyX
7062 \begin_inset Flex Code
7065 \begin_layout Plain Layout
7079 , otherwise change the
7080 \begin_inset Flex Code
7083 \begin_layout Plain Layout
7089 wrapper accordingly.
7092 \begin_layout Standard
7093 In yap, reverse search is triggered by double-click.
7096 \begin_layout Subsubsection*
7097 SumatraPDF (Windows)
7100 \begin_layout Standard
7101 In order to use SumatraPDF for inverse search, enter
7102 \begin_inset Flex Code
7105 \begin_layout Plain Layout
7106 SumatraPDF -inverse-search "lyxeditor.bat %f %l"
7111 in the viewer setting in
7112 \begin_inset Flex Noun
7115 \begin_layout Plain Layout
7116 Preferences\SpecialChar menuseparator
7117 File Handling\SpecialChar menuseparator
7118 File formats\SpecialChar menuseparator
7125 \begin_inset Flex Code
7128 \begin_layout Plain Layout
7134 is the previous wrapper.
7135 If SumatraPDF.exe is not in your command PATH, use its full file name.
7138 \begin_layout Standard
7139 Reverse search is triggered by double-click.
7142 \begin_layout Subsubsection*
7146 \begin_layout Standard
7147 First of all, make sure that yap is your default DVI viewer in the Windows
7148 environment, then launch it, choose its
7149 \begin_inset Flex Noun
7152 \begin_layout Plain Layout
7153 View\SpecialChar menuseparator
7160 \begin_inset Quotes eld
7164 \begin_inset Quotes erd
7169 \begin_inset Quotes eld
7172 New\SpecialChar ldots
7174 \begin_inset Quotes erd
7177 button and, in the window that opens, enter
7178 \begin_inset Quotes eld
7183 \begin_inset Quotes erd
7186 (or any other name you like) in the
7187 \begin_inset Quotes eld
7191 \begin_inset Quotes erd
7195 Now click on the button labeled
7196 \begin_inset Quotes eld
7201 \begin_inset Quotes erd
7204 to open a file dialog and navigate to the directory containing the
7205 \begin_inset Flex Code
7208 \begin_layout Plain Layout
7214 program (which is installed by default on Cygwin along with the \SpecialChar LyX
7217 \begin_inset Flex Code
7220 \begin_layout Plain Layout
7226 and then specify the program arguments as
7227 \begin_inset Flex Code
7230 \begin_layout Plain Layout
7237 In this way, you will be using the
7241 for communicating with \SpecialChar LyX
7243 If, for whatever reason, you want to use the
7248 \begin_inset Flex Code
7251 \begin_layout Plain Layout
7257 option and be sure to specify the \SpecialChar LyX
7258 Server pipe path in the \SpecialChar LyX
7262 \begin_layout Standard
7263 In yap, reverse search is triggered by double-click.
7266 \begin_layout Subsubsection*
7270 \begin_layout Standard
7271 In order to use SumatraPDF for inverse search, enter
7272 \begin_inset Flex Code
7275 \begin_layout Plain Layout
7276 SumatraPDF -inverse-search "lyxeditor -g %f %l"
7281 in the viewer setting in
7282 \begin_inset Flex Noun
7285 \begin_layout Plain Layout
7286 Preferences\SpecialChar menuseparator
7287 File Handling\SpecialChar menuseparator
7288 File formats\SpecialChar menuseparator
7295 If SumatraPDF.exe is not in your command PATH, use its full posix path.
7297 \begin_inset Flex Code
7300 \begin_layout Plain Layout
7306 enables communication via the
7312 \begin_inset Flex Code
7315 \begin_layout Plain Layout
7321 option if you want to use the
7325 , and be sure to specify the \SpecialChar LyX
7326 Server pipe path in the \SpecialChar LyX
7330 \begin_layout Standard
7331 Reverse search is triggered by double-click.
7334 \begin_layout Section
7338 \begin_layout Standard
7339 Forward search is, as the name implies, in a sense the
7340 \begin_inset Quotes eld
7344 \begin_inset Quotes erd
7348 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
7350 If forward search is set up (as described in what follows), you can put
7351 the cursor anywhere in your \SpecialChar LyX
7353 \begin_inset Flex Noun
7356 \begin_layout Plain Layout
7357 Navigate\SpecialChar menuseparator
7364 \begin_inset Flex Noun
7367 \begin_layout Plain Layout
7373 in the context menu via right mouse click), and then the viewer will jump
7374 to that position as well.
7375 This implies, of course, that your viewer supports this function.
7378 \begin_layout Standard
7379 To make forward search possible, you first need to provide the generated
7380 output PDF/DVI file with additional information about the \SpecialChar TeX
7382 This can be done via the methods described in the section
7383 \begin_inset CommandInset ref
7385 reference "subsec:rev-search"
7392 \begin_layout Standard
7393 Additionally, you need to configure \SpecialChar LyX
7394 for using your viewers in
7395 \begin_inset Flex Noun
7398 \begin_layout Plain Layout
7399 Tools\SpecialChar menuseparator
7400 Preferences\SpecialChar menuseparator
7401 Output\SpecialChar menuseparator
7408 We provide a range of tested configurations for some viewers, which you
7409 can select from the drop down list.
7410 If none of these configurations suits you, you have to find out and enter
7411 a suitable configuration yourself.
7412 The definition syntax uses the following placeholders:
7415 \begin_layout Itemize
7417 \begin_inset Flex Code
7420 \begin_layout Plain Layout
7429 \begin_layout Itemize
7431 \begin_inset Flex Code
7434 \begin_layout Plain Layout
7440 : name of the (temporary) exported .tex file (without path)
7443 \begin_layout Itemize
7445 \begin_inset Flex Code
7448 \begin_layout Plain Layout
7454 : name of the (temporary) exported .tex file (including path)
7457 \begin_layout Itemize
7459 \begin_inset Flex Code
7462 \begin_layout Plain Layout
7468 : name of the exported output file (either dvi or pdf, depending on which
7469 one exists in the temporary directory)
7472 \begin_layout Standard
7473 Note that only some of the viewers provide full forward search functionality,
7474 among them yap, xdvi, okular
7478 \begin_layout Plain Layout
7479 You might want to set
7480 \begin_inset Flex Code
7483 \begin_layout Plain Layout
7490 \begin_inset Flex Noun
7493 \begin_layout Plain Layout
7494 Tools\SpecialChar menuseparator
7495 Preferences\SpecialChar menuseparator
7496 File Handling\SpecialChar menuseparator
7498 \begin_inset space ~
7511 , qpdfview and SumatraPDF
7515 \begin_layout Plain Layout
7516 SumatraPDF can also use DDE commands through the external program CMCDDE
7518 \begin_inset CommandInset href
7520 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
7530 While many of the widespread PDF viewers (most notably Adobe Reader) do
7531 not support forward search at all, some other viewers – e.
7532 \begin_inset space \thinspace{}
7536 evince and xpdf – allow at least to reload the document and jump to a specific
7537 page of the file, so you can at least navigate
7538 \begin_inset Quotes eld
7542 \begin_inset Quotes erd
7546 This latter functionality is provided by an external call of synctex (see
7547 the predefined example configurations).
7551 \begin_layout Standard
7552 Forward search works both with DVI and PDF output.
7554 simply checks which preview format you have used before (i.
7555 \begin_inset space \thinspace{}
7558 e., which format is already there in the temporary directory) and chooses
7559 the appropriate configuration for the respective format.
7562 \begin_layout Chapter
7563 Special Document Classes
7566 \begin_layout Section
7570 \begin_layout Standard
7576 \begin_layout Subsection
7580 \begin_layout Standard
7581 This section describes how \SpecialChar LyX
7582 can be used to write articles for submission
7583 to the scientific journal
7585 Astronomy and Astrophysics
7588 \begin_inset Flex URL
7591 \begin_layout Plain Layout
7593 http://www.edpsciences.fr/aa/
7598 ) using Version 5.01 of the document class
7603 This package can be downloaded from the ftp site
7606 \begin_layout Standard
7607 \begin_inset VSpace medskip
7613 \begin_layout Standard
7615 \begin_inset Flex URL
7618 \begin_layout Plain Layout
7620 ftp://ftp.edpsciences.org/pub/aa/readme.html
7628 \begin_layout Standard
7629 \begin_inset VSpace medskip
7635 \begin_layout Standard
7636 A manual comes together with that package, and this text is not meant to
7637 replace the original manual but is merely a short guide in how to realize
7638 the correct form of your paper.
7642 \begin_layout Standard
7643 Please note that the publisher of the journal was changed from Springer
7644 to EDP Sciences starting January 1, 2001.
7645 That change involved also some slight changes to the style files, namely
7646 the removal of the thesaurus command.
7647 The \SpecialChar LyX
7648 class aa supports the newest version of these style files, V 5.01.
7649 If you have an older version installed, please upgrade.
7650 For compatibility, the old (version 4) layout has been kept as
7655 Please refer to the comments in
7658 Dir/layouts/aapaper.layout
7663 \begin_layout Subsection
7667 \begin_layout Standard
7668 It is recommended you start from the example template distributed with \SpecialChar LyX
7670 If you are not using a template, note the following settings:
7673 \begin_layout Itemize
7680 Document\SpecialChar menuseparator
7683 dialog (OK, that one was obvious).
7686 \begin_layout Itemize
7687 Don't change the option
7690 \begin_inset space ~
7700 The whole layout is done by the macros, you shouldn't change anything.
7703 \begin_layout Subsection
7707 \begin_layout Standard
7708 First thing to enter is the header information.
7709 It consists of seven entries, of which some are optional.
7713 \begin_layout Itemize
7721 \begin_layout Itemize
7729 \begin_layout Itemize
7737 \begin_layout Itemize
7745 \begin_layout Itemize
7750 : [optional] if more than one author: whom to contact for offprint requests.
7753 \begin_layout Itemize
7758 : [optional] mail address for contacts.
7761 \begin_layout Itemize
7769 Received: <date>; Accepted <date>
7772 \begin_layout Standard
7773 There is no need to issue the
7779 command, this is done automatically by \SpecialChar LyX
7780 when the header is finished.
7781 Although the order of the single header entries doesn't matter it is advised
7782 to keep the above sequence, just to get the best optics and meets the layout
7783 of the real document.
7786 \begin_layout Standard
7787 If you want to place footnotes in the header block, e.
7788 \begin_inset space \thinspace{}
7792 \begin_inset space \space{}
7795 to state your present address, just use the standard footnote via the menu
7798 Insert\SpecialChar menuseparator
7803 will automagically use the term
7812 \begin_layout Standard
7813 In addition to these topics, the macros use three additional \SpecialChar LaTeX
7815 have no counterpart in \SpecialChar LyX
7819 \begin_layout Itemize
7826 to separate different names for more than one author and institute, respectivel
7830 \begin_layout Itemize
7837 to mark corresponding author/institute pairs.
7838 The institutes are numbered sequentially as they appear in the
7842 field, so you have to put a marker to each author.
7845 \begin_layout Itemize
7852 to supply an email address for fast contact.
7855 \begin_layout Standard
7856 In all cases, the appropriate command has to be entered in \SpecialChar LyX
7864 \begin_layout Subsection
7868 \begin_layout Standard
7869 The abstract should immediately follow the header block.
7870 With version 5 the abstract environment was changed to a command, and there
7871 is now a resctriction to only one paragraph.
7872 In addition, it should contain an entry with the keywords.
7873 This is not yet implemented for \SpecialChar LyX
7874 , therefore you have to enter the \SpecialChar LaTeX
7882 by hand and mark it as \SpecialChar LaTeX
7884 Refer to the example paper.
7887 \begin_layout Subsection
7888 Supported environments
7891 \begin_layout Standard
7892 The A&A paper layout supports the following environments for structuring
7896 \begin_layout Itemize
7902 \begin_layout Itemize
7908 \begin_layout Itemize
7914 \begin_layout Itemize
7920 \begin_layout Itemize
7926 \begin_layout Itemize
7932 \begin_layout Itemize
7938 \begin_layout Itemize
7944 \begin_layout Itemize
7950 \begin_layout Itemize
7956 \begin_layout Itemize
7962 \begin_layout Itemize
7969 \begin_layout Subsection
7970 Commands not supported by \SpecialChar LyX
7974 \begin_layout Standard
7975 Some commands are not yet supported by the
7979 layout for \SpecialChar LyX
7981 Some have already been mentioned.
7982 For the sake of completeness, they are listed all together here:
7985 \begin_layout Itemize
7993 \begin_layout Itemize
8001 \begin_layout Itemize
8009 \begin_layout Itemize
8017 \begin_layout Itemize
8025 \begin_layout Itemize
8033 \begin_layout Itemize
8041 \begin_layout Itemize
8049 \begin_layout Standard
8050 If you want to use any of these commands, you have to enter them yourself.
8053 Do not forget to mark them as \SpecialChar LaTeX
8057 \begin_layout Subsection
8058 Figure and Table Floats
8061 \begin_layout Standard
8063 provides support for the necessary float environments
8065 figure, figure*, table
8071 , therefore we won't tell much about it here.
8075 \begin_inset space ~
8081 Just remember that tables should be left-aligned.
8082 For that, select the table and change the alignment in
8084 Edit\SpecialChar menuseparator
8086 \begin_inset space ~
8092 \begin_layout Standard
8093 There is only one special thing: the figures with caption besides the figure.
8094 To create such a figure, you have to do the following:
8097 \begin_layout Enumerate
8098 Create a wide figure float:
8100 Insert\SpecialChar menuseparator
8101 Float\SpecialChar menuseparator
8104 , then right click in the figure and select
8107 \begin_inset space ~
8115 \begin_layout Enumerate
8116 Enter your caption text.
8119 \begin_layout Enumerate
8124 to move the cursor above the caption.
8127 \begin_layout Enumerate
8131 \begin_layout Enumerate
8132 Position the cursor behind the figure and insert a horizontal fill:
8134 Insert\SpecialChar menuseparator
8136 \begin_inset space ~
8139 Character\SpecialChar menuseparator
8141 \begin_inset space ~
8149 \begin_layout Enumerate
8150 Switch to \SpecialChar LaTeX
8154 \begin_inset space ~
8162 \begin_layout Enumerate
8172 Do not close the brace!
8175 \begin_layout Enumerate
8176 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
8181 \begin_inset space ~
8193 \begin_layout Standard
8194 Also, refer to the figures in the example paper.
8197 \begin_layout Subsection
8201 \begin_layout Standard
8202 For submission, the paper has to be formated in a special double-spacing
8204 For this purpose, you have to give the option
8208 to the documentclass.
8209 This must be done using the extra class options field in the
8211 Document\SpecialChar menuseparator
8215 Just enter the string
8222 \begin_layout Subsection
8226 \begin_layout Standard
8231 directory contains an example paper written with \SpecialChar LyX
8233 It is the example paper from the original macro package, translated to
8236 Use it for inspiration, and compare the original \SpecialChar LaTeX
8237 code with \SpecialChar LyX
8241 \begin_layout Section
8246 \begin_layout Standard
8252 \begin_layout Subsection
8256 \begin_layout Standard
8258 is a set of macros produced by the American Astronomical Society to
8259 facilitate electronic manuscript submission to the three journals they
8260 publish: the Astrophysical Journal (including the Letters and Supplement),
8261 the Astronomical Journal, and the Publications of the Astronomical Society
8264 has proven to be an excellent tool for generating these documents, especially
8265 given its equation, citation, and figure handling capabilities.
8267 requires version 5.0 (or higher) of these macros; preferably 5.2, which
8268 is the version described here, or higher.
8269 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
8270 2.09 and are fundamentally
8271 incompatible with \SpecialChar LyX
8273 The AAS\SpecialChar TeX
8274 package may be downloaded from the AAS\SpecialChar TeX
8278 \begin_layout Standard
8279 \begin_inset VSpace medskip
8285 \begin_layout Standard
8287 \begin_inset Flex URL
8290 \begin_layout Plain Layout
8292 https://aas.org/aastex/aastex-downloads
8300 \begin_layout Standard
8301 \begin_inset VSpace medskip
8307 \begin_layout Standard
8308 A complete user guide is contained in that package and you should familiarize
8309 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
8312 will not reduce the need to figure out all the AAS\SpecialChar TeX
8313 commands, it will only
8314 reduce the drudgery of typing everything in.
8315 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
8317 completely to the requirements of the journal to which you are submitting
8321 \begin_layout Subsection
8322 Starting a New Paper
8325 \begin_layout Standard
8326 I strongly suggest that you start with the AAS\SpecialChar TeX
8330 File\SpecialChar menuseparator
8337 , enter the new file name, then choose the
8342 This will show the most common fields found in a manuscript.
8343 Simply overwrite the existing text (including the brackets,
8347 ) with the correct information.
8348 Many of the AAS\SpecialChar TeX
8349 commands and environments can be implemented directly in
8351 , but some cannot: most noticeably
8363 , which should stick out like a sore thumb if you actually just opened the
8365 For commands such as these, the \SpecialChar LaTeX
8366 code must be entered directly and marked
8368 Such commands are referred to as \SpecialChar TeX
8369 code, or Evil Red Text.
8370 I tried to minimize the amount of \SpecialChar TeX
8371 code needed in an AAS\SpecialChar TeX
8373 there is still a bit more required than any of us would like.
8376 \begin_layout Subsection
8377 Finishing Your Paper
8380 \begin_layout Standard
8381 When the paper is finished to your satisfaction and previews/prints correctly,
8383 \begin_inset Quotes eld
8387 \begin_inset Quotes erd
8390 actions which need to be done before you submit it to the journals.
8394 \begin_layout Enumerate
8395 Export your paper as a \SpecialChar LaTeX
8398 File\SpecialChar menuseparator
8399 Export\SpecialChar menuseparator
8407 \begin_layout Enumerate
8412 file with your favorite text editor
8416 \begin_layout Enumerate
8417 remove the comment lines before the
8426 \begin_layout Enumerate
8431 usepackage...{fontenc}
8433 line if it appears (usually just after
8448 \begin_layout Enumerate
8449 remove everything between (and including) the
8461 commands, except for any commands you specifically put into the \SpecialChar LaTeX
8463 (which should appear immediately after the
8464 \begin_inset Quotes eld
8467 User specified \SpecialChar LaTeX
8469 \begin_inset Quotes erd
8480 \begin_layout Enumerate
8481 Run the resulting file through \SpecialChar LaTeX
8482 to make sure it still processes correctly.
8485 \begin_layout Enumerate
8486 Reread the journal requirements to make sure your filenames and formats
8490 \begin_layout Enumerate
8494 \begin_layout Subsection
8495 Comments On Specific Commands
8498 \begin_layout Standard
8499 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
8506 ) gives a good description of each.
8507 Thus it's probably easiest for me to go down the list as found in the guide
8508 and offer comments where necessary.
8509 So let's begin \SpecialChar ldots
8513 \begin_layout Subsubsection
8514 Things that work as expected
8517 \begin_layout Standard
8518 Because they work as you might expect, I simply list them and the section
8619 begin{thebibliography}
8627 (2.13.2), all the cite commands and their variations (2.13.2), the generic
8628 graphicx figure commands (2.14.1),
8652 (2.15.4, amongst other places),
8679 \begin_layout Standard
8680 The following style options also work correctly:
8701 Simply put them in the
8707 Layout\SpecialChar menuseparator
8713 \begin_layout Subsubsection
8714 Things that work, but require more comment
8717 \begin_layout Standard
8718 The following items work, but require a little more discussion:
8721 \begin_layout Itemize
8722 These items are reserved for use by the journal editors, but you can put
8723 them into the \SpecialChar LaTeX
8724 preamble if you feel compelled to do so:
8757 \begin_layout Itemize
8758 These items may be placed in the \SpecialChar LaTeX
8759 preamble, and are included as blanks in
8781 \begin_layout Itemize
8788 (2.3) – can only be used
8789 \begin_inset Quotes eld
8793 \begin_inset Quotes erd
8796 , not in the middle of a paragraph.
8797 Use \SpecialChar TeX
8798 code if you need to embed it.
8801 \begin_layout Itemize
8808 (2.3) – will have extra {} after it.
8809 This should not cause an error.
8812 \begin_layout Itemize
8819 (2.6) – can only be used
8820 \begin_inset Quotes eld
8824 \begin_inset Quotes erd
8827 , not in the middle of a paragraph.
8828 Use \SpecialChar TeX
8829 code if you need to embed it.
8832 \begin_layout Itemize
8839 (2.8) – can't insert a cross-reference tag, you must type the tag name by
8843 \begin_layout Itemize
8857 \begin_layout Itemize
8864 (2.9) – will have extra {} after it.
8865 This should not cause an error.
8868 \begin_layout Itemize
8875 (2.11) – will have extra {} after it.
8876 This should not cause an error.
8879 \begin_layout Itemize
8886 (2.14.2) – you can insert an optional filename argument by placing the cursor
8887 at the beginning of the text and selecting
8889 Insert\SpecialChar menuseparator
8894 \begin_inset Quotes eld
8898 \begin_inset Quotes erd
8901 inserts an optional argument of the type needed by
8908 Hopefully it will be renamed someday.
8911 \begin_layout Itemize
8924 for the catalog ID optional parameter
8927 \begin_layout Itemize
8940 for the catalog ID optional parameter
8943 \begin_layout Subsubsection
8944 Things not implemented, use \SpecialChar TeX
8948 \begin_layout Standard
8971 setcounter{equation}
8973 (2.12), Journal name abbreviations (2.13.4),
9009 (2.15.4, insert it as the first element in the lefthand cell after where
9011 Don't use any of \SpecialChar LyX
9012 's rules in the table),
9024 (2.15.5), much of Misc (2.17, except
9075 \begin_layout Subsubsection
9076 Things that cannot be implemented
9079 \begin_layout Standard
9081 at least in any meaningful sort of way, so I suggest ignoring them.
9082 They are the references environment (2.13.3), and the deluxetable environment
9084 If you really, really need to use deluxetable, I suggest editing it in
9085 a separate file with a text editor, then using
9087 Insert\SpecialChar menuseparator
9089 \begin_inset space ~
9094 to include it in your \SpecialChar LyX
9100 file to see an example of this.
9103 \begin_layout Subsection
9104 FAQs, Tips, Tricks, and Other Ruminations
9107 \begin_layout Subsubsection
9108 Getting \SpecialChar LyX
9109 and AAS\SpecialChar TeX
9113 \begin_layout Standard
9114 It can be a bit tricky to get \SpecialChar LyX
9115 to recognize a new layout and document class.
9116 When all else fails, do this:
9119 \begin_layout Enumerate
9120 Make certain that \SpecialChar LaTeX
9121 can find AAS\SpecialChar TeX
9123 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
9125 directory completely unrelated to \SpecialChar LaTeX
9126 or AAS\SpecialChar TeX
9127 and run \SpecialChar LaTeX
9135 \begin_layout Enumerate
9140 appears in \SpecialChar LyX
9148 \begin_layout Enumerate
9151 Tools\SpecialChar menuseparator
9155 , then restart \SpecialChar LyX
9159 \begin_layout Enumerate
9160 Open a regular new file, not from a template.
9161 Does AAS\SpecialChar TeX
9162 appear in the class list in
9164 Document\SpecialChar menuseparator
9170 \begin_layout Standard
9171 If you get a warning from an existing AAS\SpecialChar TeX
9172 document about not being able
9173 to find the AAS\SpecialChar TeX
9174 layout or a message about
9175 \begin_inset Quotes eld
9178 You should not mix title layouts with normal ones
9179 \begin_inset Quotes erd
9182 , things haven't been installed correctly.
9185 \begin_layout Subsubsection
9187 error processing a table
9190 \begin_layout Standard
9192 , by default, attempts to center the table caption/title.
9193 This seems to produce a bad interaction in AAS\SpecialChar TeX
9194 so you should click somewhere
9195 in the caption/title, then select
9197 Edit\SpecialChar menuseparator
9199 \begin_inset space ~
9213 This took care of it for me.
9216 \begin_layout Subsubsection
9220 \begin_layout Standard
9221 A couple of things: 1) I have noticed some funny spacing in the reference
9222 entries in the text.
9223 When you enter the bibliography item data, make sure their is
9227 space between the last author and the parenthesis setting off the year;
9231 \begin_inset space \thinspace{}
9235 \begin_inset space \space{}
9249 2) Entering the references at all is not obvious.
9250 The easiest thing is to start typing your first reference at the end of
9251 the document, then mark it as type
9256 That will put a small gray box in front of what you just typed.
9257 Click on the box to fill in the rest of the information.
9258 For new references, go to the end of an existing reference and press return.
9259 That will create a new line with its own box, etc.
9262 \begin_layout Subsubsection
9266 \begin_layout Standard
9267 Even though AAS\SpecialChar TeX
9268 provides its own figure commands (
9274 , for example), I much prefer \SpecialChar LaTeX
9275 's standard figure commands (with the default
9284 \begin_inset space ~
9287 commands as \SpecialChar TeX
9288 code into a Figure Float box if you desire, but I never have
9289 much luck getting the layout right.
9290 With the standard graphics, \SpecialChar LyX
9295 usepackage{graphicx}
9297 command into the \SpecialChar LaTeX
9298 preamble and handle the figures in the standard \SpecialChar LaTeX2e
9300 interspersing the figures in the text.
9301 I believe ApJ accepts figures exactly this way now; AJ might still use
9303 \begin_inset Quotes eld
9306 stack everything at the end
9307 \begin_inset Quotes erd
9313 \begin_layout Subsubsection
9314 Things I could have done, but didn't
9317 \begin_layout Standard
9319 \begin_inset Quotes eld
9323 \begin_inset Quotes erd
9326 things I could have implemented, but chose not to.
9327 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
9329 even though it is double-spaced in the paper manuscript.
9330 Also, I chose not to make separate layouts for the preprint and preprint2
9332 Since I assume you will spend most of your time in the plain manuscript
9333 mode anyway, I decided not to chew up more disk space with this.
9337 \begin_layout Subsection
9341 \begin_layout Standard
9342 Your mileage may vary.
9343 I've now had papers published by both ApJ and AJ that have had 98% of the
9344 effort done in \SpecialChar LyX
9345 ; the last 2% was the \SpecialChar LaTeX
9346 post-processing and a few cleanups.
9347 I have had no trouble with the submission process, and I'm sure the journals
9348 were never aware that there might be a difference.
9349 So, go forth and publish!
9352 \begin_layout Section
9353 AMS \SpecialChar LaTeX
9357 \begin_layout Standard
9367 \begin_layout Standard
9368 \begin_inset VSpace bigskip
9374 \begin_layout Standard
9376 The AMS \SpecialChar LaTeX
9377 layouts are set up to conform to suggested styles for mathematical
9378 papers to be submitted to American Mathematical Society publications.
9379 The layouts are not tailored to a specific journal, but easily can be.
9380 You should refer to the AMS documentation for specific instructions for
9381 each journal (usually it will entail only changing a single line in the
9384 That documentation is available on the Web at
9385 \begin_inset Flex URL
9388 \begin_layout Plain Layout
9396 \begin_inset Flex URL
9399 \begin_layout Plain Layout
9401 ftp://ftp.ams.org/pub/tex/amslatex/
9407 These layouts are appropriate, and useful, for any mathematical writing.
9411 \begin_layout Standard
9412 There are two basic AMS \SpecialChar LaTeX
9416 \begin_layout Itemize
9417 amsart: The standard AMS article format.
9420 \begin_layout Itemize
9421 amsbook: the standard AMS book (really, monograph) format.
9425 \begin_layout Standard
9426 The layouts themselves contain only the minimum necessary to use the AMS
9428 They do not, in particular, contain any of the `theorem' environments used
9429 for setting theorems, lemmas, and the like.
9430 These are contained, instead, in the
9431 \begin_inset Flex Code
9434 \begin_layout Plain Layout
9440 module, which is loaded by default when you select one of the AMS classes.
9441 (It can also be used with other classes and can be removed, if you would
9442 rather use something else.) Less commonly used environments are in the
9443 \begin_inset Flex Code
9446 \begin_layout Plain Layout
9447 Theorems (AMS-Extended)
9452 module, which must be loaded manually.
9455 \begin_layout Standard
9456 By default, theorems and the like are numbered consecutively throughout
9457 the document, but this may be modified by loading the module
9458 \begin_inset Flex Code
9461 \begin_layout Plain Layout
9462 Theorems (Order by Section)
9467 or, if you are using
9468 \begin_inset Flex Code
9471 \begin_layout Plain Layout
9478 \begin_inset Flex Code
9481 \begin_layout Plain Layout
9482 Theorems (Order by Chapter)
9488 These will number the results as
9489 \begin_inset Formula $n.m$
9492 , where the first number refers to the section (or chapter) and the second
9493 refers to the total number of results so far in that section (or chapter).
9494 Many environments are also available unnumbered.
9495 These are indicated by an asterisk at the end.
9496 If you happen to want
9500 unnumbered results, the module
9501 \begin_inset Flex Code
9504 \begin_layout Plain Layout
9510 provides that option.
9513 \begin_layout Standard
9514 Note that these modules do not
9518 to be used with the AMS classes.
9519 It is perfectly possible to use the
9520 \begin_inset Flex Code
9523 \begin_layout Plain Layout
9529 module, and the others mentioned, with other classes, such as
9530 \begin_inset Flex Code
9533 \begin_layout Plain Layout
9540 \begin_inset Flex Code
9543 \begin_layout Plain Layout
9550 \begin_inset Flex Code
9553 \begin_layout Plain Layout
9562 \begin_layout Subsection
9563 What these layouts provide
9566 \begin_layout Standard
9567 There is a long list of included environments provided by these layouts.
9568 In AMS-\SpecialChar LaTeX
9569 , there is, in fact, an opportunity to define an unlimited variety
9570 of `theorem' environments.
9571 However, the AMS recommends the environments that are available in \SpecialChar LyX
9576 \begin_layout Standard
9577 The following environments—as well as the standard environments, such as
9579 \begin_inset Flex Noun
9582 \begin_layout Plain Layout
9589 \begin_inset Flex Noun
9592 \begin_layout Plain Layout
9599 \begin_inset Flex Noun
9602 \begin_layout Plain Layout
9609 \begin_inset Flex Noun
9612 \begin_layout Plain Layout
9619 \begin_inset Flex Noun
9622 \begin_layout Plain Layout
9629 \begin_inset Flex Code
9632 \begin_layout Plain Layout
9639 \begin_inset Flex Code
9642 \begin_layout Plain Layout
9651 \begin_layout Description
9652 Address This should be the author's permanent address.
9655 \begin_layout Description
9657 \begin_inset space ~
9660 Address This should be the author's temporary address at the time of submission,
9661 if different from the Address.
9664 \begin_layout Description
9665 Email Author's e-mail address
9668 \begin_layout Description
9669 URL Author's Web address, if desired.
9672 \begin_layout Description
9673 Keywords Key words or phrases used to identify specific topics discussed
9677 \begin_layout Description
9678 Subjectclass These refer to the AMS Subject Classifications, published and
9681 Mathematical Reviews
9684 These are also available online at the AMS cites listed above.
9687 \begin_layout Description
9691 \begin_layout Description
9695 \begin_layout Description
9699 \begin_layout Standard
9700 The following environments are provided by both the
9701 \begin_inset Flex Code
9704 \begin_layout Plain Layout
9711 \begin_inset Flex Code
9714 \begin_layout Plain Layout
9720 modules, in the latter case in both starred (unnumbered) and unstarred
9721 (numbered) versions.
9722 These same environments are provided only in the starred versions by the
9724 \begin_inset Flex Code
9727 \begin_layout Plain Layout
9736 \begin_layout Theorem
9737 This is typically used for the statements of major results.
9741 \begin_layout Corollary*
9742 This is used for statements which follow fairly directly from previous statement
9744 Again, these can be major results.
9749 These are smaller results needed to prove other statements.
9752 \begin_layout Proposition
9753 These are less major results which (hopefully) add to the general theory
9757 \begin_layout Conjecture
9758 These are statements provided without justification, which the author does
9759 not know how to prove, but which seem to be true (to the author, at least).
9762 \begin_layout Definition*
9763 Guess what this is for.
9764 The font is different for this environment than for the previous ones.
9768 \begin_layout Example*
9769 Used for examples illustrating proven results.
9772 \begin_layout Problem
9773 It's not really known what this is for.
9774 You should figure it out.
9777 \begin_layout Exercise*
9778 Write a description for this one.
9781 \begin_layout Remark
9782 This environment is also a type of theorem, usually a lesser sort of observation.
9785 \begin_layout Claim*
9786 Often used in the course of giving a proof of a larger result.
9790 Generally, these are used to break up long arguments, using specific instances
9796 The numbering scheme for cases is on its own, not together with other numbered
9802 At the end of this environment, a QED symbol (usually a square, but it can
9803 vary with different styles) is placed.
9804 If you want to have other environments within this one—for example, Case
9805 environments—and have the QED symbol appear only after them, then the other
9806 environments need to be nested within the proof environment.
9809 Nesting Environments
9815 for information on nesting.
9818 \begin_layout Standard
9819 And these environments are provided by
9820 \begin_inset Flex Code
9823 \begin_layout Plain Layout
9824 Theorems (AMS-Extended)
9832 \begin_layout Criterion*
9833 A required condition.
9836 \begin_layout Algorithm*
9837 A general procedure to be used.
9840 \begin_layout Axiom*
9841 This is a property or statement taken as true within the system being discussed.
9844 \begin_layout Condition*
9845 Sometimes used to state a condition assumed within the present context of
9850 Similar to a Remark.
9853 \begin_layout Notation*
9854 Used for the explanation of, yes, notation.
9857 \begin_layout Summary
9858 Do we really need to tell you?
9861 \begin_layout Acknowledgement*
9865 \begin_layout Conclusion*
9866 Sometimes used at the end of a long train of argument.
9870 Used in a way similar to Proposition, though perhaps lower on the scale.
9873 \begin_layout Standard
9874 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
9877 They need to be available on your system in order to use these environments.
9880 \begin_layout Section
9888 \begin_layout Standard
9894 \begin_layout Subsection
9898 \begin_layout Standard
9899 These are the layout files for some of the journals of the American Geophysical
9901 It is assumed that you have both the AGU's own class files and AGUplus
9902 installed (everything to be found at
9903 \begin_inset Flex URL
9906 \begin_layout Plain Layout
9908 http://publications.agu.org/files/2013/08/AGU-LaTeX.zip
9916 \begin_layout Subsection
9920 \begin_layout Standard
9930 They are still called this in the \SpecialChar LyX
9931 GUI, though their \SpecialChar LaTeX
9944 \begin_layout Standard
9945 Newly defined styles are
9982 These are mostly manuscript attributes and defined in the AGU class documentati
9986 \begin_layout Standard
9987 I suspect this is still badly incomplete.
9990 \begin_layout Subsection
9994 \begin_layout Standard
10011 \begin_layout Subsection
10015 \begin_layout Itemize
10018 Journal of Geophysical Research
10027 \begin_layout Standard
10028 Add your own, it isn't so hard! Look at the
10039 \begin_layout Subsection
10040 Bugs and things to remember
10043 \begin_layout Standard
10044 In order to use the new layouts, you must remember to do the following for
10048 \begin_layout Enumerate
10054 This can be done in the
10056 Layout\SpecialChar menuseparator
10061 Document\SpecialChar menuseparator
10065 (AGU articles are always in English, right? So
10069 choose a language.)
10072 \begin_layout Enumerate
10077 into the document's
10082 (Yes, this is a bug.)
10085 \begin_layout Enumerate
10086 Make sure you use the
10090 bibliography style, by entering
10094 into the second field of the Bib\SpecialChar TeX
10096 None of the standard styles will do.
10099 \begin_layout Section
10103 \begin_layout Standard
10109 \begin_layout Subsection
10113 \begin_layout Standard
10114 Broadway is for writing plays.
10115 The format is more decorative than Hollywood, and much less standardized.
10116 This format should be suitable for workshops.
10119 \begin_layout Subsection
10123 \begin_layout Standard
10124 The same as in Hollywood.
10127 \begin_layout Subsection
10131 \begin_layout Standard
10136 names as labels then cross-reference the label to insert the name.
10137 The cross-reference dialog will show the current cast of characters.
10140 \begin_layout Subsection
10141 Paper size and Margins
10144 \begin_layout Standard
10145 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
10148 \begin_layout Subsection
10152 \begin_layout Standard
10153 The following environments are available.
10154 You can use broadway.bind to get the bind keys shown at the right.
10157 \begin_layout Itemize
10161 \begin_inset Newline newline
10166 You should not have to use this, but it is here for anything that does not
10170 \begin_layout Itemize
10174 \begin_inset space \hfill{}
10178 \begin_inset Newline newline
10183 Used to describe stage setting and the action.
10184 First use of speaker names in all CAPs.
10187 \begin_layout Itemize
10191 \begin_inset space \hfill{}
10195 \begin_inset Newline newline
10200 Automatically numbered.
10201 On screen it will be arabic, but will print as Roman.
10204 \begin_layout Itemize
10208 \begin_inset space \hfill{}
10212 \begin_inset Newline newline
10222 It is just centered text.
10225 \begin_layout Itemize
10229 \begin_inset space \hfill{}
10233 \begin_inset Newline newline
10238 Not automatically numbered.
10239 You supply the number.
10240 This is because I couldn't figure out how.
10243 \begin_layout Itemize
10247 \begin_inset space \hfill{}
10251 \begin_inset Newline newline
10256 A special case of Narrative to describe the setting and action as the curtain
10260 \begin_layout Itemize
10264 \begin_inset space \hfill{}
10268 \begin_inset Newline newline
10273 The speaker's (actor's) title, centered in all CAPS.
10276 \begin_layout Itemize
10280 \begin_inset space \hfill{}
10284 \begin_inset Newline newline
10289 Instructions to the speaker.
10290 The parentheses are automatically inserted.
10291 The ( will appear on screen, but both will be in the printed play.
10292 This environment is only used within
10299 \begin_layout Itemize
10303 \begin_inset space \hfill{}
10307 \begin_inset Newline newline
10312 What the Speaker says.
10315 \begin_layout Itemize
10319 \begin_inset space \hfill{}
10323 \begin_inset Newline newline
10328 The curtain comes down.
10331 \begin_layout Itemize
10335 \begin_inset space \hfill{}
10341 \begin_layout Itemize
10345 \begin_inset space \hfill{}
10351 \begin_layout Itemize
10355 \begin_inset space \hfill{}
10361 \begin_layout Standard
10365 \begin_layout Section
10369 \begin_layout Standard
10374 can be used to type letters according to German conventions.
10375 A template file is included in
10377 .../lyx/share/templates
10379 for you to use as a starting point.
10382 \begin_layout Section
10390 \begin_layout Standard
10396 \begin_layout Subsection
10400 \begin_layout Standard
10401 This is the layout file for the European Geophysical Society journals.
10406 can be downloaded from the web site of the EGS under
10407 \begin_inset Flex URL
10410 \begin_layout Plain Layout
10420 \begin_layout Subsection
10424 \begin_layout Standard
10427 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
10435 The current layout file is unfortunately very unmodular and would benefit
10436 from using the various
10443 \begin_layout Section
10447 \begin_layout Standard
10448 See the \SpecialChar LyX
10454 It contains all infos you need.
10457 \begin_layout Section
10460 Foil\SpecialChar TeX
10464 \begin_inset CommandInset label
10473 \begin_layout Standard
10479 \begin_layout Subsection
10483 \begin_layout Standard
10484 This section describes how to use \SpecialChar LyX
10485 to make slides for overhead projectors.
10486 There are two document classes that can do this: the default slides class
10489 Foil\SpecialChar TeX
10493 This section documents the latter.
10496 \begin_layout Standard
10497 I'm going to say this again, nice and clear, so that there's no misunderstanding
10501 \begin_layout Standard
10502 \begin_inset VSpace bigskip
10508 \begin_layout Standard
10512 This section documents the class
10513 \begin_inset Quotes eld
10521 \begin_inset Quotes erd
10529 \begin_layout Standard
10530 \begin_inset VSpace bigskip
10536 \begin_layout Standard
10537 If you're looking for the documentation for
10538 \begin_inset Quotes eld
10546 \begin_inset Quotes erd
10549 , check out section
10550 \begin_inset space ~
10554 \begin_inset CommandInset ref
10556 reference "sec:slitex"
10561 If your machine doesn't have the
10569 installed, you'll probably have to use the default
10573 class, which isn't quite as good as
10578 \begin_layout Standard
10583 class is designed for use with version
10584 \begin_inset space ~
10592 class file which is now an integral part of \SpecialChar LaTeX2e
10596 \begin_layout Subsection
10600 \begin_layout Standard
10601 Obviously, to use this document class, you need to select
10612 \begin_inset space ~
10618 There are some settings in the
10621 \begin_inset space ~
10626 dialog that you should know about that are specific to this class:
10629 \begin_layout Itemize
10630 Don't change the options
10641 \begin_inset space ~
10647 They're ignored by the
10654 \begin_layout Itemize
10655 The default font size is 20
10656 \begin_inset space \thinspace{}
10659 pt with the other options being 17
10660 \begin_inset space \thinspace{}
10664 \begin_inset space \thinspace{}
10668 \begin_inset space \thinspace{}
10674 \begin_layout Itemize
10675 The default font is
10683 but all math equations are still typeset in the usual roman font.
10686 \begin_layout Itemize
10689 Foil\SpecialChar TeX
10692 supports A4 and Letter paper sizes as well as a special size for working
10694 \begin_inset space \thinspace{}
10698 It doesn't support A5, B5, legal or executive paper sizes.
10701 \begin_layout Itemize
10702 Don't bother changing the
10706 settings because they are ignored anyway.
10707 All floats appear where they are defined in the text.
10710 \begin_layout Itemize
10715 setting behaves a bit differently for this class.
10718 Foil\SpecialChar TeX
10721 provides extensive footer and header capabilities including a user-defined
10724 \begin_inset space ~
10728 \begin_inset CommandInset ref
10730 reference "sec:foilfoot"
10735 The title page is treated differently to all other pages in the document
10744 has the logo centered at the bottom of the page (if one is defined).
10745 The possible page style choices and what they do are as follows:
10749 \begin_layout Labeling
10750 \labelwidthstring MMMMMMM
10757 The final output contains no page numbers, or other headers or footers
10758 (except footnotes of course).
10762 \begin_layout Labeling
10763 \labelwidthstring MMMMMMM
10770 The final output contains page numbers centered at the bottom of the page.
10771 No other headings or footers (other than footnotes).
10774 \begin_layout Labeling
10775 \labelwidthstring MMMMMMM
10780 Page numbers in lower right corner.
10781 Additional headers and footers are also shown.
10782 This is also the default.
10785 \begin_layout Labeling
10786 \labelwidthstring MMMMMMM
10791 Gives you access to the
10795 package although its use with
10797 Foil\SpecialChar TeX
10800 is discouraged by the writer of the
10802 Foil\SpecialChar TeX
10805 package because of some potential page layout clashes.
10809 \begin_layout Subsubsection
10813 \begin_layout Standard
10814 The following options may be used in the extra class options in the
10816 Document\SpecialChar menuseparator
10822 \begin_layout Labeling
10823 \labelwidthstring MMMMMMx
10828 This sets up the page layout for 7.33
10829 \begin_inset space \thinspace{}
10833 \begin_inset space \thinspace{}
10836 in paper, which is about the same aspect ratio as a 35
10837 \begin_inset space \thinspace{}
10840 mm slide, making it a bit easier to work with this medium.
10843 \begin_layout Labeling
10844 \labelwidthstring MMMMMMx
10849 Places a rule across the page below the header on every page except the
10853 \begin_layout Labeling
10854 \labelwidthstring MMMMMMx
10859 Places a rule across the page above the footer on every page except the
10863 \begin_layout Labeling
10864 \labelwidthstring MMMMMMx
10869 This is automatically set each time you create a new
10876 Foil\SpecialChar TeX
10879 to use the dvips driver to rotate those pages that are set as landscape
10883 \begin_layout Labeling
10884 \labelwidthstring MMMMMMx
10889 Simply changes the page dimensions to those of a landscape page but doesn't
10891 Thus if you use this option you need to use an external program to rotate
10892 each page or feed your paper through your printer as landscape.
10893 Note that this option effectively reverses the roles of the
10901 environments (don't worry these are described in the next section).
10904 \begin_layout Labeling
10905 \labelwidthstring MMMMMMx
10910 Equation numbers on the left.
10913 \begin_layout Labeling
10914 \labelwidthstring MMMMMMx
10919 Flush-left equations.
10922 \begin_layout Subsection
10923 Supported Environments
10926 \begin_layout Standard
10927 Most of the environments commonly supported in other classes are also supported
10933 There are several additional environments provided by
10935 Foil\SpecialChar TeX
10938 as well as a couple added by \SpecialChar LyX
10940 The following environments are shared with other classes:
10943 \begin_layout Standard
10944 \begin_inset Flex Multiple Columns
10947 \begin_layout Itemize
10953 \begin_layout Itemize
10959 \begin_layout Itemize
10965 \begin_layout Itemize
10971 \begin_layout Itemize
10977 \begin_layout Itemize
10984 \begin_layout Itemize
10990 \begin_layout Itemize
10996 \begin_layout Itemize
11002 \begin_layout Itemize
11008 \begin_layout Itemize
11014 \begin_layout Itemize
11020 \begin_layout Itemize
11026 \begin_layout Itemize
11032 \begin_layout Itemize
11038 \begin_layout Itemize
11044 \begin_layout Itemize
11050 \begin_layout Itemize
11061 \begin_layout Standard
11062 That is, all the major environments apart from the sectioning environments.
11063 Since foils are essentially self-contained sections, with a title and body,
11066 Foil\SpecialChar TeX
11069 provides specific commands for starting new foils and these are:
11072 \begin_layout Itemize
11078 \begin_layout Itemize
11084 \begin_layout Standard
11086 also provides slightly modified versions of these two environments called:
11089 \begin_layout Itemize
11095 \begin_layout Itemize
11098 ShortRotatefoilhead
11101 \begin_layout Standard
11102 and the differences will be explained in the next section.
11105 \begin_layout Standard
11106 Since foils are often used in presenting ideas or new theorems and such
11109 Foil\SpecialChar TeX
11112 also provides a comprehensive box of goodies for presenting them:
11115 \begin_layout Standard
11116 \begin_inset Flex Multiple Columns
11119 \begin_layout Itemize
11125 \begin_layout Itemize
11131 \begin_layout Itemize
11137 \begin_layout Itemize
11143 \begin_layout Itemize
11149 \begin_layout Itemize
11155 \begin_layout Itemize
11161 \begin_layout Itemize
11167 \begin_layout Itemize
11173 \begin_layout Itemize
11179 \begin_layout Itemize
11190 \begin_layout Standard
11191 The starred versions are unnumbered while the unstarred versions are numbered.
11192 There are also two list environments added by \SpecialChar LyX
11196 \begin_layout Itemize
11202 \begin_layout Itemize
11208 \begin_layout Standard
11211 Foil\SpecialChar TeX
11214 provides some powerful header and footer capabilities that are best set
11215 in the preamble although they may be set at any point in a document.
11216 If you want to change these settings in your document the best place to
11217 do so is at the very top of a foil, i.
11218 \begin_inset space \thinspace{}
11224 \begin_inset space \space{}
11229 straight after the foilhead.
11232 \begin_layout Standard
11233 For this purpose, the following command styles are provided [
11240 \begin_layout Standard
11241 \begin_inset Flex Multiple Columns
11244 \begin_layout Itemize
11248 \begin_inset space ~
11254 \begin_layout Itemize
11260 \begin_layout Itemize
11264 \begin_inset space ~
11270 \begin_layout Itemize
11274 \begin_inset space ~
11280 \begin_layout Itemize
11284 \begin_inset space ~
11291 \begin_layout Plain Layout
11292 \begin_inset space ~
11304 \begin_layout Standard
11305 There are also a few commands provided by
11307 Foil\SpecialChar TeX
11310 that aren't directly supported by \SpecialChar LyX
11311 but I'll tell you what they do and how
11312 to use them in section
11313 \begin_inset space ~
11317 \begin_inset CommandInset ref
11319 reference "sec:unsuppfoils"
11326 \begin_layout Subsection
11327 Building a Set of Foils
11330 \begin_layout Standard
11331 This section will give a simple introduction to using the different environments
11332 to build a set of foils.
11333 If you want to see an example set of foils, take a look at the
11337 file you find in \SpecialChar LyX
11345 \begin_layout Subsubsection
11346 Give It a Title Page
11349 \begin_layout Standard
11350 Unlike other classes that provide
11370 creates the title on a page of its own.
11371 If you leave out the
11375 environment \SpecialChar LaTeX
11376 will substitute the current date (every time you regenerate
11380 \begin_layout Subsubsection
11384 \begin_layout Standard
11385 As I mentioned earlier, there are four ways of starting a new foil.
11386 For portrait foils you should use
11395 The difference between these two environments is the amount of space between
11396 the title of the foil (the foilhead) and the body of the foil.
11399 \begin_layout Standard
11400 Landscape foils are generated using the
11406 ShortRotatefoilhead
11409 Again the only difference is the spacing between foilhead and body.
11410 Both of the short versions have 0.5
11411 \begin_inset space ~
11414 inches less separation between the foilhead and the body.
11418 \begin_layout Standard
11419 One problem with the support for landscape foils is the requirement that
11420 you have to use the
11424 driver to generate the PostScript output otherwise the foils won't be rotated.
11425 It is possible to get landscape foils even if you haven't got the
11429 driver provided you can feed your foils sideways through your printer ;-)
11432 \begin_layout Subsubsection
11433 Theorems, Lemmas, Proofs and more
11436 \begin_layout Standard
11437 Due to a small bug in \SpecialChar LyX
11438 you can't have two of the same type of these environments
11439 directly following each other.
11440 They must be separated by something.
11441 If you try, you will just be extending the previous environment as if you
11442 had merged the two environments together.
11443 So, how do you get around this problem? The simplest option is to insert
11444 some text between the two environments or add a
11449 environment between the two with just a
11450 \begin_inset Quotes eld
11458 \begin_inset Quotes erd
11462 This will force \SpecialChar LyX
11463 to produce two separate environments and hence the correct
11466 An example is provided in the example file included with the \SpecialChar LyX
11468 Remember, this problem only occurs if you are trying to place two of the
11469 same type of theorem-like environments one directly after the other.
11472 \begin_layout Subsubsection
11476 \begin_layout Standard
11477 You get all the commonly supported list styles found in other classes as
11478 well as two new ones.
11479 I'll only describe the new ones here.
11480 If you want to find out more about the other list environments check out
11486 If you intend to use itemized lists you might also want to read about the
11490 \begin_inset space ~
11494 \begin_inset space ~
11499 dialog described above in section
11500 \begin_inset space ~
11504 \begin_inset CommandInset ref
11506 reference "sec:bullet"
11513 \begin_layout Standard
11514 The two new list styles,
11522 , are designed to make it easier for you to create lists of do's and don'ts
11523 or right and wrong by providing dedicated environments that use a tick
11524 or a cross as the label of the list.
11525 These lists are in fact dedicated variants of the
11530 They do however require that you have the
11534 packages installed.
11537 \begin_layout Subsubsection
11541 \begin_layout Standard
11544 Foil\SpecialChar TeX
11547 redefines the floating tables and figures so that they appear exactly where
11548 they are in the text rather than pushing them to the top of the page or
11549 to some user specified location.
11550 In fact if you change the float placement settings they are simply ignored.
11553 \begin_layout Subsubsection
11554 Page Headers and Footers
11555 \begin_inset CommandInset label
11557 name "sec:foilfoot"
11564 \begin_layout Standard
11568 \begin_inset space ~
11577 are two commands used to control the left-footer text string.
11578 The first is meant to allow you to include a graphic logo on your foils
11580 \begin_inset Quotes eld
11585 Foil\SpecialChar TeX
11589 \begin_inset Quotes erd
11593 While the second is meant to provide a classification for the audience,
11597 \begin_inset space \thinspace{}
11603 \begin_inset space \space{}
11607 It is empty by default.
11610 \begin_layout Standard
11611 The remaining page corners can be filled by
11614 \begin_inset space ~
11619 (which defaults to page numbers),
11622 \begin_inset space ~
11630 \begin_inset space ~
11638 \begin_layout Subsection
11641 Foil\SpecialChar TeX
11645 \begin_inset CommandInset label
11647 name "sec:unsuppfoils"
11654 \begin_layout Standard
11655 All the commands mentioned below need to be set in a
11665 within another environment.
11668 \begin_layout Subsubsection
11672 \begin_layout Standard
11673 All lengths are adjusted using the
11696 should be replaced by the name given to the length you want to change and
11701 is the length value.
11702 All lengths should be specified in units of length such as inches (
11714 ) or relative to some document or font-based length such as
11724 \begin_layout Standard
11725 It's possible to change the spacing between a foilhead and the body of the
11726 foil by adjusting the length specified by
11733 For example, to make
11738 \begin_inset space \space{}
11741 in closer to their bodies put the following in the preamble:
11747 foilheadskip}{-0.5in}
11750 \begin_layout Standard
11751 The spacings around floats can be adjusted by setting these lengths:
11754 \begin_layout Labeling
11755 \labelwidthstring MMMMMMMMMMM
11762 Separation between the text and the top of the float
11765 \begin_layout Labeling
11766 \labelwidthstring MMMMMMMMMMM
11773 Separation between the float and the caption
11776 \begin_layout Labeling
11777 \labelwidthstring MMMMMMMMMMM
11784 Separation between the caption and the following text
11787 \begin_layout Labeling
11788 \labelwidthstring MMMMMMMMMMM
11795 You can make the captions narrower than the surrounding text by adjusting
11797 Best done relative to
11806 \begin_layout Standard
11807 There are also several title page related lengths that you may find useful
11808 if you have a long title or several authors:
11811 \begin_layout Labeling
11812 \labelwidthstring MMMMMMMMMMM
11819 Separation from headers to
11824 \begin_layout Labeling
11825 \labelwidthstring MMMMMMMMMMM
11843 \begin_layout Labeling
11844 \labelwidthstring MMMMMMMMMMM
11858 \begin_layout Labeling
11859 \labelwidthstring MMMMMMMMMMM
11875 \begin_layout Labeling
11876 \labelwidthstring MMMMMMMMMMM
11892 \begin_layout Standard
11893 The last length related command affects all the list environments.
11904 a list environment then all the vertical spacing between the list items
11906 Note that this is a command not a length so it doesn't require
11912 like the stuff mentioned above.
11915 \begin_layout Subsubsection
11916 Headers and Footers
11919 \begin_layout Standard
11932 commands control whether the logo in the
11936 definition appear on a given page.
11943 in the preamble then none of the foils will have the logo on them.
11944 If you don't want the logo on a particular page place the
11950 directly after the foilhead of that page and the
11956 directly after the next foilhead.
11959 \begin_layout Standard
11960 If you decide to use the
11964 page style setting in the
11967 \begin_inset space ~
11972 dialog you should probably add
11982 to your preamble so headers and footers on landscape pages are correctly
11983 placed when rotated.
11984 This is due to some clashes between the page layouts provided by the
11995 \begin_layout Section
11996 Hollywood (Hollywood spec scripts)
11999 \begin_layout Standard
12005 \begin_layout Subsection
12009 \begin_layout Standard
12010 Getting the format of a Hollywood script right is a
12011 \begin_inset Quotes eld
12015 \begin_inset Quotes erd
12018 It is designed to make the readers focus on content and to be easy and
12019 familiar for the actors to read.
12020 Each page of a script should be one minute of film.
12021 Nothing goes in a script that you cannot see or hear on screen.
12022 The courier 12 pt font should be used throughout.
12026 \begin_layout Subsection
12030 \begin_layout Standard
12031 Speakers' lines should NEVER break in mid-sentence.
12032 If a speaker's lines continue over a page break, repeat the
12036 title followed by (Cont'd).
12039 \begin_layout Subsection
12043 \begin_layout Standard
12048 names as labels then cross-reference the label to insert the name.
12049 The cross-reference dialog will show the current cast of characters.
12050 You can use this to insert the speaker name in narratives also.
12053 \begin_layout Subsection
12054 Paper size and Margins
12057 \begin_layout Standard
12058 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12061 \begin_layout Subsection
12065 \begin_layout Standard
12066 The following environments are available.
12067 You can use hollywood.bind to get the bind keys shown at the right.
12070 \begin_layout Itemize
12074 \begin_inset Newline newline
12079 Used where nothing else works.
12083 \begin_layout Itemize
12089 \begin_inset space \hfill{}
12097 \begin_inset Newline newline
12100 Usually followed by something like
12101 \begin_inset Quotes eld
12104 on Sally waking up.
12105 \begin_inset Quotes erd
12111 \begin_layout Itemize
12115 \begin_inset space \hfill{}
12119 \begin_inset Newline newline
12124 Introduces a new INTERIOR camera set-up.
12125 Always followed by DAY or NIGHT, or something similar to define the lighting
12127 Everthing on this line in CAPS.
12130 \begin_layout Itemize
12134 \begin_inset space \hfill{}
12138 \begin_inset Newline newline
12143 Introduces a new EXTERIOR camera set-up.
12144 Everthing on this line in CAPS.
12147 \begin_layout Itemize
12151 \begin_inset space \hfill{}
12155 \begin_inset Newline newline
12160 The character speaking.
12163 \begin_layout Itemize
12167 \begin_inset space \hfill{}
12171 \begin_inset Newline newline
12176 Instructions to the speaker.
12177 The () are automatically inserted, but only the ( will show in \SpecialChar LyX
12179 Both will be printed.
12182 \begin_layout Itemize
12186 \begin_inset space \hfill{}
12190 \begin_inset Newline newline
12202 \begin_layout Itemize
12206 \begin_inset space \hfill{}
12210 \begin_inset Newline newline
12215 Camera movement instruction.
12217 \begin_inset space \thinspace{}
12221 \begin_inset space \space{}
12227 \begin_layout Itemize
12231 \begin_inset space \hfill{}
12237 \begin_layout Itemize
12241 \begin_inset space \hfill{}
12247 \begin_layout Itemize
12251 \begin_inset space \hfill{}
12257 \begin_layout Itemize
12261 \begin_inset space \hfill{}
12267 \begin_layout Subsection
12271 \begin_layout Itemize
12275 \begin_layout Itemize
12279 \begin_layout Itemize
12281 \begin_inset space \thinspace{}
12288 \begin_layout Itemize
12293 \begin_layout Itemize
12294 PAN — camera movement
12297 \begin_layout Itemize
12298 INSERT — cut to close-up of
12301 \begin_layout Section
12305 \begin_layout Standard
12308 Panayotis Papasotiriou
12311 \begin_layout Subsection
12315 \begin_layout Standard
12316 The ijmpc package is a set of macros that facilitates electronic manuscript
12319 International Journal of Modern Physics C
12322 Similarly, the ijmpd package is for creating manuscripts to be submitted
12325 International Journal of Modern Physics D
12328 Both journals are published by World Scientific.
12329 The corresponding document classes are named
12338 These files, together with instructions for the authors, can be downloaded
12340 \begin_inset Flex URL
12343 \begin_layout Plain Layout
12345 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
12351 \begin_inset Flex URL
12354 \begin_layout Plain Layout
12356 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
12362 Both packages are modified versions of the standard
12363 \begin_inset Quotes eld
12367 \begin_inset Quotes erd
12370 package, and they are almost (but not exactly) identical.
12371 Most of their features are supported by \SpecialChar LyX
12373 I have used \SpecialChar LyX
12374 successfully to write articles submitted to both journals
12375 without any problem.
12378 \begin_layout Subsection
12382 \begin_layout Standard
12383 As usual, the easiest way to write a paper is to start with a template.
12386 File\SpecialChar menuseparator
12402 This will give an (almost) empty document that includes the most common
12403 fields found in a manuscript.
12404 Simply overwrite the existing text (including the brackets,
12409 You should keep in mind the following remarks.
12412 \begin_layout Enumerate
12414 won't let you change the font size and the page style of the document,
12415 because such modifications are not allowed by both packages.
12418 \begin_layout Enumerate
12419 The language of the document should not be changed.
12420 Before previewing your paper, be sure that the babel package is not used.
12421 To do this, click on
12423 Tools\SpecialChar menuseparator
12434 checkbox in the language settings, and click on
12442 , if you wish to make this change permanent).
12445 \begin_layout Enumerate
12447 \begin_inset Quotes eld
12451 \begin_inset Quotes erd
12454 style must be used to define keywords.
12457 \begin_layout Enumerate
12458 The ijmpc package provides a style named
12459 \begin_inset Quotes eld
12462 Classification Codes
12463 \begin_inset Quotes erd
12466 , which can be used to define classification codes, such as PACS numbers.
12467 Note that this facility is not supported by the ijmpd package.
12470 \begin_layout Enumerate
12471 Several new environments are available:
12472 \begin_inset Quotes eld
12476 \begin_inset Quotes erd
12480 \begin_inset Quotes eld
12484 \begin_inset Quotes erd
12488 \begin_inset Quotes eld
12492 \begin_inset Quotes erd
12496 \begin_inset Quotes eld
12500 \begin_inset Quotes erd
12504 \begin_inset Quotes eld
12508 \begin_inset Quotes erd
12512 \begin_inset Quotes eld
12516 \begin_inset Quotes erd
12520 \begin_inset Quotes eld
12524 \begin_inset Quotes erd
12528 \begin_inset Quotes eld
12532 \begin_inset Quotes erd
12536 \begin_inset Quotes eld
12540 \begin_inset Quotes erd
12544 \begin_inset Quotes eld
12548 \begin_inset Quotes erd
12552 \begin_inset Quotes eld
12556 \begin_inset Quotes erd
12560 \begin_inset Quotes eld
12564 \begin_inset Quotes erd
12568 \begin_inset Quotes eld
12572 \begin_inset Quotes erd
12576 \begin_inset Quotes eld
12580 \begin_inset Quotes erd
12584 Their use is more or less obvious.
12586 supports all these environments; it will use the proper label, text style,
12587 and numbering scheme for each of them.
12590 \begin_layout Enumerate
12591 Both packages use basic citations; the natbib package should not be used.
12592 In \SpecialChar LyX
12593 , citation references are shown as usual; in the output, citations are
12594 shown as superscripts.
12595 If you want to use a citation as normal text, you should use the
12600 \begin_inset space \thinspace{}
12604 \begin_inset space \space{}
12608 \begin_inset Quotes eld
12612 \begin_inset space \space{}
12622 \begin_inset Quotes erd
12628 \begin_layout Enumerate
12630 \begin_inset Quotes eld
12634 \begin_inset Quotes erd
12637 section in both packages.
12638 To put acknowledgments, just use the
12639 \begin_inset Quotes eld
12643 \begin_inset Quotes erd
12649 \begin_layout Enumerate
12650 Appendices may be added to the paper,
12654 the Acknowledgments and
12660 provides a special environment, called
12661 \begin_inset Quotes eld
12665 \begin_inset Quotes erd
12668 which marks the beginning of the appendices.
12669 This environment should be left blank; it just sends a \SpecialChar LaTeX
12670 command, but nothing
12672 In \SpecialChar LyX
12674 \begin_inset Quotes eld
12678 \begin_inset Quotes erd
12681 is printed with blue letters, as a signal that all sections after that
12682 point are appendices.
12683 To write an appendix, use the
12684 \begin_inset Quotes eld
12688 \begin_inset Quotes erd
12693 will number each appendix with capital letters, as required by both journals.
12695 \begin_inset Quotes eld
12699 \begin_inset Quotes erd
12706 be present before the first appendix; if not, all appendices will be numbered
12707 as normal sections in the output.
12710 \begin_layout Enumerate
12711 The ijmpc and the ijmpd packages use the
12715 command to implement table captions.
12716 As a result, a table created by \SpecialChar LyX
12717 is printed correctly, but its caption
12719 However, you can use some \SpecialChar TeX
12720 code to overcome this problem, so that captions
12721 are printed as expected.
12722 To do so, create a float table as usual, remove the caption, and replace
12723 it with the \SpecialChar TeX
12734 (sic); you must also the \SpecialChar TeX
12739 immediately after the tabular material.
12740 Study the example table included in the template files to see how this
12741 trick is implemented.
12742 Alternatively, If you need table captions, you should implement the whole
12747 file, then include this file to the \SpecialChar LyX
12750 Insert\SpecialChar menuseparator
12751 File\SpecialChar menuseparator
12753 \begin_inset space ~
12759 Details on how to create a table float can be found in the files
12767 , included in the corresponding packages.
12770 \begin_layout Subsection
12771 Preparing a paper for submission
12774 \begin_layout Standard
12775 Before you submit your paper you must export the \SpecialChar LyX
12776 document as a \SpecialChar LaTeX
12779 File\SpecialChar menuseparator
12780 Export\SpecialChar menuseparator
12788 \begin_layout Plain Layout
12789 Actually you have the choice between \SpecialChar LaTeX
12790 (plain) and pdflatex.
12791 If you intend to use pdflatex to prepare the paper, you should use the
12792 pdflatex option so that included graphics are converted to PDF format,
12793 ready for use by pdflatex.
12798 , then make the following changes to the resulting
12805 \begin_layout Enumerate
12806 Remove the comment lines before the
12815 \begin_layout Enumerate
12816 Remove everything between (and including) the
12828 commands, except for any commands you specifically put into the \SpecialChar LaTeX
12832 \begin_layout Standard
12837 file should be saved and processed through \SpecialChar LaTeX
12838 as many times as necessary.
12839 You may also want to check the resulting
12846 \begin_layout Subsection
12847 Use of \SpecialChar TeX
12851 \begin_layout Standard
12852 The use of \SpecialChar TeX
12853 code is reduced to two commands, which must be placed at the
12854 top of the document.
12855 If you started writing your paper by using the
12863 template, the \SpecialChar TeX
12864 code needed is already in its place; you usually don't need
12866 You may only modify the first \SpecialChar TeX
12867 code to specify the information printed
12868 to the top of odd and even pages (authors' names and short paper's title,
12870 This \SpecialChar TeX
12871 code must have the form
12875 markboth{Authors' Names}{Short Paper's Title}
12880 \begin_layout Section
12884 \begin_layout Standard
12890 \begin_layout Subsection
12894 \begin_layout Standard
12895 The iopart package provides a document class to create electronic manuscript
12896 submission to the journals published by the Institute of Physics.
12897 Instructions for the authors how to create a paper using the iopart class
12898 can be downloaded together with the iopart package from the site
12899 \begin_inset Flex URL
12902 \begin_layout Plain Layout
12904 ftp://ftp.iop.org/pub/journals/latex2e
12912 \begin_layout Subsection
12916 \begin_layout Standard
12917 The easiest way to write a paper is to start with the file
12921 that is available in \SpecialChar LyX
12922 's examples files folder.
12923 Open this file, save it under a new name, and start writing.
12924 The example file explains how to use the special text environments.
12925 Here are the most important advices:
12928 \begin_layout Itemize
12929 To be able to compile your document to a PDF, PS, or DVI, ensure that the
12932 Use AMS math package
12934 in the document settings under
12941 \begin_layout Itemize
12944 The title environment defines the kind of your paper.
12945 So use one of the following environments for the title:
12949 \begin_layout Itemize
12958 \begin_layout Itemize
12967 \begin_layout Itemize
12973 for a Topical review
12976 \begin_layout Itemize
12985 \begin_layout Itemize
12994 \begin_layout Itemize
13000 for a Paper (same as Title)
13003 \begin_layout Itemize
13009 for a Preliminary communication
13012 \begin_layout Itemize
13018 for a Rapid communication
13021 \begin_layout Itemize
13027 for a Letter to the editor
13031 \begin_layout Itemize
13034 All title environments except of
13038 can have an optional short title.
13041 \begin_layout Itemize
13042 There is a general title environment
13046 which is not directly supported by the \SpecialChar LyX
13048 This can be used as \SpecialChar TeX
13049 code when your document doesn't fit into one of the
13053 \begin_layout Standard
13054 For more informations like hints for special table and formula formatting,
13055 look at the IOP author guidelines.
13058 \begin_layout Section
13062 \begin_layout Standard
13065 Panayotis Papasotiriou
13068 \begin_layout Subsection
13072 \begin_layout Standard
13073 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
13074 that facilitates electronic manuscript submission to the journals they
13076 Most known of them (at least in my domain of interest) are
13078 Astrophysics and Space Science
13084 , but there are many others (see a complete list at
13085 \begin_inset Flex URL
13088 \begin_layout Plain Layout
13090 http://www.wkap.nl/jrnllist.htm/JRNLHOME
13096 The Kluwer package may be downloaded from the site
13097 \begin_inset Flex URL
13100 \begin_layout Plain Layout
13102 http://www.wkap.nl/kaphtml.htm/STYLEFILES
13108 A complete user guide is contained in that package (but it can also be
13109 downloaded separately).
13112 \begin_layout Standard
13114 supports many features of the package but not everything.
13115 However, the \SpecialChar TeX
13116 code needed is reduced to some
13117 \begin_inset Quotes eld
13121 \begin_inset Quotes erd
13124 commands of the package (see
13125 \begin_inset space ~
13129 \begin_inset CommandInset ref
13131 reference "subsec:kluwer_peculiarities"
13136 I have recently used \SpecialChar LyX
13137 to write an article submitted to the
13139 Astrophysics and Space Science
13141 without any problem.
13144 \begin_layout Subsection
13148 \begin_layout Standard
13149 The easiest way to write a paper is to start with the Kluwer template file.
13152 File\SpecialChar menuseparator
13164 This will give an (almost) empty document that includes the most common
13165 fields found in a manuscript and a short description of their use.
13166 As in most templates, simply overwrite the existing text (including the
13171 ) with the correct information.
13174 \begin_layout Subsection
13175 Preparing a paper for submission
13178 \begin_layout Standard
13179 As in the AAS\SpecialChar TeX
13180 package, before you submit your paper to a journal you must
13182 \begin_inset Quotes eld
13186 \begin_inset Quotes erd
13192 \begin_layout Enumerate
13193 Export your paper as a \SpecialChar LaTeX
13195 To do this, click on
13197 File\SpecialChar menuseparator
13198 Export\SpecialChar menuseparator
13206 \begin_layout Enumerate
13211 file with a text editor and make the following changes
13215 \begin_layout Enumerate
13216 remove the comment lines before the
13225 \begin_layout Enumerate
13226 remove everything between (and including) the
13238 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13242 \begin_layout Standard
13251 \begin_layout Enumerate
13256 file through \SpecialChar LaTeX
13257 as many times as necessary (usually up to three).
13260 \begin_layout Enumerate
13266 \begin_inset space \thinspace{}
13270 \begin_inset space \space{}
13277 , and check if everything is OK (it should, if you didn't make any mistake).
13280 \begin_layout Subsection
13281 \begin_inset Quotes eld
13285 \begin_inset Quotes erd
13288 of the Kluwer package
13289 \begin_inset CommandInset label
13291 name "subsec:kluwer_peculiarities"
13298 \begin_layout Standard
13299 The Kluwer package has the following
13300 \begin_inset Quotes eld
13304 \begin_inset Quotes erd
13310 \begin_layout Enumerate
13311 It is possible to write multiple articles in the same \SpecialChar LaTeX
13316 \begin_layout Plain Layout
13317 I can't imagine any good reason to do this.
13323 Each article must be included in the environment
13324 \begin_inset Quotes eld
13328 \begin_inset Quotes erd
13332 Unfortunately, this environment cannot be omitted, even if you write just
13334 Therefore, each article starts with the command
13340 and, obviously, ends with the command
13347 Although this can be implemented in \SpecialChar LyX
13348 , I didn't included it, since it looks
13349 ugly and can confuse the novice user.
13350 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
13353 \begin_inset Quotes eld
13358 \begin_inset Quotes erd
13364 \begin_layout Enumerate
13365 Information given at the beginning of the article (i.
13366 \begin_inset space \thinspace{}
13370 \begin_inset space \space{}
13373 title, subtitle, author, institution, running title, running author, abstract
13374 and keywords) must be included in an environment called
13375 \begin_inset Quotes eld
13379 \begin_inset Quotes erd
13383 This is not implemented in \SpecialChar LyX
13384 , so you must enter title, subtitle etc.
13385 \begin_inset space ~
13388 between two \SpecialChar TeX
13404 \begin_layout Enumerate
13405 According to the user manual, the label of each bibliography item must be
13429 \begin_layout Standard
13434 template takes care of all these
13435 \begin_inset Quotes eld
13439 \begin_inset Quotes erd
13443 If you start a new paper using this template you don't need to do anything
13448 \begin_layout Enumerate
13449 don't delete the \SpecialChar TeX
13450 code included in the template, and
13453 \begin_layout Enumerate
13454 copy the example bibliography item included in the template and modify it
13455 as necessary to enter new bibliography items.
13458 \begin_layout Section
13462 \begin_layout Standard
13468 \begin_layout Subsection
13472 \begin_layout Standard
13473 The \SpecialChar LyX
13476 article (koma-script)
13480 report (koma-script)
13498 correspond to the \SpecialChar LaTeX
13516 \begin_inset space ~
13519 of the Koma-Script family.
13520 They are replacements for the standard document classes
13536 , resp., and fit better to European typography conventions in a number of
13540 \begin_layout Itemize
13541 Standard character size is 11pt in
13543 article (koma-script)
13547 report (koma-script)
13555 letter (koma-script)
13560 \begin_layout Itemize
13561 Headings, labels of the description environment, and a number of elements
13564 letter (koma-script)
13566 document class are set in a bold sans serif font.
13570 \begin_layout Plain Layout
13571 There is a big difference between the bold sans serif old cm fonts and new
13572 ec fonts, especially in the appearance of headings.
13573 In comparison, the ec bold sans serif fonts look a bit thin.
13574 Here the \SpecialChar LaTeX
13583 helps to produce the
13584 \begin_inset Quotes eld
13588 \begin_inset Quotes erd
13591 appearance when using the ec fonts.
13596 The numbering of chapter headings is made in the same way as the numbering
13597 of section headings, that is without the extra line
13598 \begin_inset Quotes eld
13601 Chapter\SpecialChar ldots
13603 \begin_inset Quotes erd
13607 In addition, the appearance of the headings can be modified by using a
13608 number of options (in \SpecialChar LyX
13609 to be entered in the field
13612 \begin_inset space ~
13619 Layout\SpecialChar menuseparator
13626 \begin_layout Itemize
13627 The main means in the Koma-Script document classes to design the type area
13636 (in \SpecialChar LyX
13637 to be entered in the extra class options field in the dialog
13639 Document\SpecialChar menuseparator
13643 They make a clearer modification of page margins possible as do the options
13646 Document\SpecialChar menuseparator
13653 \begin_layout Itemize
13654 The \SpecialChar LaTeX
13655 document classes of the Koma-Script family define a number of additional
13657 Those part of it which makes sense in \SpecialChar LyX
13658 is implemented in corresponding
13662 \begin_layout Standard
13663 Detailed descriptions of the \SpecialChar LaTeX
13664 document classes of the Koma-Script family
13665 can be found in the Koma-Script documentation
13676 \begin_layout Subsection
13677 article (koma-script), report (koma-script), and book (koma-script)
13680 \begin_layout Standard
13681 The document classes
13683 article (koma-script)
13687 report (koma-script)
13697 are implemented in the layout files
13710 They contain all the paragraph types of the corresponding standard document
13723 , resp., partly modified, with the exception of the \SpecialChar LyX
13728 -type, which is replaced by the new
13732 -type having the same functionality.
13737 -Type there is a number of new paragraph types added.
13744 letter (koma-script)
13749 \begin_layout Itemize
13758 : are equivalents to
13766 , resp., additionally inserting an entry in the table of contents.
13775 are not contained in
13777 article (koma-script)
13782 \begin_layout Itemize
13791 : behave exactly as
13799 , resp., additionally clearing running heads.
13804 is not contained in
13806 article (koma-script)
13812 \begin_layout Plain Layout
13825 report (koma-script)
13827 , but since this is identical to
13831 , is has not been implemented in \SpecialChar LyX
13840 \begin_layout Itemize
13845 : generates a heading directly above the following paragraph in the standard
13846 character size without affecting the structure of the document.
13849 \begin_layout Itemize
13858 are special captions which respect the different space settings needed
13859 for captions placed above or below an element (if you follow strict typographic
13860 rules, you might want to place table captions always above the table).
13861 You can also use the class option
13865 , which will switch
13878 You need at least Koma-Script version 2.8q to use this.
13881 \begin_layout Itemize
13886 : can be used to set a bonmot, e.
13887 \begin_inset space \thinspace{}
13891 \begin_inset space \space{}
13894 at the beginning of a chapter.
13895 If you use the optional argument (
13897 Insert\SpecialChar menuseparator
13899 \begin_inset space ~
13904 ), you can insert the dictum's author there.
13905 Dictum and author are separated by a line.
13906 You need at least Koma-Script version 2.8q to use this.
13911 is not contained in
13913 article (koma-script)
13918 \begin_layout Standard
13919 The following types, together with the standard types
13931 , form the title area of the document.
13932 They must be entered ahead of the first
13933 \begin_inset Quotes eld
13937 \begin_inset Quotes erd
13944 \begin_layout Plain Layout
13945 The corresponding \SpecialChar LaTeX
13946 commands must appear before the
13957 When such a type is used more than once, the latter usage overwrites the
13958 former one, that means, for every type only the latest usage is valid.
13959 The order of the different types however has, like
13971 , no effect on the appearance of the produced document.
13974 \begin_layout Itemize
13979 : produces a centered paragraph above the ordinary title (
13991 ) for the subject of the document.
13994 \begin_layout Itemize
13999 : produces a centered paragraph below the ordinary title (
14011 ) for the publishers' name.
14014 \begin_layout Itemize
14021 report (koma-script)
14027 produces a centered paragraph on its own page behind the title page, or
14030 article (koma-script)
14032 produces a centered paragraph below the ordinary title (
14048 ) for a dedication.
14051 \begin_layout Itemize
14056 : produces a left aligned paragraph above the ordinary title (
14072 ) for a document`s head.
14075 \begin_layout Itemize
14080 : produces in a double-sided print in
14082 report (koma-script)
14088 a left-aligned paragraph at the top of the title page`s back or has no
14089 effect in a single-sided print or in
14091 article (koma-script)
14096 \begin_layout Itemize
14101 : produces in a double-sided print in
14103 report (koma-script)
14109 a left-aligned paragraph at the bottom of the title page`s back or has
14110 no effect in a single-sided print or in
14112 article (koma-script)
14117 \begin_layout Itemize
14122 : produces a special
14123 \begin_inset Quotes eld
14127 \begin_inset Quotes erd
14130 page ahead of the actual document containing a paragraph without special
14134 \begin_layout Standard
14135 The layout files for the document classes
14137 article (koma-script)
14141 report (koma-script)
14147 do include the file
14152 This is thought of as a place to define your own types.
14157 in your personal layout directory and edit the file!
14160 \begin_layout Subsection
14161 letter (koma-script)
14164 \begin_layout Standard
14168 letter (koma-script)
14170 is implemented in the layout file
14175 It contains all the paragraph types of the corresponding standard document
14180 , partly modified, with the exception of the \SpecialChar LyX
14194 type, which is replaced by the new
14199 In addition, it contains, in contrast to the standard document class, the
14218 Furthermore, there are a number of new letter specific types.
14221 \begin_layout Standard
14222 The appearance of the letter produced by this document class can be controlled
14223 by a number of \SpecialChar LaTeX
14224 commands, which you can put in the \SpecialChar LaTeX
14229 \begin_layout Plain Layout
14230 For example, the standard appearance of the letter`s heading, consisting
14231 of name and address, is quite self-willed.
14233 \begin_inset Quotes eld
14237 \begin_inset Quotes erd
14240 heading is produced by the following \SpecialChar LaTeX
14241 commands in the preamble:
14244 \begin_layout LyX-Code
14254 \begin_layout LyX-Code
14270 \begin_layout LyX-Code
14280 \begin_layout LyX-Code
14300 A detailed German description of such \SpecialChar LaTeX
14301 commands can be found in the Koma-Script
14307 With it, the letter's author can produce his personal letter layout.
14310 \begin_layout Standard
14319 define the beginning of the letter and must be used in every letter.
14320 To emphasize them in the \SpecialChar LyX
14321 document class, they are marked with the letter
14331 \begin_inset space ~
14334 in the left margin.
14335 It is possible to write any number of letters in one file.
14340 type produces a new letter using the same addressee and a
14344 type produces a new addressee.
14361 are ordinary paragraph types and can also be used several times in one
14362 and the same letter.
14365 \begin_layout Itemize
14370 : produces a paragraph for the addressee and implicitly defines the beginning
14374 \begin_layout Itemize
14379 : produces a paragraph for the form of address and implicitly produces a
14383 \begin_layout Itemize
14388 : produces a paragraph for a close.
14391 \begin_layout Itemize
14396 : produces a paragraph for a postscript.
14399 \begin_layout Itemize
14404 : produces a paragraph for a distribution list.
14407 \begin_layout Itemize
14412 : produces a paragraph for enclosures.
14415 \begin_layout Standard
14456 are input types provided with a label to enter information, which will
14457 be processed by the document class.
14461 \begin_layout Plain Layout
14462 It could be seen as a matter of inconsequence, that the types
14470 described above are not such input types as well.
14471 Because of the special meaning of those types, however, I have implemented
14472 them as ordinary paragraph types with a one letter mark in the left margin.
14473 Moreover, it would affect my feeling of symmetry, if the
14481 type had such a serious different appearance.
14486 The types must be used ahead of the corresponding
14493 \begin_layout Standard
14494 An implementation of these types in a WYSIWYG fashion does not seem to make
14495 sense, because the real appearance of the produced letter does not only
14496 depend on the usage of the particular type, but also on other factors.
14497 For example, a signature entered in the
14501 type will in the standard behavior appear in the produced letter only,
14502 when in the same letter also a
14507 The entered value of the
14511 type will in the standard behavior not appear in the produced letter at
14513 The possibility to design the letter`s heading freely is already indicated
14514 in a footnote above.
14517 \begin_layout Standard
14518 The input types can also be used as empty paragraphs.
14519 This makes sense e.
14520 \begin_inset space \thinspace{}
14524 \begin_inset space \space{}
14536 type is not used at all, in the standard behavior the value of the
14540 type is used as signature, whereas if an empty
14544 type is used, no signature value is defined.
14547 \begin_layout Standard
14548 By using the input types it is possible to write a letter template, containing
14549 filled input types with your personal dates (name, address, etc.) and empty
14550 input types for other dates you want to enter.
14553 \begin_layout Itemize
14558 : sender's name, in the standard behavior appears as a centered paragraph
14559 in small caps in the letter`s heading.
14562 \begin_layout Itemize
14567 : sender's signature, in the standard behavior appears below the
14576 type is used, the value of the
14580 type appears instead.
14583 \begin_layout Itemize
14588 : sender's address, in the standard behavior appears in a centered paragraph
14589 in the letter`s heading below the sender's name.
14592 \begin_layout Itemize
14597 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
14608 \begin_layout Itemize
14613 : place of the letter`s making.
14616 \begin_layout Itemize
14621 : date of the letter`s making.
14630 , in the standard behavior, produce the place and the date in a right-aligned
14631 line below the addressee's field.
14636 type is used, neither place nor date appear, independent of the value of
14646 type is used, the date of the letter `s production is used.
14649 \begin_layout Itemize
14654 : sender`s back address, in the standard behavior appears above the addressee's
14655 field in a small sans serif font.
14658 \begin_layout Itemize
14663 : special mail information, in the standard behavior appears underlined
14664 above the addressee's field below the back address.
14667 \begin_layout Itemize
14672 : additional information, in the standard behavior appears on right side
14673 below the addressee`s field.
14676 \begin_layout Itemize
14681 : the letter's title, in the standard behavior appears in a big, bold, sans
14682 serif font above the subject.
14685 \begin_layout Itemize
14690 : the letter's subject, in the standard behavior appears in a bold font
14698 \begin_layout Standard
14719 produce a business letter like line above the
14723 line containing the fields
14724 \begin_inset Quotes eld
14728 \begin_inset Quotes erd
14732 \begin_inset Quotes eld
14736 \begin_inset Quotes erd
14740 \begin_inset Quotes eld
14744 \begin_inset Quotes erd
14748 \begin_inset Quotes eld
14752 \begin_inset Quotes erd
14756 \begin_inset Quotes eld
14760 \begin_inset Quotes erd
14764 \begin_inset Quotes eld
14768 \begin_inset Quotes erd
14772 For the date field, the value of the
14778 \begin_inset Quotes eld
14781 business letter types
14782 \begin_inset Quotes erd
14785 is used, the value of the
14789 type however does not appear, but only the \SpecialChar LaTeX
14797 The ordinary output of place and date in a right-aligned line below the
14798 addressee`s field is suppressed.
14799 The types are implemented as input types provided with a label and must
14800 be used ahead of the corresponding
14807 \begin_layout Itemize
14815 \begin_layout Itemize
14823 \begin_layout Itemize
14831 \begin_layout Itemize
14839 \begin_layout Itemize
14847 \begin_layout Subsection
14848 The new letter class: letter (koma-script v.2)
14851 \begin_layout Standard
14857 \begin_layout Standard
14858 \begin_inset VSpace medskip
14864 \begin_layout Standard
14866 Koma-Script version 2.8 has introduced a new letter class
14870 which supersedes the now unsupported
14875 It has — on the \SpecialChar LaTeX
14876 side — a completely new interface and is not compatible
14877 with the old class.
14878 Therefore, \SpecialChar LyX
14879 supports both, though it is recommended you use the new class.
14882 \begin_layout Standard
14883 This class covers the same functionality as
14885 letter (koma-script),
14888 The basic items are
14892 (receiver's address, same as
14896 in the old layout),
14909 will start a new letter (i.
14910 \begin_inset space \thinspace{}
14914 \begin_inset space \space{}
14917 you can write several letters per document).
14918 New elements are sender's
14934 and the possibility to use a
14940 Insert\SpecialChar menuseparator
14946 \begin_layout Standard
14947 The biggest improvement is, though, that the letter's layout is configurable
14948 to meet almost any needs.
14949 This can be done via the preamble or with a special style file (Letter
14950 Class Option, extension
14954 ), that will be read in as a class option.
14958 \begin_layout Plain Layout
14959 The KOMA package comes with some default
14964 There is, for instance, a
14968 file that follows german typesetting rules, or a
14972 that provides the default layout of the old
14977 The latter can be loaded with the class option
14983 Layout\SpecialChar menuseparator
14984 Document\SpecialChar menuseparator
14996 template that is included in \SpecialChar LyX
14998 A detailed description is to be found in the Koma-Script documentation
15006 \begin_layout Subsection
15010 \begin_layout Standard
15011 Visualizing the Koma-Script document classes in \SpecialChar LyX
15012 , the \SpecialChar LyX
15013 internals cause some
15017 \begin_layout Itemize
15018 The chapter number of a
15022 type appears on a line of its own above the chapter heading instead of
15023 appearing in the same line ahead of it.
15024 The cause for that is the \SpecialChar LyX
15025 internal behavior for the labeltype
15029 in the layout file.
15032 \begin_layout Itemize
15033 The headings of the types
15041 are only put in the
15042 \begin_inset Quotes eld
15046 \begin_inset Quotes erd
15050 table of contents, but not in the \SpecialChar LyX
15051 table of contents (
15053 Document\SpecialChar menuseparator
15055 \begin_inset space ~
15059 \begin_inset space ~
15067 \begin_layout Itemize
15068 The paragraphs in a
15072 document class appear in a skip separation mode, not indented.
15073 This is the standard behavior, no special \SpecialChar LaTeX
15074 commands are needed for that.
15077 Document\SpecialChar menuseparator
15080 dialog the corresponding radio button indicates
15089 value always has the effect that extra \SpecialChar LaTeX
15090 commands are inserted in the document
15091 to produce the gap, which is not what is wanted in this case.
15094 \begin_layout Section
15098 \begin_layout Standard
15104 \begin_layout Subsection
15108 \begin_layout Standard
15109 Memoir is a very powerful and constantly evolving class.
15110 It has been designed with regard to fictional and non-fictional literature.
15111 Its aim is to let the user have maximum control over the typesetting of
15113 Memoir is based on the standard book class, but it can also emulate the
15114 article class (see below).
15117 \begin_layout Standard
15118 Peter Wilson, the developer of Memoir, is known as the author of lots of
15119 useful packages in the \SpecialChar LaTeX
15121 Most of them have been merged with Memoir.
15122 Therefore, it is much easier to layout the table of contents, appendices,
15123 chapter designs and such.
15125 , though, does not support all of these goodies natively.
15126 Some of them might be added to forthcoming releases
15130 \begin_layout Plain Layout
15131 You are invited to send suggestions to
15132 \begin_inset Flex URL
15135 \begin_layout Plain Layout
15137 lyx-devel@lists.lyx.org
15147 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
15149 Of course you can still use all features with the help of some native \SpecialChar LaTeX
15151 commands (\SpecialChar TeX
15156 \begin_layout Plain Layout
15161 \begin_layout Plain Layout
15171 \begin_inset space ~
15175 \begin_inset CommandInset ref
15177 reference "sec:Inserting-TeX-Code"
15187 In this section, we can only list those features that are natively supported
15188 by \SpecialChar LyX
15190 For detailed descriptions (and for the rest of features) we recommend you
15191 have a look at the detailed manual of the Memoir class
15195 \begin_layout Plain Layout
15200 \begin_layout Plain Layout
15210 \begin_inset Flex URL
15213 \begin_layout Plain Layout
15215 CTAN:/macros/latex/memoir/memman.pdf
15225 , which is not only a user guide for the class, but also both a comprehensive
15226 description on good typesetting and a superb example for good typesetting
15230 \begin_layout Subsection
15231 Basic features and restrictions
15234 \begin_layout Standard
15235 Memoir supports basically all features of the standard book classes.
15236 There are, however, some differences, as follows:
15239 \begin_layout Description
15241 \begin_inset space ~
15244 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
15247 \begin_layout Description
15249 \begin_inset space ~
15252 style: The fancy page style is not supported, due to a command clash between
15253 Memoir and the fancyhdr package (they both define a command with the same
15254 name, which confuses \SpecialChar LaTeX
15256 Instead, Memoir comes with a number of its own page styles (see
15258 Layout\SpecialChar menuseparator
15259 Document\SpecialChar menuseparator
15261 \begin_inset space ~
15267 If you want to use these for the chapter pages, you have to use the command
15274 in the main text or in preamble (e.
15275 \begin_inset space \thinspace{}
15279 \begin_inset space \space{}
15286 chapterstyle{companion}
15291 \begin_layout Description
15292 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
15293 optional argument in the standard classes.
15294 With this, you can specify an alternative version of the title for the
15295 table of contents and the headers (for instance, if the title is too long).
15296 In \SpecialChar LyX
15297 , you can do this via
15299 Insert\SpecialChar menuseparator
15301 \begin_inset space ~
15306 at the beginning of a chapter/section.
15307 Memoir features a second optional argument and thus separates the table
15308 of contents from the header.
15309 You can define three variants of a title with this: one for the main text,
15310 one for the table of contents, and one for the headers.
15311 Simply insert two optional arguments if you need this feature, the first
15312 one containing the short title for the Table of Contents, the second one
15313 containing an alternative short title for the headers.
15316 \begin_layout Description
15317 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
15318 of contents, the list of figures and the list of table start a new page
15320 Memoir does not follow this route.
15321 You have to insert a page break yourself, if you want to have one.
15324 \begin_layout Description
15325 Titlepage: For some unknown reason, Memoir uses pagination on the title
15326 page (in the standard classes, title pages are
15327 \begin_inset Quotes eld
15331 \begin_inset Quotes erd
15335 If you want an empty title page, type
15339 aliaspagestyle{title}{empty}
15344 \begin_layout Description
15345 Article: With the class option
15351 Layout\SpecialChar menuseparator
15352 Document\SpecialChar menuseparator
15354 \begin_inset space ~
15359 ), you can emulate article style.
15360 That is, counters (footnotes, figures, tables etc.) will not be reset on
15361 new chapters, chapters don't start a new page (but are—in contrary to
15362 \begin_inset Quotes eld
15366 \begin_inset Quotes erd
15369 article classes—still allowed), parts, though, use their own page, as in
15373 \begin_layout Description
15374 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
15375 font commands, which have been used in the old \SpecialChar LaTeX
15377 \begin_inset space \thinspace{}
15381 \begin_inset space \space{}
15397 It produces an error and stops \SpecialChar LaTeX
15398 whenever such a command appears.
15403 reallows the commands and spits out warnings instead (which does at least
15404 not stop \SpecialChar LaTeX
15406 Since a lot of packages and particularly Bib\SpecialChar TeX
15407 style files are still using
15408 those commands, we have decided to use this option by default.
15411 \begin_layout Subsection
15415 \begin_layout Standard
15416 We will only describe the features supported by \SpecialChar LyX
15417 (which is not much currently).
15418 Please consult the Memoir manual
15422 \begin_layout Plain Layout
15427 \begin_layout Plain Layout
15437 \begin_inset Flex URL
15440 \begin_layout Plain Layout
15442 CTAN:/macros/latex/memoir/memman.pdf
15455 \begin_layout Description
15456 Abstract: You may wonder why an abstract is an extra feature.
15457 Well, it is in book class.
15458 Usually books don't have abstracts.
15459 Memoir, however, has.
15460 You can use it wherever and how often you like.
15463 \begin_layout Description
15464 Chapterprecis: You may know this older typesetting style: The contents of
15465 a chapter are summarized below the title and also in the table of contents
15467 \begin_inset space \thinspace{}
15471 \begin_inset space \space{}
15476 Our hero arrives in Troia; he loses some friends; he finds others
15479 Chapterprecis does exactly this.
15480 It is therefore only sensible below a chapter.
15483 \begin_layout Description
15484 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
15485 The epigraph environment provides an elegant way of typesetting such a
15487 The motto itself (text) and its author (source) are divided by a short
15489 Unfortunately, we have to fool \SpecialChar LyX
15490 a bit here again, since the environment
15491 needs two arguments (text and source).
15492 In this case, we have to use curly brackets (in \SpecialChar TeX
15493 mode) between the two
15504 <author of the slogan>.
15507 \begin_layout Description
15508 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
15509 complex figurative poems).
15511 can only support a few of them.
15512 One is poemtitle, which is a centered title for poems, which will also
15513 be added to the table of contents (verse is the standard environment for
15515 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
15517 because they have to be nested inside regular verse environments, which
15518 is not possible with \SpecialChar LyX
15522 \begin_layout Description
15523 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
15526 \begin_layout Section
15527 Article (mwart), book (mwbk) and report (mwrep)
15528 \begin_inset Argument status
15531 \begin_layout Plain Layout
15544 \begin_layout Standard
15550 \begin_layout Standard
15551 The \SpecialChar LyX
15568 correspond to the \SpecialChar LaTeX
15582 They are replacements for the standard document classes
15594 , resp., and fit better to Polish typography conventions in a number of points.
15598 \begin_layout Standard
15602 \begin_layout Itemize
15603 Unnumbered titles (with star, e.
15604 \begin_inset space \thinspace{}
15608 \begin_inset space \space{}
15615 ) are added into table of contents,
15618 \begin_layout Itemize
15619 Additional page styles:
15623 \begin_layout Description
15624 uheadings header with separated lines,
15627 \begin_layout Description
15628 myheadings custom header, contents headers via commands:
15643 \begin_layout Description
15644 myuheadings custom header with separated lines,
15647 \begin_layout Description
15648 outer page number is placed on outer side of page
15652 \begin_layout Itemize
15657 \begin_layout Description
15658 rmheadings serif titles — default,
15661 \begin_layout Description
15662 sfheadings sansserif titles,
15665 \begin_layout Description
15666 authortitle on title page first placed is author next title — default,
15669 \begin_layout Description
15670 titleauthor on title page first placed is title next author,
15673 \begin_layout Description
15674 withmarginpar reserve place on page for margins.
15678 \begin_layout Section
15682 \begin_layout Standard
15687 provides an alternative to the standard
15692 It provides similar functionality, but you might prefer this layout with
15693 sans serif sections, headings, and more.
15696 \begin_layout Section
15697 Rev\SpecialChar TeX
15701 \begin_layout Standard
15707 \begin_layout Standard
15708 \begin_inset VSpace bigskip
15714 \begin_layout Standard
15719 \begin_inset space ~
15724 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
15726 \begin_inset Formula $\beta$
15729 release of May, 1999) class.
15732 \begin_layout Standard
15738 textclass, which works with Rev\SpecialChar TeX
15740 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
15742 That means that it doesn't interact very well with \SpecialChar LyX
15743 , which requires \SpecialChar LaTeX2e
15745 it has been kludged to work.
15746 Since Rev\SpecialChar TeX
15747 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
15752 Rev\SpecialChar TeX
15754 \begin_inset space ~
15759 textclass should also be pretty easy to use.
15762 \begin_layout Standard
15763 These documents are supposed to be used in
15767 to the Rev\SpecialChar TeX
15768 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
15770 and assume you'll know what to put in the preamble if necessary.
15773 \begin_layout Subsection
15777 \begin_layout Standard
15778 All you need to do is install Rev\SpecialChar TeX
15779 4, as described in the package's README
15781 The package can be found at The Rev\SpecialChar TeX
15783 \begin_inset Flex URL
15786 \begin_layout Plain Layout
15788 http://publish.aps.org/revtex4/
15794 Install it somewhere that \SpecialChar LaTeX
15796 Test it by trying to \SpecialChar LaTeX
15797 a short Rev\SpecialChar TeX
15798 4 document in some random directory (i.
15799 \begin_inset space \thinspace{}
15803 \begin_inset space \space{}
15806 not the directory where you installed the class file.) Then, if you reconfigure
15808 , it will find the class file and let you use the Rev\SpecialChar TeX
15812 \begin_layout Standard
15813 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
15822 \begin_inset space ~
15827 template, found in the templates directory.
15830 \begin_layout Subsection
15834 \begin_layout Standard
15835 Optional arguments to
15842 \begin_inset Quotes eld
15846 \begin_inset Quotes erd
15850 \begin_inset Quotes eld
15854 \begin_inset Quotes erd
15860 \begin_inset space ~
15868 \begin_inset space ~
15874 Remember that in Rev\SpecialChar TeX
15875 , at least one optional argument is required!
15878 \begin_layout Standard
15879 Other preamble matter, like
15886 \begin_inset space ~
15893 \begin_inset space ~
15898 dialog, also as usual.
15901 \begin_layout Subsection
15905 \begin_layout Standard
15906 The layouts basically correspond to the commands in Rev\SpecialChar TeX
15908 For example, the Email layout corresponds to
15915 Note that (at least as of Rev\SpecialChar TeX
15924 layouts are exactly equivalent, so you shouldn't need to use both.
15928 \begin_layout Plain Layout
15929 In case you're curious, both were included so that
15933 would be able to translate both
15953 \begin_layout Subsection
15957 \begin_layout Standard
15958 There are a couple of important unique aspects of Rev\SpecialChar TeX
15959 4 which might cause
15960 bugs that will be even more confusing in \SpecialChar LyX
15964 \begin_layout Standard
15965 In Rev\SpecialChar TeX
15983 The \SpecialChar LyX
15984 equivalent is that there is a separate Thanks layout.
15989 write footnotes in the
15993 layout, or weird things may happen.
15994 See the Rev\SpecialChar TeX
15995 4 documentation for more details.
15998 \begin_layout Standard
16002 \begin_inset space ~
16010 \begin_inset space ~
16019 layouts must be placed
16027 layout and the corresponding
16044 , the \SpecialChar LaTeX
16048 \begin_layout Subsection
16052 \begin_layout Standard
16053 The main problem with this layout is that you can't use the optional arguments
16054 to layouts like Email and Title.
16055 (The problem is not unique to this layout; you can't use optional arguments
16056 to the Section layouts either.) This means that after you export that file
16057 to \SpecialChar LaTeX
16058 (which you'll need to do eventually to send it in to APS), you'll need
16059 to edit the \SpecialChar LaTeX
16060 file with a text editor to add the optional arguments to set,
16062 \begin_inset space \thinspace{}
16066 \begin_inset space \space{}
16069 the running title for the page headers.
16070 Lacking these layouts makes the
16076 (and the equivalent
16082 ) useless, so the corresponding layouts don't exist, and will have to be
16087 \begin_layout Plain Layout
16092 actually, \SpecialChar LyX
16093 1.3.0 supports some forms of optional arguments, but this layout
16094 has not been updated yet to take advantage of it.
16102 \begin_layout Section
16103 Springer Journals (
16110 \begin_layout Standard
16116 \begin_layout Subsection
16120 \begin_layout Standard
16121 These are the layout files for some of the journal formats used by Springer
16122 Verlag and listed on
16123 \begin_inset Flex URL
16126 \begin_layout Plain Layout
16128 http://www.springer.de/author/tex/help-journals.html
16133 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
16135 It is a modular system: the things common to all journals are implemented
16140 , which journal-specific layout files (such as, e.
16141 \begin_inset space \thinspace{}
16145 \begin_inset space \space{}
16152 for Journal of Geodesy) can include.
16155 \begin_layout Standard
16156 This means that implementing support for any other Springer journal on this
16157 list is as simple as writing your own
16165 file following the outline given in
16173 \begin_layout Standard
16174 It is reasonably well tested only for the Journal of Geodesy.
16183 come with the standard \SpecialChar LyX
16185 Install the relevant class file (downloaded from Springer) in a proper
16186 directory, reconfigure \SpecialChar LaTeX
16187 (in the te\SpecialChar TeX
16192 , as root if necessary — doesn't \SpecialChar LyX
16193 take care of this?), reconfigure \SpecialChar LyX
16198 \begin_layout Subsection
16202 \begin_layout Standard
16203 A large number of theorem-like styles —
16215 \begin_layout Standard
16218 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
16219 _Title, Author_Running, Institute,
16220 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
16223 See the Springer class file documentation for details.
16226 \begin_layout Subsection
16230 \begin_layout Itemize
16242 \begin_layout Itemize
16245 Probability Theory and Related Fields
16251 — Jean-Marc Lasgouttes
16254 \begin_layout Standard
16255 Add your own, it isn't so hard!
16258 \begin_layout Subsection
16262 \begin_layout Standard
16263 These files are partly based on the older
16267 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
16269 file from Springer.
16274 layout, are now defunct.
16275 Jean-Marc Lasgouttes helped out big in making me find my way around the
16277 layout file mechanism.
16280 \begin_layout Subsection
16284 \begin_layout Standard
16286 But probably less than in the old hacked-\SpecialChar LaTeX
16294 \begin_layout Standard
16296 \begin_inset space \thinspace{}
16299 g.: does not display the number for theorem-like layouts, just #.
16302 \begin_layout Section
16305 Sli\SpecialChar TeX
16309 \begin_inset CommandInset label
16318 \begin_layout Standard
16326 \begin_layout Subsection
16330 \begin_layout Standard
16331 This section describes how to use \SpecialChar LyX
16332 to make slides for overhead projectors.
16333 There are two document classes that can do this: the default slides class
16336 Foil\SpecialChar TeX
16340 This section documents the former.
16343 \begin_layout Standard
16344 I'm going to say this again, nice and clear, so that there's no misunderstanding
16348 \begin_layout Standard
16349 \begin_inset VSpace bigskip
16355 \begin_layout Standard
16359 This section documents the class
16360 \begin_inset Quotes eld
16368 \begin_inset Quotes erd
16376 \begin_layout Standard
16377 \begin_inset VSpace bigskip
16383 \begin_layout Standard
16384 If you're looking for the documentation for
16385 \begin_inset Quotes eld
16390 slides (Foil\SpecialChar TeX
16394 \begin_inset Quotes erd
16397 , check out section
16398 \begin_inset space ~
16402 \begin_inset CommandInset ref
16404 reference "sec:foiltex"
16414 \begin_inset Quotes eld
16419 slides (Foil\SpecialChar TeX
16423 \begin_inset Quotes erd
16426 ] is actually somewhat better than the default
16434 \begin_layout Plain Layout
16436 or so I've been told repeatedly by its advocates.
16437 Having never used it, I have no idea if this claim is true or not.
16442 which this section documents.
16445 \begin_layout Standard
16446 This class is the \SpecialChar LaTeX2e
16447 improvement of the old
16449 Sli\SpecialChar TeX
16453 Every \SpecialChar LaTeX2e
16454 distribution includes this class [which I'll just refer to as
16455 \begin_inset Quotes eld
16463 \begin_inset Quotes erd
16466 from now on], so you're bound to have it.
16467 As I noted earlier, there are other classes, such as
16471 , which also produce slides for overhead projectors and do a better job
16473 However, there are some things which
16477 can do which the others can't, such as generate overlays.
16478 Read on to learn more!
16481 \begin_layout Subsection
16483 \begin_inset CommandInset label
16485 name "sec:slidesetup"
16492 \begin_layout Standard
16493 Obviously, to use this document class, you need to select
16494 \begin_inset Quotes eld
16502 \begin_inset Quotes erd
16505 from the class list in the
16507 Document\SpecialChar menuseparator
16511 There are some other special things you should know about this class:
16514 \begin_layout Itemize
16515 Don't bother changing the options
16520 They're not supported by the
16527 \begin_layout Itemize
16531 \begin_inset space ~
16536 behaves a bit differently for this class.
16537 The possible choices and what they do are as follows:
16541 \begin_layout Description
16546 The final output contains page numbers in the lower right corner.
16549 \begin_layout Description
16558 , but also prints out any time markers you've put in.
16559 This is the default.
16562 \begin_layout Description
16567 The final output contains no page numbers, time markers, or alignment markers.
16571 \begin_layout Itemize
16576 class has an extra option:
16582 \begin_inset Quotes eld
16590 \begin_inset Quotes erd
16593 in the extra class options.
16597 \begin_layout Standard
16598 Using this options allows you to add time markers to
16604 \begin_inset space ~
16608 \begin_inset CommandInset ref
16610 reference "sec:slideNote"
16618 \begin_layout Standard
16619 You can also use the template file
16620 \begin_inset Quotes eld
16628 \begin_inset Quotes erd
16631 to automatically set up a document to use the
16637 File\SpecialChar menuseparator
16639 \begin_inset space ~
16643 \begin_inset space ~
16648 to open your new document].
16649 The template file also contains some examples of the special paragraph
16650 environments used by this class.
16651 I'll describe those next.
16654 \begin_layout Subsection
16655 Paragraph Environments
16658 \begin_layout Subsubsection
16659 Supported Environments
16662 \begin_layout Standard
16663 The first thing you'll notice when you start up a new
16667 document is the font size and type: it's the equivalent of the size
16668 \begin_inset Quotes eld
16676 \begin_inset Quotes erd
16682 \begin_inset space ~
16688 This is also what's used in the output.
16690 \begin_inset Quotes eld
16694 \begin_inset Quotes erd
16697 to remind you that this is a slide.
16698 Your final slides will use a larger font; ergo, you'll have less space.
16699 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
16702 \begin_layout Standard
16703 The next thing that becomes obvious is the changes to the paragraph environment
16704 pull-down box [at the far-left end of the toolbar].
16705 Most of the paragraph environments you're used to seeing are missing.
16706 There are also five new ones.
16711 class itself only supports certain paragraph environments:
16714 \begin_layout Itemize
16720 \begin_layout Itemize
16726 \begin_layout Itemize
16732 \begin_layout Itemize
16738 \begin_layout Itemize
16744 \begin_layout Itemize
16750 \begin_layout Itemize
16756 \begin_layout Itemize
16762 \begin_layout Itemize
16768 \begin_layout Itemize
16775 \begin_layout Itemize
16781 \begin_layout Standard
16782 All of the other standard environments, including the section-heading environmen
16783 ts, aren't used in the
16790 \begin_layout Standard
16791 On the other hand, you'll notice the following new environments:
16794 \begin_layout Itemize
16800 \begin_layout Itemize
16806 \begin_layout Itemize
16812 \begin_layout Itemize
16818 \begin_layout Itemize
16824 \begin_layout Standard
16825 These five are kind of quirky, due to a
16826 \begin_inset Quotes eld
16830 \begin_inset Quotes erd
16833 in \SpecialChar LyX
16835 You see, \SpecialChar LyX
16836 doesn't permit you to nest any other paragraph environment into
16837 an empty environment.
16838 Now, that's fine and dandy, but it means that you wouldn't be able to start
16839 a slide with anything except plain text.
16840 To deal with this, I've performed a little
16841 \begin_inset Quotes eld
16846 \begin_inset Quotes erd
16852 \begin_layout Subsubsection
16853 Quirks of the New Environments
16854 \begin_inset CommandInset label
16856 name "sec:slideQuirk"
16863 \begin_layout Standard
16864 All five of the new paragraph environments are somewhat quirky due to inherent
16865 limitiations in the current version of \SpecialChar LyX
16867 As I just mentioned, \SpecialChar LyX
16868 forbids environments that begin with another environment.
16869 To get around this, the
16873 environment isn't a paragraph environment as described in the
16881 \begin_layout Standard
16882 You should consider
16895 \begin_inset Quotes eld
16898 pseudo-environments.
16899 \begin_inset Quotes erd
16902 They look like a section heading or a
16903 \begin_inset Quotes eld
16911 \begin_inset Quotes erd
16914 but really begin a [and, if necessary, end the previous] paragraph environment.
16924 \begin_inset Quotes eld
16928 \begin_inset Quotes erd
16931 These two perform some action.
16934 \begin_layout Standard
16935 A common feature of all five environments,
16955 , is a rather long-ish label.
16956 The text following this label — ordinarily the contents of the paragraph
16957 environment — is utterly irrelevant for
16979 completely ignores it.
16980 In fact, you can leave these five environments completely empty.
16984 \begin_layout Standard
16989 to put any text after the rather long-ish label, you might want to.
16990 This could be a short description of the contents of the
16995 In that case, enter your descriptive comment and hit
16999 as you normally would.
17002 \begin_layout Standard
17003 If, on the other hand, you don't want to enter any descriptive text, you'll
17004 hit another \SpecialChar LyX
17007 , like nature, abhors a vacuum, and will not let you start a new paragraph
17008 environment until you put something in the old one.
17012 \begin_layout Itemize
17013 Start entering the text that will
17041 \begin_layout Itemize
17042 Now move to the beginning of that paragraph.
17046 \begin_layout Itemize
17055 \begin_layout Itemize
17056 Finally, change this new, empty paragraph to a
17080 \begin_layout Standard
17081 Some future version of \SpecialChar LyX
17082 will, hopefully, resolve this quirkiness\SpecialChar ldots
17086 \begin_layout Subsection
17087 Making a Presentation with
17100 \begin_layout Subsubsection
17108 \begin_layout Standard
17109 If you're expecting this section to teach you how to actually make a presentatio
17110 n, you'll be sorely disappointed.
17111 Naturally, I'll describe all of the ways the
17115 class can assist you in preparing the materials for a presentation.
17116 Filling in the contents, however, is up to you.
17121 the \SpecialChar LyX
17125 \begin_layout Standard
17130 environment [in the manner described in section
17131 \begin_inset space ~
17135 \begin_inset CommandInset ref
17137 reference "sec:slideQuirk"
17141 ] tells \SpecialChar LyX
17142 to begin a new slide [duh].
17143 The label for this environment/
17144 \begin_inset Quotes erd
17148 \begin_inset Quotes erd
17152 \begin_inset Quotes eld
17156 \begin_inset Quotes erd
17159 in cool blue, followed by the label,
17160 \begin_inset Quotes eld
17164 \begin_inset Quotes erd
17168 Any text or paragraph environments that follow this one go on the new slide.
17172 \begin_layout Standard
17173 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
17175 (this can be specified in the
17180 In fact, you'll want to, once you finish entering the contents of one slide.
17181 If you've entered more text than can physically fit on a slide, the extra
17182 overflows onto a new slide.
17183 I don't recommend doing this, however, since the overflow slide won't have
17184 any page number on it.
17185 Furthermore, it may interfere with any
17189 you've made to accompany the oversized
17196 \begin_layout Standard
17205 environments work the same way as the
17210 They both create an
17211 \begin_inset Quotes eld
17215 \begin_inset Quotes erd
17218 followed by a label [
17219 \begin_inset Quotes eld
17223 \begin_inset Quotes erd
17227 \begin_inset Quotes eld
17231 \begin_inset Quotes erd
17235 The color is a stunning magenta instead of blue, and the
17236 \begin_inset Quotes eld
17240 \begin_inset Quotes erd
17243 will look different, in style and in length.
17244 The label fonts of all three also differ from one another.
17247 \begin_layout Standard
17252 , if the contents of a
17260 exceed the physical size of a slide or sheet of paper, the extra will overflow
17262 Again, you should avoid this.
17263 It defeats the whole purpose of
17274 \begin_layout Subsubsection
17284 \begin_layout Standard
17289 is a slide that sits atop another slide.
17290 Perhaps you wish to discuss a figure on the main
17294 before displaying the text associated with it.
17295 One way to accomplish this is tape a flap of dark paper over the part of
17300 you want to display later.
17301 This method fails, however, if you wish to overlap one graph with another,
17303 You would then have to fumble while speaking to align the two separate,
17308 s to align the two graphs.
17313 environment in both cases makes life much easier.
17316 \begin_layout Standard
17321 receives the page number of its
17322 \begin_inset Quotes eld
17326 \begin_inset Quotes erd
17334 \begin_inset Quotes eld
17342 \begin_inset Quotes erd
17349 \begin_layout Plain Layout
17350 Presumably, mutliple
17355 \begin_inset Quotes eld
17363 \begin_inset Quotes erd
17367 \begin_inset Quotes eld
17375 \begin_inset Quotes erd
17379 \begin_inset Quotes eld
17387 \begin_inset Quotes erd
17391 \begin_inset space ~
17394 appended to the page number of the parent
17404 Clearly, you want the contents of both the
17412 to each fit on a single physical slide! You should probably consider an
17418 \begin_inset Quotes eld
17422 \begin_inset Quotes erd
17430 Indeed, the \SpecialChar LyX
17435 class provides a visual cue for this: the label at the start of an
17439 is shorter than that at the start of a
17444 Lastly, when you generate printable output, you'll find alignment markers
17445 in all four corners of both the
17449 page and its parent
17454 These will assist you in lining up the two physical slides.
17457 \begin_layout Standard
17458 The major problem in overlaying two slides is aligning the contents of the
17459 two transparencies.
17460 How much space should you leave for that graph on the second slide? Worse
17461 still, what if you want a graph and a sentence on second slide, but there
17462 is text on the main transparency that goes in between them? You could try
17463 and insert vertical space of the right size.
17464 The better way is to use
17475 \begin_layout Standard
17476 As their names imply,
17484 are two command-like paragraph environments that make all subsequent text
17485 invisible and visible, respectively.
17487 \begin_inset space ~
17491 \begin_inset CommandInset ref
17493 reference "sec:slideQuirk"
17497 that you don't place anything
17501 these two environments, however.
17506 , it inserts a centered, sky-blue label into the page reading
17507 \begin_inset Quotes eld
17510 <Invisible Text Follows>
17511 \begin_inset Quotes erd
17515 For paragraphs following this label, the parts of the
17523 ; it doesn't matter which] where they would be contain instead blank space.
17527 \begin_layout Standard
17532 , the corresponding centered label is
17533 \begin_inset Quotes eld
17536 <Visible Text Follows>
17537 \begin_inset Quotes erd
17541 Paragraphs following this label behave normally.
17542 Note that the beginning of a new
17554 automatically shuts off an
17559 It's therefore not necessary to use
17570 \begin_layout Standard
17571 By now, it should be obvious how to create overlay transparencies using
17572 the proper combination of
17591 \begin_layout Enumerate
17596 , including everything that will appear on it, whether on the main slide
17604 \begin_layout Enumerate
17605 Before each figure or paragraph that will appear only on the
17614 If necessary, insert a
17618 environment after the
17625 \begin_layout Enumerate
17630 immediately following the
17637 \begin_layout Enumerate
17638 Copy the contents of this
17649 \begin_layout Enumerate
17654 , change all of the
17665 \begin_layout Standard
17667 You've just made an
17674 \begin_layout Standard
17675 There's one problem with the way I've designed the \SpecialChar LyX
17680 class: you can't make text in the middle of a paragraph invisible, nor
17681 make text in the middle of an invisible paragraph visible again.
17682 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
17687 \begin_layout Plain Layout
17688 The commands of interest are:
17691 \begin_layout Itemize
17696 invisible \SpecialChar ldots
17700 \begin_layout Itemize
17705 visible \SpecialChar ldots
17709 \begin_layout Plain Layout
17711 and need to be marked as \SpecialChar TeX
17714 \begin_inset Quotes eld
17718 \begin_inset Quotes erd
17721 you wish to change goes in between the brackets [and after the
17734 If you don't know how to mark text as \SpecialChar TeX
17735 , see the appropriate section of
17748 \begin_layout Subsubsection
17758 \begin_inset CommandInset label
17760 name "sec:slideNote"
17767 \begin_layout Standard
17776 is associated with a
17777 \begin_inset Quotes eld
17781 \begin_inset Quotes erd
17789 Here, too, the \SpecialChar LyX
17794 class provides visual cues.
17799 is shorter than that of a
17803 [yet longer than that of an
17807 ] and, like the label of an
17811 is shockingly magenta.
17812 Additionally, the printed
17816 has the page number of its
17817 \begin_inset Quotes eld
17821 \begin_inset Quotes erd
17829 \begin_inset Quotes eld
17837 \begin_inset Quotes erd
17841 \begin_inset Quotes eld
17849 \begin_inset Quotes erd
17853 \begin_inset Quotes eld
17861 \begin_inset Quotes erd
17865 You can have multiple
17869 s associated with a single
17881 , you'll probably want to break up long
17885 s so that they fit on a single sheet of paper.
17888 \begin_layout Standard
17893 is obvious: it contains anything additional you might want to say about
17899 It could also be used as a sheet of reminders for a particular
17904 In the case of the latter, you might want to make use of time markers.
17905 Currently, the \SpecialChar LyX
17911 \begin_inset Quotes eld
17915 \begin_inset Quotes erd
17918 support for time markers, a
17920 Sli\SpecialChar TeX
17924 So, you'll have to resort to using the \SpecialChar LaTeX
17928 \begin_layout Standard
17929 To use time markers, you'll need to specify the extra class option
17930 \begin_inset Quotes eld
17938 \begin_inset Quotes erd
17942 \begin_inset space ~
17946 \begin_inset CommandInset ref
17948 reference "sec:slidesetup"
17953 This option turns on timing marks, which will appear in the lower-left-hand
17959 To set what appears in the time marker, you use the \SpecialChar LaTeX
17961 \begin_inset Quotes eld
17971 \begin_inset Quotes erd
17975 \begin_inset Quotes eld
17985 \begin_inset Quotes erd
17989 The arguments of both commands are time measured in seconds.
17991 \begin_inset Quotes eld
18001 \begin_inset Quotes erd
18004 sets the time marker to a given time.
18006 \begin_inset Quotes eld
18016 \begin_inset Quotes erd
18019 increments the time marker by the specified amount.
18020 Using time markers and
18024 s in this fashion, you can remind yourself how much time to spend on a particula
18032 \begin_layout Standard
18033 There's one last feature to describe.
18034 Clearly, you'd like to print out all of your
18042 s on transparencies while printing all of your
18059 with which it is associated.
18060 What's a person to do?
18063 \begin_layout Standard
18064 Luckily, there are two \SpecialChar LaTeX
18065 commands that allow you to select what to print
18067 Both must be placed into the preamble of your document.
18069 \begin_inset Quotes eld
18081 \begin_inset Quotes erd
18084 will cause the output to contain only the
18093 Correspondingly, the command
18094 \begin_inset Quotes eld
18106 \begin_inset Quotes erd
18109 prevents the output of anything but
18114 I'd advise placing both commands in the preamble and initially comment
18116 You can then preview your entire presentation as you write.
18117 When you're done writing, you can then uncomment one of the two to select
18118 what you want to print.
18119 I like to uncomment
18120 \begin_inset Quotes eld
18132 \begin_inset Quotes erd
18135 , print to a file with
18136 \begin_inset Quotes eld
18144 \begin_inset Quotes erd
18147 in its name, comment it back out, then uncomment
18148 \begin_inset Quotes eld
18160 \begin_inset Quotes erd
18164 \begin_inset Quotes eld
18172 \begin_inset Quotes erd
18176 I can then send either file to a printer, loading transparencies or plain
18177 paper as appropriate.
18180 \begin_layout Standard
18181 You can also provide other arguments to the
18182 \begin_inset Quotes eld
18192 \begin_inset Quotes erd
18196 \begin_inset Quotes eld
18206 \begin_inset Quotes erd
18210 See a good \SpecialChar LaTeX
18214 \begin_layout Subsection
18219 Class Template File
18222 \begin_layout Standard
18223 I have also provided a template file,
18224 \begin_inset Quotes eld
18232 \begin_inset Quotes erd
18240 To use it, begin your new presentation with
18242 File\SpecialChar menuseparator
18244 \begin_inset space ~
18248 \begin_inset space ~
18254 Your new \SpecialChar LyX
18255 presentation file will contain an example
18276 additionally contain an example of the use of
18285 Lastly, the preamble will contain:
18288 \begin_layout LyX-Code
18289 % Uncomment to print out only slides and overlays
18292 \begin_layout LyX-Code
18296 \begin_layout LyX-Code
18302 \begin_inset Newline newline
18308 \begin_layout LyX-Code
18309 % Uncomment to print out only notes
18312 \begin_layout LyX-Code
18316 \begin_layout LyX-Code
18324 \begin_layout Standard
18325 One final thing: I created this class to support the \SpecialChar LaTeX2e
18327 \begin_inset Quotes eld
18332 Sli\SpecialChar TeX
18336 \begin_inset Quotes erd
18339 class, one of the built-in \SpecialChar LaTeX2e
18341 Neither I nor the rest of the \SpecialChar LyX
18342 Team endorse or oppose the use of this built-in
18344 It's here if you want it or need it.
18345 There exist other \SpecialChar LaTeX2e
18346 classes for creating presentations, such as the
18351 \begin_inset space ~
18355 \begin_inset CommandInset ref
18357 reference "sec:foiltex"
18362 \begin_inset Quotes eld
18370 \begin_inset Quotes erd
18373 package [present on some \SpecialChar TeX
18375 The latter is not yet supported under \SpecialChar LyX
18380 \begin_layout Plain Layout
18381 Perhaps you can take on the task\SpecialChar ldots
18387 I know nothing about these other classes.
18388 Try them out to see what sort of alternative they provide.
18391 \begin_layout Chapter
18393 Features needing Extra Software
18396 \begin_layout Section
18397 Checking \SpecialChar TeX
18401 \begin_layout Standard
18407 \begin_layout Subsection
18411 \begin_layout Standard
18420 \begin_layout Plain Layout
18425 is not yet available when you are using the \SpecialChar LaTeX
18426 distribution MiK\SpecialChar TeX
18432 , you'll find in the
18439 \begin_inset space ~
18450 \begin_inset Newline newline
18454 \begin_inset CommandInset href
18456 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
18463 \begin_layout Standard
18466 Chk\SpecialChar TeX
18469 package is a program that was written by
18470 \begin_inset Flex Noun
18473 \begin_layout Plain Layout
18475 \begin_inset space ~
18483 in frustration because some constructs in \SpecialChar LaTeX
18484 are sometimes non-intuitive,
18485 and easy to forget.
18486 The program runs over your \SpecialChar LaTeX
18487 file, checks the integrity of the file, and
18488 flags some common errors.
18489 In other technical words, it is
18493 for \SpecialChar LaTeX
18497 \begin_layout Standard
18498 Well, what is a syntax checker doing in \SpecialChar LyX
18499 which is supposed to produce correct
18501 anyways? The answer is simple: Just as
18505 not only checks the
18509 of C programs, but also does
18513 checks for type-errors,
18515 Chk\SpecialChar TeX
18518 catches some common
18522 errors, in addition to the syntactical ones.
18525 Chk\SpecialChar TeX
18528 is capable of detecting several common errors, such as
18531 \begin_layout Itemize
18532 Ellipsis detection:
18533 \begin_inset Newline newline
18536 Use \SpecialChar ldots
18540 \begin_layout Itemize
18541 No space in front of/after parenthesis:
18542 \begin_inset Newline newline
18548 \begin_layout Itemize
18549 Enforcement of normal space after common abbreviations:
18550 \begin_inset Newline newline
18554 \begin_inset space \thinspace{}
18558 \begin_inset space \space{}
18561 is too wide spacing.
18564 \begin_layout Itemize
18565 Enforcement of end-of-sentence space when the last sentence ends with a
18567 \begin_inset Newline newline
18571 And this is wrong spacing.
18574 \begin_layout Itemize
18575 Space in front of labels and similar commands:
18576 \begin_inset Newline newline
18579 The label should stick right up to the text to avoid falling to a wrong
18582 \begin_inset CommandInset label
18592 \begin_layout Plain Layout
18593 This footnote is in danger of falling off to a wrong page
18598 The label is separated too much.
18601 \begin_layout Itemize
18602 Space in front of references, instead of hard spaces:
18603 \begin_inset Newline newline
18606 If you have bad luck, the text will break right between the referenced text
18607 and reference number, and that's a pity.
18609 \begin_inset CommandInset ref
18611 reference "sec:chktex"
18618 \begin_layout Itemize
18620 \begin_inset Quotes eld
18624 \begin_inset Quotes erd
18628 \begin_inset Formula $\times$
18632 \begin_inset Newline newline
18635 2x2 looks cheap compared to
18636 \begin_inset Formula $2\times2$
18642 \begin_layout Standard
18643 and more \SpecialChar ldots
18644 It is an invaluable tool when you are
18645 \begin_inset Quotes eld
18649 \begin_inset Quotes erd
18652 your document before printing, and you should run it right after the obligatory
18653 spelling check, and before you go fine tuning the typesetting.
18656 \begin_layout Subsection
18660 \begin_layout Standard
18661 If you have the program installed, usage is as simple as choosing
18663 Tools\SpecialChar menuseparator
18665 \begin_inset space ~
18671 This will make \SpecialChar LyX
18672 generate a \SpecialChar LaTeX
18673 file of your document, start
18675 Chk\SpecialChar TeX
18678 to check it, and then make \SpecialChar LyX
18680 \begin_inset Quotes eld
18684 \begin_inset Quotes erd
18687 with the warnings from
18689 Chk\SpecialChar TeX
18692 , if there were any.
18693 The warnings will be placed close to the point of the mistake, and you
18694 can quickly find them by using the
18696 Navigate\SpecialChar menuseparator
18699 menu item, or the shortcut key
18708 Open the error boxes by clicking on them with the mouse, or use the shortcut
18717 bindings, or the corresponding
18726 Read the warning and correct the mistake, if it is a mistake.
18727 If you have trouble understanding what the warning is about, you can safely
18729 Remember that there is a hidden layer between the document on screen and
18730 the technical details in invoking
18732 Chk\SpecialChar TeX
18735 , and this gap can make some warnings seem arcane or just plain silly.
18738 \begin_layout Standard
18739 This document is an excellent testing bed for the feature, and it should
18740 provide quite a few warnings for you to fiddle with.
18741 Since computers are only so smart, expect most of the warnings to be false
18745 \begin_layout Subsection
18746 How to fine tune it
18749 \begin_layout Standard
18750 Sometimes, you'll find that
18752 Chk\SpecialChar TeX
18755 makes more noise than suits your mood.
18756 Then you can choose not to use it, wait until your mood changes, or try
18759 Chk\SpecialChar TeX
18762 to get better along with you.
18765 \begin_layout Standard
18768 Chk\SpecialChar TeX
18775 very configurable and extensible, you should not expect to solve all problems
18778 Chk\SpecialChar TeX
18781 in \SpecialChar LyX
18783 Since \SpecialChar LyX
18784 has to generate a somewhat special \SpecialChar LaTeX
18785 file to be able to match the
18786 line numbers from the
18788 Chk\SpecialChar TeX
18795 \begin_layout Plain Layout
18796 You can inspect the specific output from
18802 Document\SpecialChar menuseparator
18805 \begin_inset space ~
18819 to the internal document structure, some of the warnings will not appear
18821 There are two things you can do about this:
18824 \begin_layout Itemize
18827 Chk\SpecialChar TeX
18830 invocation command line in
18831 \begin_inset Flex Noun
18834 \begin_layout Plain Layout
18835 Tools\SpecialChar menuseparator
18836 Preferences\SpecialChar menuseparator
18837 Output\SpecialChar menuseparator
18838 LaTeX\SpecialChar menuseparator
18846 Chk\SpecialChar TeX
18849 installation configuration file (usually with the file
18854 See below to learn what warnings can be enabled and disabled on the command
18858 \begin_layout Itemize
18859 Export your document as a raw \SpecialChar LaTeX
18862 File\SpecialChar menuseparator
18863 Export\SpecialChar menuseparator
18872 Invoked in this way, it can be a hassle to find the corresponding place
18873 in the document inside \SpecialChar LyX
18874 , but with a little patience, you should be able
18878 \begin_layout Standard
18879 Here follows the warning messages that can be enabled and disabled in
18888 to disable a warning, and
18892 to enable a warning.
18893 The emphasized entries are disabled by default, because the default is
18896 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
18901 \begin_layout Standard
18902 Notice that you should only use the options that enable and disable warnings,
18903 because \SpecialChar LyX
18904 relies on some of the other command line parameters to be set
18905 in a specific way to have a chance to communicate with
18912 \begin_layout Enumerate
18916 Command terminated with space.
18919 \begin_layout Enumerate
18922 Non-breaking space (
18923 \begin_inset Quotes eld
18931 \begin_inset Quotes erd
18934 ) should have been used.
18937 \begin_layout Enumerate
18941 You should enclose the previous parenthesis with
18942 \begin_inset Quotes eld
18950 \begin_inset Quotes erd
18956 \begin_layout Enumerate
18959 Italic correction (
18960 \begin_inset Quotes eld
18970 \begin_inset Quotes erd
18973 ) found in non-italic buffer.
18976 \begin_layout Enumerate
18979 Italic correction (
18980 \begin_inset Quotes eld
18990 \begin_inset Quotes erd
18993 ) found more than once.
18996 \begin_layout Enumerate
19000 No italic correction (
19001 \begin_inset Quotes eld
19011 \begin_inset Quotes erd
19017 \begin_layout Enumerate
19021 \begin_inset Quotes eld
19029 \begin_inset Quotes erd
19033 \begin_inset Quotes eld
19041 \begin_inset Quotes erd
19047 \begin_layout Enumerate
19050 Wrong length of dash may have been used.
19053 \begin_layout Enumerate
19057 \begin_inset Quotes eld
19065 \begin_inset Quotes erd
19069 \begin_inset Quotes eld
19077 \begin_inset Quotes erd
19083 \begin_layout Enumerate
19087 \begin_inset Quotes eld
19095 \begin_inset Quotes erd
19101 \begin_layout Enumerate
19105 \begin_inset Quotes eld
19113 \begin_inset Quotes erd
19116 to achieve an ellipsis.
19119 \begin_layout Enumerate
19122 Inter-word spacing (
19123 \begin_inset Quotes eld
19133 \begin_inset Quotes eld
19136 ) should perhaps be used.
19139 \begin_layout Enumerate
19142 Inter-sentence spacing (
19143 \begin_inset Quotes eld
19153 \begin_inset Quotes erd
19156 ) should perhaps be used.
19159 \begin_layout Enumerate
19162 Could not find argument for command.
19165 \begin_layout Enumerate
19169 \begin_inset Quotes eld
19177 \begin_inset Quotes erd
19183 \begin_layout Enumerate
19186 Math mode still on at end of \SpecialChar LaTeX
19190 \begin_layout Enumerate
19194 \begin_inset Quotes eld
19202 \begin_inset Quotes erd
19205 doesn't match the number of
19206 \begin_inset Quotes eld
19214 \begin_inset Quotes erd
19220 \begin_layout Enumerate
19223 You should use either
19226 \begin_inset Quotes eld
19234 \begin_inset Quotes erd
19239 as an alternative to
19240 \begin_inset Quotes eld
19248 \begin_inset Quotes erd
19254 \begin_layout Enumerate
19261 " (ASCII 39) instead of "
19268 \begin_layout Enumerate
19271 User-specified pattern found.
19274 \begin_layout Enumerate
19277 This command might not be intended.
19280 \begin_layout Enumerate
19287 \begin_layout Enumerate
19305 \begin_layout Enumerate
19308 Delete this space to maintain correct page references.
19311 \begin_layout Enumerate
19315 You might wish to put this between a pair of
19316 \begin_inset Quotes eld
19324 \begin_inset Quotes erd
19330 \begin_layout Enumerate
19333 You ought to remove spaces in front of punctuation.
19336 \begin_layout Enumerate
19339 Could not execute \SpecialChar LaTeX
19343 \begin_layout Enumerate
19352 in front of small punctuation.
19355 \begin_layout Enumerate
19363 may look prettier here.
19366 \begin_layout Enumerate
19370 Multiple spaces detected in output.
19373 \begin_layout Enumerate
19376 This text may be ignored.
19379 \begin_layout Enumerate
19385 \begin_inset Quotes eld
19390 to begin quotation, not
19397 \begin_layout Enumerate
19404 to end quotation, not
19407 \begin_inset Quotes eld
19415 \begin_layout Enumerate
19421 \begin_layout Enumerate
19424 You should perhaps use
19425 \begin_inset Quotes eld
19433 \begin_inset Quotes erd
19439 \begin_layout Enumerate
19442 You should put a space in front of/after parenthesis.
19445 \begin_layout Enumerate
19448 You should avoid spaces in front of/after parenthesis.
19451 \begin_layout Enumerate
19455 You should not use punctuation in front of/after quotes.
19458 \begin_layout Enumerate
19461 Double space found.
19464 \begin_layout Enumerate
19467 You should put punctuation outside inner/inside display math mode.
19470 \begin_layout Enumerate
19473 You ought to not use primitive \SpecialChar TeX
19474 in \SpecialChar LaTeX
19478 \begin_layout Enumerate
19481 You should remove spaces in front of
19482 \begin_inset Quotes eld
19490 \begin_inset Quotes erd
19496 \begin_layout Enumerate
19499 \begin_inset Quotes eld
19507 \begin_inset Quotes erd
19510 is normally not followed by
19511 \begin_inset Quotes eld
19519 \begin_inset Quotes erd
19525 \begin_layout Standard
19526 In later versions of \SpecialChar LyX
19527 , we hope to provide a more complete interface to this
19528 tool (and it's smaller cousin
19532 ) to exploit the full power of it.
19533 But it's not exactly useless as it is now: go try it on one of your existing
19534 documents of a certain length and be surprised.
19537 \begin_layout Section
19538 Version Control in \SpecialChar LyX
19542 \begin_layout Standard
19545 Lars Gullik Bjønnes
19552 \begin_layout Subsection
19556 \begin_layout Standard
19558 supports some of the most basic RCS/CVS/SVN/GIT commands.
19559 If you need something a bit more sophisticated you will have to do that
19560 manually in a terminal.
19563 \begin_layout Standard
19564 Also note that CVS support is not as good as subversion support so we advise
19566 A good place to start learning Subversion is SVN Book
19570 \begin_layout Plain Layout
19571 \begin_inset CommandInset href
19573 target "http://svnbook.red-bean.com/"
19583 In the case of RCS you should read
19584 \begin_inset Quotes eld
19588 \begin_inset Quotes erd
19591 (a man file, read it with
19596 This file describes all the basic features of RCS.
19597 You should especially notice the comment about a RCS directory, and the
19598 notion of a master RCS file (the file ending in
19605 \begin_layout Standard
19606 Before you begin to use the version control features in \SpecialChar LyX
19608 familiar with RCS/CVS/SVN/GIT usage.
19609 The implementation in \SpecialChar LyX
19610 assumes a recent version of the GNU RCS or CVS/SVN
19611 package — no guarantees are made for older versions.
19612 Most of the log messages are not currently displayed after operations —
19613 you can check them in the Messages pane if unsure.
19614 Regular users of version control will appreciate VC toolbar, which can
19617 View\SpecialChar menuseparator
19618 Toolbars\SpecialChar menuseparator
19620 \begin_inset space ~
19628 \begin_layout Standard
19629 For introducing your own external commands consult vc-command in the manual
19630 of \SpecialChar LyX
19634 \begin_layout Standard
19635 It is strongly recommended to store documents in uncompressed format if
19636 using version control (uncheck
19638 Document\SpecialChar menuseparator
19641 if it is checked): Uncompressed LyX documents are text files and therefore
19642 for merging two different versions by version control systems.
19643 Compressed LyX documents are binary files, which cannot be merged by version
19647 \begin_layout Subsection
19648 RCS commands in \SpecialChar LyX
19652 \begin_layout Standard
19653 The following sections describe the RCS commands supported by \SpecialChar LyX
19655 You can find them in the
19657 File\SpecialChar menuseparator
19659 \begin_inset space ~
19666 was tested against RCS 5.7/5.8.
19669 \begin_layout Subsubsection
19675 \begin_layout Standard
19676 If your document is not under revision control, this is the only item shown
19678 And if it is under revision control, the
19682 item is not visible.
19686 \begin_layout Standard
19687 This command registers your document with RCS (unless you are under the
19688 directory managed by CVS)\SpecialChar endofsentence
19689 You are asked interactively to supply an initial
19690 description of the document.
19691 The document is now set in Read-Only mode and you have to
19694 \begin_inset space ~
19698 \begin_inset space ~
19702 \begin_inset space ~
19707 , before making any changes to it.
19708 A document under revision control has a
19709 \begin_inset Quotes eld
19712 [RCS:<version> <locker>]
19713 \begin_inset Quotes erd
19716 item tagged to the filename in the minibuffer.
19719 \begin_layout Standard
19720 RCS command that is run:
19722 ci -q -u -i -t-"<initial description>" <file-name>
19725 \begin_layout Standard
19730 to understand the switches.
19734 \begin_layout Subsubsection
19740 \begin_layout Standard
19741 When you are finished editing a file, you check in your changes.
19742 When you do this, you are asked for a description of the changes.
19743 This is stored in the history log.
19744 The version number is bumped, your changes are applied to the master RCS
19745 file, the document is unlocked and set to Read-Only mode.
19748 \begin_layout Standard
19751 ci -q -u -m"<description>" <file-name>
19754 \begin_layout Subsubsection
19760 \begin_layout Standard
19761 By doing this you lock the document so that only you can edit it.
19762 This will also make the document Read-Write only for you.
19763 You will usually continue editing for a while and when you are finished
19764 you check in your changes.
19765 The status line is changed to reflect that you have locked the file.
19768 \begin_layout Standard
19771 co -q -l <file-name>
19774 \begin_layout Subsubsection
19777 Revert To Repository Version
19780 \begin_layout Standard
19781 This will discard all changes made to the document since the last check
19783 You get a warning before changes are discarded.
19786 \begin_layout Standard
19789 co -f -u<version> <file-name>
19792 \begin_layout Subsubsection
19798 \begin_layout Standard
19799 This will create a copy of the current document.
19800 Since RCS does not support copy operations natively, the version history
19801 is not preserved, and the copy is added as a new file.
19802 It requires a clean document without any changes since the last checkin.
19803 You are asked for a file name and a description of the copy operation.
19804 After that the copy is created, both locally and in the repository.
19805 If the parent directories of the copied and original document differ, all
19806 relative paths of included files of the copy are adjusted (like in
19808 File\SpecialChar menuseparator
19813 Finally, the copy is loaded instead of the original document.
19816 \begin_layout Labeling
19817 \labelwidthstring 00.00.0000
19819 \begin_inset space ~
19823 \begin_inset space ~
19827 \begin_inset Newline newline
19831 \begin_inset Flex Code
19834 \begin_layout Plain Layout
19837 \begin_inset Quotes eld
19841 \begin_inset Quotes erd
19850 \begin_inset Flex Code
19853 \begin_layout Plain Layout
19856 \begin_inset Quotes eld
19860 \begin_inset Quotes erd
19869 \begin_inset Newline newline
19873 \begin_inset Flex Code
19876 \begin_layout Plain Layout
19880 \begin_inset Quotes eld
19884 \begin_inset Quotes erd
19895 \begin_layout Subsubsection
19901 \begin_layout Standard
19902 This makes as if the last check in never happened.
19903 No changes are made to the document loaded into \SpecialChar LyX
19904 , but the last version
19905 is removed from the master RCS file.
19908 \begin_layout Standard
19911 rcs -o<version> <file-name>
19914 \begin_layout Subsubsection
19920 \begin_layout Standard
19921 This shows the complete history of the RCS document.
19926 is shown in a browser.
19934 \begin_layout Subsubsection
19938 \begin_layout Standard
19940 supports RCS version number, author name, date and time of last commit.
19941 All those are extracted from
19943 rlog -r <file-name>
19947 \begin_inset CommandInset ref
19949 reference "subsec:VCS-Revision-Information"
19956 \begin_layout Subsection
19957 CVS commands in \SpecialChar LyX
19961 \begin_layout Standard
19962 A subset of CVS operations is supported by \SpecialChar LyX
19964 You can find the commands in the
19966 File\SpecialChar menuseparator
19968 \begin_inset space ~
19974 The version control system SVN is more powerful, so please use it instead
19975 of CVS if possible.
19978 \begin_layout Subsubsection
19984 \begin_layout Standard
19985 If you start from scratch with CVS you have to create your repository and
19986 checkout the working copy with external tools.
19987 If you're using a client-server setup you may need to login before doing
19988 the first repository checkout.
19991 \begin_layout Standard
19992 If your documents are under revision control and others are using the same
19993 repository problems arise when different changes to the same document at
19994 the same location happen.
19995 Standard CVS repositories don't operate with a file locking mechanism.
19996 This may be surprising, but conflicts only occur if people disagree on
19997 the proper content of the same part of a document.
19998 So, if co-workers are used to communicate regularly, these conflicts occur
20000 If they don't communicate they have a fundamental problem anyway.
20001 Nevertheless some people like to work with so called
20002 \begin_inset Quotes eld
20006 \begin_inset Quotes erd
20010 If they do so the working copy of all files is readonly when checked out
20011 first and the user starts editing after using a special command to make
20012 the working copy writable.
20013 When the changes are checked in the working copy returns to readonly state.
20014 With \SpecialChar LyX
20015 one has to edit the
20016 \begin_inset Flex Code
20019 \begin_layout Plain Layout
20025 file and add the line
20026 \begin_inset Flex Code
20029 \begin_layout Plain Layout
20035 to work with reserved checkouts.
20036 The benefit is the possibility to see who is using a writable copy of some
20038 It's not guaranteed only one user makes a copy writable.
20041 \begin_layout Standard
20043 tries to guess if you're using reserved or non-reserved checkouts.
20044 If your working copy is readonly or it is writable and an additional copy
20045 of your document exists in the CVS/Base sub-directory a reserved otherwise
20046 a non-reserved checkout is assumed.
20047 When a reserved checkout is detected you have to use
20048 \begin_inset Flex Noun
20051 \begin_layout Plain Layout
20057 to make your working copy writable if it's readonly.
20059 \begin_inset Flex Noun
20062 \begin_layout Plain Layout
20068 operation is possible and that makes your working copy readonly again after
20069 transferring your changes to the repository.
20072 \begin_layout Standard
20073 More information about CVS can be found here
20074 \begin_inset Flex URL
20077 \begin_layout Plain Layout
20079 http://www.nongnu.org/cvs
20085 \begin_inset Flex URL
20088 \begin_layout Plain Layout
20090 http://ximbiot.com/cvs
20098 \begin_layout Standard
20103 to understand the sub-commands and the switches mentioned below.
20106 \begin_layout Subsubsection
20112 \begin_layout Standard
20113 If your document is not under revision control, this is the only item shown
20115 And if it is under revision control, the
20119 item is not visible.
20123 \begin_layout Standard
20124 This command registers in CVS your document
20125 \begin_inset Flex Strong
20128 \begin_layout Plain Layout
20136 in the case you have already the documents directory under CVS control
20142 This means you have to create or checkout the archive by yourself using
20144 (In case you forget that step \SpecialChar LyX
20145 registers the document with RCS.)
20148 \begin_layout Standard
20149 Then you are asked interactively to supply an initial description of the
20151 Don't forget that registered file is not yet checked in.
20154 \begin_layout Standard
20155 CVS command that is run:
20157 cvs -q add -m"<entered message>" "<file-name>"
20160 \begin_layout Standard
20165 above and for all other CVS commands is an abbreviation for
20166 \begin_inset Quotes eld
20169 change the current working directory to file location and use the file name
20170 without path component as argument
20171 \begin_inset Quotes erd
20177 \begin_layout Subsubsection
20183 \begin_layout Standard
20184 When you are finished editing a file, you commit your changes.
20185 When you do this and you had changed the document, you are asked for a
20186 description of the changes.
20187 After that changes are written to the repository.
20188 In case you didn't change the document and a reserved checkout is detected
20189 the reservation made on
20190 \begin_inset Flex Noun
20193 \begin_layout Plain Layout
20202 \begin_layout Labeling
20203 \labelwidthstring 00.00.0000
20205 \begin_inset space ~
20209 \begin_inset space ~
20213 \begin_inset Newline newline
20217 \begin_inset Flex Code
20220 \begin_layout Plain Layout
20223 -q commit -m"<description>" "<file-name>"
20229 \begin_inset Newline newline
20233 \begin_inset Flex Code
20236 \begin_layout Plain Layout
20247 \begin_layout Subsubsection
20253 \begin_layout Standard
20254 When you are sharing a repository with others, you may have to incorporate
20255 their changes into your working copy.
20258 \begin_layout Standard
20261 cvs -q update "<file-name>"
20264 \begin_layout Standard
20265 If a readonly checkout is detected the working copy is made writable and
20269 \begin_layout Standard
20272 cvs -q edit "<file-name>"
20275 \begin_layout Subsubsection
20278 Revert To Repository Version
20281 \begin_layout Standard
20282 This will discard all changes made to the document since the last check
20284 You get a warning before changes are discarded.
20285 Firstly the file is deleted, secondly CVS update command is run.
20288 \begin_layout Standard
20291 cvs -q update "<file-name>"
20294 \begin_layout Standard
20295 If a reserved checkout is detected and the working copy has no changes only
20296 the reservation is undone.
20299 \begin_layout Standard
20302 cvs -q unedit "<file-name>"
20305 \begin_layout Subsubsection
20311 \begin_layout Standard
20312 This will create a copy of the current document.
20313 Since CVS does not support copy operations natively, the version history
20314 is not preserved, and the copy is added as a new file.
20315 It requires a clean document without any changes since the last checkin.
20316 You are asked for a file name and a description of the copy operation.
20317 After that the copy is created, both locally and in the repository.
20318 If the parent directories of the copied and original document differ, all
20319 relative paths of included files of the copy are adjusted (like in
20321 File\SpecialChar menuseparator
20326 Finally, the copy is loaded instead of the original document.
20329 \begin_layout Labeling
20330 \labelwidthstring 00.00.0000
20332 \begin_inset space ~
20336 \begin_inset space ~
20340 \begin_inset Newline newline
20344 \begin_inset Flex Code
20347 \begin_layout Plain Layout
20350 \begin_inset Quotes eld
20354 \begin_inset Quotes erd
20363 \begin_inset Flex Code
20366 \begin_layout Plain Layout
20369 \begin_inset Quotes eld
20373 \begin_inset Quotes erd
20382 \begin_inset Newline newline
20386 \begin_inset Flex Code
20389 \begin_layout Plain Layout
20393 \begin_inset Quotes eld
20397 \begin_inset Quotes erd
20408 \begin_layout Subsubsection
20414 \begin_layout Standard
20415 This will rename the current document.
20416 Since CVS does not support rename operations natively, the version history
20417 is not preserved, the renamed document is added as a new file, and the
20418 original document is deleted.
20419 It requires a clean document without any changes since the last checkin.
20420 You are asked for a file name and a description of the rename operation.
20421 After that the document is renamed, both locally and in the repository.
20422 If the parent directories of the new and old file names differ, all relative
20423 paths of included files are adjusted (like in
20425 File\SpecialChar menuseparator
20430 Finally, the document is reloaded using the new name.
20433 \begin_layout Labeling
20434 \labelwidthstring 00.00.0000
20436 \begin_inset space ~
20440 \begin_inset space ~
20444 \begin_inset Newline newline
20448 \begin_inset Flex Code
20451 \begin_layout Plain Layout
20454 \begin_inset Quotes eld
20458 \begin_inset Quotes erd
20467 \begin_inset Flex Code
20470 \begin_layout Plain Layout
20473 \begin_inset Quotes eld
20477 \begin_inset Quotes erd
20486 \begin_inset Newline newline
20490 \begin_inset Flex Code
20493 \begin_layout Plain Layout
20497 \begin_inset Quotes eld
20501 \begin_inset Quotes erd
20510 \begin_inset Newline newline
20514 \begin_inset Flex Code
20517 \begin_layout Plain Layout
20521 \begin_inset Quotes eld
20525 \begin_inset Quotes erd
20536 \begin_layout Subsubsection
20537 Update of the local directory checkout from repository
20540 \begin_layout Standard
20541 Once your documents gets more complex, containing sub-documents and pictures,
20543 \begin_inset Flex Code
20546 \begin_layout Plain Layout
20552 files and so on using version control becomes more complicated.
20554 supports updating the whole tree in which resides the document.
20555 This become especially useful once you cooperate with people which neither
20556 have detailed knowledge about CVS usage nor they have ambition to commit
20557 additional material to the repository.
20558 You have to organize the files structure so that all external files are
20559 in the same directory or subdirectories of the document.
20560 It's good practice anyway to store multipart documents in an extra directory.
20563 \begin_layout Standard
20565 \begin_inset Flex Code
20568 \begin_layout Plain Layout
20569 Update local directory from repository
20574 command updates the whole directory.
20575 If local changes are detected user is warned before update starts.
20576 In case of merge conflicts both versions of the conflicting document parts
20577 are placed in the final document.
20578 You have to review and correct the result of the merge.
20579 You'll find the conflicts enclosed in pairs of
20580 \begin_inset Flex Code
20583 \begin_layout Plain Layout
20590 \begin_inset Flex Code
20593 \begin_layout Plain Layout
20600 \begin_inset Flex Code
20603 \begin_layout Plain Layout
20610 The first part is your version as before the update operation with the
20611 document name prepended.
20612 The second one is the repository version with the version number after
20614 \begin_inset Flex Code
20617 \begin_layout Plain Layout
20626 \begin_layout Labeling
20627 \labelwidthstring 00.00.0000
20629 \begin_inset space ~
20633 \begin_inset space ~
20637 \begin_inset Newline newline
20641 \begin_inset Flex Code
20644 \begin_layout Plain Layout
20652 (Ask if changes are detected.)
20653 \begin_inset Newline newline
20657 \begin_inset Flex Code
20660 \begin_layout Plain Layout
20661 cd $path; cvs -q update
20671 \begin_layout Standard
20673 \begin_inset Flex Code
20676 \begin_layout Plain Layout
20682 stands for the path to the document.
20685 \begin_layout Subsubsection
20691 \begin_layout Standard
20692 This shows the complete history of the CVS document.
20695 cvs log "<file-name>"
20697 is shown in a browser.
20700 \begin_layout Subsubsection
20704 \begin_layout Standard
20706 supports CVS version number, author name, date and time of last commit.
20707 All those are extracted from
20709 cvs log -r <file-name>
20713 \begin_inset CommandInset ref
20715 reference "subsec:VCS-Revision-Information"
20722 \begin_layout Subsection
20723 SVN commands in \SpecialChar LyX
20727 \begin_layout Standard
20728 SVN is now partially supported by \SpecialChar LyX
20730 You can find the commands in the
20732 File\SpecialChar menuseparator
20734 \begin_inset space ~
20740 Please note that if you use password protected access to repository via
20741 ssh, you will be asked in terminal window.
20743 was tested against SVN 1.5, 1.6, 1.7 and 1.8
20747 \begin_layout Plain Layout
20748 Most of the commands will work with 1.4 too, see
20749 \begin_inset CommandInset ref
20751 reference "subsec:SVN-Repo-Update"
20756 There seems to be currently unresolved permissions problem under SVN 1.8
20757 with reverting changes when file is locked.
20765 \begin_layout Subsubsection
20771 \begin_layout Standard
20772 If your document is not under revision control, this is the only item shown
20774 And if it is under revision control, the
20778 item is not visible.
20781 \begin_layout Standard
20782 This command registers in SVN your document ONLY in case you have already
20783 the documents directory under SVN control (in particular
20788 This means you have to checkout the archive by yourself.
20791 \begin_layout Standard
20792 Then you are asked interactively to supply an initial description of the
20794 Don't forget that registered file is not yet commited.
20797 \begin_layout Standard
20798 SVN command that is run:
20801 \begin_inset Quotes eld
20805 \begin_inset Quotes erd
20811 \begin_layout Standard
20816 to understand the switches.
20819 \begin_layout Subsubsection
20825 \begin_layout Standard
20826 When you are finished editing a file, you commit your changes.
20827 When you do this, you are asked for a description of the changes.
20828 After that changes are commited.
20831 \begin_layout Standard
20836 \begin_layout Plain Layout
20837 In case locking is not enabled.
20839 \begin_inset CommandInset ref
20841 reference "subsec:SVN-File-Locking"
20852 svn commit -q -m"<description>" <file-name>
20855 \begin_layout Subsubsection
20861 \begin_layout Standard
20862 Updates the changes of this file from the repository.
20863 Be sure you understand SVN merging and conflicts resolving before using
20864 this function, because all conflicts has to be resolved manually by you!
20867 \begin_layout Standard
20872 \begin_layout Plain Layout
20880 svn update --non-interactive
20881 \begin_inset Quotes eld
20885 \begin_inset Quotes erd
20891 \begin_layout Subsubsection
20894 Revert To Repository Version
20897 \begin_layout Standard
20898 This will discard all changes made to the document since the last check
20900 You get a warning before changes are discarded.
20903 \begin_layout Standard
20907 \begin_inset Quotes eld
20911 \begin_inset Quotes erd
20917 \begin_layout Subsubsection
20923 \begin_layout Standard
20924 This will create a copy of the current document including the version history.
20925 It requires a clean document without any changes since the last checkin.
20926 You are asked for a file name and a description of the copy operation.
20927 After that the copy is created, both locally and in the repository.
20928 If the parent directories of the copied and original document differ, all
20929 relative paths of included files of the copy are adjusted (like in
20931 File\SpecialChar menuseparator
20936 Finally, the copy is loaded instead of the original document.
20939 \begin_layout Labeling
20940 \labelwidthstring 00.00.0000
20942 \begin_inset space ~
20946 \begin_inset space ~
20950 \begin_inset Newline newline
20954 \begin_inset Flex Code
20957 \begin_layout Plain Layout
20961 \begin_inset Quotes eld
20965 \begin_inset Quotes erd
20969 \begin_inset Quotes eld
20973 \begin_inset Quotes erd
20982 \begin_inset Newline newline
20986 \begin_inset Flex Code
20989 \begin_layout Plain Layout
20998 \begin_layout Subsubsection
21004 \begin_layout Standard
21005 This will rename the current document including the version history.
21006 It requires a clean document without any changes since the last checkin.
21007 You are asked for a file name and a description of the rename operation.
21008 After that the document is renamed, both locally and in the repository.
21009 If the parent directories of the new and old file names differ, all relative
21010 paths of included files are adjusted (like in
21012 File\SpecialChar menuseparator
21017 Finally, the document is reloaded using the new name.
21020 \begin_layout Labeling
21021 \labelwidthstring 00.00.0000
21023 \begin_inset space ~
21027 \begin_inset space ~
21031 \begin_inset Newline newline
21035 \begin_inset Flex Code
21038 \begin_layout Plain Layout
21042 \begin_inset Quotes eld
21046 \begin_inset Quotes erd
21050 \begin_inset Quotes eld
21054 \begin_inset Quotes erd
21063 \begin_inset Newline newline
21067 \begin_inset Flex Code
21070 \begin_layout Plain Layout
21079 \begin_layout Subsubsection
21080 \begin_inset CommandInset label
21082 name "subsec:SVN-Repo-Update"
21086 Update of the local directory checkout from repository
21090 \begin_layout Plain Layout
21091 Note that this command will work only with subversion
21092 \begin_inset Formula $\geqq1.5$
21103 \begin_layout Standard
21104 All the commands above have one shortcomming - they deal with the current
21106 Once your document contains pictures, includes external
21107 \begin_inset Flex Code
21110 \begin_layout Plain Layout
21116 files and so on administration becomes more complicated.
21118 now supports updating the whole tree in which resides the document
21122 \begin_layout Plain Layout
21123 One need to organize the files structure so that all external files are
21124 in the same directory or subdirectories of the document.
21131 This become especially useful once you cooperate with people which neither
21132 know about subversion management nor they have ambition to commit additional
21133 material to the repository.
21137 \begin_layout Standard
21138 \begin_inset Flex Code
21141 \begin_layout Plain Layout
21142 Update local directory from repository
21147 command updates the whole directory and in case of merge conflicts local
21148 version of the files are left, so no unintended data loss occurs.
21149 If local changes are detected user is warned before update starts.
21152 \begin_layout Labeling
21153 \labelwidthstring 00.00.0000
21155 \begin_inset space ~
21159 \begin_inset space ~
21163 \begin_inset Newline newline
21167 \begin_inset Flex Code
21170 \begin_layout Plain Layout
21176 (Ask if changes are detected.)
21177 \begin_inset Newline newline
21181 \begin_inset Flex Code
21184 \begin_layout Plain Layout
21185 svn update –accept mine-full $path
21193 \begin_layout Standard
21195 \begin_inset Flex Code
21198 \begin_layout Plain Layout
21204 stands for the path to the document.
21207 \begin_layout Subsubsection
21213 \begin_layout Standard
21214 This shows the complete history of the SVN document.
21218 \begin_inset Quotes eld
21222 \begin_inset Quotes erd
21227 is shown in a browser.
21230 \begin_layout Subsubsection
21232 \begin_inset CommandInset label
21234 name "subsec:SVN-File-Locking"
21241 \begin_layout Standard
21242 The file exchange through various revision control systems brings the problem
21243 of merge conflicts in case two different users try to edit the same (parts
21245 When such a conflict happens it needs manual resolving and one reasonable
21246 alternative is to provide some kind of locking mechanism, which guarantees
21247 that only one user is allowed to edit file at the given time.
21250 \begin_layout Standard
21251 SVN has two such mechanisms to provide mutual exclusivity for file access
21252 - locks and automatic setting of write permissions (see sec.
21254 \begin_inset CommandInset ref
21256 reference "subsec:Automatical-Locking-Property"
21261 \begin_inset Flex Code
21264 \begin_layout Plain Layout
21274 \begin_layout Plain Layout
21275 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
21281 If this property is detected for a given document \SpecialChar LyX
21282 starts to use SVN locks
21283 for document editing automatically and the whole check-in/out mechanism
21284 switches to the same regimen as for RCS.
21285 This in particular means there are two different modes of file use in \SpecialChar LyX
21289 \begin_layout Itemize
21291 The loaded file is in the read-only mode.
21292 For editing on needs to check-out.
21297 consists of updating from the repository and gaining write lock.
21298 If the lock is not possible to obtain, we remain in unlocked state.
21301 \begin_layout Itemize
21303 The loaded file is in the 'normal' edit mode.
21304 No other user is allowed to edit the file.
21309 consists of commiting changes and releasing write-lock.
21310 If no changes have been made to the document, no commit will be produced
21314 \begin_layout Plain Layout
21315 Don't be puzzled by the fact that you will be asked for commit message anyway.
21320 and only the write-lock will be released.
21323 \begin_layout Standard
21327 \begin_layout Labeling
21328 \labelwidthstring 00.00.0000
21331 svn commit -q -m"<description>" "<file-name>"
21332 \begin_inset Newline newline
21335 svn unlock "<file-name>"
21338 \begin_layout Labeling
21339 \labelwidthstring 00.00.0000
21342 svn update "<file-name>"
21343 \begin_inset Newline newline
21346 svn lock "<file-name>"
21349 \begin_layout Subsubsection
21352 \begin_inset CommandInset label
21354 name "subsec:Automatical-Locking-Property"
21360 Automatic Locking Property
21363 \begin_layout Standard
21364 The above mentioned automatic setting of write permissions of the .lyx file
21367 File\SpecialChar menuseparator
21369 \begin_inset space ~
21372 Control\SpecialChar menuseparator
21373 Toggle locking property
21376 This command is active only when the file is not locked on the svn server
21378 you need to check-out before proceeding).
21381 \begin_layout Labeling
21382 \labelwidthstring 00.00.0000
21384 \begin_inset space ~
21390 \begin_layout Labeling
21391 \labelwidthstring 00.00.0000
21394 svn propset svn:needs-lock ON "<file-name>"
21397 \begin_layout Labeling
21398 \labelwidthstring 00.00.0000
21401 svn propdel svn:needs-lock "<file-name>"
21404 \begin_layout Subsubsection
21405 \begin_inset CommandInset label
21407 name "subsec:VCS-Revision-Information"
21411 Revision Information in Documents
21414 \begin_layout Standard
21415 There are more possibilities how to activate revision information in our
21419 \begin_layout Itemize
21425 \begin_layout Itemize
21426 tree revision information (
21427 \begin_inset Flex Code
21430 \begin_layout Plain Layout
21437 The result is the output of the
21438 \begin_inset Flex Code
21441 \begin_layout Plain Layout
21447 command, the following table gives you an idea, how to read the results.
21450 \begin_layout Standard
21452 \begin_inset Tabular
21453 <lyxtabular version="3" rows="6" columns="2">
21454 <features tabularvalignment="middle">
21455 <column alignment="center" valignment="top">
21456 <column alignment="center" valignment="top">
21458 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21461 \begin_layout Plain Layout
21467 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21470 \begin_layout Plain Layout
21478 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21481 \begin_layout Plain Layout
21487 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21490 \begin_layout Plain Layout
21491 mixed revision working copy
21498 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21501 \begin_layout Plain Layout
21507 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21510 \begin_layout Plain Layout
21511 modified working copy
21518 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21521 \begin_layout Plain Layout
21527 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21530 \begin_layout Plain Layout
21531 switched working copy
21538 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21541 \begin_layout Plain Layout
21547 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21550 \begin_layout Plain Layout
21551 partial working copy, from a sparse checkout
21558 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21561 \begin_layout Plain Layout
21567 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21570 \begin_layout Plain Layout
21571 mixed revision, modified, switched working copy
21584 \begin_layout Itemize
21585 file revision information.
21586 The result comes from parsing the output of
21587 \begin_inset Flex Code
21590 \begin_layout Plain Layout
21592 \begin_inset space ~
21596 \begin_inset space ~
21600 \begin_inset space ~
21609 Supported flags are:
21613 \begin_layout Itemize
21614 version number of the last commit (
21615 \begin_inset Flex Code
21618 \begin_layout Plain Layout
21627 \begin_layout Itemize
21628 author of the last commit (
21629 \begin_inset Flex Code
21632 \begin_layout Plain Layout
21641 \begin_layout Itemize
21642 date of the last commit (
21643 \begin_inset Flex Code
21646 \begin_layout Plain Layout
21655 \begin_layout Itemize
21656 time of the last commit (
21657 \begin_inset Flex Code
21660 \begin_layout Plain Layout
21670 \begin_layout Standard
21671 You can obtain this info via InsetInfo (e.g.
21673 \begin_inset Flex Code
21676 \begin_layout Plain Layout
21677 info-insert buffer vcs-date
21683 The information will be available only when you have the file stored under
21684 svn managment (i.e.
21686 \begin_inset Flex Code
21689 \begin_layout Plain Layout
21695 directory is available with your document).
21699 \begin_layout Itemize
21700 Another—a hacking one—possibility is to use svn keywords
21704 \begin_layout Plain Layout
21705 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
21711 In short – you set file keywords property (e.g.
21714 svn propset svn:keywords 'Rev' file.lyx
21716 ) and then paste keyword \SpecialChar TeX
21721 \begin_layout Plain Layout
21722 This is an easy way how to ensure that \SpecialChar LyX
21723 won't break the line in the middle
21729 tag in your document (e.g.
21734 \begin_layout Plain Layout
21742 This way svn client will automatically substitute revision number (e.g.
21747 \begin_layout Plain Layout
21754 ) after each update and commit.
21755 There are more problems with this approach.
21756 Firstly, the '$' character is used in \SpecialChar TeX
21757 world for math equations, so any
21758 occurence of math formula
21759 \begin_inset Formula $Rev$
21763 \begin_inset Formula $Rev:59$
21766 in your \SpecialChar LyX
21768 Similarly for other keywords like Id, Date, Author, etc.
21769 Secondly svn output is dependent on your locales, so its very easy that
21770 svn would produce some problematic strings once Date is used.
21771 Thirdly you get the whole 'Rev: 59' string in your document instead of
21773 Until subversion implements user's custom keywords it will be hard to use
21774 this approach reliably or let \SpecialChar LyX
21775 to support it directly.
21778 \begin_layout Subsection
21779 SVN and Windows Environment
21782 \begin_layout Quote
21783 My inclination is to say that if the user cannot figure out the command
21784 line operations on their own fairly quickly, they would be well advised
21785 to use TortoiseSVN.
21791 \begin_layout Subsubsection
21795 \begin_layout Standard
21796 In addition to installing \SpecialChar LyX
21797 , and having access to a Subversion repository,
21798 the user will need to install the Subversion client program.
21799 A Windows installer for the client program is available from
21800 \begin_inset CommandInset href
21803 target "http://www.collab.net/nonav/downloads/subversion/"
21808 The user may also want to install
21809 \begin_inset CommandInset href
21812 target "http://tortoisesvn.tigris.org/"
21816 , which integrates Subversion operations into the context (rightclick) menu
21817 of Windows Explorer.
21818 Operations done outside \SpecialChar LyX
21819 will typically be more convenient using the Explorer
21821 Note that TortoiseSVN is not a replacement for the client program, which
21822 is what \SpecialChar LyX
21826 \begin_layout Subsubsection
21827 Bringing a document under Subversion control
21830 \begin_layout Standard
21831 Before a \SpecialChar LyX
21832 document can be brought under version control in Subversion, its
21833 parent directory needs to be under version control.
21834 If the document is being added to a project already in the repository,
21835 this is accomplished by checking the project out to the directory where
21836 the new document will be placed.
21837 If the project itself is not yet under version control (for instance, if
21838 this document starts a new project), the directory must be imported into
21840 This is done outside \SpecialChar LyX
21842 Both import and checkout are easily accomplished from the Explorer context
21843 menu using TortoiseSVN, or alternatively can be done using the command
21844 line client at a DOS prompt.
21845 The procedure for importing the project using TortoiseSVN is described
21846 below, assuming an existing repository and a new project being started
21854 For information on using the Subversion client program, run
21861 \begin_layout Enumerate
21868 in Windows Explorer, right click it, and select
21870 TortoiseSVN\SpecialChar menuseparator
21874 If necessary, adjust the URL for the repository, then click OK.
21877 \begin_layout Enumerate
21878 Right click the level of the repository under which you want to place the
21879 new project folder (typically the top level) and click
21883 Supply a name for the project folder and click OK.
21884 Add a message for the log file if desired, then click OK again.
21885 The new project folder should appear in the repository.
21886 Finally, click OK again to exit the repository browser.
21889 \begin_layout Enumerate
21890 Once again right click
21896 , this time selecting SVN Checkout\SpecialChar ldots
21897 Select the URL of the project folder
21898 you just created in the repository, and set the checkout directory to
21906 You will be warned about a non-empty folder; click OK to proceed.
21907 You should now have a
21918 \begin_layout Enumerate
21919 Create or open your document in \SpecialChar LyX
21922 File\SpecialChar menuseparator
21924 \begin_inset space ~
21927 Control\SpecialChar menuseparator
21931 Add a log message and click OK to commit the document to version control.
21934 \begin_layout Standard
21935 From this point onward, you should have full functionality in the
21937 File\SpecialChar menuseparator
21939 \begin_inset space ~
21945 You also have the option of checking the document in and out, viewing its
21947 using the TortoiseSVN context menu in Windows Explorer or the Subversion
21948 client program from a command prompt.
21951 \begin_layout Subsubsection
21952 SSH tunnel used with SVN under Windows
21955 \begin_layout Standard
21956 Compared with Linux setting up an svn client to communicate over ssh under
21957 Windows is a rather troublesome task.
21958 We will at least offer some hints how to setup the client side but prior
21959 knowledge about ssh and the Windows command line is needed, also be prepared
21960 for a great deal of frustration\SpecialChar ldots
21964 \begin_layout Enumerate
21965 Get an svn client for windows, as described in the previous sections.
21966 When it is a fresh install run some svn command (e.g.
21968 \begin_inset Flex Code
21971 \begin_layout Plain Layout
21977 ) to create config files, which you will need to change later on.
21980 \begin_layout Enumerate
21981 Choose an ssh client for Windows.
21982 There are several possibilities, we will use the one from Putty tools
21986 \begin_layout Plain Layout
21987 \begin_inset Flex URL
21990 \begin_layout Plain Layout
21992 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
22003 You will need to set the connection up so that the client doesn't ask for
22004 any password from you.
22005 To keep things easy we will use only keys without any additional password
22010 \begin_layout Enumerate
22012 \begin_inset Flex Code
22015 \begin_layout Plain Layout
22022 Save your private .ppk key file and put the public one on the server side.
22023 If the SVN server runs on Linux, note that the format of the public key
22024 is not compatible with Linux openssh and you will need to direcly copy-paste
22027 Public key for pasting into OpenSSH authorized_keys file
22029 :” edit field into the server's
22030 \begin_inset Flex Code
22033 \begin_layout Plain Layout
22034 ~/.ssh/authorized_keys
22040 \begin_inset Flex Code
22043 \begin_layout Plain Layout
22052 \begin_layout Enumerate
22054 \begin_inset Flex Code
22057 \begin_layout Plain Layout
22064 In the SVN config file
22068 \begin_layout Plain Layout
22069 Exact path depends on Windows version, usually somewhere around
22070 \begin_inset Flex Code
22073 \begin_layout Plain Layout
22076 Documents and Settings
22090 \begin_inset Flex Code
22093 \begin_layout Plain Layout
22108 , section [tunnels], setup ssh command, e.g.
22110 \begin_inset Flex Code
22113 \begin_layout Plain Layout
22114 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
22123 \begin_layout Plain Layout
22124 It will usually take a lot of time to get exact command right and it depends
22126 For example do not have some remote server saved as a default session in
22128 If things fail, try to connect via plink without SVN first.
22137 \begin_layout Enumerate
22138 Checkout the SVN archive, e.
22139 \begin_inset space \thinspace{}
22143 \begin_inset Newline newline
22147 \begin_inset Flex Code
22150 \begin_layout Plain Layout
22151 svn co svn+ssh://user@server/repository_path
22159 \begin_layout Subsubsection
22160 End-of-Line Conversions
22163 \begin_layout Standard
22164 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
22166 use different line endings inside the .lyx files.
22167 This is not a problem as far as \SpecialChar LyX
22168 functionality is concerned, but the commit
22169 diffs will be huge and merge-conflicts prone.
22170 Fortunately SVN itself knows
22174 \begin_layout Plain Layout
22175 \begin_inset Flex URL
22178 \begin_layout Plain Layout
22180 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
22190 how to deal with CR/LF problems when switching .lyx files to the
22191 \begin_inset Flex Code
22194 \begin_layout Plain Layout
22204 \begin_layout Plain Layout
22206 \begin_inset Flex Code
22209 \begin_layout Plain Layout
22210 svn propset svn:eol-style native FILE_NAME
22223 \begin_layout Subsection
22224 GIT commands in \SpecialChar LyX
22228 \begin_layout Standard
22229 A minimal subset of GIT commands is now supported by \SpecialChar LyX
22231 You can find the commands in the
22233 File\SpecialChar menuseparator
22235 \begin_inset space ~
22241 Please note that if you use password protected access to repository via
22242 ssh, you will be asked in terminal window.
22244 was tested against GIT 1.7.
22248 \begin_layout Plain Layout
22249 Windows users please note that you need to ensure that git is on the path.
22250 This can be set from within \SpecialChar LyX
22253 Tools\SpecialChar menuseparator
22254 Preferences\SpecialChar menuseparator
22255 Paths\SpecialChar menuseparator
22266 \begin_layout Standard
22267 One big difference of GIT and the other supported version control systems
22268 is the distributed nature of GIT: With traditional version control systems
22269 there is one central server which hosts the repository.
22270 Users commit their changes to the server, and get updates made by other
22272 With GIT, users commit to a local repository.
22273 The local repository can be synchronized with one or more remote repositories
22275 \begin_inset Flex Code
22278 \begin_layout Plain Layout
22285 \begin_inset Flex Code
22288 \begin_layout Plain Layout
22296 does not interact in any way with remote GIT repositories.
22297 It works exclusively with the local repository in a very similar way as
22298 with a central CVS or SVN repository.
22299 If you use remote GIT repositories you need to do the
22300 \begin_inset Flex Code
22303 \begin_layout Plain Layout
22310 \begin_inset Flex Code
22313 \begin_layout Plain Layout
22319 operations with your favourite GIT client.
22322 \begin_layout Subsubsection
22328 \begin_layout Standard
22329 If your document is not under revision control, this is the only item shown
22331 And if it is under revision control, the
22335 item is not visible.
22338 \begin_layout Standard
22339 This command registers in GIT your document ONLY in case you have already
22340 the documents directory under GIT control (in particular
22345 This means you have to checkout the archive by yourself.
22348 \begin_layout Standard
22349 Then you are asked interactively to supply an initial description of the
22351 Don't forget that registered file is not yet commited.
22354 \begin_layout Standard
22355 GIT command that is run:
22358 \begin_inset Quotes eld
22362 \begin_inset Quotes erd
22368 \begin_layout Standard
22373 to understand the switches.
22376 \begin_layout Subsubsection
22382 \begin_layout Standard
22383 When you are finished editing a file, you commit your changes.
22384 When you do this, you are asked for a description of the changes.
22385 After that changes are commited.
22388 \begin_layout Standard
22391 git commit -q -m"<description>" <file-name>
22394 \begin_layout Subsubsection
22397 Revert To Repository Version
22400 \begin_layout Standard
22401 This will discard all changes made to the document since the last check
22403 You get a warning before changes are discarded.
22406 \begin_layout Standard
22410 \begin_inset Quotes eld
22414 \begin_inset Quotes erd
22420 \begin_layout Subsubsection
22426 \begin_layout Standard
22427 This will rename the current document including the version history.
22428 It requires a clean document without any changes since the last checkin.
22429 You are asked for a file name and a description of the rename operation.
22430 After that the document is renamed, both locally and in the repository.
22431 If the parent directories of the new and old file names differ, all relative
22432 paths of included files are adjusted (like in
22434 File\SpecialChar menuseparator
22439 Finally, the document is reloaded using the new name.
22442 \begin_layout Labeling
22443 \labelwidthstring 00.00.0000
22445 \begin_inset space ~
22449 \begin_inset space ~
22453 \begin_inset Newline newline
22457 \begin_inset Flex Code
22460 \begin_layout Plain Layout
22464 \begin_inset Quotes eld
22468 \begin_inset Quotes erd
22472 \begin_inset Quotes eld
22476 \begin_inset Quotes erd
22485 \begin_inset Newline newline
22489 \begin_inset Flex Code
22492 \begin_layout Plain Layout
22501 \begin_layout Subsubsection
22507 \begin_layout Standard
22508 This shows the complete history of the GIT document.
22512 \begin_inset Quotes eld
22516 \begin_inset Quotes erd
22521 is shown in a browser.
22524 \begin_layout Subsubsection
22528 \begin_layout Standard
22530 supports GIT hash number of the last commit to the file, author name, date
22531 and time of last commit.
22532 All those are extracted from
22534 git log -n 1 --pretty=format:%H%n%an%n%ai
22537 Tree version information is obtained via
22539 git describe --abbrev --dirty --long
22543 \begin_inset CommandInset ref
22545 reference "subsec:VCS-Revision-Information"
22552 \begin_layout Subsection
22556 \begin_layout Standard
22557 With the recent addition of the vc-command function \SpecialChar LyX
22558 power users are allowed
22559 to create their own commands for revision control.
22562 \begin_layout Standard
22563 As an example you can see how two TortoiseSVN commands could be integrated
22567 \begin_layout Description
22569 \begin_inset Flex Code
22572 \begin_layout Plain Layout
22573 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
22581 \begin_layout Description
22583 \begin_inset Flex Code
22586 \begin_layout Plain Layout
22587 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
22595 \begin_layout Subsection
22596 Version control and Document comparison
22599 \begin_layout Standard
22600 One of the typical uses of version control is to inspect the changes between
22601 revisions, usually by creating
22602 \begin_inset Flex Code
22605 \begin_layout Plain Layout
22612 While this is useful for plain text files, it is much less useful in the
22613 case of \SpecialChar LyX
22614 files, which have more a complicated structure.
22615 Hence we provide binding to the Document comparison feature.
22616 There are two ways of calling this feature - either by direct call of
22617 \begin_inset Flex Code
22620 \begin_layout Plain Layout
22627 function (for details see \SpecialChar LyX
22628 functions manual) or by icon/menu item
22629 \begin_inset Flex Noun
22632 \begin_layout Plain Layout
22633 Compare with older revision...
22639 One can either compare two chosen revisions of the document or he can simply
22640 compare the current version of edited text with older revisions (where
22642 \begin_inset Flex Noun
22645 \begin_layout Plain Layout
22651 ' revisions back means comparison of the edited file with last commited
22656 \begin_layout Standard
22657 This feature is supported for SVN and RCS though due to the more complicated
22658 versioning scheme of RCS there is a constraint – when addressing the revisions
22659 in dialog, numbers always point to the last number in RCS revision number,
22662 We don't currently support GIT addressing of revisions, one can just compare
22663 edited document with its revision X steps backs, where X is addressed as
22667 \begin_layout Section
22668 Literate Programming
22671 \begin_layout Standard
22676 (kayvan@sylvan.com)
22680 original documentation written by
22682 Edmar Wienskoski Jr.
22685 (edmar-w-jr@technologist.com)
22688 \begin_layout Subsection
22692 \begin_layout Standard
22693 The main purpose of this documentation is to show you how to use \SpecialChar LyX
22695 programming, where it is assumed that you are familiar with this programming
22696 technique, and know what
22697 \begin_inset Quotes eld
22701 \begin_inset Quotes erd
22705 \begin_inset Quotes eld
22709 \begin_inset Quotes erd
22713 If that is not the case, please follow the web links provided in the following
22715 There is a lot of good documentation out there covering old development
22716 history to the latest tools tips.
22719 \begin_layout Standard
22720 It is also assumed that you are familiar with \SpecialChar LyX
22721 itself to a point that you
22722 are comfortable changing your \SpecialChar LyX
22723 preferences, and X resources file.
22724 If that is not the case please refer to other \SpecialChar LyX
22725 documentation to cover your
22729 \begin_layout Subsection
22730 Literate Programming
22733 \begin_layout Standard
22734 From the Literate Programming FAQ:
22737 \begin_layout Quotation
22738 Literate programming is the combination of documentation and source together
22739 in a fashion suited for reading by human beings.
22740 In fact, literate programs should be enjoyable reading, even inviting!
22741 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
22742 and documentation in a single file.
22743 Literate programming tools then parse the file to produce either readable
22744 documentation or compilable source.
22745 The WEB style of literate programming was created by D.
22746 \begin_inset space \thinspace{}
22750 Knuth during the development of his \SpecialChar TeX
22751 typesetting software.
22755 \begin_layout Standard
22756 Another excerpt says:
22759 \begin_layout Quotation
22762 How is literate programming different from verbose commenting?
22765 \begin_layout Quotation
22766 There are three distinguishing characteristics.
22767 In order of importance, they are:
22771 \begin_layout Itemize
22772 flexible order of elaboration
22775 \begin_layout Itemize
22776 automatic support for browsing
22779 \begin_layout Itemize
22780 typeset documentation, especially diagrams and mathematics
22784 \begin_layout Standard
22785 Now that I sparked your curiosity, take a look in the references.
22788 \begin_layout Subsubsection
22792 \begin_layout Standard
22793 The complete Literate Programming FAQ can be found at:
22796 \begin_layout Quote
22797 Literate Programming FAQ
22798 \begin_inset Flex URL
22801 \begin_layout Plain Layout
22803 http://www.literateprogramming.com/lpfaq.pdf
22811 \begin_layout Standard
22812 The FAQ lists 23 (twenty three!) different literate programming tools.
22813 Where some are specialized or
22814 \begin_inset Quotes eld
22818 \begin_inset Quotes erd
22821 for particular programming languages, while other have general scope.
22826 for my own use for several reasons:
22829 \begin_layout Itemize
22830 It can generate the documentation either in \SpecialChar LaTeX
22834 \begin_layout Itemize
22835 It has a open architecture, i.
22836 \begin_inset space \thinspace{}
22840 \begin_inset space \space{}
22843 it is easy to plug in new filters and to perform special processing that
22848 \begin_layout Itemize
22849 There is a good selection of filters available already (the HTML is one
22853 \begin_layout Itemize
22857 \begin_layout Standard
22858 The Noweb web page can be found at:
22861 \begin_layout Quote
22863 \begin_inset Flex URL
22866 \begin_layout Plain Layout
22868 http://www.cs.virginia.edu/~nr/noweb/
22876 \begin_layout Standard
22877 Starting from there you can reach many other interesting links and even
22878 some literate program examples.
22881 \begin_layout Subsection
22883 and Literate Programming with Noweb
22886 \begin_layout Standard
22887 The \SpecialChar LyX
22888 support for Literate Programming is provided by using the generic \SpecialChar LyX
22890 converters mechanism.
22891 This support is provided in a
22892 \begin_inset Quotes eld
22896 \begin_inset Quotes erd
22900 \begin_inset space \thinspace{}
22904 \begin_inset space \space{}
22907 you will be able to use this new \SpecialChar LyX
22908 feature with some other literate programming
22909 tool of your choice by just changing your \SpecialChar LyX
22913 \begin_layout Subsubsection
22914 Generating documents and code (weaving and tangling)
22917 \begin_layout Paragraph
22918 Using the noweb module
22921 \begin_layout Standard
22922 If you have installed Noweb and \SpecialChar LyX
22923 successfully, whenever you open a new document,
22924 after you have chosen its document class, use the Document->Settings menu
22926 \begin_inset Quotes eld
22930 \begin_inset Quotes erd
22934 If Noweb is correctly installed, when you click on the
22935 \begin_inset Quotes eld
22939 \begin_inset Quotes erd
22942 link, you will see the
22943 \begin_inset Quotes eld
22947 \begin_inset Quotes erd
22950 module in the available list and you can add it to your document.
22953 \begin_layout Paragraph
22957 \begin_layout Standard
22959 enables you to write code with a layout named
22960 \begin_inset Flex Noun
22963 \begin_layout Plain Layout
22970 Noweb delimits chunks like this:
22973 \begin_layout LyX-Code
22977 \begin_layout LyX-Code
22981 \begin_layout LyX-Code
22985 \begin_layout LyX-Code
22989 \begin_layout LyX-Code
22993 \begin_layout Standard
22994 The problem is that whatever is written in between the << and the
22998 must be taken literally, i.
22999 \begin_inset space \thinspace{}
23003 \begin_inset space \space{}
23007 should be prevented from making any special interpretation of what has
23009 This is also handled by
23010 \begin_inset Flex Noun
23013 \begin_layout Plain Layout
23019 , that works like a normal paragraph but has a free spacing capability.
23022 \begin_layout Standard
23023 As a special note, you can also use the
23024 \begin_inset Quotes eld
23028 \begin_inset Quotes erd
23031 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
23035 \begin_layout LyX-Code
23039 \begin_layout LyX-Code
23040 def some_function(args):
23043 \begin_layout LyX-Code
23044 "This is the doc string for this function."
23047 \begin_layout LyX-Code
23048 print "My args: ", args
23051 \begin_layout LyX-Code
23052 @ %def some_function
23055 \begin_layout Standard
23056 For an example of this usage and the resulting cross-reference output, look
23057 at the Literate python program in
23059 LIBDIR/examples/listerrors.lyx
23061 which should make this all clear.
23064 \begin_layout Paragraph
23065 Generating the documentation
23068 \begin_layout Standard
23069 At this point you already have a new document file with a proper document
23070 class, and with some code and text on it.
23071 How do I print it? The answer is simple, you select
23073 View\SpecialChar menuseparator
23077 Just like you would do for a plain document.
23078 No special procedure is required.
23081 \begin_layout Standard
23082 To help orientate you, I will now explain what happens inside \SpecialChar LyX
23086 \begin_layout Enumerate
23089 Update\SpecialChar menuseparator
23092 menu option is chosen, a \SpecialChar LaTeX
23098 \begin_layout Standard
23099 If the document is of any literate class the generated file will be named
23100 with an extension name defined by the
23101 \begin_inset Quotes eld
23105 \begin_inset Quotes erd
23108 format (defined in the Preferences panel), otherwise the file will have
23117 \begin_layout Enumerate
23118 Note that the only difference so far is in the name of the file, no special
23119 processing is required by \SpecialChar LyX
23121 Given that you formatted the code using the
23122 \begin_inset Flex Noun
23125 \begin_layout Plain Layout
23131 layout that, by itself, takes care of the business.
23134 \begin_layout Enumerate
23135 If the document is of any literate class \SpecialChar LyX
23136 will then use the internal \SpecialChar LyX
23138 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
23143 \begin_layout Plain Layout
23144 The converters are defined in the
23146 Tools\SpecialChar menuseparator
23150 \begin_inset Quotes eld
23154 \begin_inset Quotes erd
23166 manual for general information about converters.
23171 to generate the \SpecialChar LaTeX
23176 \begin_layout Standard
23177 Otherwise it will just skip this step.
23181 \begin_layout Enumerate
23182 Finally, \SpecialChar LaTeX
23183 is invoked and the regular post processing continues as in a plain
23187 \begin_layout Standard
23188 Independence from a particular
23189 \begin_inset Quotes eld
23193 \begin_inset Quotes erd
23196 is easily achieved by changing the commands that are run by the various
23200 \begin_layout Paragraph
23201 Generating the code
23204 \begin_layout Standard
23205 When the build menu option is chosen or the corresponding button in the
23206 toolbar is pressed, a \SpecialChar LaTeX
23207 file is generated just like step 1 above.
23208 Next, \SpecialChar LyX
23214 This converter needs to be defined by the user and is not installed by
23215 default, though the Program format is.
23216 This converter (like any other converter) will have two parts:
23219 \begin_layout Enumerate
23220 The converter program itself.
23221 This program performs the conversion from the one format to the other (in
23222 this case, from the Noweb format to the Program pseudo-format).
23225 \begin_layout Enumerate
23226 The error log parser.
23227 This is a program whose sole purpose is to rewrite error messages in a
23228 format that \SpecialChar LyX
23230 This makes it possible for \SpecialChar LyX
23231 to place error boxes in the right places in
23235 \begin_layout Standard
23236 The first part, the
23237 \begin_inset Quotes eld
23241 \begin_inset Quotes erd
23244 setting, should be set to
23245 \begin_inset Newline newline
23249 \begin_inset Quotes eld
23257 \begin_inset Quotes erd
23261 \begin_inset Newline newline
23264 This basically means that \SpecialChar LyX
23266 \begin_inset Quotes eld
23270 \begin_inset Quotes erd
23273 (a program or script) with the name of the Noweb file (normally a file
23274 in the \SpecialChar LyX
23275 temp directory) and the directory path of the original \SpecialChar LyX
23280 \begin_layout Standard
23281 This is an implementation of
23282 \begin_inset Quotes eld
23286 \begin_inset Quotes erd
23289 that you can place in a directory on your path:
23292 \begin_layout Standard
23293 \begin_inset VSpace defskip
23299 \begin_layout Standard
23300 \begin_inset Newpage pagebreak
23306 \begin_layout Standard
23312 \begin_layout Standard
23318 \begin_layout Standard
23321 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
23324 \begin_layout Standard
23325 \begin_inset VSpace defskip
23331 \begin_layout Standard
23332 The next part of the converter setting is the
23333 \begin_inset Quotes eld
23337 \begin_inset Quotes erd
23340 which is to be set to
23341 \begin_inset Newline newline
23345 \begin_inset Quotes eld
23350 parselog=$$s/scripts/listerrors
23353 \begin_inset Quotes erd
23357 \begin_inset Newline newline
23360 This will run any errors that are generated by the
23361 \begin_inset Quotes eld
23365 \begin_inset Quotes erd
23368 process through the
23369 \begin_inset Quotes eld
23373 \begin_inset Quotes erd
23379 \begin_layout Standard
23380 The build will normally take place in \SpecialChar LyX
23381 's temporary directory, so the files
23382 produced by the conversion will be in that directory.
23384 will copy out what it regards as the `main' file, but the
23388 conversion may produce several files, and so most of these would then be
23389 deleted when \SpecialChar LyX
23391 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
23392 the build-script chunk can place the generated files in that location.
23395 \begin_layout Paragraph
23396 Build instructions in the document
23399 \begin_layout Standard
23400 The last piece of the integration between \SpecialChar LyX
23402 \begin_inset Quotes eld
23406 \begin_inset Quotes erd
23410 Generally, the instructions for building your program should be embedded
23411 in a chunk of its own.
23413 \begin_inset Quotes eld
23417 \begin_inset Quotes erd
23420 above uses the notangle command to look for this chunk (called
23421 \begin_inset Quotes eld
23425 \begin_inset Quotes erd
23428 ) and runs its contents through
23429 \begin_inset Quotes eld
23433 \begin_inset Quotes erd
23439 \begin_layout Standard
23440 Typically, such a chunk would look something like this:
23443 \begin_layout LyX-Code
23447 \begin_layout LyX-Code
23449 \begin_inset Newline newline
23452 if [ -z "${NOWEB_SOURCE}" ]
23453 \begin_inset Newline newline
23459 \begin_layout LyX-Code
23460 NOWEB_SOURCE=myfile.nw
23461 \begin_inset Newline newline
23465 \begin_inset Newline newline
23469 code to extract files ...
23470 use NOWEB_OUTPUT_DIR here ...]
23471 \begin_inset Newline newline
23475 code to compile files ...]
23476 \begin_inset Newline newline
23482 \begin_layout Standard
23485 LIBDIR/examples/listerrors.lyx
23489 LIBDIR/examples/Literate.lyx
23491 which implement two versions of the
23492 \begin_inset Quotes eld
23496 \begin_inset Quotes erd
23499 program for some illustrations of how all of these pieces go together or
23502 LIBDIR/examples/noweb2lyx.lyx.
23505 Interestingly, these three files show off the language-indepence of the
23507 literate programming support since they are written in Python, C and Perl
23511 \begin_layout Subsubsection
23512 Configuring \SpecialChar LyX
23516 \begin_layout Standard
23517 All the Literate Programming support is configured by the
23519 Tools\SpecialChar menuseparator
23523 \begin_inset Quotes eld
23527 \begin_inset Quotes erd
23531 The important parts are:
23534 \begin_layout Description
23536 \begin_inset space ~
23540 \begin_inset Quotes eld
23544 \begin_inset Quotes erd
23548 \begin_inset space ~
23551 format Set up via the File Formats tab, this is where the Noweb-specific
23561 , the file extension is set to
23566 This tells \SpecialChar LyX
23567 to create a file with a
23571 extension in the first step of the conversion process.
23574 \begin_layout Description
23576 \begin_inset space ~
23584 \begin_inset space ~
23587 format This is an empty format whose sole purpose is to be the endpoint
23588 of a conversion (which then allows us to set up a converter for it).
23591 \begin_layout Description
23601 This converter performs the
23602 \begin_inset Quotes eld
23606 \begin_inset Quotes erd
23609 of the literate document.
23610 For Noweb, it is set to
23611 \begin_inset Quotes eld
23616 noweave -delay -index $$i > $$o
23619 \begin_inset Quotes erd
23625 \begin_layout Description
23635 \begin_inset Quotes eld
23639 \begin_inset Quotes erd
23643 As stated above, the Converter is set to
23644 \begin_inset Quotes eld
23652 \begin_inset Quotes erd
23655 , with Flags set to
23656 \begin_inset Newline newline
23660 \begin_inset Quotes eld
23665 parselog=$$s/scripts/listerrors
23668 \begin_inset Quotes erd
23674 \begin_layout Subsubsection
23678 \begin_layout Standard
23679 There is also a new function implemented in the \SpecialChar LyX
23681 \begin_inset Quotes eld
23684 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
23688 \begin_layout Standard
23689 When debugging code with ddd/gdb, it is possible to invoke a text editor
23690 at the current execution position with a single key stroke.
23691 The default ddd configuration for that is shift-ctrl-V.
23692 It happens that you can define the editor command line invocation in ddd
23695 Edit\SpecialChar menuseparator
23696 Preferences\SpecialChar menuseparator
23699 dialog and changing the "Edit Sources" entry.
23702 \begin_layout Standard
23703 I take advantage of the newly created \SpecialChar LyX
23704 server function and this ddd feature,
23706 \begin_inset Quotes eld
23710 \begin_inset Quotes erd
23716 \begin_layout Standard
23717 \begin_inset VSpace defskip
23723 \begin_layout Standard
23726 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
23729 \begin_layout Standard
23730 \begin_inset VSpace defskip
23736 \begin_layout Standard
23737 With this, whenever you are using ddd and find a point in the program that
23738 you want to edit, you just press shift-ctrl-V (in the ddd window), and
23739 ddd will forward this information to \SpecialChar LyX
23740 through the \SpecialChar LyX
23741 server and then the
23743 window will show the same file with the cursor at the same position ddd
23745 No more guessing or long scrolling to locate a point in the program back
23749 \begin_layout Standard
23750 Note however that you must enable the \SpecialChar LyX
23751 server to get this feature working
23752 (it is disabled by default).
23753 You can enable it in
23765 ) by entering in the
23771 \begin_inset Quotes eld
23776 /home/<your-home-directory>/.lyx/lyxpipe
23779 \begin_inset Quotes erd
23785 \begin_layout Standard
23786 Read the \SpecialChar LyX
23787 server documentation in the
23789 Customization Manual
23791 for further information.
23794 \begin_layout Subsubsection
23798 \begin_layout Standard
23799 There are six new buttons that can be added to your \SpecialChar LyX
23801 Five of these buttons are short cuts to layout styles:
23824 The last one is a short cut to the
23825 \begin_inset Quotes eld
23829 \begin_inset Quotes erd
23836 \begin_layout Standard
23838 has a range of buttons that are available for tool bar customization.
23839 In my toolbar I like to combine the six short cuts above with two more:
23844 \SpecialChar menuseparator
23849 \SpecialChar menuseparator
23856 Document\SpecialChar menuseparator
23857 View\SpecialChar menuseparator
23861 Here is how it looks like:
23864 \begin_layout LyX-Code
23868 \begin_layout LyX-Code
23872 \begin_layout LyX-Code
23873 Icon "layout Standard"
23876 \begin_layout LyX-Code
23877 Icon "layout Section"
23880 \begin_layout LyX-Code
23881 Icon "layout \SpecialChar LaTeX
23885 \begin_layout LyX-Code
23886 Icon "layout \SpecialChar LyX
23890 \begin_layout LyX-Code
23891 Icon "layout Chunk"
23894 \begin_layout LyX-Code
23898 \begin_layout LyX-Code
23902 \begin_layout LyX-Code
23903 Icon "buffer-typeset"
23906 \begin_layout LyX-Code
23907 Icon "build-program"
23910 \begin_layout LyX-Code
23914 \begin_layout LyX-Code
23918 \begin_layout LyX-Code
23922 \begin_layout LyX-Code
23926 \begin_layout LyX-Code
23930 \begin_layout Subsubsection
23931 Colors customization
23934 \begin_layout Standard
23935 There are a number of colors in \SpecialChar LyX
23936 that can be customized in
23941 One of the things that bothers people is the \SpecialChar LaTeX
23943 The default color is red, since the chunks uses \SpecialChar LaTeX
23944 font, and there is a lot
23945 of chunks in literate documents, you may get tired of seeing everything
23947 You can change it by going to the tabs
23956 \begin_layout Standard
23957 The next thing is the visible presence of the newline character in the screen.
23958 You can choose the color of this particular character and make it blend
23960 I recommend you choosing a color that is close to the background but not
23961 equal, that way you still can see it is there, but it is not bothering
23965 \begin_layout Subsection
23970 \begin_layout Standard
23979 is documented in the
23983 example file and in the Sweave manual (menu
23985 Help\SpecialChar menuseparator
23991 \begin_layout Chapter
23995 \begin_layout Standard
23996 You can do everything with \SpecialChar LyX
23997 that you can do with \SpecialChar LaTeX
23999 However, \SpecialChar LyX
24000 cannot support every \SpecialChar LaTeX
24002 But you can always use \SpecialChar TeX
24004 This chapter shows you some more special things you might want to use.
24005 For other special things you can do with figures, tables, floats, boxes
24006 and notes, have a look at the
24009 \begin_inset space ~
24017 \begin_layout Section
24018 Multiple Text Columns
24021 \begin_layout Standard
24022 This feature is independent of the option
24024 Two-column document
24026 in the document settings under
24031 If you want to have 2
24032 \begin_inset space ~
24035 columns for the whole document, it is recommended to use the
24037 Two-column document
24040 For all other cases use this feature.
24043 \begin_layout Standard
24044 To use multiple text columns in your document, you have to load the module
24051 Document\SpecialChar menuseparator
24052 Settings\SpecialChar menuseparator
24055 ) and must have the \SpecialChar LaTeX
24063 \begin_layout Standard
24064 Footnotes within multiple columns will be placed at the bottom of the page
24065 and not under each column.
24066 Within the different columns you can use everything, with the limitation
24067 that for floats you need to use the float option
24074 \begin_layout Subsection
24078 \begin_layout Standard
24079 If you want to have 2
24080 \begin_inset space ~
24083 columns in your text, insert a multicolumn inset via the menu
24085 Insert\SpecialChar menuseparator
24087 \begin_inset space ~
24090 Insets\SpecialChar menuseparator
24092 \begin_inset space ~
24097 where the columns should start.
24098 Write all text that should be printed in 2
24099 \begin_inset space ~
24102 columns into this inset.
24105 \begin_layout Standard
24106 Here is an example:
24109 \begin_layout Standard
24111 \begin_inset Flex Multiple Columns
24114 \begin_layout Plain Layout
24119 The Adventure of the Empty House
24122 \begin_inset Newline newline
24125 by Sir Arthur Conan Doyle
24128 \begin_layout Plain Layout
24131 It was in the spring of the year 1894 that all London was interested, and
24132 the fashionable world dismayed, by the murder of the Honourable Ronald
24133 Adair under most unusual and inexplicable circumstances.
24134 The public has already learned those particulars of the crime which came
24135 out in the police investigation, but a good deal was suppressed upon that
24136 occasion, since the case for the prosecution was so overwhelmingly strong
24137 that it was not necessary to bring forward all the facts.
24138 Only now, at the end of nearly ten years, am I allowed to supply those
24139 missing links which make up the whole of that remarkable chain.
24140 The crime was of interest in itself, but that interest was as nothing to
24141 me compared to the inconceivable sequel, which afforded me the greatest
24142 shock and surprise of any event in my adventurous life.
24143 Even now, after this long interval, I find myself thrilling as I think
24144 of it, and feeling once more that sudden flood of joy, amazement, and increduli
24145 ty which utterly submerged my mind.
24146 Let me say to that public, which has shown some interest in those glimpses
24147 which I have occasionally given them of the thoughts and actions of a very
24148 remarkable man, that they are not to blame me if I have not shared my knowledge
24149 with them, for I should have considered it my first duty to do so, had
24150 I not been barred by a positive prohibition from his own lips, which was
24151 only withdrawn upon the third of last month.
24159 \begin_layout Standard
24160 To get 3 or more columns, set the cursor into the multicolumn inset and
24163 Insert\SpecialChar menuseparator
24165 \begin_inset space ~
24169 \begin_inset space ~
24175 The number of the desired columns is written into that inset (for 3
24176 \begin_inset space ~
24180 \begin_inset Quotes eld
24184 \begin_inset Quotes erd
24188 \begin_inset Newline newline
24191 Here is an example with 3
24192 \begin_inset space ~
24198 \begin_layout Standard
24199 \begin_inset Flex Multiple Columns
24202 \begin_layout Plain Layout
24205 \begin_inset Argument 1
24208 \begin_layout Plain Layout
24214 It can be imagined that my close intimacy with Sherlock Holmes had interested
24215 me deeply in crime, and that after his disappearance I never failed to
24216 read with care the various problems which came before the public.
24217 And I even attempted, more than once, for my own private satisfaction,
24218 to employ his methods in their solution, though with indifferent success.
24219 There was none, however, which appealed to me like this tragedy of Ronald
24221 As I read the evidence at the inquest, which led up to a verdict of willful
24222 murder against some person or persons unknown, I realized more clearly
24223 than I had ever done the loss which the community had sustained by the
24224 death of Sherlock Holmes.
24225 There were points about this strange business which would, I was sure,
24226 have specially appealed to him, and the efforts of the police would have
24227 been supplemented, or more probably anticipated, by the trained observation
24228 and the alert mind of the first criminal agent in Europe.
24229 All day, as I drove upon my round, I turned over the case in my mind and
24230 found no explanation which appeared to me to be adequate.
24231 At the risk of telling a twice-told tale, I will recapitulate the facts
24232 as they were known to the public at the conclusion of the inquest.
24240 \begin_layout Standard
24241 You can have up to 10
24242 \begin_inset space ~
24245 columns if you want to, but that might not be very pleasant for the readers
24249 \begin_layout Standard
24250 \begin_inset Newpage newpage
24256 \begin_layout Subsection
24257 Columns inside Columns
24260 \begin_layout Standard
24261 You can also have columns inside columns:
24264 \begin_layout Standard
24265 \begin_inset Flex Multiple Columns
24268 \begin_layout Plain Layout
24271 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
24272 at that time governor of one of the Australian colonies.
24273 Adair's mother had returned from Australia to undergo the operation for
24274 cataract, and she, her son Ronald, and her daughter Hilda were living together
24278 \begin_layout Plain Layout
24279 \begin_inset Flex Multiple Columns
24282 \begin_layout Plain Layout
24285 The youth moved in the best society–had, so far as was known, no enemies
24286 and no particular vices.
24287 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
24288 had been broken off by mutual consent some months before, and there was
24289 no sign that it had left any very profound feeling behind it.
24290 For the rest {sic} the man's life moved in a narrow and conventional circle,
24291 for his habits were quiet and his nature unemotional.
24292 Yet it was upon this easy-going young aristocrat that death came, in most
24293 strange and unexpected form, between the hours of ten and eleven-twenty
24294 on the night of March 30, 1894.
24302 \begin_layout Plain Layout
24305 Ronald Adair was fond of cards–playing continually, but never for such stakes
24307 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
24308 It was shown that, after dinner on the day of his death, he had played
24309 a rubber of whist at the latter club.
24310 He had also played there in the afternoon.
24315 The evidence of those who had played with him– Mr.
24316 Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
24317 and that there was a fairly equal fall of the cards.
24318 Adair might have lost five pounds, but not more.
24319 His fortune was a considerable one, and such a loss could not in any way
24321 He had played nearly every day at one club or other, but he was a cautious
24322 player, and usually rose a winner.
24323 It came out in evidence that, in partnership with Colonel Moran, he had
24324 actually won as much as four hundred and twenty pounds in a sitting, some
24325 weeks before, from Godfrey Milner and Lord Balmoral.
24326 So much for his recent history as it came out at the inquest.
24334 \begin_layout Subsection
24338 \begin_layout Standard
24339 The examples in this section show some more special features of multiple
24343 \begin_layout Standard
24344 For more features of multiple columns, have a look at the documentation
24345 of the \SpecialChar LaTeX
24351 \begin_inset CommandInset citation
24360 \begin_layout Subsubsection
24364 \begin_layout Standard
24365 To add a preface text for multiple columns, set the cursor into the multicolumn
24366 inset and use the menu
24368 Insert\SpecialChar menuseparator
24372 Write your preface text into that inset.
24373 \begin_inset Newline newline
24376 This is an example with some preface text:
24379 \begin_layout Standard
24380 \begin_inset VSpace bigskip
24386 \begin_layout Standard
24387 \begin_inset Flex Multiple Columns
24390 \begin_layout Plain Layout
24391 \begin_inset Argument 2
24394 \begin_layout Plain Layout
24395 And the story continues and continues and continues and continues\SpecialChar ldots
24403 On the evening of the crime, he returned from the club exactly at ten.
24404 His mother and sister were out spending the evening with a relation.
24405 The servant deposed that she heard him enter the front room on the second
24406 floor, generally used as his sitting-room.
24407 She had lit a fire there, and as it smoked she had opened the window.
24408 No sound was heard from the room until eleven-twenty, the hour of the return
24409 of Lady Maynooth and her daughter.
24410 Desiring to say good-night, she attempted to enter her son's room.
24411 The door was locked on the inside, and no answer could be got to their
24412 cries and knocking.
24413 Help was obtained, and the door forced.
24414 The unfortunate young man was found lying near the table.
24415 His head had been horribly mutilated by an expanding revolver bullet, but
24416 no weapon of any sort was to be found in the room.
24424 \begin_layout Standard
24425 You can also use a section heading as the preface if you use a section command
24426 as \SpecialChar TeX
24428 For example the command
24431 \begin_layout Standard
24436 subsection{subsection title}
24439 \begin_layout Standard
24440 creates a subsection.
24441 In this example the preface is a subsubsection:
24444 \begin_layout Standard
24445 \begin_inset Flex Multiple Columns
24448 \begin_layout Plain Layout
24449 \begin_inset Argument 2
24452 \begin_layout Plain Layout
24456 \begin_layout Plain Layout
24465 This is a subsubsection heading as a preface
24469 \begin_layout Plain Layout
24483 A minute examination of the circumstances served only to make the case more
24485 In the first place, no reason could be given why the young man should have
24486 fastened the door upon the inside.
24487 There was the possibility that the murderer had done this, and had afterwards
24488 escaped by the window.
24489 The drop was at least twenty feet, however, and a bed of crocuses in full
24491 Neither the flowers nor the earth showed any sign of having been disturbed,
24492 nor were there any marks upon the narrow strip of grass which separated
24493 the house from the road.
24494 Apparently, therefore, it was the young man himself who had fastened the
24496 But how did he come by his death? No one could have climbed up to the window
24497 without leaving traces.
24498 Suppose a man had fired through the window, he would indeed be a remarkable
24499 shot who could with a revolver inflict so deadly a wound.
24500 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
24501 a hundred yards of the house.
24502 No one had heard a shot.
24510 \begin_layout Standard
24511 If there is less vertical space than 6
24512 \begin_inset space ~
24515 text lines is left on the page at the beginning of the multiple columns,
24516 a page break will be inserted before the multiple columns.
24517 Depending on the number of lines of the preface text, you might want to
24519 This is done by setting the cursor into the mulitcolumn inset behind the
24520 preface (if there is any) and using the menu
24522 Insert\SpecialChar menuseparator
24524 \begin_inset space ~
24528 \begin_inset space ~
24532 \begin_inset space ~
24538 Insert into that inset the amount of space like e.
24539 \begin_inset space \thinspace{}
24543 \begin_inset space \space{}
24547 \begin_inset Quotes eld
24551 \begin_inset Quotes erd
24555 \begin_inset Newline newline
24558 In this example the space is set to 7
24559 \begin_inset space ~
24562 text lines by using
24563 \begin_inset Quotes eld
24569 \begin_inset Quotes erd
24578 needs to be inserted as \SpecialChar TeX
24582 \begin_layout Standard
24583 \begin_inset Flex Multiple Columns
24586 \begin_layout Plain Layout
24587 \begin_inset Argument 3
24590 \begin_layout Plain Layout
24595 \begin_layout Plain Layout
24611 On the evening of the crime, he returned from the club exactly at ten.
24612 His mother and sister were out spending the evening with a relation.
24613 The servant deposed that she heard him enter the front room on the second
24614 floor, generally used as his sitting-room.
24615 She had lit a fire there, and as it smoked she had opened the window.
24616 No sound was heard from the room until eleven-twenty, the hour of the return
24617 of Lady Maynooth and her daughter.
24618 Desiring to say good-night, she attempted to enter her son's room.
24619 The door was locked on the inside, and no answer could be got to their
24620 cries and knocking.
24621 Help was obtained, and the door forced.
24622 The unfortunate young man was found lying near the table.
24623 His head had been horribly mutilated by an expanding revolver bullet, but
24624 no weapon of any sort was to be found in the room.
24632 \begin_layout Subsubsection
24636 \begin_layout Standard
24637 The amount of space before and after multiple columns can be changed by
24638 changing the length
24645 For example the command
24648 \begin_layout Standard
24658 \begin_layout Standard
24659 in \SpecialChar TeX
24660 Code changes its value to 3
24661 \begin_inset space \thinspace{}
24665 The change must be made before the multiple columns' start.
24666 The predefined value is 13
24667 \begin_inset space \thinspace{}
24673 \begin_layout Standard
24681 \begin_inset space \thinspace{}
24687 \begin_layout Standard
24691 \begin_layout Plain Layout
24697 multicolsep}{2.5cm}
24705 \begin_layout Standard
24706 \begin_inset Flex Multiple Columns
24709 \begin_layout Plain Layout
24712 All day I turned these facts over in my mind, endeavouring to hit upon some
24713 theory which could reconcile them all, and to find that line of least resistanc
24714 e which my poor friend had declared to be the starting-point of every investigat
24716 I confess that I made little progress.
24717 In the evening I strolled across the Park, and found myself about six o'clock
24718 at the Oxford Street end of Park Lane.
24719 A group of loafers upon the pavements, all staring up at a particular window,
24720 directed me to the house which I had come to see.
24721 A tall, thin man with coloured glasses, whom I strongly suspected of being
24722 a plain-clothes detective, was pointing out some theory of his own, while
24723 the others crowded round to listen to what he said.
24724 I got as near him as I could, but his observations seemed to me to be absurd,
24725 so I withdrew again in some disgust.
24726 As I did so I struck against an elderly, deformed man, who had been behind
24727 me, and I knocked down several books which he was carrying.
24735 \begin_layout Standard
24736 \begin_inset Note Greyedout
24739 \begin_layout Plain Layout
24744 The values you set with
24750 will be used for all following multiple columns until you change them again.
24758 \begin_layout Standard
24762 \begin_layout Plain Layout
24774 \begin_inset Note Note
24777 \begin_layout Plain Layout
24778 go back to the default
24786 \begin_layout Standard
24787 \begin_inset Newpage newpage
24793 \begin_layout Subsubsection
24797 \begin_layout Standard
24798 A column break can be forced by inserting the command
24804 as \SpecialChar TeX
24805 Code to that position in the text where the column should be broken.
24806 Note that this leads in most cases to whitespace in the text.
24807 \begin_inset Newline newline
24810 Here is an example:
24813 \begin_layout Standard
24814 \begin_inset Flex Multiple Columns
24817 \begin_layout Plain Layout
24820 \begin_inset Quotes eld
24823 You're surprised to see me, sir,
24824 \begin_inset Quotes erd
24827 said he, in a strange, croaking voice.
24830 \begin_layout Plain Layout
24833 I acknowledged that I was.
24836 \begin_layout Plain Layout
24839 \begin_inset Quotes eld
24842 Well, I've a conscience, sir, and when I chanced to see you go into this
24843 house, as I came hobbling after you, I thought to myself, I'll just step
24844 in and see that kind gentleman, and tell him that if I was a bit gruff
24845 in my manner there was not any harm meant, and that I am much obliged to
24846 him for picking up my books.
24847 \begin_inset Quotes erd
24853 \begin_layout Plain Layout
24856 \begin_inset Quotes eld
24859 You make too much of a trifle,
24860 \begin_inset Quotes erd
24865 \begin_inset Quotes eld
24868 May I ask how you knew who I was?
24869 \begin_inset Quotes erd
24872 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
24876 \begin_layout Plain Layout
24888 \begin_layout Plain Layout
24891 \begin_inset Quotes eld
24894 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
24895 you'll find my little bookshop at the corner of Church Street, and very
24896 happy to see you, I am sure.
24897 Maybe you collect yourself, sir.
24901 \begin_inset space ~
24914 –a bargain, every one of them.
24915 With five volumes you could just fill that gap on that second shelf.
24916 It looks untidy, does it not, sir?
24917 \begin_inset Quotes erd
24928 \begin_layout Subsubsection
24932 \begin_layout Standard
24933 The width of the columns is automatically calculated, but you can modify
24934 the space between the columns.
24935 This is done by changing the length
24942 Its predefined value is 10
24943 \begin_inset space \thinspace{}
24947 Here is an example where
24954 \begin_inset space \thinspace{}
24960 \begin_layout Standard
24964 \begin_layout Plain Layout
24978 \begin_layout Standard
24979 \begin_inset Flex Multiple Columns
24982 \begin_layout Plain Layout
24985 My observations of No.
24986 \begin_inset space \space{}
24989 427 Park Lane did little to clear up the problem in which I was interested.
24990 The house was separated from the street by a low wall and railing, the
24991 whole not more than five feet high.
24992 It was perfectly easy, therefore, for anyone to get into the garden, but
24993 the window was entirely inaccessible, since there was no water pipe or
24994 anything which could help the most active man to climb it.
24995 More puzzled than ever, I retraced my steps to Kensington.
24996 I had not been in my study five minutes when the maid entered to say that
24997 a person desired to see me.
24998 To my astonishment it was none other than my strange old book collector,
24999 his sharp, wizened face peering out from a frame of white hair, and his
25000 precious volumes, a dozen of them at least, wedged under his right arm.
25008 \begin_layout Standard
25012 \begin_layout Plain Layout
25024 \begin_inset Note Note
25027 \begin_layout Plain Layout
25028 go back to the default
25036 \begin_layout Subsubsection
25040 \begin_layout Standard
25041 Between the columns a rule with a width of the length
25048 If this rule width is set to 0
25049 \begin_inset space \thinspace{}
25052 pt (this is the default), the rule is suppressed.
25053 In the following example the rule is 2
25054 \begin_inset space \thinspace{}
25060 \begin_layout Standard
25064 \begin_layout Plain Layout
25070 columnseprule}{2pt}
25078 \begin_layout Standard
25079 \begin_inset Flex Multiple Columns
25082 \begin_layout Plain Layout
25085 \begin_inset Quotes eld
25088 You're surprised to see me, sir,
25089 \begin_inset Quotes erd
25092 said he, in a strange, croaking voice.
25095 \begin_layout Plain Layout
25098 I acknowledged that I was.
25101 \begin_layout Plain Layout
25104 \begin_inset Quotes eld
25107 Well, I've a conscience, sir, and when I chanced to see you go into this
25108 house, as I came hobbling after you, I thought to myself, I'll just step
25109 in and see that kind gentleman, and tell him that if I was a bit gruff
25110 in my manner there was not any harm meant, and that I am much obliged to
25111 him for picking up my books.
25112 \begin_inset Quotes erd
25118 \begin_layout Plain Layout
25121 \begin_inset Quotes eld
25124 You make too much of a trifle,
25125 \begin_inset Quotes erd
25130 \begin_inset Quotes eld
25133 May I ask how you knew who I was?
25134 \begin_inset Quotes erd
25140 \begin_layout Plain Layout
25143 \begin_inset Quotes eld
25146 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25147 you'll find my little bookshop at the corner of Church Street, and very
25148 happy to see you, I am sure.
25149 Maybe you collect yourself, sir.
25153 \begin_inset space ~
25166 –a bargain, every one of them.
25167 With five volumes you could just fill that gap on that second shelf.
25168 It looks untidy, does it not, sir?
25169 \begin_inset Quotes erd
25180 \begin_layout Standard
25181 \begin_inset VSpace defskip
25187 \begin_layout Standard
25188 The rule can be colored by redefining the command
25195 This is done by inserting the command
25196 \begin_inset Newline newline
25205 columnseprulecolor}{
25210 \begin_inset Newline newline
25213 as \SpecialChar TeX
25214 Code before the multicolumn inset.
25219 in this command by a color of your choice.
25220 You can use all pre- and self-defined colors.
25228 \begin_inset space ~
25233 for more information about pre- and self-defined colors.
25234 To go back to the default color insert the command
25235 \begin_inset Newline newline
25244 columnseprulecolor}{
25249 \begin_inset Newline newline
25252 Here is the example with a cyan rule and 1
25253 \begin_inset space \thinspace{}
25256 cm column separation:
25259 \begin_layout Standard
25263 \begin_layout Plain Layout
25272 \begin_layout Plain Layout
25278 columnseprulecolor}{
25288 \begin_layout Standard
25289 \begin_inset Flex Multiple Columns
25292 \begin_layout Plain Layout
25295 \begin_inset Quotes eld
25298 You're surprised to see me, sir,
25299 \begin_inset Quotes erd
25302 said he, in a strange, croaking voice.
25305 \begin_layout Plain Layout
25308 I acknowledged that I was.
25311 \begin_layout Plain Layout
25314 \begin_inset Quotes eld
25317 Well, I've a conscience, sir, and when I chanced to see you go into this
25318 house, as I came hobbling after you, I thought to myself, I'll just step
25319 in and see that kind gentleman, and tell him that if I was a bit gruff
25320 in my manner there was not any harm meant, and that I am much obliged to
25321 him for picking up my books.
25322 \begin_inset Quotes erd
25328 \begin_layout Plain Layout
25331 \begin_inset Quotes eld
25334 You make too much of a trifle,
25335 \begin_inset Quotes erd
25340 \begin_inset Quotes eld
25343 May I ask how you knew who I was?
25344 \begin_inset Quotes erd
25350 \begin_layout Plain Layout
25353 \begin_inset Quotes eld
25356 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25357 you'll find my little bookshop at the corner of Church Street, and very
25358 happy to see you, I am sure.
25359 Maybe you collect yourself, sir.
25363 \begin_inset space ~
25376 –a bargain, every one of them.
25377 With five volumes you could just fill that gap on that second shelf.
25378 It looks untidy, does it not, sir?
25379 \begin_inset Quotes erd
25390 \begin_layout Standard
25394 \begin_layout Plain Layout
25400 columnseprule}{0pt}
25403 \begin_layout Plain Layout
25409 columnseprulecolor}{
25417 \begin_inset Note Note
25420 \begin_layout Plain Layout
25421 go back to the default
25429 \begin_layout Section
25430 Non-standard Paragraph Shapes
25433 \begin_layout Standard
25436 as well as any other text processor uses by default rectangular paragraphs.
25437 For special cases like for example posters, invitation cards or poems you
25438 can modify the paragraph shape to one of your choice.
25439 This can be done by using the \SpecialChar LaTeX
25444 which is loaded by using in the document settings the module
25446 Custom paragraph shapes
25451 \begin_layout Subsection
25455 \begin_layout Standard
25460 provides the following shapes:
25463 \begin_layout Standard
25464 \begin_inset Tabular
25465 <lyxtabular version="3" rows="13" columns="3">
25466 <features booktabs="true" islongtable="true" longtabularalignment="center">
25467 <column alignment="center" valignment="middle" width="16col%">
25468 <column alignment="center" valignment="middle" width="40col%">
25469 <column alignment="center" valignment="middle" width="35col%">
25470 <row endhead="true">
25471 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25474 \begin_layout Plain Layout
25480 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25483 \begin_layout Plain Layout
25489 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
25492 \begin_layout Plain Layout
25500 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25503 \begin_layout Plain Layout
25509 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25512 \begin_layout Plain Layout
25513 Circle with circular hole (in the size of a CD/DVD)
25518 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25521 \begin_layout Plain Layout
25522 Cannot be scaled, take care there is not too much text
25529 <cell alignment="center" valignment="top" topline="true" usebox="none">
25532 \begin_layout Plain Layout
25538 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25541 \begin_layout Plain Layout
25547 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25550 \begin_layout Plain Layout
25551 Fragile, calculation might fail
25558 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25561 \begin_layout Plain Layout
25567 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25570 \begin_layout Plain Layout
25571 Rhomboid (symbolizing a
25572 \begin_inset Quotes eld
25576 \begin_inset Quotes erd
25584 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25587 \begin_layout Plain Layout
25595 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25598 \begin_layout Plain Layout
25604 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25607 \begin_layout Plain Layout
25613 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25616 \begin_layout Plain Layout
25624 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25627 \begin_layout Plain Layout
25633 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25636 \begin_layout Plain Layout
25642 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25645 \begin_layout Plain Layout
25653 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25656 \begin_layout Plain Layout
25662 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25665 \begin_layout Plain Layout
25666 Nut for bolt (hexagon with circular hole)
25671 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25674 \begin_layout Plain Layout
25682 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25685 \begin_layout Plain Layout
25691 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25694 \begin_layout Plain Layout
25700 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25703 \begin_layout Plain Layout
25711 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25714 \begin_layout Plain Layout
25720 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25723 \begin_layout Plain Layout
25729 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
25732 \begin_layout Plain Layout
25740 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25743 \begin_layout Plain Layout
25749 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25752 \begin_layout Plain Layout
25758 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25761 \begin_layout Plain Layout
25769 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25772 \begin_layout Plain Layout
25778 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25781 \begin_layout Plain Layout
25782 Normal/reversed rain drop
25787 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25790 \begin_layout Plain Layout
25791 Fragile, calculation might fail
25798 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25801 \begin_layout Plain Layout
25808 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25811 \begin_layout Plain Layout
25812 The \SpecialChar TeX
25818 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25821 \begin_layout Plain Layout
25829 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25832 \begin_layout Plain Layout
25834 \begin_inset Newline newline
25842 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25845 \begin_layout Plain Layout
25846 Triangles in different orientations
25851 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
25854 \begin_layout Plain Layout
25868 \begin_layout Standard
25869 To use a shape for your paragraph, simply select it in \SpecialChar LyX
25871 for environments in the toolbar.
25874 \begin_layout Standard
25875 \begin_inset Newpage newpage
25881 \begin_layout Standard
25882 Here is an example paragraph in the shape of a nut:
25885 \begin_layout Standard
25886 \begin_inset VSpace bigskip
25895 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
25896 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
25898 At vero eos et accusam et justo duo dolores et ea rebum.
25899 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
25901 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
25902 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
25906 \begin_layout Standard
25907 \begin_inset VSpace bigskip
25913 \begin_layout Standard
25914 \begin_inset Note Greyedout
25917 \begin_layout Plain Layout
25922 : shapepar paragraphs cannot run over a page break.
25930 \begin_layout Standard
25931 \begin_inset VSpace bigskip
25937 \begin_layout Standard
25942 takes care that the shape will always be preserved, no matter how much
25943 text is in the paragraph.
25944 Therefore the paragraph size changes with the amount of contained text.
25945 This can lead to paragraph sizes exceeding the page margins.
25946 To demonstrate the size scaling, here is the same example paragraph but
25947 with twice as much text:
25950 \begin_layout Standard
25951 \begin_inset Newpage newpage
25960 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
25961 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
25963 At vero eos et accusam et justo duo dolores et ea rebum.
25964 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
25966 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
25967 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
25969 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
25970 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
25972 At vero eos et accusam et justo duo dolores et ea rebum.
25973 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
25975 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
25976 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
25980 \begin_layout Standard
25981 \begin_inset VSpace bigskip
25987 \begin_layout Standard
25988 An exception is the shape
25993 It cannot be scaled because it must fit the size of a CD/DVD.
25994 Therefore the amount of text that fits into the shape is limited.
25995 \begin_inset Newline newline
26006 shape are fragile, meaning that the calculation of their size can fail,
26007 depending on the amount of text.
26008 You will then get the \SpecialChar LaTeX
26010 \begin_inset Quotes eld
26013 Arithmetic overflow
26014 \begin_inset Quotes erd
26018 In this case one can try to remove or add some text; if nothing works one
26019 has to use another shape.
26022 \begin_layout Standard
26023 \begin_inset VSpace bigskip
26029 \begin_layout Standard
26030 For shapes with tips you will maybe see that \SpecialChar LaTeX
26031 's hyphenation routine fails
26032 for text in the tips.
26033 Therefore it is often necessary to add hyphenation points
26038 arg "specialchar-insert hyphenation"
26043 ) to the corresponding text parts.
26046 \begin_layout Standard
26047 \begin_inset VSpace bigskip
26053 \begin_layout Standard
26054 Shapepar paragraphs are either always centered or placed on the page so
26055 that their left border touches the left page margin.
26056 You can therefore not use the paragraph dialog to align such paragraphs.
26057 A solution is to put the paragraph into a minipage or parbox and align
26059 The problem is hereby to find the right width for the box.
26060 Because if it is too wide and you center the box, the paragraph is not
26061 centered too because it sticks at the left side of the box.
26062 So you might have to play a bit with the width until it fits.
26063 Here are two heart-shaped paragraphs, the first one is not aligned, the
26064 second one is right-aligned:
26067 \begin_layout Standard
26068 \begin_inset Newpage newpage
26074 \begin_layout Heart
26078 Lo\SpecialChar softhyphen
26079 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26080 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26082 At vero eos et accusam et justo duo dolores et ea rebum.
26083 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26087 \begin_layout Standard
26088 \begin_inset VSpace bigskip
26094 \begin_layout Standard
26097 \begin_inset Box Frameless
26107 height_special "totalheight"
26112 backgroundcolor "none"
26115 \begin_layout Heart
26119 Lo\SpecialChar softhyphen
26120 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26121 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26123 At vero eos et accusam et justo duo dolores et ea rebum.
26124 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26133 \begin_layout Subsection
26137 \begin_layout Standard
26138 You can define any shape you want.
26139 Doing this manually is a lot of work because every coordinate must be specified.
26140 But there is a way to let the computer calculate the coordinates:
26143 \begin_layout Enumerate
26144 Install the program
26145 \begin_inset CommandInset href
26148 target "http://www.ctan.org/tex-archive/graphics/jpgfdraw"
26155 \begin_layout Enumerate
26162 TeX/LaTeX\SpecialChar menuseparator
26163 Settings\SpecialChar menuseparator
26166 and select the font size you are using in your document.
26167 For example this document uses the size 12
26168 \begin_inset space \thinspace{}
26174 \begin_layout Enumerate
26178 \begin_layout Enumerate
26181 TeX/LaTeX\SpecialChar menuseparator
26184 to export the shape to coordinates.
26185 In the appearing dialog use either the outline of your shape for the coordinate
26186 s or the path itself.
26190 \begin_layout Plain Layout
26191 For more information see
26192 \begin_inset CommandInset href
26194 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
26206 \begin_layout Standard
26207 The coordinates are written into a \SpecialChar TeX
26209 To use it for your \SpecialChar LyX
26213 \begin_layout Enumerate
26214 Place the cursor before the first character of your paragraph (or into a
26218 \begin_layout Enumerate
26219 Open in \SpecialChar LyX
26222 Insert\SpecialChar menuseparator
26223 File\SpecialChar menuseparator
26225 \begin_inset space ~
26230 , select the file and use
26239 \begin_layout Standard
26240 \begin_inset VSpace defskip
26246 \begin_layout Standard
26247 \begin_inset Note Greyedout
26250 \begin_layout Plain Layout
26255 : The changed shape only applies to the current paragraph; everything is
26256 reset to normal for the next paragraph.
26257 Therefore the shape definition file must be input into every paragraph
26258 with the desired shape.
26266 \begin_layout Standard
26267 \begin_inset VSpace bigskip
26273 \begin_layout Standard
26274 Here is an example:
26277 \begin_layout Standard
26278 \begin_inset VSpace bigskip
26284 \begin_layout Standard
26285 \begin_inset CommandInset include
26287 filename "SpecialParagraphShape.tex"
26293 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26294 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26296 At vero eos et accusam et justo duo dolores et ea rebum.
26297 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26299 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26300 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26304 \begin_layout Standard
26305 \begin_inset VSpace bigskip
26311 \begin_layout Standard
26316 to draw complexer shapes in
26320 you can draw the shape in a program of your choice and import the resulting
26326 Then you only need to draw a line or spline along the outline of the image.
26329 \begin_layout Standard
26330 \begin_inset VSpace bigskip
26336 \begin_layout Standard
26339 Custom paragraph shapes
26341 also provides the two commands
26349 which can be used to define custom shapes coordinate by coordinate.
26353 \begin_layout Plain Layout
26354 These commands are internally used for all shapes described here.
26359 For information how these styles are used and about further customization
26360 possibilities, have a look at the documentation of the package
26365 \begin_inset CommandInset citation
26374 \begin_layout Bibliography
26375 \begin_inset CommandInset bibitem
26376 LatexCommand bibitem
26381 Documentation of the \SpecialChar LaTeX
26383 \begin_inset CommandInset href
26386 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
26393 \begin_layout Bibliography
26394 \begin_inset CommandInset bibitem
26395 LatexCommand bibitem
26400 Documentation of the \SpecialChar LaTeX
26402 \begin_inset CommandInset href
26405 target "http://mirrors.ctan.org/macros/latex/contrib/shapepar/shapepar.pdf"